property_sets 0.0.11 → 0.0.12

data/README.rdoc

@@ -1,18 +1,16 @@
 = Property sets
 
-The property_set gem is an evolution of the has_settings gem which was an evolution of the features gem. This is getting old.
-
 This gem is a way for you to use a basic "key/value" store for storing attributes for a given model in a relational fashion where there's a row per attribute. Alternatively you'd need to add a new column per attribute to your main table, or serialize the attributes and their values.
 
 == Description
 
-You configure the allowed stored properties by specifying these in an initializer:
+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
-      property :product
+      property :featured, :protected => true
+      property :activated
     end
 
     property_set :texts do
@@ -34,25 +32,68 @@ The declared properties can then be accessed runtime via the defined association
   # Destroy the version record
   account.settings.version.destroy
 
-On top of the basic access paths, there are some short cuts:
+=== Convenience methods
+
+On top of the basic access paths, there are some short cuts, mainly convenience methods for dealing with booleans:
+
+  # immediately changes the value of the setting
+  account.settings.version=("v3.0")
+
+  # coerces the setting to boolean AR style
+  account.settings.featured?
 
-  account.settings.featured=(1)     # immediately changes the value of the setting
-  account.settings.featured?        # coerces the setting to boolean AR style
-  account.settings.featured.enable  # sets the value of this setting to a true value
-  account.settings.featured.disable # sets the value of this setting to a false value
+  # sets the value of this setting to a true value
+  account.settings.featured.enable
 
-If the value has never been set, a nil (or default) is returned. And that's pretty much it.
+  # sets the value of this setting to a false value
+  account.settings.featured.disable
+
+=== Bulk operations
 
 Stored properties can also be updated with the update_attributes and update_attributes! methods by
-enabling nested attributes. See the test cases for examples.
+enabling nested attributes. Like this (from the test cases):
+
+  @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" }
+  ])
+
+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 = { :property_sets => {
+    :settings => { :version => "v4.0", :featured => "1" },
+    :texts    => { :epilogue => "Wibble wobble" }
+  }}
+  @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 single convenience mechanism for building forms and putting the values into the above hash structure. So far, we only support check boxes:
+
+  <% form_for(:account, :html => { :method => :put }) do |f| %>
+    <h3>
+      <%= f.property_set(:settings).check_box :activated %> Activated?
+    </h3>
+  <% end %>
 
 == Installation
 
 Install the gem in your rails project by putting it in your Gemfile:
 
-  gem 'property_set'
+  gem "property_sets"
 
-Also remember to create the storage table, if for example you are going to be using this with an accounts model, you can define the table like:
+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
@@ -66,13 +107,13 @@ Also remember to create the storage table, if for example you are going to be us
 == Requirements
 
 * ActiveRecord
-* ActionPack
+* ActiveSupport
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2010 Zendesk
+Copyright (c) 2011 Zendesk
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/lib/property_sets.rb

@@ -1,6 +1,6 @@
+require 'property_sets/property_set_helper'
 require 'property_sets/property_set_model'
 require 'property_sets/active_record_extension'
-require 'property_sets/property_set_helper'
 
 module PropertySets
   def self.ensure_property_set_class(association, owner_class)

data/lib/property_sets/active_record_extension.rb

@@ -34,10 +34,15 @@ module PropertySets
         has_many association.to_s.pluralize.to_sym, :class_name => property_class.name, :dependent => :destroy do
 
           # Accepts a name value pair hash { :name => 'value', :pairs => true } and builds a property for each key
-          def bulk(property_pairs)
+          def bulk(property_pairs, with_protection = false)
             property_pairs.keys.each do |name|
-              value = property_pairs[name]
-              self << proxy_reflection.klass.new(:name => name.to_s, :value => value)
+              record = lookup(name).record
+              if with_protection && record.protected?
+                logger.warn("Someone tried to update the protected #{name} property to #{property_pairs[name]}")
+              else
+                record.value = property_pairs[name]
+                self << record
+              end
             end
           end
 
@@ -73,9 +78,32 @@ module PropertySets
       end
     end
 
+    module InstanceMethods
+      def update_attributes_with_property_sets(attributes)
+        update_property_set_attributes(attributes)
+        update_attributes_without_property_sets(attributes)
+      end
+
+      def update_attributes_with_property_sets!(attributes)
+        update_property_set_attributes(attributes)
+        update_attributes_without_property_sets!(attributes)
+      end
+
+      def update_property_set_attributes(attributes)
+        if attributes && property_sets = attributes.delete(:property_sets)
+          property_sets.each do |property_set, property_set_attributes|
+            send(property_set).bulk(property_set_attributes, true)
+          end
+        end
+      end
+    end
   end
 end
 
 ActiveRecord::Base.class_eval do
-  extend PropertySets::ActiveRecordExtension::ClassMethods
+  include PropertySets::ActiveRecordExtension::InstanceMethods
+  extend  PropertySets::ActiveRecordExtension::ClassMethods
+
+  alias_method_chain :update_attributes, :property_sets
+  alias_method_chain :update_attributes!, :property_sets
 end

data/lib/property_sets/form_builder_proxy.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+
+module PropertySets
+  class FormBuilderProxy < Delegator
+    attr_accessor :builder
+    attr_accessor :property_set
+
+    def initialize(property_set, builder)
+      self.property_set = property_set
+      self.builder      = builder
+    end
+
+    def __getobj__
+      builder
+    end
+
+    def check_box(property, options = {}, checked_value = "1", unchecked_value = "0")
+      builder.property_set_check_box(property_set, property, options, checked_value, unchecked_value)
+    end
+  end
+end
+

data/lib/property_sets/property_set_helper.rb

@@ -1,19 +1,28 @@
+require 'property_sets/form_builder_proxy'
+
 module ActionView
   module Helpers
-    def setting_check_box(model_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+    # property_set_check_box(:account, :property_association, :property_key, options)
+    def property_set_check_box(model_name, property_set, property, options = {}, checked_value = "1", unchecked_value = "0")
       the_model = @template.instance_variable_get("@#{model_name}")
+
       throw "No @#{model_name} in scope" if the_model.nil?
-      throw "The setting_check_box only works on models with settings" unless the_model.respond_to?(:settings)
-      options[:checked] = the_model.settings.send("#{method}?")
-      options[:id]    ||= "#{model_name}_settings_#{method}"
-      options[:name]    = "#{model_name}[settings][#{method}]"
-      @template.check_box(model_name, "settings_#{method}", options, checked_value, unchecked_value)
+      throw "The property_set_check_box only works on models with property set #{property_set}" unless the_model.respond_to?(property_set)
+
+      options[:checked] = the_model.send(property).send("#{method}?")
+      options[:id]    ||= "#{model_name}_property_sets_#{property_set}_#{method}"
+      options[:name]    = "#{model_name}[property_sets][#{property_set}][#{method}]"
+      @template.check_box(model_name, "property_sets_#{property_set}_#{method}", options, checked_value, unchecked_value)
+    end
+  end
+
+  class FormBuilder
+    def property_set(identifier)
+      PropertySets::FormBuilderProxy.new(identifier, self)
     end
 
-    class FormBuilder
-      def setting_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
-        @template.setting_check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
-      end
+    def property_set_check_box(property_set, property, options, checked_value, unchecked_value)
+      @template.property_set_check_box(@object_name, property_set, property, objectify_options(options), checked_value, unchecked_value)
     end
   end
 end

data/lib/property_sets/property_set_model.rb

@@ -20,6 +20,10 @@ module PropertySets
         self
       end
 
+      def protected?
+        self.class.protected?(name.to_sym)
+      end
+
       def to_s
         value.to_s
       end
@@ -43,7 +47,9 @@ module PropertySets
       end
 
       def update_owner_timestamp
-        owner_class_instance.update_attribute(:updated_at, Time.now) if owner_class_instance && !owner_class_instance.new_record?
+        if owner_class_instance && !owner_class_instance.new_record? && owner_class_instance.updated_at < 1.second.ago
+          owner_class_instance.update_attribute(:updated_at, Time.now)
+        end
       end
 
       def reset_owner_association
@@ -72,6 +78,10 @@ module PropertySets
         @properties[key] && @properties[key].key?(:default) ? @properties[key][:default] : nil
       end
 
+      def protected?(key)
+        @properties[key] && !!@properties[key][:protected]
+      end
+
       def owner_class=(owner_class)
         @owner_class_sym = owner_class.name.underscore.to_sym
         belongs_to              owner_class_sym

data/property_sets.gemspec

@@ -5,28 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property_sets}
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]
-  s.date = %q{2011-01-13}
+  s.date = %q{2011-01-17}
   s.description = %q{This gem is an ActiveRecord extension which provides a convenient interface for managing per row properties}
   s.email = %q{morten@zendesk.com}
   s.extra_rdoc_files = [
-    "LICENSE",
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
     ".document",
     "Gemfile",
-    "LICENSE",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
     "lib/property_sets.rb",
     "lib/property_sets/active_record_extension.rb",
+    "lib/property_sets/form_builder_proxy.rb",
     "lib/property_sets/property_set_helper.rb",
     "lib/property_sets/property_set_model.rb",
     "property_sets.gemspec",

data/test/test_property_sets.rb

@@ -7,6 +7,7 @@ class Account < ActiveRecord::Base
     property :baz
     property :hep, :default   => 'skep'
     property :bob
+    property :bla, :protected => true
   end
 
   property_set :texts do
@@ -31,6 +32,10 @@ class TestPropertySets < ActiveSupport::TestCase
       assert defined?(AccountText)
     end
 
+    should "support protecting attributes" do
+      assert @account.settings.bla.protected?
+    end
+
     should "be empty on a new account" do
       assert @account.settings.empty?
       assert @account.texts.empty?
@@ -114,40 +119,99 @@ class TestPropertySets < ActiveSupport::TestCase
       assert @account.settings.foo.value.nil?
     end
 
-    should "support bulk build multiple properties in one go" do
-      @account.settings.bulk(:foo => "123", :bar => "456")
-      @account.save!
-      assert_equal @account.reload.settings.size, 2
-      assert_equal @account.settings.foo.value, "123"
-      assert_equal @account.settings.foo.name, "foo"
-      assert_equal @account.settings.bar.value, "456"
-      assert_equal @account.settings.bar.name, "bar"
-    end
-
-    should "be updatable as nested attributes" do
-      assert !@account.texts.foo?
-      assert !@account.texts.bar?
-      assert !@account.texts.foo.id
-      assert !@account.texts.bar.id
-      assert @account.texts.empty?
+    context "bulk updates" do
+      should "support bulk create/update of multiple properties in one go" do
+        [ @account, Account.new(:name => "Mibble") ].each do |account|
+          account.settings.bulk(:foo => "123", :bar => "456")
+          account.save!
+
+          assert_equal account.reload.settings.size, 2
+          assert_equal account.settings.foo.value, "123"
+          assert_equal account.settings.foo.name, "foo"
+          assert_equal account.settings.bar.value, "456"
+          assert_equal account.settings.bar.name, "bar"
+
+          account.settings.bulk(:bar => "789", :baz => "012")
+          account.save!
+
+          assert_equal account.reload.settings.size, 3
+          assert_equal account.settings.foo.value, "123"
+          assert_equal account.settings.bar.value, "789"
+          assert_equal account.settings.baz.value, "012"
+        end
+      end
 
-      assert @account.texts_attributes = [{ :name => "foo", :value => "1"  }, { :name => "bar", :value => "0"  }]
-      @account.save!
+      should "be updateable as AR nested attributes" do
+        assert !@account.texts.foo?
+        assert !@account.texts.bar?
+        assert !@account.texts.foo.id
+        assert !@account.texts.bar.id
+        assert @account.texts.empty?
+
+        assert @account.texts_attributes = [{ :name => "foo", :value => "1"  }, { :name => "bar", :value => "0"  }]
+        @account.save!
+
+        assert @account.texts.foo?
+        assert !@account.texts.bar?
+        assert @account.texts.foo.id
+        assert @account.texts.bar.id
+
+        @account.update_attributes!(:texts_attributes => [
+          { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
+          { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
+        ])
+        assert !@account.texts.foo?
+        assert @account.texts.bar?
+      end
 
-      assert @account.texts.foo?
-      assert !@account.texts.bar?
-      assert @account.texts.foo.id
-      assert @account.texts.bar.id
+      should "be updateable as a nested structure" do
+        assert !@account.settings.foo?
+        assert !@account.settings.bar?
+        assert !@account.settings.foo.id
+        assert !@account.settings.bar.id
+        assert @account.settings.empty?
+
+        attribs = {
+          :name => "Kim",
+          :property_sets => {
+            :settings => { :foo => "1", :bar => "0" }
+          }
+        }
+
+        assert @account.update_attributes(attribs)
+        @account.save!
+
+        assert @account.settings.foo?
+        assert !@account.settings.bar?
+        assert @account.settings.foo.id
+        assert @account.settings.bar.id
+        assert @account.settings.foo.value == "1"
+        assert @account.settings.bar.value == "0"
+
+        attribs = {
+          :name => "Kim",
+          :property_sets => {
+            :settings => { :foo => "1", :bar => "1", :baz => "1", :bla => "1" }
+          }
+        }
+
+        assert @account.update_attributes!(attribs)
+
+        assert @account.settings.foo?
+        assert @account.settings.bar?
+        assert @account.settings.baz?
+        assert !@account.settings.bla?
+      end
+    end
 
-      @account.update_attributes!(:texts_attributes => [
-        { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
-        { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
-      ])
-      assert !@account.texts.foo?
-      assert @account.texts.bar?
+    context "view construction" do
+      should "provide a form builder proxy" do
+        proxy = ActionView::FormBuilder.new.property_set(:foo)
+        assert proxy.is_a?(PropertySets::FormBuilderProxy)
+        assert_equal :foo, proxy.property_set
+        proxy.builder.expects(:property_set_check_box).once.with(:foo, :bar, {}, "1", "0")
+        proxy.check_box(:bar)
+      end
     end
   end
 end
-
-
-

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: property_sets
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 -08:00
+date: 2011-01-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,19 +99,18 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - LICENSE.txt
 - README.rdoc
 files: 
 - .document
 - Gemfile
-- LICENSE
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/property_sets.rb
 - lib/property_sets/active_record_extension.rb
+- lib/property_sets/form_builder_proxy.rb
 - lib/property_sets/property_set_helper.rb
 - lib/property_sets/property_set_model.rb
 - property_sets.gemspec

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Morten Primdahl
-
-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.