Module: ArrayFields

Defined in:
lib/arrayfields.rb

Overview

The ArrayFields module implements methods which allow an Array to be indexed by String or Symbol. It is not required to manually use this module to extend Arrays - they are auto-extended on a per-object basis when Array#fields= is called

Defined Under Namespace

Classes: FieldSet

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.version ⇒ Object 



9
 
# File 'lib/arrayfields.rb', line 9

def self.version() Arrayfields::VERSION end

Instance Method Details

#[](idx, *args) ⇒ Object

methods redefined to work with fields as well as numeric indexes



54
55
56
57
58
59
60
61
62
 
# File 'lib/arrayfields.rb', line 54

def [] idx, *args
  if @fieldset and (String === idx or Symbol === idx)
    pos = @fieldset.pos idx
    return nil unless pos
    super(pos, *args)
  else
    super
  end
end

#[]=(idx, *args) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/arrayfields.rb', line 73

def []=(idx, *args) 
  if @fieldset and (String === idx or Symbol === idx) 
    pos = @fieldset.pos idx
    unless pos
      @fieldset.fields << idx
      @fieldset.fieldpos[idx] = pos = size
    end
    super(pos, *args)
  else
    super
  end
end

#at(idx) ⇒ Object 



85
86
87
88
89
90
91
92
93
 
# File 'lib/arrayfields.rb', line 85

def at idx
  if @fieldset and (String === idx or Symbol === idx)
    pos = @fieldset.pos idx
    return nil unless pos
    super pos
  else
    super
  end
end

#clone ⇒ Object 



255
256
257
258
259
 
# File 'lib/arrayfields.rb', line 255

def clone
  clone = super
ensure
  clone.fields = fields.clone
end

#deepcopy ⇒ Object 



267
268
269
270
271
 
# File 'lib/arrayfields.rb', line 267

def deepcopy 
  cp = Marshal.load(Marshal.dump(self))
  cp.fields = Marshal.load(Marshal.dump(self.fields))
  cp 
end

#delete_at(idx) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/arrayfields.rb', line 94

def delete_at idx
  if @fieldset and (String === idx or Symbol === idx)
    pos = @fieldset.pos idx
    return nil unless pos
    new_fields = fields.dup
    new_fields.delete_at(pos)
    self.fields = new_fields
    super pos
  else
    super
  end
end

#dup ⇒ Object 



261
262
263
264
265
 
# File 'lib/arrayfields.rb', line 261

def dup
  dup = super
ensure
  dup.fields = fields.dup
end

#each_key ⇒ Object 



157
158
159
 
# File 'lib/arrayfields.rb', line 157

def each_key
  @fieldset.each{|field| yield field}
end

#each_pair ⇒ Object

methods which give a hash-like interface



152
153
154
155
156
 
# File 'lib/arrayfields.rb', line 152

def each_pair
  each_with_index do |elem, i|
    yield @fieldset.fields[i], elem
  end
end

#each_value(*args, &block) ⇒ Object 



160
161
162
 
# File 'lib/arrayfields.rb', line 160

def each_value *args, &block
  each(*args, &block)
end

#each_with_field ⇒ Object 



144
145
146
147
148
 
# File 'lib/arrayfields.rb', line 144

def each_with_field
  each_with_index do |elem, i|
    yield elem, @fieldset.fields[i]
  end
end

#fetch(key) ⇒ Object 



163
164
165
 
# File 'lib/arrayfields.rb', line 163

def fetch key
  self[key] or raise IndexError, 'key not found'
end

#fill(obj, *args) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/arrayfields.rb', line 106

def fill(obj, *args)
  idx = args.first
  if idx and @fieldset and (String === idx or Symbol === idx)
    idx = args.shift
    pos = @fieldset.pos idx
    super(obj, pos, *args)
  else
    super
  end
end

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/arrayfields.rb', line 167

def has_key? key
  @fieldset.fields.include? key
end

#has_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
180
181
182
183
184
185
 
# File 'lib/arrayfields.rb', line 177

def has_value? value
  if respond_to? 'include?'
    self.include? value
  else
    a = []
    each{|val| a << val}
    a.include? value
  end
end

#indexes(*idxs) ⇒ Object 



131
132
133
134
135
136
137
 
# File 'lib/arrayfields.rb', line 131

def indexes(*idxs)
  idxs.flatten!
  if @fieldset
    idxs.map!{|i| (String === i or Symbol === i) ? @fieldset.pos(i) : i}
  end
  super(*idxs)
end

#indices(*idxs) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/arrayfields.rb', line 124

def indices(*idxs)
  idxs.flatten!
  if @fieldset
    idxs.map!{|i| (String === i or Symbol === i) ? @fieldset.pos(i) : i}
  end
  super(*idxs)
end

#invert ⇒ Object 



246
247
248
 
# File 'lib/arrayfields.rb', line 246

def invert
  to_hash.invert
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/arrayfields.rb', line 173

def key? key
  @fieldset.fields.include? key
end

#keys ⇒ Object 



196
197
198
 
# File 'lib/arrayfields.rb', line 196

def keys
  fields
end

#member?(key) ⇒ Boolean

Returns:

  • (Boolean) 


170
171
172
 
# File 'lib/arrayfields.rb', line 170

def member? key
  @fieldset.fields.include? key
end

#replace(other) ⇒ Object 



243
244
245
 
# File 'lib/arrayfields.rb', line 243

def replace other
  Hash === other ? update(other) : super
end

#slice(idx, *args) ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'lib/arrayfields.rb', line 63

def slice idx, *args
  if @fieldset and (String === idx or Symbol === idx)
    pos = @fieldset.pos idx
    return nil unless pos
    super(pos, *args)
  else
    super
  end
end

#slice!(*args) ⇒ Object 



139
140
141
142
143
 
# File 'lib/arrayfields.rb', line 139

def slice!(*args)
  ret = self[*args]
  self[*args] = nil
  ret
end

#store(key, value) ⇒ Object 



199
200
201
 
# File 'lib/arrayfields.rb', line 199

def store key, value
  self[key] = value
end

#to_h ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/arrayfields.rb', line 225

def to_h
  if respond_to? 'to_ary'
    h = {}
    @fieldset.fields.zip(to_ary){|f,e| h[f] = e}
    h
  else
    a = []
    each{|val| a << val}
    h = {}
    @fieldset.fields.zip(a){|f,e| h[f] = e}
    h
  end
end

#to_hash ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/arrayfields.rb', line 212

def to_hash
  if respond_to? 'to_ary'
    h = {}
    @fieldset.fields.zip(to_ary){|f,e| h[f] = e}
    h
  else
    a = []
    each{|val| a << val}
    h = {}
    @fieldset.fields.zip(a){|f,e| h[f] = e}
    h
  end
end

#to_pairs ⇒ Object Also known as: pairs 



250
251
252
 
# File 'lib/arrayfields.rb', line 250

def to_pairs
  fields.zip values
end

#update(other) ⇒ Object 



239
240
241
242
 
# File 'lib/arrayfields.rb', line 239

def update other
  other.each{|k,v| self[k] = v}
  to_hash
end

#value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
189
190
191
192
193
194
 
# File 'lib/arrayfields.rb', line 186

def value? value
  if respond_to? 'include?'
    self.include? value
  else
    a = []
    each{|val| a << val}
    a.include? value
  end
end

#values ⇒ Object 



202
203
204
205
206
207
208
209
210
 
# File 'lib/arrayfields.rb', line 202

def values
  if respond_to? 'to_ary'
    self.to_ary
  else
    a = []
    each{|val| a << val}
    a
  end
end

#values_at(*idxs) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/arrayfields.rb', line 117

def values_at(*idxs)
  idxs.flatten!
  if @fieldset
    idxs.map!{|i| (String === i or Symbol === i) ? @fieldset.pos(i) : i}
  end
  super(*idxs)
end