eav_hashes 1.0.1 → 1.0.2

data/lib/eav_hashes/eav_entry.rb

@@ -1,129 +1,129 @@
-module ActiveRecord
-  module EavHashes
-    # Used instead of nil when a nil value is assigned
-    # (otherwise, the value will try to deserialize itself and
-    #  that would break everything horrifically)
-    class NilPlaceholder; end
-
-    # Represent an EAV row. This class should NOT be used directly, instead it should be inherited from
-    # by the class generated by eav_hash_for.
-    class EavEntry < ActiveRecord::Base
-      # prevent activerecord from thinking we're trying to do STI
-      self.abstract_class = true
-
-      # Tell ActiveRecord to convert the value to its DB storable format
-      before_save :serialize_value
-
-      # Let the key be assignable only once on creation
-      attr_readonly :entry_key
-
-      # Contains the values the value_type column should have based on the type of the value being stored
-      SUPPORTED_TYPES = {
-          :String     => 0,
-          :Symbol     => 1,
-          :Integer    => 2,
-          :Fixnum     => 2,
-          :Bignum     => 2,
-          :Float      => 3,
-          :Complex    => 4,
-          :Rational   => 5,
-          :Boolean    => 6, # For code readability
-          :TrueClass  => 6,
-          :FalseClass => 6,
-          :Object     => 7 # anything else (including Hashes, Arrays) will be serialized to yaml and saved as Object
-      }
-
-      # Does some sanity checks.
-      def after_initialize
-        raise "key should be a string or symbol!" unless key.is_a? String or key.is_a? Symbol
-        raise "value should not be empty!" if @value.is_a? String and value.empty?
-        raise "value should not be nil!" if @value.nil?
-      end
-
-      # Gets the EAV row's value
-      def value
-        return nil if @value.is_a? NilPlaceholder
-        @value.nil? ? deserialize_value : @value
-      end
-
-      # Sets the EAV row's value
-      # @param [Object] val the value
-      def value= (val)
-        @value = (val.nil? ? NilPlaceholder.new : val)
-      end
-
-
-      def key
-        k = read_attribute :entry_key
-        (read_attribute :symbol_key) ? k.to_sym : k
-      end
-
-      # Raises an error if you try changing the key (unless no key is set)
-      def key= (val)
-        raise "Keys are immutable!" if read_attribute(:entry_key)
-        raise "Key must be a string!" unless val.is_a?(String) or val.is_a?(Symbol)
-        write_attribute :entry_key, val.to_s
-        write_attribute :symbol_key, (val.is_a? Symbol)
-      end
-
-      # Gets the value_type column's value for the type of value passed
-      # @param [Object] val the object whose value_type to determine
-      def self.get_value_type (val)
-        return nil if val.nil?
-        ret = SUPPORTED_TYPES[val.class.name.to_sym]
-        if ret.nil?
-          ret = SUPPORTED_TYPES[:Object]
-        end
-        ret
-      end
-
-    private
-      # Sets the value_type column to the appropriate value based on the value's type
-      def update_value_type
-        write_attribute :value_type, EavEntry.get_value_type(@value)
-      end
-
-      # Converts the value to its database-storable form and tells ActiveRecord that it's been changed (if it has)
-      def serialize_value
-        # Returning nil will prevent the row from being saved, to save some time since the EavHash that manages this
-        # entry will have marked it for deletion.
-        raise "Tried to save with a nil value!" if @value.nil? or @value.is_a? NilPlaceholder
-
-        update_value_type
-        if value_type == SUPPORTED_TYPES[:Object]
-          write_attribute :value, YAML::dump(@value)
-        else
-          write_attribute :value, @value.to_s
-        end
-
-        read_attribute :value
-      end
-
-      # Converts the value from it's database representation to the type specified in the value_type column.
-      def deserialize_value
-        if @value.nil?
-          @value = read_attribute :value
-        end
-
-        case value_type
-          when SUPPORTED_TYPES[:Object] # or Hash, Array, etc.
-            @value = YAML::load @value
-          when SUPPORTED_TYPES[:Symbol]
-            @value = @value.to_sym
-          when SUPPORTED_TYPES[:Integer] # or Fixnum, Bignum
-            @value = @value.to_i
-          when SUPPORTED_TYPES[:Float]
-            @value = @value.to_f
-          when SUPPORTED_TYPES[:Complex]
-            @value = Complex @value
-          when SUPPORTED_TYPES[:Rational]
-            @value = Rational @value
-          when SUPPORTED_TYPES[:Boolean]
-            @value = (@value == "true")
-          else
-            @value
-        end
-      end
-    end
-  end
+module ActiveRecord
+  module EavHashes
+    # Used instead of nil when a nil value is assigned
+    # (otherwise, the value will try to deserialize itself and
+    #  that would break everything horrifically)
+    class NilPlaceholder; end
+
+    # Represent an EAV row. This class should NOT be used directly, instead it should be inherited from
+    # by the class generated by eav_hash_for.
+    class EavEntry < ActiveRecord::Base
+      # prevent activerecord from thinking we're trying to do STI
+      self.abstract_class = true
+
+      # Tell ActiveRecord to convert the value to its DB storable format
+      before_save :serialize_value
+
+      # Let the key be assignable only once on creation
+      attr_readonly :entry_key
+
+      # Contains the values the value_type column should have based on the type of the value being stored
+      SUPPORTED_TYPES = {
+          :String     => 0,
+          :Symbol     => 1,
+          :Integer    => 2,
+          :Fixnum     => 2,
+          :Bignum     => 2,
+          :Float      => 3,
+          :Complex    => 4,
+          :Rational   => 5,
+          :Boolean    => 6, # For code readability
+          :TrueClass  => 6,
+          :FalseClass => 6,
+          :Object     => 7 # anything else (including Hashes, Arrays) will be serialized to yaml and saved as Object
+      }
+
+      # Does some sanity checks.
+      def after_initialize
+        raise "key should be a string or symbol!" unless key.is_a? String or key.is_a? Symbol
+        raise "value should not be empty!" if @value.is_a? String and value.empty?
+        raise "value should not be nil!" if @value.nil?
+      end
+
+      # Gets the EAV row's value
+      def value
+        return nil if @value.is_a? NilPlaceholder
+        @value.nil? ? deserialize_value : @value
+      end
+
+      # Sets the EAV row's value
+      # @param [Object] val the value
+      def value= (val)
+        @value = (val.nil? ? NilPlaceholder.new : val)
+      end
+
+
+      def key
+        k = read_attribute :entry_key
+        (read_attribute :symbol_key) ? k.to_sym : k
+      end
+
+      # Raises an error if you try changing the key (unless no key is set)
+      def key= (val)
+        raise "Keys are immutable!" if read_attribute(:entry_key)
+        raise "Key must be a string!" unless val.is_a?(String) or val.is_a?(Symbol)
+        write_attribute :entry_key, val.to_s
+        write_attribute :symbol_key, (val.is_a? Symbol)
+      end
+
+      # Gets the value_type column's value for the type of value passed
+      # @param [Object] val the object whose value_type to determine
+      def self.get_value_type (val)
+        return nil if val.nil?
+        ret = SUPPORTED_TYPES[val.class.name.to_sym]
+        if ret.nil?
+          ret = SUPPORTED_TYPES[:Object]
+        end
+        ret
+      end
+
+    private
+      # Sets the value_type column to the appropriate value based on the value's type
+      def update_value_type
+        write_attribute :value_type, EavEntry.get_value_type(@value)
+      end
+
+      # Converts the value to its database-storable form and tells ActiveRecord that it's been changed (if it has)
+      def serialize_value
+        # Returning nil will prevent the row from being saved, to save some time since the EavHash that manages this
+        # entry will have marked it for deletion.
+        raise "Tried to save with a nil value!" if @value.nil? or @value.is_a? NilPlaceholder
+
+        update_value_type
+        if value_type == SUPPORTED_TYPES[:Object]
+          write_attribute :value, YAML::dump(@value)
+        else
+          write_attribute :value, @value.to_s
+        end
+
+        read_attribute :value
+      end
+
+      # Converts the value from it's database representation to the type specified in the value_type column.
+      def deserialize_value
+        if @value.nil?
+          @value = read_attribute :value
+        end
+
+        case value_type
+          when SUPPORTED_TYPES[:Object] # or Hash, Array, etc.
+            @value = YAML::load @value
+          when SUPPORTED_TYPES[:Symbol]
+            @value = @value.to_sym
+          when SUPPORTED_TYPES[:Integer] # or Fixnum, Bignum
+            @value = @value.to_i
+          when SUPPORTED_TYPES[:Float]
+            @value = @value.to_f
+          when SUPPORTED_TYPES[:Complex]
+            @value = Complex @value
+          when SUPPORTED_TYPES[:Rational]
+            @value = Rational @value
+          when SUPPORTED_TYPES[:Boolean]
+            @value = (@value == "true")
+          else
+            @value
+        end
+      end
+    end
+  end
 end

data/lib/eav_hashes/eav_hash.rb

@@ -1,168 +1,168 @@
-module ActiveRecord
-  module EavHashes
-    # Wraps a bunch of EavEntries and lets you use them like you would a hash
-    # This class should not be used directly and you should instead let eav_hash_for create one for you
-    class EavHash
-      # Creates a new EavHash. You should really let eav_hash_for do this for you...
-      # @param [ActiveRecord::Base] owner the Model which will own this hash
-      # @param [Hash] options the options hash which eav_hash generated
-      def initialize(owner, options)
-        Util::sanity_check options
-        @owner = owner
-        @options = options
-      end
-
-      # Saves any modified entries and deletes any which have been nil'd to save DB space
-      def save_entries
-        # The entries are lazy-loaded, so don't do anything if they haven't been accessed or modified
-        return unless (@entries and @changes_made)
-
-        @entries.values.each do |entry|
-          if entry.value.nil?
-            entry.delete
-          else
-            set_entry_owner(entry)
-            entry.save
-          end
-        end
-      end
-
-      # Gets the value of an EAV attribute
-      # @param [String, Symbol] key
-      def [](key)
-        raise "Key must be a string or a symbol!" unless key.is_a?(String) or key.is_a?(Symbol)
-        load_entries_if_needed
-        return @entries[key].value if @entries[key]
-        nil
-      end
-
-      # Sets the value of the EAV attribute `key` to `value`
-      # @param [String, Symbol] key the attribute
-      # @param [Object] value the value
-      def []=(key, value)
-        update_or_create_entry key, value
-      end
-
-      # I don't know why Ruby hashes don't have a shovel operator, but I will make damn sure that I
-      # fight the power and stick it to the man by implementing it.
-      # @param [Hash, EavHash] dirt the dirt to shovel (ba dum, tss)
-      def <<(dirt)
-        if dirt.is_a? Hash
-          dirt.each do |key, value|
-            update_or_create_entry key, value
-          end
-        elsif dirt.is_a? EavHash
-          dirt.entries.each do |key, entry|
-            update_or_create_entry key, entry.value
-          end
-        else
-          raise "You can't shovel something that's not a Hash or EavHash here!"
-        end
-
-        self
-      end
-
-      # Gets the raw hash containing EavEntries by their keys
-      def entries
-        load_entries_if_needed
-      end
-
-      # Gets the actual values this EavHash contains
-      def values
-        load_entries_if_needed
-
-        ret = []
-        @entries.values.each do |value|
-          ret << value
-        end
-
-        ret
-      end
-
-      # Gets the keys this EavHash manages
-      def keys
-        load_entries_if_needed
-        @entries.keys
-      end
-
-      # Emulates Hash.each
-      def each (&block)
-        as_hash.each block
-      end
-
-      # Emulates Hash.each_pair (same as each)
-      def each_pair (&block)
-        each &block
-      end
-
-      # Empties the hash by setting all the values to nil
-      # (without committing them, of course)
-      def clear
-        load_entries_if_needed
-        @entries.each do |_, entry|
-          entry.value = nil
-        end
-      end
-
-      # Returns a hash with each entry key mapped to its actual value,
-      # not the internal EavEntry
-      def as_hash
-        load_entries_if_needed
-        hsh = {}
-        @entries.each do |k, entry|
-          hsh[k] = entry.value
-        end
-
-        hsh
-      end
-
-      # Take the crap out of #inspect calls
-      def inspect
-        as_hash
-      end
-
-    private
-      def update_or_create_entry(key, value)
-        raise "Key must be a string or a symbol!" unless key.is_a?(String) or key.is_a?(Symbol)
-        load_entries_if_needed
-
-        @changes_made = true
-        @owner.updated_at = Time.now
-
-        if @entries[key]
-          @entries[key].value = value
-        else
-          new_entry = @options[:entry_class].new
-          set_entry_owner(new_entry)
-          new_entry.key = key
-          new_entry.value = value
-
-          @entries[key] = new_entry
-
-          value
-        end
-      end
-
-      # Since entries are lazy-loaded, this is called just before an operation on an entry happens and
-      # loads the rows only once per EavHash lifetime.
-      def load_entries_if_needed
-        if @entries.nil?
-          @entries = {}
-          rows_from_model = @owner.send("#{@options[:entry_assoc_name]}")
-          rows_from_model.each do |row|
-            @entries[row.key] = row
-          end
-        end
-
-        @entries
-      end
-
-      # Sets an entry's owner ID. This is called when we save attributes for a model which has just been
-      # created and not committed to the DB prior to having its EAV hash(es) modified
-      # @param [EavEntry] entry the entry whose owner to change
-      def set_entry_owner(entry)
-        entry.send "#{@options[:parent_assoc_name]}_id=", @owner.id
-      end
-    end
-  end
+module ActiveRecord
+  module EavHashes
+    # Wraps a bunch of EavEntries and lets you use them like you would a hash
+    # This class should not be used directly and you should instead let eav_hash_for create one for you
+    class EavHash
+      # Creates a new EavHash. You should really let eav_hash_for do this for you...
+      # @param [ActiveRecord::Base] owner the Model which will own this hash
+      # @param [Hash] options the options hash which eav_hash generated
+      def initialize(owner, options)
+        Util::sanity_check options
+        @owner = owner
+        @options = options
+      end
+
+      # Saves any modified entries and deletes any which have been nil'd to save DB space
+      def save_entries
+        # The entries are lazy-loaded, so don't do anything if they haven't been accessed or modified
+        return unless (@entries and @changes_made)
+
+        @entries.values.each do |entry|
+          if entry.value.nil?
+            entry.delete
+          else
+            set_entry_owner(entry)
+            entry.save
+          end
+        end
+      end
+
+      # Gets the value of an EAV attribute
+      # @param [String, Symbol] key
+      def [](key)
+        raise "Key must be a string or a symbol!" unless key.is_a?(String) or key.is_a?(Symbol)
+        load_entries_if_needed
+        return @entries[key].value if @entries[key]
+        nil
+      end
+
+      # Sets the value of the EAV attribute `key` to `value`
+      # @param [String, Symbol] key the attribute
+      # @param [Object] value the value
+      def []=(key, value)
+        update_or_create_entry key, value
+      end
+
+      # I don't know why Ruby hashes don't have a shovel operator, but I will make damn sure that I
+      # fight the power and stick it to the man by implementing it.
+      # @param [Hash, EavHash] dirt the dirt to shovel (ba dum, tss)
+      def <<(dirt)
+        if dirt.is_a? Hash
+          dirt.each do |key, value|
+            update_or_create_entry key, value
+          end
+        elsif dirt.is_a? EavHash
+          dirt.entries.each do |key, entry|
+            update_or_create_entry key, entry.value
+          end
+        else
+          raise "You can't shovel something that's not a Hash or EavHash here!"
+        end
+
+        self
+      end
+
+      # Gets the raw hash containing EavEntries by their keys
+      def entries
+        load_entries_if_needed
+      end
+
+      # Gets the actual values this EavHash contains
+      def values
+        load_entries_if_needed
+
+        ret = []
+        @entries.values.each do |value|
+          ret << value
+        end
+
+        ret
+      end
+
+      # Gets the keys this EavHash manages
+      def keys
+        load_entries_if_needed
+        @entries.keys
+      end
+
+      # Emulates Hash.each
+      def each (&block)
+        as_hash.each block
+      end
+
+      # Emulates Hash.each_pair (same as each)
+      def each_pair (&block)
+        each &block
+      end
+
+      # Empties the hash by setting all the values to nil
+      # (without committing them, of course)
+      def clear
+        load_entries_if_needed
+        @entries.each do |_, entry|
+          entry.value = nil
+        end
+      end
+
+      # Returns a hash with each entry key mapped to its actual value,
+      # not the internal EavEntry
+      def as_hash
+        load_entries_if_needed
+        hsh = {}
+        @entries.each do |k, entry|
+          hsh[k] = entry.value
+        end
+
+        hsh
+      end
+
+      # Take the crap out of #inspect calls
+      def inspect
+        as_hash
+      end
+
+    private
+      def update_or_create_entry(key, value)
+        raise "Key must be a string or a symbol!" unless key.is_a?(String) or key.is_a?(Symbol)
+        load_entries_if_needed
+
+        @changes_made = true
+        @owner.updated_at = Time.now
+
+        if @entries[key]
+          @entries[key].value = value
+        else
+          new_entry = @options[:entry_class].new
+          set_entry_owner(new_entry)
+          new_entry.key = key
+          new_entry.value = value
+
+          @entries[key] = new_entry
+
+          value
+        end
+      end
+
+      # Since entries are lazy-loaded, this is called just before an operation on an entry happens and
+      # loads the rows only once per EavHash lifetime.
+      def load_entries_if_needed
+        if @entries.nil?
+          @entries = {}
+          rows_from_model = @owner.send("#{@options[:entry_assoc_name]}")
+          rows_from_model.each do |row|
+            @entries[row.key] = row
+          end
+        end
+
+        @entries
+      end
+
+      # Sets an entry's owner ID. This is called when we save attributes for a model which has just been
+      # created and not committed to the DB prior to having its EAV hash(es) modified
+      # @param [EavEntry] entry the entry whose owner to change
+      def set_entry_owner(entry)
+        entry.send "#{@options[:parent_assoc_name]}_id=", @owner.id
+      end
+    end
+  end
 end