eav_hashes 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae80ab5c3269d2d2d014229a916e6bd2d1f5887a
+  data.tar.gz: 5e90a1d6874451e1cf34ccfd88bce14e459b274d
+SHA512:
+  metadata.gz: 160c12fd33afa959a6597fa45c3e0d3edfa663d8fa7c33037fb0131e791180829dbc1c2fe1a43f8927a3f22e3e51cc6776bec16c0204e320513080677c03027d
+  data.tar.gz: bbd73843daaad8e0668a3ee1eba60eaabb20e80490bfe0d86203303b08ca4e44bb7d66720d4d67c7e3657acdb0bb57bad063b21d037fd928931f4cd9d9501075

data/MIT-LICENSE

@@ -1,20 +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.
+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

@@ -1,147 +1,147 @@
-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, but first lets set up the gem.
-
-Put this in your gemfile...
-
-    gem "eav_hashes", "~> 1.0.0"
-
-...and update your bundle.
-
-    $ bundle install
-
-
-Now, lets make this Rails model.
-
-```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](https://github.com/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
+eav_hashes
+=========
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/iostat/eav_hashes) [![Build Status](https://travis-ci.org/iostat/eav_hashes.png?branch=master)](https://travis-ci.org/iostat/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, but first lets set up the gem.
+
+Put this in your gemfile...
+
+    gem "eav_hashes", "~> 1.0.0"
+
+...and update your bundle.
+
+    $ bundle install
+
+
+Now, lets make this Rails model.
+
+```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](https://github.com/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/iostat/eav_hashes

data/Rakefile

@@ -1,30 +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
+#!/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/lib/eav_hashes/activerecord_extension.rb

@@ -1,37 +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", dependent: :delete_all
-          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
+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", dependent: :delete_all
+          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