hstore_radio_buttons 0.0.1 → 0.0.2

data/README.md

@@ -152,9 +152,17 @@ To display the radio button set on the form, you have three options:
     <%= form_for @person do |f|>
       <%= f.hstore_radio_button('gender') %>
       ...
-      <%= f.hstore_radio_button('favorite barn animal') %>
+      <%= f.hstore_radio_button(:favorite_barn_animal) %>
     <% end %>
 
+You can use the string or a symbolized form. These are synonymous:
+
+    <%= f.hstore_radio_button('gender') %>
+    <%= f.hstore_radio_button(:gender) %>
+    or
+    <%= f.hstore_radio_button('Favorite Barn Animal') %>
+    <%= f.hstore_radio_button(:favorite_barn_animal) %>
+
 #### Use a helper to display all the radio buttons
 
     <%= form_for @person do |f|>
@@ -167,7 +175,10 @@ To display the radio button set on the form, you have three options:
       <%= f.label(:gender) %>
       <%= f.radio_button(:gender, 'male') %>
       <%= f.label(:gender, "Male", :value => 'male') %>
-      ...etc...
+      ...
+      <%= f.radio_button(:favorite_barn_animal, 'sheep') %>
+      <%= f.label(:favorite_barn_animal, "Sheep", :value => 'sheep') %>
+      ...
     <% end %>
 
 If you want to avoid the duplication that the above introduces, you can
@@ -181,6 +192,15 @@ use the _options method that is added to your model:
       <% end %>
     <% end %>
 
+##### Method names when using Rails helpers
+If you use the Rails helpers, you'll need to use the correct name for
+the attribute. Use the lowercase, underscored version of your button set
+name:
+
+    <%= f.radio_button(:favorite_barn_animal, 'sheep') %> #works!
+    <%= f.radio_button('favorite_barn_animal', 'cow') %> #works!
+    <%= f.radio_button('Favorite Barn Animal', 'pig') %> #fail
+
 ### Controlling helper-created output
 
 By default the `hstore_radio_button` or `hstore_radio_buttons` helpers
@@ -223,6 +243,18 @@ buttons as 'selected' when the form is loaded later.
 TODO: It'd be nice to have default values for a set.  
 TODO: Formtastic integration
 
+### Thanks, etc.
+
+Many code ideas were 'borrowed' from [Vestal
+Versions](https://github.com/laserlemon/vestal_versions/) and [LRD]
+(https://github.com/LRDesign). Testing and design ideas were also
+contributed by [Davin Lagerroos](https://github.com/davinlagerroos).
+
+### Versions
+
+0.0.2 - Fixes to inconsistency in how you call buttons by name.
+0.0.1 - Initial
+
 ## Contributing
 
 1. Fork it

data/lib/hstore_radio_buttons.rb

@@ -6,6 +6,8 @@ require 'hstore_radio_buttons/version'
 require 'hstore_radio_buttons/configuration'
 require 'hstore_radio_buttons/button_options'
 require 'hstore_radio_buttons/button_set'
+require 'hstore_radio_buttons/method_namer'
+require 'hstore_radio_buttons/formatter'
 require 'hstore_radio_buttons/helpers/form_helper'
 
 module HstoreRadioButtons

data/lib/hstore_radio_buttons/button_options.rb

@@ -2,7 +2,7 @@ module HstoreRadioButtons
   class ButtonOptions
     attr_accessor :name, :options
     def initialize(name, options)
-      self.name = name.gsub(/ /,"_").downcase
+      self.name = name
       self.options = *options
     end
   end

data/lib/hstore_radio_buttons/button_set.rb

@@ -1,32 +1,49 @@
 module HstoreRadioButtons
   class ButtonSet
     def initialize(button_definition, model)
-      setter_method = "#{button_definition.name}=".to_sym
-      getter_method = button_definition.name.to_sym
-      options_method = "#{button_definition.name}_options".to_sym
+      namer = HstoreRadioButtons::MethodNamer.new(button_definition.name)
 
-      model.send(:define_method, getter_method) {
+      create_instance_methods(button_definition, model, namer)
+      create_getters_on_class(model, namer)
+    end
+
+    private
+
+    def create_instance_methods(button_definition, model, namer)
+      create_getter(button_definition, model, namer)
+      create_setter(button_definition, model, namer)
+      create_options(button_definition, model, namer)
+    end
+
+    def create_getter(button_definition, model, namer)
+      model.send(:define_method, namer.getter) {
         hstore_data_proxy[button_definition.name]
       }
+    end
 
-      model.send(:define_method, setter_method) {|value|
-        if self.send(options_method).include?(value)
+    def create_setter(button_definition, model, namer)
+      model.send(:define_method, namer.setter) {|value|
+        if self.send(namer.options).include?(value)
           hstore_data_proxy[button_definition.name] = value
         else
           hstore_data_proxy[button_definition.name] = nil
         end
       }
+    end
 
-      model.send(:define_method, options_method) {
+    def create_options(button_definition, model, namer)
+      model.send(:define_method, namer.options) {
         button_definition.options
       }
+    end
 
-      if !model.instance_variable_defined?(:@hstore_button_names)
-        model.instance_variable_set(:@hstore_button_names, Set.new)
+    def create_getters_on_class(model, namer)
+      if !model.instance_variable_defined?(:@hstore_button_getters)
+        model.instance_variable_set(:@hstore_button_getters, Set.new)
       end
-      all_buttons_on_model = model.send(:instance_variable_get, :@hstore_button_names)
+      all_buttons_on_model = model.send(:instance_variable_get, :@hstore_button_getters)
 
-      model.send(:instance_variable_set, :@hstore_button_names, all_buttons_on_model << button_definition.name.to_sym)
+      model.send(:instance_variable_set, :@hstore_button_getters, all_buttons_on_model << namer.getter)
     end
   end
 end

data/lib/hstore_radio_buttons/formatter.rb

@@ -0,0 +1,19 @@
+module HstoreRadioButtons
+  class Formatter
+    def initialize(raw_button_name)
+      self.raw_button_name = raw_button_name
+    end
+
+    def to_method
+      raw_button_name.to_s.gsub(/ /,"_").downcase
+    end
+
+    def to_title
+      raw_button_name.to_s.gsub(/_/," ").titleize
+    end
+
+    private
+
+    attr_accessor :raw_button_name
+  end
+end

data/lib/hstore_radio_buttons/helpers/form_helper.rb

@@ -14,17 +14,19 @@ module HstoreRadioButtons::FormBuilder
 
   def hstore_radio_button(method, options = {})
     options[:separator] = (options[:separator] ? options[:separator] : "<br />")
-    radio_options = object.public_send("#{method}_options".to_sym)
-    button_set = "#{method.to_s.titleize}#{options[:separator]}"
-    radio_options.each do |radio_option|
-      button_set += @template.hstore_radio_button(@object_name, method, radio_option, objectify_options(options))
+    methods = HstoreRadioButtons::MethodNamer.new(method)
+
+    button_set = "#{HstoreRadioButtons::Formatter.new(method).to_title}#{options[:separator]}"
+
+    object.public_send(methods.options).each do |radio_option|
+      button_set += @template.hstore_radio_button(@object_name, methods.getter, radio_option, objectify_options(options))
     end
     content_tag(:div, button_set.html_safe).html_safe
   end
 
   def hstore_radio_buttons(options = {})
     all_buttons = ""
-    object.class.instance_variable_get(:@hstore_button_names).each do |method|
+    object.class.instance_variable_get(:@hstore_button_getters).each do |method|
       all_buttons += hstore_radio_button(method, options)
     end
     all_buttons.html_safe

data/lib/hstore_radio_buttons/method_namer.rb

@@ -0,0 +1,24 @@
+module HstoreRadioButtons
+  class MethodNamer
+    def initialize(button_name)
+      self.button_name = HstoreRadioButtons::Formatter.new(button_name).to_method
+    end
+
+    def setter
+      "#{button_name}=".to_sym
+    end
+
+    def getter
+      button_name.to_sym
+    end
+
+    def options
+      "#{button_name}_options".to_sym
+    end
+
+    private
+
+    attr_accessor :button_name
+
+  end
+end

data/lib/hstore_radio_buttons/version.rb

@@ -1,3 +1,3 @@
 module HstoreRadioButtons
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/lib/hstore_radio_buttons/button_options_test.rb

@@ -1,18 +1,6 @@
 require_relative '../../test_helper.rb'
 
 describe HstoreRadioButtons::ButtonOptions do
-  describe "#name" do
-    it "replaces spaces in a name with underscores" do
-      it = HstoreRadioButtons::ButtonOptions.new('test name', nil)
-      it.name.must_equal 'test_name'
-    end
-
-    it "downcases the name" do
-      it = HstoreRadioButtons::ButtonOptions.new('Test', nil)
-      it.name.must_equal 'test'
-    end
-  end
-
   describe "#options" do
     it "turns a single option into an array" do
       it = HstoreRadioButtons::ButtonOptions.new('test', 1)

data/test/lib/hstore_radio_buttons/button_set_test.rb

@@ -3,56 +3,41 @@ require_relative '../../test_helper.rb'
 describe HstoreRadioButtons::ButtonSet do
   describe '#initialize' do
     before :each do
-      @test_yaml_file_location = './test/support/config/hstore_radio_button_sets.yml'
       @it = Person.new
-      config = YAML.load(File.open(@test_yaml_file_location))
-      @raw_button_definitions = config[@it.class.to_s.downcase]
-      @button_definitions = []
-
-      @raw_button_definitions.each do |button_definition|
-        button_options = HstoreRadioButtons::ButtonOptions.new(button_definition[0],button_definition[1])
-        @button_definitions << button_options
-        HstoreRadioButtons::ButtonSet.new(button_options,@it.class)
-      end
+      @button_definition = OpenStruct.new({name: 'test name', options: [1,2,3]})
+      HstoreRadioButtons::ButtonSet.new(@button_definition,@it.class)
+      @method_names = HstoreRadioButtons::MethodNamer.new(@button_definition.name)
     end
 
     it 'adds getters and setters for the button sets defined in the config file' do
-      @button_definitions.each do |button_definition|
-        @it.must_respond_to button_definition.name.to_sym
-        @it.must_respond_to "#{button_definition.name}=".to_sym
-      end
+      @it.must_respond_to @method_names.getter
+      @it.must_respond_to @method_names.setter
     end
 
     it "adds a method that returns the button set's options" do
-      @button_definitions.each do |button_definition|
-        @it.must_respond_to "#{button_definition.name}_options".to_sym
-        @it.send("#{button_definition.name}_options".to_sym).must_equal button_definition.options
-      end
+      @it.must_respond_to @method_names.options
+      @it.send(@method_names.options).must_equal @button_definition.options
     end
 
     it "defines the setter so that a value not in the set's option is not passed to the hstore" do
       bad_value = "hackery_nonsense"
-      @button_definitions.each do |button_definition|
-        @it.send("#{button_definition.name}=".to_sym, bad_value)
-        @it.send(button_definition.name.to_sym).must_be_nil
-      end
+      @it.send(@method_names.setter, bad_value)
+      @it.send(@method_names.getter).must_be_nil
     end
 
     it 'persists data sent to setters' do
-      @button_definitions.each do |button_definition|
-        random_value = button_definition.options.sample
-        @it.send("#{button_definition.name}=".to_sym, random_value)
-        @it.send(button_definition.name.to_sym).must_equal random_value
-      end
+      random_value = @button_definition.options.sample
+      @it.send(@method_names.setter, random_value)
+      @it.send(@method_names.getter).must_equal random_value
     end
 
     it 'allows the use of ActiveModel validation methods' do
-      @it.class.validates_presence_of(@button_definitions.sample.name)
+      @it.class.validates_presence_of(@method_names.getter)
       @it.valid?.must_equal false
     end
 
     it 'creates a class instance variable that returns the names of all hstore button names' do
-      @it.class.instance_variable_get(:@hstore_button_names).must_equal @button_definitions.map {|d| d.name.to_sym}.to_set
+      @it.class.instance_variable_get(:@hstore_button_getters).must_include :test_name
     end
   end
 end

data/test/lib/hstore_radio_buttons/helpers/form_builder_test.rb

@@ -18,6 +18,12 @@ class FormBuilderTest < ActionView::TestCase
     assert it.respond_to?(:hstore_radio_button)
   end
 
+  test "#hstore_radio_button responds to both symbolized and string forms of button-set names" do
+    it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
+    assert_equal it.hstore_radio_button(:gender), it.hstore_radio_button('gender')
+    assert_equal it.hstore_radio_button(:favorite_barn_animal), it.hstore_radio_button('Favorite Barn Animal')
+  end
+
   test "FormBuilder#hstore_radio_button wraps the whole thing in a div" do
     view.stubs(:hstore_radio_button).with(any_parameters).returns("")
     it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
@@ -53,7 +59,7 @@ class FormBuilderTest < ActionView::TestCase
   test "#hstore_radio_buttons builds a button set for each button defined in the class" do
     it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
 
-    all_buttons = Person.instance_variable_get(:@hstore_button_names)
+    all_buttons = Person.instance_variable_get(:@hstore_button_getters)
     expected = ""
     all_buttons.each do |b|
       expected += it.hstore_radio_button(b)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hstore_radio_buttons
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70257637365360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257637365360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70257637364800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257637364800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70257637364220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257637364220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activerecord-postgres-hstore
-  requirement: &70257637363740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257637363740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70257637363060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70257637363060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70257637362480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257637362480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70257637361800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257637361800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70257637361240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +133,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257637361240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Works with postgres's hstore data type and Rails to let you display/store
   a collection of radio buttons in an hstore field
 email:
@@ -120,8 +160,10 @@ files:
 - lib/hstore_radio_buttons/button_options.rb
 - lib/hstore_radio_buttons/button_set.rb
 - lib/hstore_radio_buttons/configuration.rb
+- lib/hstore_radio_buttons/formatter.rb
 - lib/hstore_radio_buttons/helpers/form_helper.rb
 - lib/hstore_radio_buttons/hstore_radio_data.rb
+- lib/hstore_radio_buttons/method_namer.rb
 - lib/hstore_radio_buttons/version.rb
 - test/lib/hstore_radio_buttons/button_options_test.rb
 - test/lib/hstore_radio_buttons/button_set_test.rb
@@ -155,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Define a set of radio buttons for a model and then save the perisisted data