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
Defined Under Namespace
Classes: WhereChain
Class Method Summary collapse
- .add_default_value(field_name, default_value) ⇒ Object
- .add_to_record_index(entry) ⇒ Object
- .all(options = {}) ⇒ Object
- .auto_assign_fields(array_of_hashes) ⇒ Object
-
.base_class ⇒ Object
Needed for ActiveRecord polymorphic associations.
- .cache_key ⇒ Object
- .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
- .empty? ⇒ Boolean
- .exists?(record) ⇒ Boolean
- .field(field_name, options = {}) ⇒ Object
- .field_names ⇒ Object
- .fields(*args) ⇒ Object
- .find(id, *args) ⇒ Object
- .find_by(options) ⇒ Object
- .find_by!(options) ⇒ Object
- .find_by_id(id) ⇒ Object
- .insert(record) ⇒ Object
- .mark_clean ⇒ Object
- .mark_dirty ⇒ Object
- .match_options?(record, options) ⇒ Boolean
- .method_missing(method_name, *args) ⇒ Object
- .next_id ⇒ Object
- .normalize(v) ⇒ Object
- .pluck(*column_names) ⇒ Object
- .pluralize_table_names ⇒ Object
-
.polymorphic_name ⇒ Object
Needed for ActiveRecord polymorphic associations(rails/rails#32148).
- .primary_key ⇒ Object
- .range_to_array(range) ⇒ Object
- .record_index ⇒ Object
- .reload ⇒ Object
- .reset_record_index ⇒ Object
- .respond_to?(method_name, include_private = false) ⇒ Boolean
- .scope(name, body) ⇒ Object
- .the_meta_class ⇒ Object
- .transaction ⇒ Object
- .validate_field(field_name) ⇒ Object
- .validate_unique_id(record) ⇒ Object
- .where(options = :chain) ⇒ Object
Instance Method Summary collapse
- #[](key) ⇒ Object
- #[]=(key, val) ⇒ Object
- #_read_attribute(key) ⇒ Object (also: #read_attribute)
- #attributes ⇒ Object
- #cache_key ⇒ Object
- #destroyed? ⇒ Boolean
- #eql?(other) ⇒ Boolean (also: #==)
- #errors ⇒ Object
- #hash ⇒ Object
- #id ⇒ Object (also: #quoted_id)
- #id=(id) ⇒ Object
-
#initialize(attributes = {}) {|_self| ... } ⇒ 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 = {}) {|_self| ... } ⇒ Base
Returns a new instance of Base.
491 492 493 494 495 496 497 498 |
# File 'lib/active_hash/base.rb', line 491 def initialize(attributes = {}) attributes.symbolize_keys! @attributes = attributes attributes.dup.each do |key, value| send "#{key}=", value end yield self if block_given? end |
Class Method Details
.add_default_value(field_name, default_value) ⇒ Object
364 365 366 367 |
# File 'lib/active_hash/base.rb', line 364 def add_default_value field_name, default_value self.default_attributes ||= {} self.default_attributes[field_name] = default_value end |
.add_to_record_index(entry) ⇒ Object
158 159 160 |
# File 'lib/active_hash/base.rb', line 158 def add_to_record_index(entry) record_index.merge!(entry) end |
.all(options = {}) ⇒ Object
185 186 187 188 189 190 191 |
# File 'lib/active_hash/base.rb', line 185 def all(={}) if .has_key?(:conditions) where([:conditions]) else @records ||= [] end end |
.auto_assign_fields(array_of_hashes) ⇒ Object
433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/active_hash/base.rb', line 433 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
450 451 452 |
# File 'lib/active_hash/base.rb', line 450 def base_class ActiveHash::Base end |
.cache_key ⇒ Object
70 71 72 73 74 75 76 |
# File 'lib/active_hash/base.rb', line 70 def cache_key if Object.const_defined?(:ActiveModel) model_name.cache_key else ActiveSupport::Inflector.tableize(self.name).downcase end end |
.compute_type(type_name) ⇒ Object
92 93 94 |
# File 'lib/active_hash/base.rb', line 92 def compute_type(type_name) self end |
.configuration_for_custom_finder(finder_name) ⇒ Object
352 353 354 355 356 357 358 359 360 |
# File 'lib/active_hash/base.rb', line 352 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
248 249 250 |
# File 'lib/active_hash/base.rb', line 248 def count all.length end |
.create(attributes = {}) ⇒ Object Also known as: add
170 171 172 173 174 175 |
# File 'lib/active_hash/base.rb', line 170 def create(attributes = {}) record = new(attributes) record.save mark_dirty record end |
.create!(attributes = {}) ⇒ Object
179 180 181 182 183 |
# File 'lib/active_hash/base.rb', line 179 def create!(attributes = {}) record = new(attributes) record.save! record end |
.data ⇒ Object
104 105 106 |
# File 'lib/active_hash/base.rb', line 104 def data _data end |
.data=(array_of_hashes) ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/active_hash/base.rb', line 108 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
416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/active_hash/base.rb', line 416 def define_custom_find_all_method(field_name) method_name = :"find_all_by_#{field_name}" unless singleton_methods.include?(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
401 402 403 404 405 406 407 408 409 410 411 412 |
# File 'lib/active_hash/base.rb', line 401 def define_custom_find_method(field_name) method_name = :"find_by_#{field_name}" unless singleton_methods.include?(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
369 370 371 372 373 374 375 |
# File 'lib/active_hash/base.rb', line 369 def define_getter_method(field, default_value) unless instance_methods.include?(field.to_sym) define_method(field) do attributes[field].nil? ? default_value : attributes[field] end end end |
.define_interrogator_method(field) ⇒ Object
390 391 392 393 394 395 396 397 |
# File 'lib/active_hash/base.rb', line 390 def define_interrogator_method(field) method_name = :"#{field}?" unless instance_methods.include?(method_name) define_method(method_name) do send(field).present? end end end |
.define_setter_method(field) ⇒ Object
379 380 381 382 383 384 385 386 |
# File 'lib/active_hash/base.rb', line 379 def define_setter_method(field) method_name = :"#{field}=" unless instance_methods.include?(method_name) define_method(method_name) do |new_val| @attributes[field] = new_val end end end |
.delete_all ⇒ Object
266 267 268 269 270 |
# File 'lib/active_hash/base.rb', line 266 def delete_all mark_dirty reset_record_index @records = [] end |
.empty? ⇒ Boolean
100 101 102 |
# File 'lib/active_hash/base.rb', line 100 def empty? false end |
.exists?(record) ⇒ Boolean
121 122 123 124 125 |
# File 'lib/active_hash/base.rb', line 121 def exists?(record) if record.id.present? record_index[record.id.to_s].present? end end |
.field(field_name, options = {}) ⇒ Object
303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/active_hash/base.rb', line 303 def field(field_name, = {}) validate_field(field_name) field_names << field_name add_default_value(field_name, [:default]) if [:default] 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
82 83 84 |
# File 'lib/active_hash/base.rb', line 82 def field_names @field_names ||= [] end |
.fields(*args) ⇒ Object
296 297 298 299 300 301 |
# File 'lib/active_hash/base.rb', line 296 def fields(*args) = args. args.each do |field| field(field, ) end end |
.find(id, *args) ⇒ Object
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/active_hash/base.rb', line 272 def find(id, * args) case id when :all all when :first all(*args).first when Array id.map { |i| find(i) } when nil raise RecordNotFound.new("Couldn't find #{name} without an ID") else find_by_id(id) || begin raise RecordNotFound.new("Couldn't find #{name} with ID=#{id}") end end end |
.find_by(options) ⇒ Object
213 214 215 |
# File 'lib/active_hash/base.rb', line 213 def find_by() where().first end |
.find_by!(options) ⇒ Object
217 218 219 |
# File 'lib/active_hash/base.rb', line 217 def find_by!() find_by() || (raise RecordNotFound.new("Couldn't find #{name}")) end |
.find_by_id(id) ⇒ Object
289 290 291 292 |
# File 'lib/active_hash/base.rb', line 289 def find_by_id(id) index = record_index[id.to_s] index and @records[index] end |
.insert(record) ⇒ Object
127 128 129 130 131 132 133 134 135 |
# File 'lib/active_hash/base.rb', line 127 def insert(record) @records ||= [] record[: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
473 474 475 |
# File 'lib/active_hash/base.rb', line 473 def mark_clean self.dirty = false end |
.mark_dirty ⇒ Object
467 468 469 |
# File 'lib/active_hash/base.rb', line 467 def mark_dirty self.dirty = true end |
.match_options?(record, options) ⇒ Boolean
221 222 223 224 225 226 227 228 229 |
# File 'lib/active_hash/base.rb', line 221 def (record, ) .all? do |col, match| if match.kind_of?(Array) match.any? { |v| normalize(v) == normalize(record[col]) } else normalize(record[col]) == normalize(match) end end end |
.method_missing(method_name, *args) ⇒ Object
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/active_hash/base.rb', line 333 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
137 138 139 140 141 142 143 144 |
# File 'lib/active_hash/base.rb', line 137 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 |
.normalize(v) ⇒ Object
233 234 235 |
# File 'lib/active_hash/base.rb', line 233 def normalize(v) v.respond_to?(:to_sym) ? v.to_sym : v end |
.pluck(*column_names) ⇒ Object
252 253 254 |
# File 'lib/active_hash/base.rb', line 252 def pluck(*column_names) column_names.map { |column_name| all.map(&column_name.to_sym) }.inject(&:zip) end |
.pluralize_table_names ⇒ Object
96 97 98 |
# File 'lib/active_hash/base.rb', line 96 def pluralize_table_names true end |
.polymorphic_name ⇒ Object
Needed for ActiveRecord polymorphic associations(rails/rails#32148)
455 456 457 |
# File 'lib/active_hash/base.rb', line 455 def polymorphic_name base_class.name end |
.primary_key ⇒ Object
78 79 80 |
# File 'lib/active_hash/base.rb', line 78 def primary_key "id" end |
.range_to_array(range) ⇒ Object
239 240 241 242 243 244 |
# File 'lib/active_hash/base.rb', line 239 def range_to_array(range) return range.to_a unless range.end.nil? e = data.last[:id] (range.begin..e).to_a end |
.record_index ⇒ Object
146 147 148 |
# File 'lib/active_hash/base.rb', line 146 def record_index @record_index ||= {} end |
.reload ⇒ Object
459 460 461 462 463 |
# File 'lib/active_hash/base.rb', line 459 def reload reset_record_index self.data = _data mark_clean end |
.reset_record_index ⇒ Object
152 153 154 |
# File 'lib/active_hash/base.rb', line 152 def reset_record_index record_index.clear end |
.respond_to?(method_name, include_private = false) ⇒ Boolean
323 324 325 326 327 328 329 330 331 |
# File 'lib/active_hash/base.rb', line 323 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 |
.scope(name, body) ⇒ Object
479 480 481 482 483 484 485 486 487 |
# File 'lib/active_hash/base.rb', line 479 def scope(name, body) raise ArgumentError, 'body needs to be callable' unless body.respond_to?(:call) .instance_eval do define_method(name) do |*args| instance_exec(*args, &body) end end end |
.the_meta_class ⇒ Object
86 87 88 89 90 |
# File 'lib/active_hash/base.rb', line 86 def class << self self end end |
.transaction ⇒ Object
256 257 258 259 260 261 262 263 264 |
# File 'lib/active_hash/base.rb', line 256 def transaction yield rescue LocalJumpError => err raise err rescue StandardError => e unless Object.const_defined?(:ActiveRecord) && e.is_a?(ActiveRecord::Rollback) raise e end end |
.validate_field(field_name) ⇒ Object
315 316 317 318 319 |
# File 'lib/active_hash/base.rb', line 315 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
164 165 166 |
# File 'lib/active_hash/base.rb', line 164 def validate_unique_id(record) raise IdError.new("Duplicate ID found for record #{record.attributes.inspect}") if record_index.has_key?(record.id.to_s) end |
.where(options = :chain) ⇒ Object
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/active_hash/base.rb', line 193 def where( = :chain) if == :chain return WhereChain.new(self) elsif .blank? return @records end # use index if searching by id if .key?(:id) || .key?("id") ids = (.delete(:id) || .delete("id")) ids = range_to_array(ids) if ids.is_a?(Range) candidates = Array.wrap(ids).map { |id| find_by_id(id) }.compact end return candidates if .blank? (candidates || @records || []).select do |record| (record, ) end end |
Instance Method Details
#[](key) ⇒ Object
508 509 510 |
# File 'lib/active_hash/base.rb', line 508 def [](key) attributes[key] end |
#[]=(key, val) ⇒ Object
517 518 519 |
# File 'lib/active_hash/base.rb', line 517 def []=(key, val) @attributes[key] = val end |
#_read_attribute(key) ⇒ Object Also known as: read_attribute
512 513 514 |
# File 'lib/active_hash/base.rb', line 512 def _read_attribute(key) attributes[key] end |
#attributes ⇒ Object
500 501 502 503 504 505 506 |
# File 'lib/active_hash/base.rb', line 500 def attributes if self.class.default_attributes (self.class.default_attributes.merge @attributes).freeze else @attributes end end |
#cache_key ⇒ Object
557 558 559 560 561 562 563 564 565 566 |
# File 'lib/active_hash/base.rb', line 557 def cache_key case when new_record? "#{self.class.cache_key}/new" when = self[:updated_at] "#{self.class.cache_key}/#{id}-#{.to_s(:number)}" else "#{self.class.cache_key}/#{id}" end end |
#destroyed? ⇒ Boolean
535 536 537 |
# File 'lib/active_hash/base.rb', line 535 def destroyed? false end |
#eql?(other) ⇒ Boolean Also known as: ==
547 548 549 |
# File 'lib/active_hash/base.rb', line 547 def eql?(other) other.instance_of?(self.class) and not id.nil? and (id == other.id) end |
#errors ⇒ Object
568 569 570 571 572 573 574 575 576 577 578 579 580 |
# File 'lib/active_hash/base.rb', line 568 def errors obj = Object.new def obj.[](key) [] end def obj.() [] end obj end |
#hash ⇒ Object
553 554 555 |
# File 'lib/active_hash/base.rb', line 553 def hash id.hash end |
#id ⇒ Object Also known as: quoted_id
521 522 523 |
# File 'lib/active_hash/base.rb', line 521 def id attributes[:id] ? attributes[:id] : nil end |
#id=(id) ⇒ Object
525 526 527 |
# File 'lib/active_hash/base.rb', line 525 def id=(id) @attributes[:id] = id end |
#marked_for_destruction? ⇒ Boolean
595 596 597 |
# File 'lib/active_hash/base.rb', line 595 def marked_for_destruction? false end |
#new_record? ⇒ Boolean
531 532 533 |
# File 'lib/active_hash/base.rb', line 531 def new_record? !self.class.all.include?(self) end |
#persisted? ⇒ Boolean
539 540 541 |
# File 'lib/active_hash/base.rb', line 539 def persisted? self.class.all.map(&:id).include?(id) end |
#readonly? ⇒ Boolean
543 544 545 |
# File 'lib/active_hash/base.rb', line 543 def readonly? true end |
#save(*args) ⇒ Object Also known as: save!
582 583 584 585 586 587 |
# File 'lib/active_hash/base.rb', line 582 def save(*args) unless self.class.exists?(self) self.class.insert(self) end true end |
#to_param ⇒ Object
63 64 65 |
# File 'lib/active_hash/base.rb', line 63 def to_param id.present? ? id.to_s : nil end |
#valid? ⇒ Boolean
591 592 593 |
# File 'lib/active_hash/base.rb', line 591 def valid? true end |