acts-as-optionable 0.3.1 → 0.4.0

data/README.rdoc

@@ -41,8 +41,14 @@ Use #get_option, #set_option, and #delete_option for interacting with options.
   
 You can also store an optional "kind" attribute as a hint to what you are storing:
 
-  style.set_option("bgcolor", "white", "color")
+  style.set_option("bgcolor", "white", :kind => "color")
   style.get_option("bgcolor").kind => "color"
+  
+You can also store an optional display name for human consumption:
+
+  style.set_option("bgcolor", "white", :display_name => "Background Color")
+  style.get_option("bgcolor").display_name => "Background Color"
+
 
 === Specifying default options at the class level
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/generators/option/templates/create_options.rb

@@ -2,6 +2,7 @@ class CreateOptions < ActiveRecord::Migration
   def self.up
     create_table :options do |t|
       t.string :name
+      t.string :display_name
       t.string :value
       t.string :kind
       t.references :optionable, :polymorphic => true

data/generators/option/templates/option.rb

@@ -37,34 +37,18 @@ class Option < ActiveRecord::Base
   end
 
   def display_name
-    name.humanize.titleize
+    read_attribute(:display_name) || name.humanize.titleize
   end
   
   def to_h
     option_hash = {}
     option_hash["value"] = value
+    option_hash["display_name"] = display_name
     option_hash["default"] = default if default
     option_hash["kind"] = kind if kind
     option_hash.dup
   end
-  
-  # def default_value
-  #   @config['default']
-  # end
-  # 
-  # def evaluated_value
-  #   value && !value.empty? ? value : default_value
-  # end
-  # 
-  # def color?
-  #   @config['type'] == :color
-  # end
-  # 
-  # def config=(h)
-  #   @config = h
-  #   write_attribute(:name, h['name'])
-  # end
-  
+    
   protected
   
   def value_class_ok?(val)

data/lib/acts_as_optionable/acts_as_optionable.rb

@@ -16,8 +16,8 @@ module ActiveRecord
     
       module IntanceMethods
         # Store an option persistently and override default option
-        def set_option(name, value, kind = nil)
-          option = get_stored_option(name) || options.build(:name => name.to_s, :value => value, :kind => kind)
+        def set_option(name, value, opts = {})
+          option = get_stored_option(name) || options.build(:name => name.to_s, :value => value, :kind => opts[:kind], :display_name => opts[:display_name])
           return if new_option_matches_current?(option, value)
           option.value = value
           ret = option.save!
@@ -67,6 +67,7 @@ module ActiveRecord
             opt_key = name.to_s
             options[opt_key] = option.value
             options["#{opt_key}_kind"] = option.kind
+            options["#{opt_key}_display_name"] = option.display_name
           end        
           OpenStruct.new(options)
         end

data/lib/acts_as_optionable/specify_option.rb

@@ -6,7 +6,7 @@ module ActiveRecord
           # Setup a default value at the class level.
           def specify_option(option_name, opts = {})
             name = option_name.to_s
-            optionable_specified_options[name] = Option.new_readonly(:name => name, :default => opts[:default], :kind => opts[:kind])
+            optionable_specified_options[name] = Option.new_readonly(:name => name, :default => opts[:default], :kind => opts[:kind], :display_name => opts[:display_name])
           end
           
           # Returns a hash of options specified at the class level
@@ -40,7 +40,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], :kind => attributes[:kind])
+              @instance_specified_options[option_name.to_s] = Option.new_readonly(:name => option_name.to_s, :default => attributes[:default], :kind => attributes[:kind], :display_name => attributes[:display_name])
             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", :kind => "example"
+  specify_option :bar, :default => "BARBAR", :kind => "example", :display_name => "Bar Bar"
 end
 
 class NoSpecifiedMixin < Mixin
@@ -28,6 +28,7 @@ def setup_db
     
     create_table :options do |t|
       t.string :name
+      t.string :display_name
       t.string :value
       t.string :kind
       t.references :optionable, :polymorphic => true
@@ -79,6 +80,9 @@ describe "ActsAsOptionable" do
       @optionable.get_option(:bar).kind.should == "example"
     end
     
+    it "should be able to specify a display name" do
+      @optionable.get_option(:bar).display_name.should == "Bar Bar"
+    end
     
     it "should not mix specifications across unrelated classes" do
       class Foobar < Mixin
@@ -119,6 +123,11 @@ describe "ActsAsOptionable" do
       @optionable.get_option(:kind_is_set).kind.should == "example_kind"
     end
     
+    it "should have the display name if set" do
+      @optionable.instance_specified_options = @options_template.merge(:display_name_is_set => {:default => "kind_is_set", :kind => "example_kind", :display_name => "Example Name" })
+      @optionable.get_option(:display_name_is_set).display_name.should == "Example Name"
+    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
@@ -196,7 +205,7 @@ describe "ActsAsOptionable" do
       end
       
       it "should allowing storing the option kind" do
-        @optionable.set_option(@key, "red", "color")
+        @optionable.set_option(@key, "red", :kind => "color")
         @optionable.get_option(@key).kind.should == "color"
       end
       
@@ -289,7 +298,7 @@ describe "ActsAsOptionable" do
     it "should contain both set and default options" do
       @optionable.instance_specified_options = @options_template
       @optionable.set_option("example_option", 99)
-      option_values = @optionable.options_values_struct
+       option_values = @optionable.options_values_struct
       option_values.foo.should == "FOOFOO"
       option_values.fizz.should == "FIZZFIZZ"
       option_values.example_option.should == 99
@@ -298,7 +307,7 @@ describe "ActsAsOptionable" do
   
   describe "getting options and defaults as a hash" do
     before(:each) do
-      @optionable.set_option("example_option", "example_value")
+      @optionable.set_option("example_option", "example_value", :kind => "example", :display_name => "Example Name")
       @options_and_defaults_hash = @optionable.options_and_defaults_hash
     end
     
@@ -319,5 +328,9 @@ describe "ActsAsOptionable" do
       @options_and_defaults_hash["bar"]["default"].should == "BARBAR"
       @options_and_defaults_hash["bar"]["kind"].should == "example"
     end
+    
+    it "should include the display name" do
+      @options_and_defaults_hash["example_option"]["display_name"].should == "Example Name"
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Brendon Murphy
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -07:00
+date: 2010-04-30 00:00:00 -07:00
 default_executable: 
 dependencies: []