property_sets 1.0.4 → 1.0.5

data/README.md

@@ -6,112 +6,131 @@ This gem is a way for you to use a basic "key/value" store for storing attribute
 
 You configure the allowed stored properties by specifying these in the model:
 
-    class Account < ActiveRecord::Base
-      property_set :settings do
-        property :version, :default => "v1.0"
-        property :featured, :protected => true
-        property :activated
-      end
-
-      property_set :texts do
-        property :epilogue
-      end
-    end
+```ruby
+class Account < ActiveRecord::Base
+  property_set :settings do
+    property :version, :default => "v1.0"
+    property :featured, :protected => true
+    property :activated
+  end
+
+  property_set :texts do
+    property :epilogue
+  end
+end
+```
 
 The declared properties can then be accessed runtime via the defined association:
 
-    # Return the value of the version record for this account, or the default value if not set
-    account.settings.version
+```ruby
+# Return the value of the version record for this account, or the default value if not set
+account.settings.version
 
-    # Update the version record with given value
-    account.settings.version = "v1.1"
+# Update the version record with given value
+account.settings.version = "v1.1"
 
-    # Query the truth value of the property
-    account.settings.featured?
+# Query the truth value of the property
+account.settings.featured?
 
-    # Short hand for setting one or more values
-    account.settings.set(:version => "v1.2", :activated => true)
+# Short hand for setting one or more values
+account.settings.set(:version => "v1.2", :activated => true)
+```
 
 ### Validations
 
 Property sets supports standard AR validations, although in a somewhat manual fashion.
 
-    class Account < ActiveRecord::Base
-      property_set :settings do
-        property :version, :default => "v1.0"
-        property :featured, :protected => true
+```ruby
+class Account < ActiveRecord::Base
+  property_set :settings do
+    property :version, :default => "v1.0"
+    property :featured, :protected => true
 
-        validates_format_of :value, :with => /v\d+\.\d+/, :message => "of version is invalid",
-                            :if => Proc.new { |r| r.name.to_sym == :version }
-      end
-    end
+    validates_format_of :value, :with => /v\d+\.\d+/, :message => "of version is invalid",
+                        :if => Proc.new { |r| r.name.to_sym == :version }
+  end
+end
+```
 
-On +account.save+ this will result in an error record being added. You can also inspect the
-setting record using +account.settings.version_record+
+On `account.save` this will result in an error record being added. You can also inspect the
+setting record using `account.settings.version_record`
 
 ### Bulk operations
 
 Stored properties can also be updated with the update_attributes and update_attributes! methods by
 enabling nested attributes. Like this (from the test cases):
 
-    @account.texts_attributes = [
-      { :name => "foo", :value => "1"  },
-      { :name => "bar", :value => "0"  }
-    ]
+```ruby
+@account.texts_attributes = [
+  { :name => "foo", :value => "1"  },
+  { :name => "bar", :value => "0"  }
+]
+```
 
 And for existing records:
 
-    @account.update_attributes!(:texts_attributes => [
-      { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
-      { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
-    ])
+```ruby
+@account.update_attributes!(:texts_attributes => [
+  { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
+  { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
+])
+```
 
 Using nested attributes is subject to implementing your own security measures for mass update assignments.
 Alternatively, it is possible to use a custom hash structure:
 
-    params = {
-      :settings => { :version => "v4.0", :featured => "1" },
-      :texts    => { :epilogue => "Wibble wobble" }
-    }
-    @account.update_attributes(params)
+```ruby
+params = {
+  :settings => { :version => "v4.0", :featured => "1" },
+  :texts    => { :epilogue => "Wibble wobble" }
+}
 
-The above will not update +featured+ as this has the protected flag set and is hence protected from
+@account.update_attributes(params)
+```
+
+The above will not update `featured` as this has the protected flag set and is hence protected from
 mass updates.
 
 ### View helpers
 
 We support a couple of convenience mechanisms for building forms and putting the values into the above hash structure. So far, only support check boxes and radio buttons:
 
-    <% form_for(:account, :html => { :method => :put }) do |f| %>
-      <h3><%= f.property_set(:settings).check_box :activated %> Activated?</h3>
-      <h3><%= f.property_set(:settings).radio_button :hot, "yes" %> Hot</h3>
-      <h3><%= f.property_set(:settings).radio_button :not, "no" %> Not</h3>
-      <h3><%= f.property_set(:settings).select :level, [["One", 1], ["Two", 2]] %></h3>
-    <% end %>
+```erb
+<% form_for(:account, :html => { :method => :put }) do |f| %>
+  <h3><%= f.property_set(:settings).check_box :activated %> Activated?</h3>
+  <h3><%= f.property_set(:settings).radio_button :hot, "yes" %> Hot</h3>
+  <h3><%= f.property_set(:settings).radio_button :not, "no" %> Not</h3>
+  <h3><%= f.property_set(:settings).select :level, [["One", 1], ["Two", 2]] %></h3>
+<% end %>
+```
 
 ## Installation
 
 Install the gem in your rails project by putting it in your Gemfile:
 
-    gem "property_sets"
+```
+gem "property_sets"
+```
 
 Also remember to create the storage table(s), if for example you are going to be using this with an accounts model and a "settings" property set, you can define the table like:
 
-    create_table :account_settings do |t|
-      t.integer  :account_id, :null => false
-      t.string   :name, :null => false
-      t.string   :value
-      t.timestamps
-    end
+```ruby
+create_table :account_settings do |t|
+  t.integer  :account_id, :null => false
+  t.string   :name, :null => false
+  t.string   :value
+  t.timestamps
+end
 
-    add_index :account_settings, [ :account_id, :name ], :unique => true
+add_index :account_settings, [ :account_id, :name ], :unique => true
+```
 
 ## Requirements
 
 * ActiveRecord
 * ActiveSupport
 
-## License
+## License and copyright
 
 Copyright 2013 Zendesk
 

data/lib/property_sets/action_view_extension.rb

@@ -4,14 +4,13 @@ module ActionView
   module Helpers
     class FormBuilder
       class PropertySetFormBuilderProxy
-        attr_accessor :property_set
-        attr_accessor :template
-        attr_accessor :object_name
-
-        def initialize(property_set, template, object_name)
-          self.property_set = property_set
-          self.template     = template
-          self.object_name  = object_name
+        attr_reader :property_set, :template, :object_name, :object
+
+        def initialize(property_set, template, object_name, object)
+          @property_set = property_set
+          @template     = template
+          @object_name  = object_name
+          @object       = object
         end
 
         def check_box(property, options = {}, checked_value = "1", unchecked_value = "0")
@@ -46,29 +45,33 @@ module ActionView
           template.select("#{object_name}[#{property_set}]", property, choices, { :selected => current_value }, html_options )
         end
 
+        private
+
         def prepare_id_name(property, options)
           throw "Invalid options type #{options.inspect}" unless options.is_a?(Hash)
 
           options.clone.tap do |prepared_options|
-            instance = template.instance_variable_get("@#{object_name}")
-
-            throw "No @#{object_name} in scope" if instance.nil?
-            throw "The property_set_check_box only works on models with property set #{property_set}" unless instance.respond_to?(property_set)
-
+            prepared_options[:object]   = object || fetch_target_object
             prepared_options[:id]     ||= "#{object_name}_#{property_set}_#{property}"
             prepared_options[:name]     = "#{object_name}[#{property_set}][#{property}]"
-            prepared_options[:object]   = instance
           end
         end
 
+        def fetch_target_object
+          instance = template.instance_variable_get("@#{object_name}")
+
+          throw "No @#{object_name} in scope" if instance.nil?
+          throw "The property_set_check_box only works on models with property set #{property_set}" unless instance.respond_to?(property_set)
+
+          instance
+        end
+
         def prepare_options(property, options, &block)
           options = prepare_id_name(property, options)
           options[:checked] = yield(options[:object].send(property_set))
           options
         end
 
-        private
-
         def cast_boolean(value)
           case value
           when TrueClass  then '1'
@@ -80,7 +83,7 @@ module ActionView
       end
 
       def property_set(identifier)
-        PropertySetFormBuilderProxy.new(identifier, @template, @object_name)
+        PropertySetFormBuilderProxy.new(identifier, @template, object_name, object)
       end
 
     end

data/property_sets.gemspec

@@ -1,4 +1,4 @@
-Gem::Specification.new "property_sets", "1.0.4" do |s|
+Gem::Specification.new "property_sets", "1.0.5" do |s|
   s.summary     = "Property sets for ActiveRecord."
   s.description = "This gem is an ActiveRecord extension which provides a convenient interface for managing per row properties."
   s.authors  = ["Morten Primdahl"]

data/test/test_view_extensions.rb

@@ -11,8 +11,6 @@ class TestViewExtensions < ActiveSupport::TestCase
       @template     = stub
       @builder      = ActionView::Helpers::FormBuilder.new(@object_name, @object, @template, {}, 'proc')
       @proxy        = @builder.property_set(@property_set)
-
-      @template.stubs(:instance_variable_get).with("@#{@object_name}").returns(@object)
     end
 
     should "provide a form builder proxy" do
@@ -20,6 +18,17 @@ class TestViewExtensions < ActiveSupport::TestCase
       assert_equal @property_set, @proxy.property_set
     end
 
+    should "fetch the target object when not available" do
+      @builder = ActionView::Helpers::FormBuilder.new(@object_name, nil, @template, {}, 'proc')
+      @proxy   = @builder.property_set(@property_set)
+
+      @object.stubs(@property_set).returns(stub(@property => 'value'))
+      @template.stubs(:hidden_field)
+
+      @template.expects(:instance_variable_get).with("@#{@object_name}").returns(@object)
+      @proxy.hidden_field(@property)
+    end
+
     context "#check_box" do
       context "when called with checked true for a truth value" do
         setup do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: property_sets
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport