acts-as-optionable 0.1.1 → 0.2.0

data/README.rdoc

@@ -110,7 +110,6 @@ This is useful, for instance, for passing a set of options into a liquid templat
 * Thinking about finding a way to optionally associate the option with an asset table.  This would be useful for allowing user defined stylesheet options referencing S3 assets.
 * Add in a way to return an option value straight away.
 * Assign multiple settings at a time.
-
-
+* Add a type or hint storage on options (i.e. this option is for a color)
 
 Copyright (c) 2010 Brendon Murphy, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/acts_as_optionable/acts_as_optionable.rb

@@ -16,9 +16,9 @@ module ActiveRecord
     
       module IntanceMethods
         # Store an option persistently and override default option
-        def set_option(name, value)
-          option = get_stored_option(name) || options.build(:name => name.to_s)
-          return if new_option_matches_current?(option)
+        def set_option(name, value, kind = nil)
+          option = get_stored_option(name) || options.build(:name => name.to_s, :value => value, :kind => kind)
+          return if new_option_matches_current?(option, value)
           option.value = value
           ret = option.save!
           options(:reload)
@@ -55,6 +55,7 @@ module ActiveRecord
           options = {}
           options_and_defaults.each do |name, option|
             options[name.to_s] = option.value
+            options["#{name.to_s}_kind"] = option.kind
           end        
           OpenStruct.new(options)
         end
@@ -77,8 +78,9 @@ module ActiveRecord
         end
         
         # Check if a new value provided is the same as the default option.
-        def new_option_matches_current?(option)
-          (!option.new_record? && option.value == value) || (get_default_option(name).value == value rescue nil)
+        def new_option_matches_current?(option, new_value)
+          default_value = ( get_default_option(option.name).value rescue nil )
+          ( option.value == default_value ) || ( option.value == new_value && ! option.new_record? )
         end
         
         # Return the stored options as a hash, with the option names as keys.

data/lib/acts_as_optionable/specify_option.rb

@@ -5,7 +5,7 @@ module ActiveRecord
         module ClassMethods
           # Setup a default value at the class level.
           def specify_option(option_name, opts = {})
-            optionable_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name.to_s, :default => opts[:default])
+            optionable_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name.to_s, :default => opts[:default], :kind => opts[:kind])
           end
           
           # Returns a hash of options specified at the class level
@@ -39,7 +39,7 @@ module ActiveRecord
             @instance_specified_options = {}
             opts.each do |option_name, attributes|
               attributes.symbolize_keys!
-              @instance_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name, :default => attributes[:default])
+              @instance_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name, :default => attributes[:default], :kind => attributes[:kind])
             end
           end
         end

data/spec/acts_as_optionable_spec.rb

@@ -9,7 +9,7 @@ class SpecifiedMixin < Mixin
   acts_as_optionable
   
   specify_option :foo, :default => "FOOFOO"
-  specify_option :bar, :default => "BARBAR"
+  specify_option :bar, :default => "BARBAR", :kind => "example"
 end
 
 class NoSpecifiedMixin < Mixin
@@ -23,16 +23,16 @@ def setup_db
   ActiveRecord::Base.logger
   ActiveRecord::Schema.define do
     create_table :mixins do |t|
-      t.string :value
+      t.string :stuff
     end
     
     create_table :options do |t|
       t.string :name
       t.string :value
+      t.string :kind
       t.references :optionable, :polymorphic => true
       t.timestamps
     end
-    
   end  
 end
 
@@ -70,6 +70,15 @@ describe "ActsAsOptionable" do
       @optionable.get_option(:foo).value.should == "FOOFOO"
       @optionable.get_option(:bar).value.should == "BARBAR"
     end
+
+    it "should not have a kind if none was specified" do
+      @optionable.get_option(:foo).kind.should be_blank
+    end
+    
+    it "should be able to specify the kind of option" do
+      @optionable.get_option(:bar).kind.should == "example"
+    end
+    
     
     it "should not mix specifications across unrelated classes" do
       class Foobar < Mixin
@@ -105,6 +114,16 @@ describe "ActsAsOptionable" do
       @optionable.get_option(:buzz).value.should == "BUZZBUZZ"
     end
     
+    it "should have the kind if set" do
+      @optionable.instance_specified_options = @options_template.merge(:kind_is_set => {:default => "kind_is_set", :kind => "example_kind" })
+      @optionable.get_option(:kind_is_set).kind.should == "example_kind"
+    end
+    
+    it "should not have the kind if none was provided" do
+      @optionable.instance_specified_options = @options_template
+      @optionable.get_option(:fizz).kind.should be_blank
+    end
+    
     it "should return readonly records for the default options" do
       @optionable.instance_specified_options = @options_template
       @optionable.get_option(:fizz).should be_readonly
@@ -175,6 +194,26 @@ describe "ActsAsOptionable" do
         @optionable.set_option(@key, false)
         @optionable.get_option(@key).value.should be_false
       end
+      
+      it "should allowing storing the option kind" do
+        @optionable.set_option(@key, "red", "color")
+        @optionable.get_option(@key).kind.should == "color"
+      end
+      
+      it "should not update the option if it already matches current" do
+        @optionable.set_option(@key, "red", "color")
+        timestamp = @optionable.get_option(@key).updated_at.dup
+        sleep 1 # not worth a dependency for 1 time check
+        @optionable.set_option(@key, "red", "color")
+        @optionable.get_option(@key).updated_at.should == timestamp
+      end
+      
+      it "should not set the option if it matches default" do
+        @optionable.get_option(:foo).value.should == "FOOFOO"
+        lambda {
+          @optionable.set_option(:foo, "FOOFOO") 
+        }.should_not change { Option.count }
+      end
     end
     
     describe "getting options" do
@@ -241,6 +280,12 @@ describe "ActsAsOptionable" do
       option_values.bar.should == "BARBAR"
     end
     
+    it "should have option_name_kind methods set" do
+      option_values = @optionable.options_values_struct
+      option_values.foo_kind.should be_blank
+      option_values.bar_kind.should == "example"
+    end
+    
     it "should contain both set and default options" do
       @optionable.instance_specified_options = @options_template
       @optionable.set_option("example_option", 99)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brendon Murphy
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 -07:00
+date: 2010-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: []