hstore_radio_buttons 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hstore_radio_buttons.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ian Whitney
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,232 @@
+# hstore_radio_buttons
+
+So, you need a bunch of radio buttons on a form. But there's no particular reason for you to save each question in its own database field. And, even better, you have access to the Hstore data type in postgres. hstore_radio_buttons is the library you are looking for. Define a set of radio buttons, display them in your form and then gather them all up and save the data in an hstore field.
+
+# Requirements
+
+- Postgres. If you have the hstore extension enabled, great. If not, the
+  migration generated by this gem will turn it on.
+- Rails 3 and the activerecord-postgres-hstore gem installed
+
+This might work with Rails 4, which has native support for hstore, but I haven't tried that yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hstore_radio_buttons'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hstore_radio_buttons
+
+hstore_radio_buttons will save all of your hstores in a single table. To
+generate that table, do:
+
+    $ rails generate hstore_radio_buttons:migration
+    $ rake db:migrate
+
+The migration does two things:
+
+1. Executes the command "CREATE EXTENSION IF NOT EXISTS hstore"
+2. Creates a polymorphic table hstore_radio_data, which is where all the
+   persisted data will be saved.
+
+If you don't need to set up the hstore extension, just remove that part
+of the migration before running it.
+
+## Usage
+
+For every collection of radio button questions, you'll need to define their set of values as well as a label for the set of buttons. Say you want something like this:
+
+    Gender:
+      o Male
+      o Female
+      o Other
+  
+    Favorite Barn Animal:
+      o Cow
+      o Sheep
+      o Pig
+
+### Defining buttons in a YAML file
+
+In above example we have two sets of buttons, one for the Gender question and one for the Barn Animal question. By default, this yaml file is stored in `config/hstore_radio_button_sets.yml`. But you can override that and put the file elsewhere, if you want.
+
+    ---
+    person:
+      gender:
+      - male
+      - female
+      - other
+      'favorite barn animal':
+      - cow
+      - sheep
+      - pig
+
+The above defines two sets of buttons that can be used by the person model. For a model to generate/save radio button data, the set must be defined for the model.
+
+Then set up your model so that it knows it has hstore_radio_buttons.
+
+    class Person < ActiveRecord::Base
+      include HstoreRadioButtons
+
+      hstore_radio_buttons
+      ...
+    end
+
+Changing the location of the file is done by passing in the path of your
+configuration file:
+
+    class Person < ActiveRecord::Base
+      include HstoreRadioButtons
+
+      hstore_radio_buttons './config/yamls/person_hstore_buttons.yml'
+      ...
+    end
+
+### Defining buttons with macros in the model itself
+
+Instead of using the yaml file, you can define your buttons macro-style
+within the model itself.
+
+    class Report < ActiveRecord::Base
+      include HstoreRadioButtons
+
+      hstore_radio_button Hash['viewed' => ['true', 'false']]
+      hstore_radio_button Hash['written by' => %w(monkeys interns milton)]
+    end
+
+### Getters, Setters, Security
+
+Adding the button sets gives you getters and setters for those sets:
+
+    >> p = Person.find(1)
+    >> p.gender 
+      => 'female'
+    >> p.favorite_barn_animal
+      => 'sheep'
+    >> p.favorite_barn_animal = 'pig'
+      => 'pig'
+
+Keep in mind that the returned data will always be strings. So boolean
+values aren't true and false, they are 'true' and 'false'. That's just
+how hstore works.
+
+And, for the sake of security, you can't set a value to
+something that's not in your button definition. So if someone changes their
+form submission values to include malicious data that should not be a
+problem.<sup>*</sup>
+
+
+    >> p = Person.find(1)
+    >> p.gender = 'something hackerish' 
+    >> p.gender = nil
+
+<sup>*</sup> Notice the 'should' part there. I am not a security expert
+and I welcome any pull requests that make this gem more secure.
+
+Validations from ActiveModel work as well. So you can do:
+
+    class Person < ActiveRecord::Base
+      ...
+      validates_presence_of :gender
+    end
+
+Or whatever other validations you need.
+
+### Displaying buttons in a form
+
+To display the radio button set on the form, you have three options:
+
+1. Use a helper to display a single radio button
+2. Use a helper to display all the radio buttons
+3. Use the Rails form helpers
+
+#### Use a helper to display a single radio button
+
+    <%= form_for @person do |f|>
+      <%= f.hstore_radio_button('gender') %>
+      ...
+      <%= f.hstore_radio_button('favorite barn animal') %>
+    <% end %>
+
+#### Use a helper to display all the radio buttons
+
+    <%= form_for @person do |f|>
+      <%= f.hstore_radio_buttons %>
+    <% end %>
+
+#### Use the Rails form helpers:
+
+    <%= form_for @person do |f|>
+      <%= f.label(:gender) %>
+      <%= f.radio_button(:gender, 'male') %>
+      <%= f.label(:gender, "Male", :value => 'male') %>
+      ...etc...
+    <% end %>
+
+If you want to avoid the duplication that the above introduces, you can
+use the _options method that is added to your model:
+
+    <%= form_for @person do |f|>
+      <%= f.label(:gender) %>
+      <% @person.gender_options.each do |option| %>
+        <%= f.radio_button(:gender, option) %>
+        <%= f.label(:gender, option.titleize, :value => option) %>
+      <% end %>
+    <% end %>
+
+### Controlling helper-created output
+
+By default the `hstore_radio_button` or `hstore_radio_buttons` helpers
+will give you output like this:
+
+    <div>
+      <label for='person_gender'>Gender</label><br />
+      <input id='person_gender_male' name 'person[gender]' type='radio'
+      value='male'>
+      <label for='person_gender_male'>Male</label><br />
+    </div>
+
+You can swap those `<br />` tags for a different separator by passing in
+your own:
+
+    <%= f.hstore_radio_button('gender', separator: " - " %>
+
+If you need more control, you should probably just use the Rails helpers
+approach.
+
+### Persistence
+
+The conversion of your data into an hstore is handled by
+[activerecord-postgres-store]
+(https://github.com/engageis/activerecord-postgres-hstore) so refer to
+their documentation.
+
+Your data will be stored in the hstore_radio_data table. If you saved
+data for a Person with the id of 1, it will be saved as
+
+    model_id  model_type  hstore_data
+    1         Person      {'gender' => 'other'....}
+
+But it's easiest to just work with the getters and setters in the Person
+model than dealing directly with this table.
+
+And, of course, this perisisted data is used to mark the correct radio
+buttons as 'selected' when the form is loaded later.
+
+TODO: It'd be nice to have default values for a set.  
+TODO: Formtastic integration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/hstore_radio_buttons.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hstore_radio_buttons/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hstore_radio_buttons"
+  spec.version       = HstoreRadioButtons::VERSION
+  spec.authors       = ["Ian Whitney"]
+  spec.email         = ["ian@ianwhitney.com"]
+  spec.description   = %q{Works with postgres's hstore data type and Rails to let you display/store a collection of radio buttons in an hstore field}
+  spec.summary       = %q{Define a set of radio buttons for a model and then save the perisisted data for these buttons in an hstore field. Good for data that you want to persist, but that isn't important enough for its own field in the model.}
+  spec.homepage      = "https://github.com/IanWhitney/hstore_radio_buttons"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '~> 3.0'
+  spec.add_dependency 'activesupport', '~> 3.0'
+  spec.add_dependency 'actionpack', '~> 3.0'
+  spec.add_dependency 'activerecord-postgres-hstore'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "mocha"
+end

data/lib/generators/hstore_radio_buttons.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/named_base'
+
+module HstoreRadioButtons
+  module Generators
+    module Base
+      def source_root
+        @_hstore_radio_buttons_source_root ||= File.expand_path(File.join('../hstore_radio_buttons', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

data/lib/generators/hstore_radio_buttons/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+require 'generators/hstore_radio_buttons'
+require 'rails/generators/active_record'
+
+module HstoreRadioButtons
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'create_hstore_radio_data'
+
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}"
+      end
+    end
+  end
+end

data/lib/generators/hstore_radio_buttons/migration/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateHstoreRadioData < ActiveRecord::Migration
+  def self.up
+    create_table :hstore_radio_data do |t|
+      t.belongs_to :model, :polymorphic => true
+      t.hstore    :hstore_data
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :hstore_radio_data
+  end
+end

data/lib/hstore_radio_buttons.rb

@@ -0,0 +1,39 @@
+require 'action_view'
+require 'active_support/concern'
+require 'active_support/dependencies/autoload'
+
+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/helpers/form_helper'
+
+module HstoreRadioButtons
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+
+  autoload :HstoreRadioData
+
+  module ClassMethods
+    def hstore_radio_buttons(yaml_file_location = './config/hstore_radio_button_sets.yml')
+      HstoreRadioButtons::Configuration.from_yaml(self,yaml_file_location)
+    end
+
+    def hstore_radio_button(button_hash)
+      HstoreRadioButtons::Configuration.from_hash(self, button_hash)
+    end
+  end
+
+  def hstore_data_proxy
+    if self.hstore_radio_data.nil?
+      self.build_hstore_radio_data.hstore_data
+    else
+      self.hstore_radio_data.hstore_data
+    end
+  end
+  private :hstore_data_proxy
+
+  included do
+    has_one :hstore_radio_data, :class_name => 'HstoreRadioButtons::HstoreRadioData', :as => :model
+  end
+end

data/lib/hstore_radio_buttons/button_options.rb

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

data/lib/hstore_radio_buttons/button_set.rb

@@ -0,0 +1,32 @@
+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
+
+      model.send(:define_method, getter_method) {
+        hstore_data_proxy[button_definition.name]
+      }
+
+      model.send(:define_method, setter_method) {|value|
+        if self.send(options_method).include?(value)
+          hstore_data_proxy[button_definition.name] = value
+        else
+          hstore_data_proxy[button_definition.name] = nil
+        end
+      }
+
+      model.send(:define_method, options_method) {
+        button_definition.options
+      }
+
+      if !model.instance_variable_defined?(:@hstore_button_names)
+        model.instance_variable_set(:@hstore_button_names, Set.new)
+      end
+      all_buttons_on_model = model.send(:instance_variable_get, :@hstore_button_names)
+
+      model.send(:instance_variable_set, :@hstore_button_names, all_buttons_on_model << button_definition.name.to_sym)
+    end
+  end
+end

data/lib/hstore_radio_buttons/configuration.rb

@@ -0,0 +1,48 @@
+module HstoreRadioButtons
+  class Configuration
+    def self.from_yaml(model, yaml_file_location = './config/hstore_radio_button_sets.yml')
+      self.new._from_yaml(model, yaml_file_location)
+    end
+
+    def self.from_hash(model, raw_button_options)
+      self.new._from_hash(model, raw_button_options)
+    end
+
+    def _from_yaml(model, yaml_file_location)
+      self.yaml_file_location = yaml_file_location
+      self.model = model
+
+      if yaml_exists?
+        button_options_from_yaml.each {|button_options| HstoreRadioButtons::ButtonSet.new(button_options,model)}
+      end
+    end
+
+    def _from_hash(model, raw_button_options)
+      self.model = model
+      button_options = button_options_from_raw(raw_button_options)
+      HstoreRadioButtons::ButtonSet.new(button_options,model)
+    end
+
+  private
+    attr_accessor :model, :yaml_file_location
+    def config_file
+      File.open(yaml_file_location)
+    end
+
+    def yaml_exists?
+      File.exists?(yaml_file_location)
+    end
+
+    def button_options_from_yaml
+      button_options = []
+      YAML.load(config_file)[model.to_s.downcase].each do |key, value|
+        button_options << button_options_from_raw(Hash[key,value])
+      end
+      button_options
+    end
+
+    def button_options_from_raw(raw_button_options)
+      ButtonOptions.new(raw_button_options.keys.first, raw_button_options.values.first)
+    end
+  end
+end

data/lib/hstore_radio_buttons/helpers/form_helper.rb

@@ -0,0 +1,36 @@
+require 'action_view'
+
+module HstoreRadioButtons::FormHelper
+  def hstore_radio_button(object_name, method, tag_value, options = {})
+    separator = options.delete(:separator)
+    label = label(object_name, tag_value, options)
+    input = radio_button(object_name, method, tag_value, options)
+    "#{input}#{label}#{separator}"
+  end
+end
+
+module HstoreRadioButtons::FormBuilder
+  include ActionView::Helpers::TagHelper
+
+  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))
+    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|
+      all_buttons += hstore_radio_button(method, options)
+    end
+    all_buttons.html_safe
+  end
+end
+
+ActionView::Helpers::FormHelper.send(:include, HstoreRadioButtons::FormHelper)
+ActionView::Base.send(:include, HstoreRadioButtons::FormHelper)
+ActionView::Helpers::FormBuilder.send(:include, HstoreRadioButtons::FormBuilder)

data/lib/hstore_radio_buttons/hstore_radio_data.rb

@@ -0,0 +1,7 @@
+require 'activerecord-postgres-hstore'
+module HstoreRadioButtons
+  class HstoreRadioData < ActiveRecord::Base
+    belongs_to :model, :polymorphic => true
+    serialize :hstore_data, ActiveRecord::Coders::Hstore
+  end
+end

data/lib/hstore_radio_buttons/version.rb

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

data/test/lib/hstore_radio_buttons/button_options_test.rb

@@ -0,0 +1,27 @@
+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)
+      it.options.must_equal [1]
+    end
+
+    it "turns a null options into an array" do
+      it = HstoreRadioButtons::ButtonOptions.new('test', nil)
+      it.options.must_equal []
+    end
+  end
+end

data/test/lib/hstore_radio_buttons/button_set_test.rb

@@ -0,0 +1,58 @@
+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
+    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
+    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
+    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
+    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
+    end
+
+    it 'allows the use of ActiveModel validation methods' do
+      @it.class.validates_presence_of(@button_definitions.sample.name)
+      @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
+    end
+  end
+end

data/test/lib/hstore_radio_buttons/configuration_test.rb

@@ -0,0 +1,57 @@
+require_relative '../../test_helper.rb'
+
+describe HstoreRadioButtons::Configuration do
+
+  describe "#from_yaml" do
+    before :each do
+      @test_yaml_file_location = './test/support/config/hstore_radio_button_sets.yml'
+    end
+
+    it "checks if a provided yaml file exists" do
+      File.expects(:exists?).with(@test_yaml_file_location).returns(true)
+      HstoreRadioButtons::Configuration.from_yaml(Person, @test_yaml_file_location)
+    end
+
+    it "checks if the default yaml file exists if none provided" do
+      yaml_file_location = './config/hstore_radio_button_sets.yml'
+      File.expects(:exists?).with(yaml_file_location).returns(false)
+      HstoreRadioButtons::Configuration.from_yaml(Person, yaml_file_location)
+    end
+
+    describe "has a yaml file to use" do
+      before :each do
+        @it = Person.new
+        config = YAML.load(File.open(@test_yaml_file_location))
+        @button_sets = config[@it.class.to_s.downcase]
+        @button_option_double = HstoreRadioButtons::ButtonOptions.new('test',[])
+        HstoreRadioButtons::ButtonOptions.stubs(:new).returns(@button_option_double)
+      end
+
+      it 'creates a button_set for each button set defined in the config file' do
+        @button_sets.each do |button_set|
+          HstoreRadioButtons::ButtonSet.expects(:new).with(@button_option_double,@it.class).returns(nil)
+        end
+        HstoreRadioButtons::Configuration.from_yaml(Person, @test_yaml_file_location)
+      end
+    end
+  end
+
+  describe "#from_hash" do
+    describe "accepts a model and a button-defining hash to create a button" do
+      it "creates a button_set for each button defined by a hstore_radio_button macro" do
+        class Report < ActiveRecord::Base; end
+        @button_option_double = HstoreRadioButtons::ButtonOptions.new('test',[])
+        HstoreRadioButtons::ButtonOptions.stubs(:new).returns(@button_option_double)
+
+        HstoreRadioButtons::ButtonSet.expects(:new).with(@button_option_double,Report).twice.returns(nil)
+
+        class Report < ActiveRecord::Base
+          include HstoreRadioButtons
+
+          hstore_radio_button Hash['viewed' => ['true', 'false']]
+          hstore_radio_button Hash['written by' => %w(monkeys interns milton)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require_relative '../../../test_helper.rb'
+require 'action_view/test_case'
+
+class FormBuilderTest < ActionView::TestCase
+  include ActiveSupport::Testing::SetupAndTeardown
+  include ActionView::TestCase::Behavior
+
+  setup do
+    @person_instance = Person.new
+  end
+
+  test "adds my FormHelper to Rails' FormHelper" do
+    assert ActionView::Helpers::FormBuilder.include?(HstoreRadioButtons::FormBuilder)
+  end
+
+  test "FormBuilder instances can respond to hstore_radio_button" do
+    it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
+    assert it.respond_to?(:hstore_radio_button)
+  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 {})
+    assert_match /^<div>/, it.hstore_radio_button(:gender)
+    assert_match /<\/div>$/, it.hstore_radio_button(:gender)
+  end
+
+  test "FormBuilder#hstore_radio_button returns a set of buttons that are prefaced with the button set's name" do
+    view.stubs(:hstore_radio_button).with(any_parameters).returns("")
+    it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
+    assert_match /^<div>Gender/, it.hstore_radio_button(:gender)
+  end
+
+  test "#hstore_radio_button accepts a separator, which will be used to separate the button-set header from the buttons" do
+    view.stubs(:hstore_radio_button).with(any_parameters).returns("")
+    it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
+    assert_match /^<div>Gender-/, it.hstore_radio_button(:gender, separator: "-")
+  end
+
+  test "FormBuilder#hstore_radio_button gets a button from FormHelper for each value in the _options method" do
+    expected = "<div>Gender<br />"
+    @person_instance.gender_options.each do |option|
+      view.stubs(:hstore_radio_button).with(:person, :gender, option, {:separator => "<br />", :object => @person_instance}).returns(option)
+      expected += "#{option}"
+    end
+    expected += "</div>"
+
+    it = ActionView::Helpers::FormBuilder.new(:person, @person_instance, view, {}, proc {})
+
+    assert_equal expected, it.hstore_radio_button(:gender)
+  end
+
+  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)
+    expected = ""
+    all_buttons.each do |b|
+      expected += it.hstore_radio_button(b)
+    end
+
+    assert_equal expected, it.hstore_radio_buttons
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative '../../../test_helper.rb'
+require 'action_view/test_case'
+
+class FormHelperTest < ActionView::TestCase
+  include ActionView::TestCase::Behavior
+
+  test "adds my FormHelper to Rails' FormHelper" do
+    assert ActionView::Helpers::FormHelper.include?(HstoreRadioButtons::FormHelper)
+    assert ActionView::Base.include?(HstoreRadioButtons::FormHelper)
+  end
+
+  test "view can respond to hstore_radio_button" do
+    assert view.respond_to?(:hstore_radio_button)
+  end
+
+  test "returns a radio input, label and separator of <br />" do
+    it = view.hstore_radio_button(:person, :gender, 'male', separator: "<br />")
+    expected = ""
+    expected += view.radio_button(:person, :gender, 'male', {})
+    expected += view.label(:person, 'male', {})
+    expected += "<br />"
+    assert_equal expected, it
+  end
+end

data/test/lib/hstore_radio_buttons/hstore_radio_buttons_test.rb

@@ -0,0 +1,16 @@
+require_relative '../../test_helper.rb'
+
+describe HstoreRadioButtons do
+  it 'adds a HstoreRadioData active record class' do
+    HstoreRadioButtons::HstoreRadioData.new.wont_be_nil
+  end
+
+  it 'allows a class to respond to hstore_radio_buttons' do
+    Person.must_respond_to :hstore_radio_buttons
+  end
+
+  it 'builds a has_one association with the hstore_radio_data table' do
+    Person.new.must_respond_to :hstore_radio_data
+    Person.new.must_respond_to :build_hstore_radio_data
+  end
+end

data/test/lib/hstore_radio_buttons/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper.rb'
+
+describe HstoreRadioButtons do
+  it "must have a version" do
+    HstoreRadioButtons::VERSION.wont_be_nil
+  end
+end

data/test/support/config/hstore_radio_button_sets.yml

@@ -0,0 +1,14 @@
+---
+person:
+  gender:
+  - male
+  - female
+  - other
+  'favorite barn animal':
+  - cow
+  - sheep
+  - pig
+report:
+  accepted:
+    - true
+    - false

data/test/support/models.rb

@@ -0,0 +1,6 @@
+class Person < ActiveRecord::Base
+  include HstoreRadioButtons
+
+  hstore_radio_buttons './test/support/config/hstore_radio_button_sets.yml'
+end
+

data/test/support/schema.rb

@@ -0,0 +1,23 @@
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => File.expand_path('../../test.db', __FILE__)
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :people, :force => true do |t|
+      t.timestamps
+    end
+
+    create_table :reports, :force => true do |t|
+      t.timestamps
+    end
+
+    create_table :hstore_radio_data, :force => true do |t|
+      t.belongs_to :model, :polymorphic => true
+      t.text    :hstore_data
+
+      t.timestamps
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'hstore_radio_buttons'
+
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'fileutils'
+require 'active_record'
+require_relative 'support/models.rb'
+require_relative 'support/schema.rb'
+
+CreateSchema.suppress_messages{ CreateSchema.migrate(:up) }
+
+MiniTest::Unit.after_tests do
+  FileUtils.rm_rf(File.expand_path('../test.db', __FILE__))
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: hstore_radio_buttons
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Whitney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70257637365360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257637365360
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70257637364800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257637364800
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70257637364220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257637364220
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgres-hstore
+  requirement: &70257637363740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257637363740
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70257637363060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70257637363060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70257637362480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257637362480
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70257637361800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257637361800
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70257637361240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257637361240
+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:
+- ian@ianwhitney.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hstore_radio_buttons.gemspec
+- lib/generators/hstore_radio_buttons.rb
+- lib/generators/hstore_radio_buttons/migration/migration_generator.rb
+- lib/generators/hstore_radio_buttons/migration/templates/migration.rb
+- lib/hstore_radio_buttons.rb
+- lib/hstore_radio_buttons/button_options.rb
+- lib/hstore_radio_buttons/button_set.rb
+- lib/hstore_radio_buttons/configuration.rb
+- lib/hstore_radio_buttons/helpers/form_helper.rb
+- lib/hstore_radio_buttons/hstore_radio_data.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
+- test/lib/hstore_radio_buttons/configuration_test.rb
+- test/lib/hstore_radio_buttons/helpers/form_builder_test.rb
+- test/lib/hstore_radio_buttons/helpers/form_helper_test.rb
+- test/lib/hstore_radio_buttons/hstore_radio_buttons_test.rb
+- test/lib/hstore_radio_buttons/version_test.rb
+- test/support/config/hstore_radio_button_sets.yml
+- test/support/models.rb
+- test/support/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/IanWhitney/hstore_radio_buttons
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Define a set of radio buttons for a model and then save the perisisted data
+  for these buttons in an hstore field. Good for data that you want to persist, but
+  that isn't important enough for its own field in the model.
+test_files:
+- test/lib/hstore_radio_buttons/button_options_test.rb
+- test/lib/hstore_radio_buttons/button_set_test.rb
+- test/lib/hstore_radio_buttons/configuration_test.rb
+- test/lib/hstore_radio_buttons/helpers/form_builder_test.rb
+- test/lib/hstore_radio_buttons/helpers/form_helper_test.rb
+- test/lib/hstore_radio_buttons/hstore_radio_buttons_test.rb
+- test/lib/hstore_radio_buttons/version_test.rb
+- test/support/config/hstore_radio_button_sets.yml
+- test/support/models.rb
+- test/support/schema.rb
+- test/test_helper.rb