property_sets 0.0.12 → 0.1.0

data/Gemfile

@@ -1,7 +1,9 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-#   gem "activesupport", ">= 2.3.5"
+
+gem "activesupport", "~> 2.3.5"
+gem "activerecord", "~> 2.3.5"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -9,5 +11,5 @@ group :development do
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
+  gem "ruby-debug"
 end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.10)
+      activesupport (= 2.3.10)
+    activesupport (2.3.10)
+    columnize (0.3.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.43)
+    rake (0.8.7)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.5)
+  activesupport (~> 2.3.5)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  ruby-debug
+  shoulda

data/README.rdoc

@@ -20,33 +20,17 @@ You configure the allowed stored properties by specifying these in the model:
 
 The declared properties can then be accessed runtime via the defined association:
 
-  # Return the version record for this account - or a new record if none exists
+  # Return the value of the version record for this account, or the default value if not set
   account.settings.version
 
-  # Create (or update) the version record with default value
-  account.settings.version.create
+  # Update the version record with given value
+  account.settings.version = "v1.1"
 
-  # Create (or update) the version record with the given value
-  account.settings.version.create(:value => "v1.1")
-
-  # Destroy the version record
-  account.settings.version.destroy
-
-=== 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
+  # Query the truth value of the property
   account.settings.featured?
 
-  # sets the value of this setting to a true value
-  account.settings.featured.enable
-
-  # sets the value of this setting to a false value
-  account.settings.featured.disable
+  # Short hand for setting one or more values
+  account.settings.set(:version => "v1.2", :activated => true)
 
 === Bulk operations
 

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.1.0

data/lib/property_sets/active_record_extension.rb

@@ -3,75 +3,55 @@ require 'delegate'
 module PropertySets
   module ActiveRecordExtension
 
-    class PropertySetProxy < Delegator
-      attr_accessor :record
-
-      def initialize(record)
-        self.record = record
-      end
-
-      def __getobj__
-        record
-      end
-
-      def id
-        record.id
-      end
-
-      def create(args = {})
-        record.attributes = args
-        record.save
-        record
-      end
-    end
-
     module ClassMethods
       def property_set(association, &block)
         raise "Invalid association name, letters only" unless association.to_s =~ /[a-z]+/
         property_class = PropertySets.ensure_property_set_class(association, self)
         property_class.instance_eval(&block)
 
-        has_many association.to_s.pluralize.to_sym, :class_name => property_class.name, :dependent => :destroy do
+        has_many association, :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, with_protection = false)
+          def set(property_pairs, with_protection = false)
             property_pairs.keys.each do |name|
-              record = lookup(name).record
+              record = lookup(name)
               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
+                send("#{name}=", property_pairs[name])
               end
             end
           end
 
-          # Define the settings query methods, e.g. +account.settings.wiffle?+
           property_class.keys.each do |key|
-            raise "Invalid key #{key}" if self.respond_to?(key)
+            raise "Invalid property key #{key}" if self.respond_to?(key)
 
-            # Reports the coerced truth valye of the property
+            # Reports the coerced truth value of the property
             define_method "#{key}?" do
               lookup(key).true?
             end
 
+            # Returns the value of the property
+            define_method "#{key}" do
+              lookup(key).value
+            end
+
+            define_method "protected?" do |arg|
+              lookup(arg).protected?
+            end
+
             # Assigns a new value to the property
             define_method "#{key}=" do |value|
               instance = lookup(key)
               instance.value = value
-              instance.save
-            end
-
-            # Returns the value of the property
-            define_method "#{key}" do
-              lookup(key)
+              @owner.send(association) << instance
+              value
             end
 
             # The finder method which returns the property if present, otherwise a new instance with defaults
             define_method "lookup" do |arg|
-              instance = detect { |property| property.name.to_sym == arg }
-              instance ||= property_class.new(@owner.class.name.underscore.to_sym => @owner, :name => arg.to_s, :value => property_class.default(arg))
-              PropertySetProxy.new(instance)
+              instance   = detect { |property| property.name.to_sym == arg }
+              instance ||= property_class.new(:name => arg.to_s, :value => property_class.default(arg))
             end
           end
         end
@@ -92,7 +72,7 @@ module PropertySets
       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)
+            send(property_set).set(property_set_attributes, true)
           end
         end
       end

data/property_sets.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{property_sets}
-  s.version = "0.0.12"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Morten Primdahl"]
-  s.date = %q{2011-01-17}
+  s.date = %q{2011-01-18}
   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 = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     "Gemfile",
+    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
@@ -52,23 +53,29 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 2.3.5"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     else
+      s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     end
   else
+    s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
   end
 end

data/test/helper.rb

@@ -4,6 +4,7 @@ require 'active_support'
 require 'active_record'
 require 'active_record/fixtures'
 require 'shoulda'
+require 'ruby-debug'
 
 ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
 ActiveRecord::Base.establish_connection('test')

data/test/test_property_sets.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require File.expand_path(File.dirname(__FILE__) + '/helper')
 
 class Account < ActiveRecord::Base
   property_set :settings do
@@ -6,8 +6,7 @@ class Account < ActiveRecord::Base
     property :bar
     property :baz
     property :hep, :default   => 'skep'
-    property :bob
-    property :bla, :protected => true
+    property :pro, :protected => true
   end
 
   property_set :texts do
@@ -33,20 +32,25 @@ class TestPropertySets < ActiveSupport::TestCase
     end
 
     should "support protecting attributes" do
-      assert @account.settings.bla.protected?
+      assert @account.settings.protected?(:pro)
+      assert !@account.settings.protected?(:foo)
     end
 
     should "be empty on a new account" do
       assert @account.settings.empty?
       assert @account.texts.empty?
+
+      assert !@account.texts.foo?
+      assert !@account.texts.bar?
+      assert @account.texts.foo.nil?
+      assert @account.texts.bar.nil?
     end
 
-    should "respond to defaults" do
+    should "respond with defaults" do
       assert_equal false, @account.settings.bar?
-      assert_equal nil, @account.settings.bar.value
+      assert_equal nil, @account.settings.bar
       assert_equal true, @account.settings.hep?
-      assert_equal 'skep', @account.settings.hep.value
-      assert @account.settings.hep.id.nil?
+      assert_equal 'skep', @account.settings.hep
     end
 
     should "reject settings with an invalid name" do
@@ -64,113 +68,75 @@ class TestPropertySets < ActiveSupport::TestCase
     end
 
     should "validate uniqueness of settings" do
-      AccountSetting.create!(:account => @account, :name => 'unique')
+      @account.settings.create!(:name => "unique")
       assert_raise ActiveRecord::RecordInvalid do
-        AccountSetting.create!(:account => @account, :name => 'unique')
+        @account.settings.create!(:name => "unique")
       end
     end
 
     should "be creatable using the = operator" do
       assert !@account.settings.foo?
-      assert @account.settings.foo = "1"
-      assert @account.settings.size == 1
-      assert @account.texts.size == 0
-      assert @account.settings.foo?
-      assert @account.settings.foo = "2"
-      assert @account.settings.size == 1
-      assert @account.settings.foo?
-    end
+      [ "1", "2" ].each do |value|
+        assert @account.settings.foo = value
+        assert @account.settings.foo?
+        assert @account.settings.size == 1
+      end
 
-    should "be creatable through association" do
-      assert @account.settings.foo.create.id
-      @account.settings.foo.destroy
-      @account.reload
-      assert @account.settings.foo.new_record?
-      assert @account.settings.foo.create(:value => 8)
-      assert @account.settings.foo.id
-      assert @account.settings.foo.value == "8"
-      assert @account.settings.hep.create
-      assert_equal @account.settings.hep.value, "skep"
+      assert @account.texts.empty?
     end
 
-    should "be destroyable through association" do
-      assert !@account.settings.foo?
-      assert @account.settings.foo = "1"
-      assert @account.settings.foo?
-      assert @account.settings.foo.destroy
-      @account.settings.reload
-      assert !@account.settings.foo?
+    should "coerce everything but nil to string" do
+      @account.settings.foo = 3
+      assert @account.settings.foo == "3"
+      @account.settings.foo = nil
+      assert @account.settings.foo.nil?
     end
 
-    should "support enable/disable semantics" do
-      assert !@account.settings.foo?
-      assert @account.settings.foo.id.nil?
-      @account.settings.foo.enable
-      assert @account.settings.foo.id.present?
-      assert @account.settings.foo?
-      @account.settings.foo.disable
-      assert !@account.settings.foo?
-    end
+    context "#set" do
+      should "support writing multiple values to the association" do
+        assert !@account.settings.foo?
+        assert !@account.settings.bar?
 
-    should "coerce everything but nil to string" do
-      assert @account.settings.foo.create(:value => 3)
-      assert @account.settings.foo.value == "3"
-      assert @account.settings.foo.create(:value => nil)
-      assert @account.settings.foo.value.nil?
-    end
+        @account.settings.set(:foo => "123", :bar => "456")
 
-    context "bulk updates" do
-      should "support bulk create/update of multiple properties in one go" do
+        assert @account.settings.foo?
+        assert @account.settings.bar?
+      end
+
+      should "work identically for new and existing owner objects" 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"
+          account.settings.set(:foo => "123", :bar => "456")
+
+          assert_equal account.settings.size, 2
+          assert_equal account.settings.foo, "123"
+          assert_equal account.settings.bar, "456"
+
+          account.settings.set(:bar => "789", :baz => "012")
+
+          assert_equal account.settings.size, 3
+          assert_equal account.settings.foo, "123"
+          assert_equal account.settings.bar, "789"
+          assert_equal account.settings.baz, "012"
         end
       end
 
       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
+        assert @account.texts.foo == "1"
+        assert @account.texts.bar == "0"
 
         @account.update_attributes!(:texts_attributes => [
-          { :id => @account.texts.foo.id, :name => "foo", :value => "0"  },
-          { :id => @account.texts.bar.id, :name => "bar", :value => "1" }
+          { :id => @account.texts.lookup(:foo).id, :name => "foo", :value => "0"  },
+          { :id => @account.texts.lookup(:bar).id, :name => "bar", :value => "1" }
         ])
-        assert !@account.texts.foo?
-        assert @account.texts.bar?
+
+        assert @account.texts.foo == "0"
+        assert @account.texts.bar == "1"
       end
 
       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 => {
@@ -183,15 +149,14 @@ class TestPropertySets < ActiveSupport::TestCase
 
         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"
+        assert @account.settings.foo == "1"
+        assert @account.settings.bar == "0"
+        assert !@account.settings.pro?
 
         attribs = {
           :name => "Kim",
           :property_sets => {
-            :settings => { :foo => "1", :bar => "1", :baz => "1", :bla => "1" }
+            :settings => { :foo => "1", :bar => "1", :baz => "1", :pro => "1" }
           }
         }
 
@@ -200,7 +165,7 @@ class TestPropertySets < ActiveSupport::TestCase
         assert @account.settings.foo?
         assert @account.settings.bar?
         assert @account.settings.baz?
-        assert !@account.settings.bla?
+        assert !@account.settings.pro?
       end
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: property_sets
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 12
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors: 
 - Morten Primdahl
@@ -15,14 +15,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 -08:00
+date: 2011-01-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +63,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +79,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +95,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id003
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: ruby-debug
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,12 +109,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: thoughtbot-shoulda
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -91,7 +123,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
+  requirement: *id007
 description: This gem is an ActiveRecord extension which provides a convenient interface for managing per row properties
 email: morten@zendesk.com
 executables: []
@@ -104,6 +136,7 @@ extra_rdoc_files:
 files: 
 - .document
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile