hstore_attribute_support 0.0.3 → 0.0.4

data/{README → README.md}

@@ -1,21 +1,31 @@
-== hstore_attribute_support
+hstore_attribute_support
+========================
 
-A class that has hstore attribute support will get the ability to set up virtual
-attributes stored in hstore columns very easily.
+Enables AR models to set up virtual attributes stored in hstore columns.
+The main problem with a naked hstore solution in rails is, that defaults
+are not supported (no schema.rb that tells rails, what the default is) and the
+types get lost when loading the serialized hstore data into a hash.
+With hstore attribute support, you can wire up your models in a rails like
+fashion very easily.
 
+### What it can do for you
 Consider a Person class with two hstore columns named "work_details" and
 "address". This class will, upon activation of the hstore attribute support, get
-new class methods: work_details_hstore_accessor and address_hstore_accessor.
+two new class methods: work_details_hstore_accessor and address_hstore_accessor.
+Activating the support is done by just inserting the method call
+"has_hstore_columns" into your AR class.
 
-These methods can be used on class level (like attr_accessor) to set up getter
-and setter methods for virtual attributes stored in these hstore columns.
-Additionally it will allow you to give a type hint and default values along.
-Because of that, new instances will be able to use an "after_initialize"
-callback to set up their hstore'd attributes to the default value which was
-provided, as well as enabling the getter methods to return values typecasted
-(hstore data looses its type and was returned as a string otherwise...)
+These methods can now be used (on AR class level, just like attr_accessor) to
+set up getter/setter methods for virtual attributes that are stored in the
+hstore columns.
 
-**Example:**
+Additionally you are able to give a type hint and default values along.
+Because of that, new instances will be able (using an "after_initialize"
+callback) to set up their hstore'd attributes to the default value you provided.
+On top of this, the model obtains getter methods to return values typecasted
+(hstore data looses its type and was returned as a string otherwise...).
+
+### Example
 
     # Schema for User:
     # - id:   int

data/hstore_attribute_support.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name          = 'hstore_attribute_support'
-  s.version       = '0.0.3'
-  s.date          = '2011-11-07'
+  s.version       = '0.0.4'
+  s.date          = '2011-11-16'
   s.summary       = "Adds AR Attributes support for Postgres hstore columns "
   s.description   = "Adds AR Attributes support for Postgres hstore columns "
   s.authors       = ["Andreas Schwarzkopf"]

data/lib/hstore_attribute_support/base.rb

@@ -19,7 +19,7 @@ module HstoreAttributeSupport
       # be used to set up this models hstore'd attributes more rails like.
       # A Person class with a data hstore column could setup its name like this:
       #
-      # data_hstore_accessor :name, :string, ''
+      # data_hstore_accessor :name, :cast => :string, :default => ''
       #
       # Which will set up accessors to the virtual attribute "name", defaults to
       # an empty string and is stored in the data column.
@@ -28,8 +28,8 @@ module HstoreAttributeSupport
       self.columns.each do |column|
         next unless column.type == :hstore
         class_eval %Q{
-          def self.#{column.name}_hstore_accessor(attribute_name, cast = nil, default = nil)
-            return hstore_attr_accessor(attribute_name, "#{column.name}", cast, default)
+          def self.#{column.name}_hstore_accessor(attribute_name, options = {})
+            return hstore_attr_accessor(attribute_name, "#{column.name}", options)
           end
         }
       end
@@ -38,7 +38,7 @@ module HstoreAttributeSupport
       # instance to set up default values for its hstore'd attributes.
       after_initialize do
         # iterate over the class instance variable "hstore_attributes", which
-        # contains types & defaults for virtual hstore attributes and apply them
+        # contains casts & defaults for virtual hstore attributes and apply them
         (self.class.hstore_attributes || {}).each do |attr_name, settings|
           column      = settings[:column]
           default     = settings[:default]
@@ -57,13 +57,18 @@ module HstoreAttributeSupport
       #    is lost by the hstore and was a pure string otherwise
       # 2. it provides an easy way to set up defaults, as rails AR mechanism
       #    fail here (no database defaults available for virtual attributes)
-      def hstore_attr_accessor(attribute_name, hstore_column, type  = nil, default = nil)
+      def hstore_attr_accessor(attribute_name, hstore_column, options = {})
+        options = {
+          :cast    => nil,
+          :default => nil
+        }.merge(options).with_indifferent_access
+
         self.hstore_attributes ||= {}
 
         self.hstore_attributes[attribute_name.to_s] = {
           :column  => hstore_column.to_s,
-          :type    => type,
-          :default => default
+          :cast    => options[:cast],
+          :default => options[:default]
         }
 
         class_eval %Q{
@@ -86,16 +91,16 @@ module HstoreAttributeSupport
       
       def read_hstore_attribute(attribute_name)
         ha_column   = self.class.hstore_attributes[attribute_name][:column]
-        ha_type     = self.class.hstore_attributes[attribute_name][:type]
+        ha_cast     = self.class.hstore_attributes[attribute_name][:cast]
         hstore_data = self.send(:"#{ha_column}").try(:with_indifferent_access)
 
         return nil unless hstore_data
 
         value = hstore_data[attribute_name]
 
-        return value unless ha_type
+        return value unless ha_cast
 
-        case ha_type
+        case ha_cast
         when :integer
           return value.to_i
         when :float
@@ -115,9 +120,9 @@ module HstoreAttributeSupport
         else
         end
 
-        return ha_type.call(value) if ha_type.is_a?(Proc)
+        return ha_cast.call(value) if ha_cast.is_a?(Proc)
 
-        raise "read_hstore_attribute failed when trying to cast the type \"#{ha_type.inspect}\". Please define the type as one of [:integer, :float, :decimal, :boolean, :string, :datetime, :date] or pass in a lambda with one parameter to perform custom casts."
+        raise "read_hstore_attribute failed when trying to cast the type \"#{ha_cast.inspect}\". Please define the type as one of [:integer, :float, :decimal, :boolean, :string, :datetime, :date] or pass in a lambda with one parameter to perform custom casts."
       end
 
       def write_hstore_attribute(attribute_name, value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hstore_attribute_support
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000Z
+date: 2011-11-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-postgres-hstore
-  requirement: &70277821577800 !ruby/object:Gem::Requirement
+  requirement: &70308241492240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70277821577800
+  version_requirements: *70308241492240
 description: ! 'Adds AR Attributes support for Postgres hstore columns '
 email: asmailbox@gmx.de
 executables: []
@@ -29,7 +29,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- README
+- README.md
 - hstore_attribute_support.gemspec
 - lib/hstore_attribute_support.rb
 - lib/hstore_attribute_support/base.rb