selections 0.1.7 → 0.1.11

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.11
+
+* https://github.com/nigelr/selections/issues/2 - Added feature of radios for radio_buttons
+
 ## 0.1.7
 
 * https://github.com/nigelr/selections/issues/5 - issue with forgetting selected item when page was invalid

data/README.md

@@ -1,12 +1,14 @@
-# Selections
+# Selections [![Gem Version](https://badge.fury.io/rb/selections.png)](http://badge.fury.io/rb/selections)
 
 Selection list management and form and view helpers.
 
 ##Key Features
 
-* Manages one table to hold all selections items/ dropdown lists ( tree )
+* Manages one table to hold all selections items/dropdown lists or Radio Buttons ( tree )
 * Dynamic lookup to find parent or children ( eg. Selection.priorities )
-* Form helper to display lists ( eg. f.selections :priorities )
+* Form helper to display lists
+ - f.selections :priorities # dropdowns
+ - f.radios :priorities # radio buttons
 * Model helpers for joining tables ( eg. belongs_to_selection :priority )
 * Handling of archived items ( displaying if selected only )
 * Ordering of lists based on alpha or numbered
@@ -69,9 +71,9 @@ Dynamic lookups support pluralization and will then return the children:
 Selection.priorities  -> [high,med,low] records
 ```
 
-#### Form Helper
+## Form Helper
 
-if we had a controller for Ticket model with fields of:
+If we had a controller for Ticket model with fields of:
 
 * name
 * priority_id
@@ -97,7 +99,7 @@ within the _form.html.erb just use the selections helper method:
 <% end %>
 ```
 
-### Form Helper Options
+### Selection List Options
 
 ```ruby
   f.selections :fieldname, options = {}, html_options = {}
@@ -113,6 +115,14 @@ If you have a selection named differently to the foreign key eg. the foreign key
 <%= f.selections :variety, :system_code => :category %>
 ```
 
+### Radio Buttons Options
+
+```ruby
+  f.radios :ticket, options = {}
+```
+
+The radios method excepts all the standard Ruby on Rails form helper options and html formatting - http://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-radio_button
+
 ### Scoped System Code
 
 If you have naming conflicts/duplicates system_codes (parent codes) eg. category_id field for user and ticket models
@@ -196,7 +206,6 @@ Selections.model { YourSelectionModel }
 
 * Add model generators
 * Add selections management scaffold/generator
-* Add Radio Button support
 
 ## Contributing
 

data/lib/selections/form_builder_extensions.rb

@@ -2,10 +2,9 @@ module Selections
   module FormBuilderExtensions
     # Create a select list based on the field name finding items within Selection.
     #
-    #
     # Example
     #   form_for(@ticket) do |f|
-    #     f. select("priority")
+    #     f.select("priority")
     #
     # Uses priority_id from the ticket table and creates options list based on items in Selection table with a system_code of
     # either priority or ticket_priority
@@ -16,7 +15,21 @@ module Selections
     # * +system_code+ - Overrides the automatic system_code name based on the fieldname and looks up the list of items in Selection
 
     def selections(field, options = {}, html_options = {})
-      SelectionTag.new(self, object, field, options, html_options).to_tag
+      SelectionTag.new(self, object, field, options, html_options).select_tag
+    end
+
+    # Build a radio button list based field name finding items within Selection
+    #
+    # Example
+    #   form_for(@ticket) do |f|
+    #     f.select :priority
+    # options
+    # * +system_code+ - Overrides the automatic system_code name based on the fieldname and looks up the list of items in Selection
+
+    def radios(field, options = {})
+      html_options = options.clone
+      html_options.delete_if {|key, value| key == :system_code}
+      SelectionTag.new(self, object, field, options, html_options).radio_tag
     end
 
     class SelectionTag #:nodoc:
@@ -51,7 +64,7 @@ module Selections
         @items ||= system_code.children.filter_archived_except_selected(object.send(field_id))
       end
 
-      def to_tag
+      def select_tag
         if system_code
           #TODO add default style
           #html_options[:style] ||=
@@ -59,10 +72,30 @@ module Selections
           options[:selected] = selected_item
           form.select field_id, items.map { |item| [item.name, item.id] }, options, html_options
         else
-          "Could not find system_code of '#{system_code_name}' or '#{form.object_name}_#{system_code_name}'"
+          error_message
         end
       end
 
+      def radio_tag
+        if system_code
+          items.unshift(selection.new(name: blank_content)) if include_blank?
+
+          items.inject('') do |build, item|
+            label_html_options = item.id ? html_options.merge(value: item.id.to_s) : html_options
+            html_options[:checked] = selected_item == item.id.to_s && !item.new_record?
+            build + form.label(field_id, label_html_options) do
+              form.radio_button(field_id, item.id, html_options) + item.name
+            end
+          end.html_safe
+        else
+          error_message
+        end
+      end
+
+      def error_message
+        "Could not find system_code of '#{system_code_name}' or '#{form.object_name}_#{system_code_name}'"
+      end
+
       def selected_item
         if object.new_record? && object.send(field_id).blank?
            default_item
@@ -74,6 +107,10 @@ module Selections
       def default_item
         items.where(:is_default => true).first.try(:id).to_s
       end
+
+      def blank_content
+        options[:blank_content] || 'none'
+      end
     end
 
     ActiveSupport.on_load :action_view do

data/lib/selections/version.rb

@@ -1,3 +1,3 @@
 module Selections
-  VERSION = '0.1.7'
+  VERSION = '0.1.11'
 end

data/spec/selections/selections_tag_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 include Selections::FormBuilderExtensions
 
@@ -225,45 +225,102 @@ describe SelectionTag do
     end
   end
 
-  describe ".to_tag" do
-    context "invalid" do
-      it "displays warning when system_code does not exist" do
-        expect(edit_form.to_tag).to eq("Could not find system_code of 'priority' or 'ticket_priority'")
-      end
-      it "displays warning for system_code override" do
-        expect(edit_form(options: {system_code: "hello"}).to_tag).to eq("Could not find system_code of 'hello' or 'ticket_hello'")
-      end
+  describe '.blank_content' do
+    it 'when nothing set' do
+      expect(new_form.blank_content).to eq('none')
     end
-    context "valid system_code" do
-      before { all_selections }
+    it 'when set' do
+      expect(new_form(options: {blank_content: 'hello'}).blank_content).to eq('hello')
+    end
+  end
 
-      context "new form" do
-        context "no default" do
-          it("has no selected item") { expect(Nokogiri::HTML(new_form.to_tag).search("option[selected]")).to be_empty }
-          it("has a blank option") { expect(Nokogiri::HTML(new_form.to_tag).search("option[value='']").count).to eq(1) }
+  context 'html output' do
+    describe '.select_tag' do
+      context 'invalid' do
+        it 'displays warning when system_code does not exist' do
+          expect(edit_form.select_tag).to eq("Could not find system_code of 'priority' or 'ticket_priority'")
         end
-        context "default is set" do
-          before { selection_3.update_attribute(:is_default, true) }
-
-          it("has selection_3 selected") { expect(Nokogiri::HTML(new_form.to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
-          it("has no blank option") { expect(Nokogiri::HTML(new_form.to_tag).search("option[value='']").count).to eq(0) }
+        it 'displays warning for system_code override' do
+          expect(edit_form(options: {system_code: 'hello'}).select_tag).to eq("Could not find system_code of 'hello' or 'ticket_hello'")
         end
       end
+      context 'valid system_code' do
+        before { all_selections }
 
-      context "edit form" do
-        context "relation (priority_id) is nil" do
-          it("has no selected item") { expect(Nokogiri::HTML(edit_form.to_tag).search("option[selected]")).to be_empty }
-          it("has a blank option") { expect(Nokogiri::HTML(edit_form.to_tag).search("option[value='']").count).to eq(1) }
+        context 'new form' do
+          context 'no default' do
+            it('has no selected item') { expect(Nokogiri::HTML(new_form.select_tag).search('option[selected]')).to be_empty }
+            it('has a blank option') { expect(Nokogiri::HTML(new_form.select_tag).search("option[value='']").count).to eq(1) }
+          end
+          context 'default is set' do
+            before { selection_3.update_attribute(:is_default, true) }
+
+            it('has selection_3 selected') { expect(Nokogiri::HTML(new_form.select_tag).search('option[selected]').first.content).to eq(selection_3.name) }
+            it('has no blank option') { expect(Nokogiri::HTML(new_form.select_tag).search("option[value='']").count).to eq(0) }
+          end
         end
-        context "when relation (priority_id) is set to selection_3" do
-          before { ticket.update_attribute(:priority_id, selection_3.id) }
 
-          it("item is selected") { expect(Nokogiri::HTML(edit_form.to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
-          it("has no blank option") { expect(Nokogiri::HTML(edit_form.to_tag).search("option[value='']").count).to eq(0) }
+        context 'edit form' do
+          context 'relation (priority_id) is nil' do
+            it('has no selected item') { expect(Nokogiri::HTML(edit_form.select_tag).search('option[selected]')).to be_empty }
+            it('has a blank option') { expect(Nokogiri::HTML(edit_form.select_tag).search("option[value='']").count).to eq(1) }
+          end
+          context 'when relation (priority_id) is set to selection_3' do
+            before { ticket.update_attribute(:priority_id, selection_3.id) }
+
+            it('item is selected') { expect(Nokogiri::HTML(edit_form.select_tag).search('option[selected]').first.content).to eq(selection_3.name) }
+            it('has no blank option') { expect(Nokogiri::HTML(edit_form.select_tag).search("option[value='']").count).to eq(0) }
+          end
+        end
+        it 'returns valid html' do
+          expect(edit_form.select_tag).to eq "<select id=\"ticket_priority_id\" name=\"ticket[priority_id]\"><option value=\"\"></option>\n<option value=\"4\">high</option>\n<option value=\"2\">low</option>\n<option value=\"3\">medium</option></select>"
         end
       end
-      it "returns valid html" do
-        expect(edit_form.to_tag).to eq "<select id=\"ticket_priority_id\" name=\"ticket[priority_id]\"><option value=\"\"></option>\n<option value=\"4\">high</option>\n<option value=\"2\">low</option>\n<option value=\"3\">medium</option></select>"
+    end
+    describe '.radio_tag' do
+      context 'invalid' do
+        it 'displays warning when system_code does not exist' do
+          expect(edit_form.radio_tag).to eq("Could not find system_code of 'priority' or 'ticket_priority'")
+        end
+        it 'displays warning for system_code override' do
+          expect(edit_form(options: {system_code: "hello"}).radio_tag).to eq("Could not find system_code of 'hello' or 'ticket_hello'")
+        end
+      end
+      context 'valid system_code' do
+        before { all_selections }
+
+        context 'new form' do
+          context 'no default' do
+            it('has no selected item') { expect(Nokogiri::HTML(new_form.radio_tag).search('input[checked]')).to be_empty }
+            it('has a blank option') { expect(Nokogiri::HTML(new_form.radio_tag).search('label').first.content).to eq('none') }
+            it('has a custom blank option') { expect(Nokogiri::HTML(new_form(options: {blank_content: 'hello'}).radio_tag).search('label').first.content).to eq('hello') }
+          end
+          context 'default is set' do
+            before { selection_3.update_attribute(:is_default, true) }
+
+            it('has selection_3 selected') { expect(Nokogiri::HTML(new_form.radio_tag).search('input[checked]').first['value']).to eq(selection_3.id.to_s) }
+            it('has no blank option') { expect(Nokogiri::HTML(new_form.radio_tag).search('label').first.content).to eq(selection_3.name) }
+          end
+        end
+
+        context 'edit form' do
+          context 'relation (priority_id) is nil' do
+            it('has no selected item') { expect(Nokogiri::HTML(edit_form.radio_tag).search('input[checked]')).to be_empty }
+            it('has a blank option') { expect(Nokogiri::HTML(edit_form.radio_tag).search('label').first.content).to eq('none') }
+          end
+          context 'when relation (priority_id) is set to selection_3' do
+            before { ticket.update_attribute(:priority_id, selection_3.id) }
+
+            it('item is selected') { expect(Nokogiri::HTML(edit_form.radio_tag).search('input[checked]').first['value']).to eq(selection_3.id.to_s) }
+            it('has no blank option') { expect(Nokogiri::HTML(edit_form.radio_tag).search('label').first.content).to eq(selection_3.name) }
+            it('has a blank option when include_blank set') { expect(Nokogiri::HTML(edit_form(options: {include_blank: true}).radio_tag).search('label').first.content).to eq('none') }
+          end
+        end
+        it 'returns valid html' do
+          ticket.update_attribute(:priority_id, selection_3.id)
+          #p edit_form(options: {:include_blank => true}, html_options: {class: 'fred'}).radio_tag
+          expect(edit_form(options: {:include_blank => true}, html_options: {class: 'fred'}).radio_tag).to eq "<label class=\"fred\" for=\"ticket_priority_id\"><input class=\"fred\" id=\"ticket_priority_id\" name=\"ticket[priority_id]\" type=\"radio\" />none</label><label class=\"fred\" for=\"ticket_priority_id_4\"><input checked=\"checked\" class=\"fred\" id=\"ticket_priority_id_4\" name=\"ticket[priority_id]\" type=\"radio\" value=\"4\" />high</label><label checked=\"checked\" class=\"fred\" for=\"ticket_priority_id_2\"><input class=\"fred\" id=\"ticket_priority_id_2\" name=\"ticket[priority_id]\" type=\"radio\" value=\"2\" />low</label><label class=\"fred\" for=\"ticket_priority_id_3\"><input class=\"fred\" id=\"ticket_priority_id_3\" name=\"ticket[priority_id]\" type=\"radio\" value=\"3\" />medium</label>"
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selections
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord