eav_hashes 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Ilya Ostrovskiy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+eav_hashes
+=========
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/200proof/eav_hashes) [![Build Status](https://travis-ci.org/200proof/eav_hashes.png?branch=master)](https://travis-ci.org/200proof/eav_hashes)
+
+`eav_hashes` is a neato gem for implementing the EAV (entity-attribute-value)
+database design pattern in your Rails models. All you need to do is add one
+line to your model's code and that's it! Schema generation is automatically
+handled for you.
+
+Why would I need it?
+-
+Rails' ActiveRecord includes a helper function, `serialize`, to allow you to
+save complex data types (like hashes) into your database. Unfortunately, it
+isn't very useful. A lot of overhead is created from serialization and
+deserialization, and you can't search by the contents of your hash. That's
+where `eav_hashes` comes in.
+
+How does it work?
+-
+Great question! Lets dive in with a simple code example:
+
+```ruby
+class Product < ActiveRecord::Base
+    eav_hash_for :tech_specs
+end
+```
+
+Now run this generator to create a migration:
+
+    $ rails generate eav_migration Product tech_specs
+
+And run the migration:
+
+    $ rake db:migrate
+
+Now watch the magic the happen:
+
+```ruby
+# Assuming this whole example is on a blank DB, of course
+a_product = Product.new
+a_product.tech_specs["Widget Power"] = "1.21 GW"
+a_product.tech_specs["Battery Life (hours)"] = 12
+a_product.tech_specs["Warranty (years)"] = 3.5
+a_product.tech_specs["RoHS Compliant"] = true
+a_product.save!
+
+# Setting a value to nil deletes the entry
+a_product.tech_specs["Warranty (years)"] = nil
+a_product.save!
+
+the_same_product = Product.first
+puts the_same_product.tech_specs["nonexistant key"]
+
+# magic alert: this actually gets the count of EVERY entry of every
+# hash for this model, but for this example this works
+puts "Entry Count: #{ProductTechSpecsEntry.count}"
+the_same_product.tech_specs.each_pair do |key, value|
+    puts "#{key}: #{value.to_s}"
+end
+
+# Ruby's default types: Integer, Float, Complex, Rational, Symbol,
+# TrueClass, and FalseClass are preserved between transactions like
+# you would expect them to.
+puts the_same_product.tech_specs["Battery Life (hours)"]+3
+```
+
+And the output, as you can expect, will be along the lines of:
+
+    nil
+    Entry Count: 3
+    Widget Power: 1.21 GW
+    Battery Life (hours): 12
+    RoHS Compliant: true
+    15
+
+
+That looks incredibly simple, right? Good! It's supposed to be! All the magic
+happens when you call `save!`.
+
+Now you could start doing other cool stuff, like searching for products based
+on their tech specs! You've already figured out how to do this, haven't you?
+
+```ruby
+flux_capacitor = Product.find_by_tech_specs("Widget Power", "1.21 GW")
+```
+
+Nifty, right?
+
+Can I store arrays/hashes/custom types inside my hashes?
+--
+Sure, but they'll be serialized into YAML (so you cant search by them like you
+would an eav_hash). The `value` column is a TEXT type by default but if you
+want to optimize your DB size you could change it to a VARCHAR in the migration
+if you don't plan on storing large values.
+
+
+What if I want to change the table name?
+--
+By default, `eav_hash` uses a table name derived from the following:
+
+```ruby
+"<ClassName>_<hash_name>".tableize
+```
+
+You can change this by passing a symbol to the `:table_name` argument:
+
+```ruby
+class Widget < ActiveRecord::Base
+    eav_hash_for :foobar, table_name: :bar_foo
+end
+```
+
+Just remember to edit the table name in the migration, or use the following
+migration generator:
+
+    $ rails generate eav_migration Widget foobar bar_foo
+
+
+What's the catch?
+-
+By using this software, you agree to write me into your will as your next of
+kin, and to sacrifice the soul of your first born child to Beelzebub.
+
+Just kidding, the code is released under the MIT license so you can use it for
+whatever purposes you see fit. Just don't sue me if your application blows up
+from the sheer awesomeness! Check out the LICENSE file for more information.
+
+Special Thanks!
+-
+Thanks to Matt Kimmel (@mattkimmel) for adding support for models contained in namespaces.
+
+I found a bug or want to contribute!
+-
+You're probably reading this from GitHub, so you know what to do. If not, the
+Github project is at https://github.com/200proof/eav_hashes

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EavHashes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'lib/eav_hashes'

data/lib/eav_hashes.rb

@@ -0,0 +1,8 @@
+require "eav_hashes/util"
+require "eav_hashes/eav_entry"
+require "eav_hashes/eav_hash"
+require "eav_hashes/activerecord_extension"
+require "generators/eav_migration/eav_migration"
+
+# tally-ho!
+ActiveRecord::Base.send :include, ActiveRecord::EavHashes

data/lib/eav_hashes/activerecord_extension.rb

@@ -0,0 +1,37 @@
+module ActiveRecord
+  module EavHashes
+    def self.included (base)
+      base.extend ActiveRecord::EavHashes::ClassMethods
+    end
+
+    module ClassMethods
+      def eav_hash_for (hash_name, options={})
+        # Fill in default options not otherwise specified
+        options[:hash_name] = hash_name
+        options[:parent_class_name] = self.name.to_sym
+        options = ActiveRecord::EavHashes::Util::fill_options_hash options
+
+        # Store the options hash in a class variable to create the EavHash object
+        # if and when it's actually used.
+        class_variable_set "@@#{hash_name}_hash_options".to_sym, options
+
+        # Create the association, the entry update hook, and a helper method to lazy-load the entries
+        class_eval <<-END_EVAL
+          has_many :#{options[:entry_assoc_name]}, class_name: #{options[:entry_class_name]}, foreign_key: "#{options[:parent_assoc_name]}_id"
+          after_save :save_#{hash_name}
+          def #{hash_name}
+            @#{hash_name} ||= ActiveRecord::EavHashes::EavHash.new(self, @@#{hash_name}_hash_options)
+          end
+
+          def save_#{hash_name}
+            @#{hash_name}.save_entries if @#{hash_name}
+          end
+
+          def self.find_by_#{hash_name} (key, value=nil)
+            self.find (ActiveRecord::EavHashes::Util::run_find_expression(key, value, @@#{hash_name}_hash_options))
+          end
+        END_EVAL
+      end
+    end
+  end
+end

data/lib/eav_hashes/eav_entry.rb

@@ -0,0 +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
+end

data/lib/eav_hashes/eav_hash.rb

@@ -0,0 +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
+end