Class: Megam::SpaceCollection

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/megam/core/space_collection.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SpaceCollection

Returns a new instance of SpaceCollection.



22
23
24
25
26
 
# File 'lib/megam/core/space_collection.rb', line 22

def initialize
  @spaces = Array.new
  @spaces_by_name = Hash.new
  @insert_after_idx = nil
end

Instance Attribute Details

#iterator ⇒ Object (readonly)

Returns the value of attribute iterator.



21
22
23
 
# File 'lib/megam/core/space_collection.rb', line 21

def iterator
  @iterator
end

Class Method Details

.json_create(o) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/megam/core/space_collection.rb', line 120

def self.json_create(o)
  collection = self.new()
  o["results"].each do |spaces_list|
    spaces_array = spaces_list.kind_of?(Array) ? spaces_list : [ spaces_list ]
    spaces_array.each do |space|
      collection.insert(space)
    end
  end
  collection
end

Instance Method Details

#<<(*args) ⇒ Object Also known as: push 



42
43
44
45
46
47
48
49
 
# File 'lib/megam/core/space_collection.rb', line 42

def <<(*args)
  args.flatten.each do |a|
    is_megam_space(a)
    @spaces << a
    @spaces_by_name[a.wiki_name] = @spaces.length - 1
  end
  self
end

#[](index) ⇒ Object 



32
33
34
 
# File 'lib/megam/core/space_collection.rb', line 32

def [](index)
  @spaces[index]
end

#[]=(index, arg) ⇒ Object 



36
37
38
39
40
 
# File 'lib/megam/core/space_collection.rb', line 36

def []=(index, arg)
  is_megam_space(arg)
  @spaces[index] = arg
  @spaces_by_name[arg.wiki_name] = index
end

#all_spaces ⇒ Object 



28
29
30
 
# File 'lib/megam/core/space_collection.rb', line 28

def all_spaces
  @spaces
end

#each ⇒ Object 



73
74
75
76
77
 
# File 'lib/megam/core/space_collection.rb', line 73

def each
  @spaces.each do |space|
    yield space
  end
end

#each_index ⇒ Object 



79
80
81
82
83
 
# File 'lib/megam/core/space_collection.rb', line 79

def each_index
  @spaces.each_index do |i|
    yield i
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/megam/core/space_collection.rb', line 85

def empty?
  @spaces.empty?
end

#insert(space) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/megam/core/space_collection.rb', line 54

def insert(space)
  is_megam_space(space)
  if @insert_after_idx
    # in the middle of executing a run, so any spaces inserted now should
    # be placed after the most recent addition done by the currently executing
    # space
    @spaces.insert(@insert_after_idx + 1, space)
    # update name -> location mappings and register new space
    @spaces_by_name.each_key do |key|
    @spaces_by_name[key] += 1 if @spaces_by_name[key] > @insert_after_idx
    end
    @spaces_by_name[space.wiki_name] = @insert_after_idx + 1
    @insert_after_idx += 1
  else
  @spaces << space
  @spaces_by_name[space.wiki_name] = @spaces.length - 1 
  end
end

#lookup(space) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/megam/core/space_collection.rb', line 89

def lookup(space)
  lookup_by = nil
  if space.kind_of?(Megam::Space)
  lookup_by = space.wiki_name
  elsif space.kind_of?(String)
  lookup_by = space
  else
    raise ArgumentError, "Must pass a Megam::Space or String to lookup"
  end
  res = @spaces_by_name[lookup_by]
  unless res
    raise ArgumentError, "Cannot find a space matching #{lookup_by} (did you define it first?)"
  end
  @spaces[res]
end

#to_hash ⇒ Object

Transform the ruby obj -> to a Hash



106
107
108
109
110
111
112
 
# File 'lib/megam/core/space_collection.rb', line 106

def to_hash
  index_hash = Hash.new
  self.each do |space|
    index_hash[space.wiki_name] = space.to_s
  end
  index_hash
end

#to_json(*a) ⇒ Object

Serialize this object as a hash: called from JsonCompat. Verify if this called from JsonCompat during testing.



116
117
118
 
# File 'lib/megam/core/space_collection.rb', line 116

def to_json(*a)
  for_json.to_json(*a)
end