Class: ActiveHash::Base
- Inherits:
-
Object
- Object
- ActiveHash::Base
- Extended by:
- ActiveModel::Naming
- Includes:
- ActiveModel::Conversion
- Defined in:
- lib/active_hash/base.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
Class Method Summary collapse
- .add_to_record_index(entry) ⇒ Object
- .all(options = {}) ⇒ Object
- .auto_assign_fields(array_of_hashes) ⇒ Object
-
.base_class ⇒ Object
Needed for ActiveRecord polymorphic associations.
- .compute_type(type_name) ⇒ Object
- .configuration_for_custom_finder(finder_name) ⇒ Object
- .count ⇒ Object
- .create(attributes = {}) ⇒ Object (also: add)
- .create!(attributes = {}) ⇒ Object
- .data ⇒ Object
- .data=(array_of_hashes) ⇒ Object
- .define_custom_find_all_method(field_name) ⇒ Object
- .define_custom_find_method(field_name) ⇒ Object
- .define_getter_method(field, default_value) ⇒ Object
- .define_interrogator_method(field) ⇒ Object
- .define_setter_method(field) ⇒ Object
- .delete_all ⇒ Object
- .field(field_name, options = {}) ⇒ Object
- .field_names ⇒ Object
- .fields(*args) ⇒ Object
- .find(id, *args) ⇒ Object
- .find_by_id(id) ⇒ Object
- .has_instance_method?(name) ⇒ Boolean
- .has_singleton_method?(name) ⇒ Boolean
- .insert(record) ⇒ Object
- .mark_clean ⇒ Object
- .mark_dirty ⇒ Object
- .method_missing(method_name, *args) ⇒ Object
- .next_id ⇒ Object
- .pluralize_table_names ⇒ Object
- .primary_key ⇒ Object
- .record_index ⇒ Object
- .reload ⇒ Object
- .reset_record_index ⇒ Object
- .respond_to?(method_name, include_private = false) ⇒ Boolean
- .the_meta_class ⇒ Object
- .transaction ⇒ Object
- .validate_field(field_name) ⇒ Object
- .validate_unique_id(record) ⇒ Object
- .where(options) ⇒ Object
Instance Method Summary collapse
- #[](key) ⇒ Object
- #[]=(key, val) ⇒ Object
- #cache_key ⇒ Object
- #destroyed? ⇒ Boolean
- #eql?(other) ⇒ Boolean (also: #==)
- #errors ⇒ Object
- #hash ⇒ Object
- #id ⇒ Object (also: #quoted_id)
- #id=(id) ⇒ Object
-
#initialize(attributes = {}) ⇒ Base
constructor
A new instance of Base.
- #marked_for_destruction? ⇒ Boolean
- #new_record? ⇒ Boolean
- #persisted? ⇒ Boolean
- #readonly? ⇒ Boolean
- #save(*args) ⇒ Object (also: #save!)
- #to_param ⇒ Object
- #valid? ⇒ Boolean
Constructor Details
#initialize(attributes = {}) ⇒ Base
Returns a new instance of Base.
369 370 371 372 373 374 375 |
# File 'lib/active_hash/base.rb', line 369 def initialize(attributes = {}) attributes.symbolize_keys! @attributes = attributes attributes.dup.each do |key, value| send "#{key}=", value end end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
367 368 369 |
# File 'lib/active_hash/base.rb', line 367 def attributes @attributes end |
Class Method Details
.add_to_record_index(entry) ⇒ Object
101 102 103 |
# File 'lib/active_hash/base.rb', line 101 def add_to_record_index(entry) record_index.merge!(entry) end |
.all(options = {}) ⇒ Object
128 129 130 131 132 133 134 |
# File 'lib/active_hash/base.rb', line 128 def all(={}) if .has_key?(:conditions) where([:conditions]) else @records || [] end end |
.auto_assign_fields(array_of_hashes) ⇒ Object
312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/active_hash/base.rb', line 312 def auto_assign_fields(array_of_hashes) (array_of_hashes || []).inject([]) do |array, row| row.symbolize_keys! row.keys.each do |key| unless key.to_s == "id" array << key end end array end.uniq.each do |key| field key end end |
.base_class ⇒ Object
Needed for ActiveRecord polymorphic associations
329 330 331 |
# File 'lib/active_hash/base.rb', line 329 def base_class ActiveHash::Base end |
.compute_type(type_name) ⇒ Object
45 46 47 |
# File 'lib/active_hash/base.rb', line 45 def compute_type(type_name) self end |
.configuration_for_custom_finder(finder_name) ⇒ Object
236 237 238 239 240 241 242 243 244 |
# File 'lib/active_hash/base.rb', line 236 def configuration_for_custom_finder(finder_name) if finder_name.to_s.match(/^find_(all_)?by_(.*?)(!)?$/) && !($1 && $3) { :all? => !!$1, :bang? => !!$3, :fields => $2.split('_and_') } end end |
.count ⇒ Object
142 143 144 |
# File 'lib/active_hash/base.rb', line 142 def count all.length end |
.create(attributes = {}) ⇒ Object Also known as: add
113 114 115 116 117 118 |
# File 'lib/active_hash/base.rb', line 113 def create(attributes = {}) record = new(attributes) record.save mark_dirty record end |
.create!(attributes = {}) ⇒ Object
122 123 124 125 126 |
# File 'lib/active_hash/base.rb', line 122 def create!(attributes = {}) record = new(attributes) record.save! record end |
.data ⇒ Object
53 54 55 |
# File 'lib/active_hash/base.rb', line 53 def data _data end |
.data=(array_of_hashes) ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/active_hash/base.rb', line 57 def data=(array_of_hashes) mark_dirty @records = nil reset_record_index self._data = array_of_hashes if array_of_hashes auto_assign_fields(array_of_hashes) array_of_hashes.each do |hash| insert new(hash) end end end |
.define_custom_find_all_method(field_name) ⇒ Object
295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/active_hash/base.rb', line 295 def define_custom_find_all_method(field_name) method_name = :"find_all_by_#{field_name}" unless has_singleton_method?(method_name) .instance_eval do unless singleton_methods.include?(method_name) define_method(method_name) do |*args| = args. identifier = args[0] all.select { |record| record.send(field_name) == identifier } end end end end end |
.define_custom_find_method(field_name) ⇒ Object
280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/active_hash/base.rb', line 280 def define_custom_find_method(field_name) method_name = :"find_by_#{field_name}" unless has_singleton_method?(method_name) .instance_eval do define_method(method_name) do |*args| = args. identifier = args[0] all.detect { |record| record.send(field_name) == identifier } end end end end |
.define_getter_method(field, default_value) ⇒ Object
248 249 250 251 252 253 254 |
# File 'lib/active_hash/base.rb', line 248 def define_getter_method(field, default_value) unless has_instance_method?(field) define_method(field) do attributes[field].nil? ? default_value : attributes[field] end end end |
.define_interrogator_method(field) ⇒ Object
269 270 271 272 273 274 275 276 |
# File 'lib/active_hash/base.rb', line 269 def define_interrogator_method(field) method_name = :"#{field}?" unless has_instance_method?(method_name) define_method(method_name) do send(field).present? end end end |
.define_setter_method(field) ⇒ Object
258 259 260 261 262 263 264 265 |
# File 'lib/active_hash/base.rb', line 258 def define_setter_method(field) method_name = "#{field}=" unless has_instance_method?(method_name) define_method(method_name) do |new_val| attributes[field] = new_val end end end |
.delete_all ⇒ Object
153 154 155 156 157 |
# File 'lib/active_hash/base.rb', line 153 def delete_all mark_dirty reset_record_index @records = [] end |
.field(field_name, options = {}) ⇒ Object
188 189 190 191 192 193 194 195 196 197 |
# File 'lib/active_hash/base.rb', line 188 def field(field_name, = {}) validate_field(field_name) field_names << field_name define_getter_method(field_name, [:default]) define_setter_method(field_name) define_interrogator_method(field_name) define_custom_find_method(field_name) define_custom_find_all_method(field_name) end |
.field_names ⇒ Object
35 36 37 |
# File 'lib/active_hash/base.rb', line 35 def field_names @field_names ||= [] end |
.fields(*args) ⇒ Object
181 182 183 184 185 186 |
# File 'lib/active_hash/base.rb', line 181 def fields(*args) = args. args.each do |field| field(field, ) end end |
.find(id, *args) ⇒ Object
159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/active_hash/base.rb', line 159 def find(id, * args) case id when nil nil when :all all when Array id.map { |i| find(i) } else find_by_id(id) || begin raise RecordNotFound.new("Couldn't find #{name} with ID=#{id}") end end end |
.find_by_id(id) ⇒ Object
174 175 176 177 |
# File 'lib/active_hash/base.rb', line 174 def find_by_id(id) index = record_index[id.to_s] index and @records[index] end |
.has_instance_method?(name) ⇒ Boolean
353 354 355 |
# File 'lib/active_hash/base.rb', line 353 def has_instance_method?(name) instance_methods.map { |method| method.to_sym }.include?(name) end |
.has_singleton_method?(name) ⇒ Boolean
359 360 361 |
# File 'lib/active_hash/base.rb', line 359 def has_singleton_method?(name) singleton_methods.map { |method| method.to_sym }.include?(name) end |
.insert(record) ⇒ Object
70 71 72 73 74 75 76 77 78 |
# File 'lib/active_hash/base.rb', line 70 def insert(record) @records ||= [] record.attributes[:id] ||= next_id validate_unique_id(record) if dirty mark_dirty add_to_record_index({ record.id.to_s => @records.length }) @records << record end |
.mark_clean ⇒ Object
347 348 349 |
# File 'lib/active_hash/base.rb', line 347 def mark_clean self.dirty = false end |
.mark_dirty ⇒ Object
341 342 343 |
# File 'lib/active_hash/base.rb', line 341 def mark_dirty self.dirty = true end |
.method_missing(method_name, *args) ⇒ Object
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/active_hash/base.rb', line 217 def method_missing(method_name, *args) return super unless respond_to? method_name config = configuration_for_custom_finder(method_name) attribute_pairs = config[:fields].zip(args) matches = all.select { |base| attribute_pairs.all? { |field, value| base.send(field).to_s == value.to_s } } if config[:all?] matches else result = matches.first if config[:bang?] result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attribute_pairs.collect { |pair| "#{pair[0]} = #{pair[1]}" }.join(', ')}") else result end end end |
.next_id ⇒ Object
80 81 82 83 84 85 86 87 |
# File 'lib/active_hash/base.rb', line 80 def next_id max_record = all.max { |a, b| a.id <=> b.id } if max_record.nil? 1 elsif max_record.id.is_a?(Numeric) max_record.id.succ end end |
.pluralize_table_names ⇒ Object
49 50 51 |
# File 'lib/active_hash/base.rb', line 49 def pluralize_table_names true end |
.primary_key ⇒ Object
31 32 33 |
# File 'lib/active_hash/base.rb', line 31 def primary_key "id" end |
.record_index ⇒ Object
89 90 91 |
# File 'lib/active_hash/base.rb', line 89 def record_index @record_index ||= {} end |
.reload ⇒ Object
333 334 335 336 337 |
# File 'lib/active_hash/base.rb', line 333 def reload reset_record_index self.data = _data mark_clean end |
.reset_record_index ⇒ Object
95 96 97 |
# File 'lib/active_hash/base.rb', line 95 def reset_record_index record_index.clear end |
.respond_to?(method_name, include_private = false) ⇒ Boolean
207 208 209 210 211 212 213 214 215 |
# File 'lib/active_hash/base.rb', line 207 def respond_to?(method_name, include_private=false) super || begin config = configuration_for_custom_finder(method_name) config && config[:fields].all? do |field| field_names.include?(field.to_sym) || field.to_sym == :id end end end |
.the_meta_class ⇒ Object
39 40 41 42 43 |
# File 'lib/active_hash/base.rb', line 39 def class << self self end end |
.transaction ⇒ Object
146 147 148 149 150 151 |
# File 'lib/active_hash/base.rb', line 146 def transaction yield rescue LocalJumpError => err raise err rescue ActiveRecord::Rollback end |
.validate_field(field_name) ⇒ Object
199 200 201 202 203 |
# File 'lib/active_hash/base.rb', line 199 def validate_field(field_name) if [:attributes].include?(field_name.to_sym) raise ReservedFieldError.new("#{field_name} is a reserved field in ActiveHash. Please use another name.") end end |
.validate_unique_id(record) ⇒ Object
107 108 109 |
# File 'lib/active_hash/base.rb', line 107 def validate_unique_id(record) raise IdError.new("Duplicate Id found for record #{record.attributes}") if record_index.has_key?(record.id.to_s) end |
.where(options) ⇒ Object
136 137 138 139 140 |
# File 'lib/active_hash/base.rb', line 136 def where() (@records || []).select do |record| .all? { |col, match| record[col] == match } end end |
Instance Method Details
#[](key) ⇒ Object
377 378 379 |
# File 'lib/active_hash/base.rb', line 377 def [](key) attributes[key] end |
#[]=(key, val) ⇒ Object
381 382 383 |
# File 'lib/active_hash/base.rb', line 381 def []=(key, val) attributes[key] = val end |
#cache_key ⇒ Object
421 422 423 424 425 426 427 428 429 430 |
# File 'lib/active_hash/base.rb', line 421 def cache_key case when new_record? "#{self.class.model_name.cache_key}/new" when = self[:updated_at] "#{self.class.model_name.cache_key}/#{id}-#{.to_s(:number)}" else "#{self.class.model_name.cache_key}/#{id}" end end |
#destroyed? ⇒ Boolean
399 400 401 |
# File 'lib/active_hash/base.rb', line 399 def destroyed? false end |
#eql?(other) ⇒ Boolean Also known as: ==
411 412 413 |
# File 'lib/active_hash/base.rb', line 411 def eql?(other) other.instance_of?(self.class) and not id.nil? and (id == other.id) end |
#errors ⇒ Object
432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'lib/active_hash/base.rb', line 432 def errors obj = Object.new def obj.[](key) [] end def obj.() [] end obj end |
#hash ⇒ Object
417 418 419 |
# File 'lib/active_hash/base.rb', line 417 def hash id.hash end |
#id ⇒ Object Also known as: quoted_id
385 386 387 |
# File 'lib/active_hash/base.rb', line 385 def id attributes[:id] ? attributes[:id] : nil end |
#id=(id) ⇒ Object
389 390 391 |
# File 'lib/active_hash/base.rb', line 389 def id=(id) attributes[:id] = id end |
#marked_for_destruction? ⇒ Boolean
457 458 459 |
# File 'lib/active_hash/base.rb', line 457 def marked_for_destruction? false end |
#new_record? ⇒ Boolean
395 396 397 |
# File 'lib/active_hash/base.rb', line 395 def new_record? !self.class.all.include?(self) end |
#persisted? ⇒ Boolean
403 404 405 |
# File 'lib/active_hash/base.rb', line 403 def persisted? self.class.all.map(&:id).include?(id) end |
#readonly? ⇒ Boolean
407 408 409 |
# File 'lib/active_hash/base.rb', line 407 def readonly? true end |
#save(*args) ⇒ Object Also known as: save!
446 447 448 449 |
# File 'lib/active_hash/base.rb', line 446 def save(*args) self.class.insert(self) true end |
#to_param ⇒ Object
24 25 26 |
# File 'lib/active_hash/base.rb', line 24 def to_param id.present? ? id.to_s : nil end |
#valid? ⇒ Boolean
453 454 455 |
# File 'lib/active_hash/base.rb', line 453 def valid? true end |