selections 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 ## 0.0.1
 
-* Initial release
+* Initial release
+
+## 0.1.1
+
+* Clean up of specs and readme
+
+## 0.1.2
+
+* Fixing issues with readme

data/README.md

@@ -45,24 +45,25 @@ end
 ```
 
 Selections table can contain one or many lists, it uses the acts_as_tree so each root is a new list
-meta example: (see below for example YAML file)
- - priority
-   - high
-   - medium
-   - low
- - user_role
-   - admin
-   - owner
-   - user
-
-From the rails console it is be possible to access these items directly using dynamic lookups
+meta example: (see below for example YAML file).
+
+* priority
+ - high
+ - medium
+ - low
+* user_role
+ - admin
+ - owner
+ - user
+
+From the rails console it is be possible to access these items directly using dynamic lookups:
 
 ```ruby
 Selection.priority => returns the parent row
 Selection.user_role
 ```
 
-Dynamic lookups support pluralization and will then return the children
+Dynamic lookups support pluralization and will then return the children:
 
 ```ruby
 Selection.priorities => [high,med,low] records
@@ -70,11 +71,12 @@ Selection.priorities => [high,med,low] records
 
 #### Form Helper
 
-if we had a controller for Ticket model with fields of
-- name
-- priority_id
+if we had a controller for Ticket model with fields of:
+
+* name
+* priority_id
 
-within the _form.html.erb just use the selections helper method
+within the _form.html.erb just use the selections helper method:
 
 ```ruby
 <%= form_for(@ticket) do |f| %>
@@ -98,13 +100,15 @@ within the _form.html.erb just use the selections helper method
 If you have naming conflicts/duplicates eg. user categories and ticket categories within in the selections name the parent/system_code
 user_category & ticket_category. The foreign key within the user and ticket can both be category_id and the form_helper will still be
 
-user form
+user form file
+
 ```ruby
 f.selections :category
 ```
+
 this will automatically look up the user_category selections.
 
-If you have a selection named differently to the foreign key eg the foreign key is variety_id, you can use a system_code option
+If you have a selection named differently to the foreign key eg the foreign key is variety_id, you can use a system_code option.
 
 ```ruby
 f.selections :variety, :system_code => :category
@@ -125,7 +129,6 @@ end
 From an instance of a ticket within a view the belongs_to selection will return string (to_s).
 eg: show.html.erb
 
-
 ```ruby
   ticket.priority.try(:name) # don't need to do this
 
@@ -136,16 +139,16 @@ eg: show.html.erb
 #### Include Blank
 
 In a new form the selections list will have blank top row unless a default item is set in the selections eg. Medium Priority, then there
-will be no blank row and the default item will be selected
+will be no blank row and the default item will be selected.
 
-When editing a form, by default the blank row will not be displayed
+When editing a form, by default the blank row will not be displayed.
 
 #### Archived Item
 
 On a new form items that are archived in Selections will not appear in the selection list. When editing an existing record the list will only
 contain un-archived items, unless the item selected is archived it will then appear.
 
-eg. A ticket has a priority set to high, later the high selection list item was archived, when we edit the ticket record again the item will show in the list even though it is archived
+eg. A ticket has a priority set to high, later the high selection list item was archived, when we edit the ticket record again the item will show in the list even though it is archived.
 
 #### Order
 
@@ -173,7 +176,7 @@ Selections.model { YourSelectionModel }
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## YAML example
+## example selections.yml
 
 ```yaml
 priority:

data/lib/selections/form_builder_extensions.rb

@@ -22,7 +22,7 @@ module Selections
     class SelectionTag #:nodoc:
       attr_reader :form, :object, :field, :html_options, :options, :selection, :field_id, :system_code_name
 
-      def initialize(form, object, field, html_options, options)
+      def initialize(form, object, field, options, html_options)
         @form = form
         @object = object
         @field = field

data/lib/selections/version.rb

@@ -1,3 +1,3 @@
 module Selections
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/selections/selections_tag_spec.rb

@@ -1,7 +1,25 @@
 require "spec_helper"
 
-
 include Selections::FormBuilderExtensions
+
+def edit_form args = {}
+  args[:object] ||= ticket
+  common_form args
+end
+
+def new_form args = {}
+  args[:object] ||= Ticket.new
+  common_form args
+end
+
+def common_form args = {}
+  args[:form]   ||= form
+  args[:field] ||= :priority
+  args[:html_options] ||= {}
+  args[:options] ||= {}
+  SelectionTag.new(args[:form], args[:object], args[:field], args[:options], args[:html_options])
+end
+
 describe SelectionTag do
   let(:parent) { Selection.create(name: "priority") }
   let(:model_parent) { Selection.create(name: "ticket_priority") }
@@ -21,17 +39,13 @@ describe SelectionTag do
   describe ".system_code" do
     context "direct parent" do
       before { parent }
-      it "returns priority selection item" do
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).system_code).to eq(parent)
-      end
-      it "does not find" do
-        expect(SelectionTag.new(form, ticket, :non_existent, {}, {}).system_code).to be_nil
-      end
+      it("returns priority selection item") { expect(edit_form.system_code).to eq(parent) }
+      it("does not find") { expect(edit_form(field: "non_existent").system_code).to be_nil }
     end
 
     it "finds with form model prefixed" do
       model_parent
-      expect(SelectionTag.new(form, ticket, :priority, {}, {}).system_code).to eq(model_parent)
+      expect(edit_form.system_code).to eq(model_parent)
     end
   end
 
@@ -39,28 +53,28 @@ describe SelectionTag do
     before { all_selections }
 
     it "returns all children items" do
-      expect(SelectionTag.new(form, ticket, :priority, {}, {}).items.all).to eq(parent.children)
+      expect(edit_form.items.all).to eq(parent.children)
     end
     context "archived" do
       before { selection_2.update_attribute(:archived, "1") }
       it "returns only non archived items" do
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).items).to eq(parent.children - [selection_2])
+        expect(edit_form.items).to eq(parent.children - [selection_2])
       end
       it "returns archived items when selected" do
         ticket.update_attribute(:priority_id, selection_2.id)
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).items.all).to eq(parent.children)
+        expect(edit_form.items.all).to eq(parent.children)
       end
     end
   end
 
   describe ".field_id" do
-    it("when string") { expect(SelectionTag.new(nil, nil, "priority", {}, {}).field_id).to eq(:priority_id) }
-    it("when symbol") { expect(SelectionTag.new(nil, nil, :priority, {}, {}).field_id).to eq(:priority_id) }
+    it("when string") { expect(edit_form(field: "priority").field_id).to eq(:priority_id) }
+    it("when symbol") { expect(edit_form(field: :priority).field_id).to eq(:priority_id) }
   end
 
   describe ".system_code_name" do
-    it("sets to field name") { expect(SelectionTag.new(nil, nil, :priority, {}, {}).system_code_name).to eq(:priority) }
-    it("when override system_code") { expect(SelectionTag.new(nil, nil, :hello, {}, {system_code: :priority}).system_code_name).to eq(:priority) }
+    it("sets to field name") { expect(edit_form.system_code_name).to eq(:priority) }
+    it("when override system_code") { expect(edit_form(field: :hello, options: {system_code: :priority}).system_code_name).to eq(:priority) }
   end
 
   context "include blank" do
@@ -68,63 +82,63 @@ describe SelectionTag do
 
     context "when not set" do
       context "new form" do
-        it("has blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).include_blank?).to be_true }
+        it("has blank") { expect(new_form.include_blank?).to be_true }
         it "has no blank when default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).include_blank?).to be_false
+          expect(new_form.include_blank?).to be_false
         end
       end
       context "edit form" do
         it("has no blank when ticket.priority_id is set") do
           ticket.update_attribute(:priority_id, selection_3.id)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_false
+          expect(edit_form.include_blank?).to be_false
         end
-        it("has blank when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_true }
+        it("has blank when ticket.priority_id is nil") { expect(edit_form.include_blank?).to be_true }
         it "has no blank when ticket.priority_id is nil and default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {}).include_blank?).to be_false
+          expect(edit_form.include_blank?).to be_false
         end
       end
     end
 
     context "when set false" do
       context "new form" do
-        it("has no blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).include_blank?).to be_false }
+        it("has no blank") { expect(new_form(options: {include_blank: false}).include_blank?).to be_false }
         it "has no blank when default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).include_blank?).to be_false
+          expect(new_form(options: {include_blank: false}).include_blank?).to be_false
         end
       end
       context "edit form" do
         it("has no blank when ticket.priority_id is set") do
           ticket.update_attribute(:priority_id, selection_3.id)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false
+          expect(edit_form(options: {include_blank: false}).include_blank?).to be_false
         end
-        it("has no blank even when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false }
+        it("has no blank even when ticket.priority_id is nil") { expect(edit_form(options: {include_blank: false}).include_blank?).to be_false }
         it "has no blank when ticket.priority_id is nil and default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: false}).include_blank?).to be_false
+          expect(edit_form(options: {include_blank: false}).include_blank?).to be_false
         end
       end
     end
 
     context "when set to true" do
       context "new form" do
-        it("has blank") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: true}).include_blank?).to be_true }
+        it("has blank") { expect(new_form(options: {include_blank: true}).include_blank?).to be_true }
         it "has blank even when default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: true}).include_blank?).to be_true
+          expect(new_form(options: {include_blank: true}).include_blank?).to be_true
         end
       end
       context "edit form" do
         it("has blank even when ticket.priority_id is set") do
           ticket.update_attribute(:priority_id, selection_3.id)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true
+          expect(edit_form(options: {include_blank: true}).include_blank?).to be_true
         end
-        it("has blank even when ticket.priority_id is nil") { expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true }
+        it("has blank even when ticket.priority_id is nil") { expect(edit_form(options: {include_blank: true}).include_blank?).to be_true }
         it "has blank even when ticket.priority_id is nil and default set" do
           selection_1.update_attribute(:is_default, true)
-          expect(SelectionTag.new(form, ticket, :priority, {}, {include_blank: true}).include_blank?).to be_true
+          expect(edit_form(options: {include_blank: true}).include_blank?).to be_true
         end
       end
     end
@@ -133,11 +147,11 @@ describe SelectionTag do
   context ".default_item" do
     before { all_selections }
     it "returns nil when no default set" do
-      expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).default_item).to be_blank
+      expect(new_form.default_item).to be_blank
     end
     it "should set to default item" do
       selection_2.update_attribute(:is_default, true)
-      expect(SelectionTag.new(form, Ticket.new, :priority, {}, {include_blank: false}).default_item).to eq(selection_2.id.to_s)
+      expect(new_form.default_item).to eq(selection_2.id.to_s)
     end
   end
 
@@ -145,58 +159,58 @@ describe SelectionTag do
     before { all_selections }
 
     context "when default not set" do
-      it("when new form") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).selected_item).to eq("") }
+      it("when new form") { expect(new_form.selected_item).to eq("") }
       it "when edit form with ticket.priority_id set" do
         ticket.update_attribute(:priority_id, selection_3.id)
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq(selection_3.id.to_s)
+        expect(edit_form.selected_item).to eq(selection_3.id.to_s)
       end
-      it("when edit form with no ticket.priority_id set") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq("") }
+      it("when edit form with no ticket.priority_id set") { expect(edit_form.selected_item).to eq("") }
     end
     context "when default is set" do
       before { selection_2.update_attribute(:is_default, true) }
-      it("when new form") { expect(SelectionTag.new(form, Ticket.new, :priority, {}, {}).selected_item).to eq(selection_2.id.to_s) }
+      it("when new form") { expect(new_form.selected_item).to eq(selection_2.id.to_s) }
       it "when edit form with ticket.priority_id set" do
         ticket.update_attribute(:priority_id, selection_3.id)
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq(selection_3.id.to_s)
+        expect(edit_form.selected_item).to eq(selection_3.id.to_s)
       end
-      it("when edit form with no ticket.priority_id set") { expect(SelectionTag.new(form, ticket, :priority, {}, {}).selected_item).to eq("") }
+      it("when edit form with no ticket.priority_id set") { expect(edit_form.selected_item).to eq("") }
     end
   end
 
   describe ".to_tag" do
     it "displays warning when system_code does not exist" do
-      expect(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).to eq("Invalid system_code of 'priority'")
+      expect(edit_form.to_tag).to eq("Invalid system_code of 'priority'")
     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(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[selected]")).to be_empty }
-          it("has a blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(1) }
+          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) }
         end
         context "default is set" do
           before { selection_3.update_attribute(:is_default, true) }
 
-          it("has selection_3 selected") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
-          it("has no blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, Ticket.new, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(0) }
+          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) }
         end
       end
 
       context "edit form" do
         context "relation (priority_id) is nil" do
-          it("has no selected item") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[selected]")).to be_empty }
-          it("has a blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(1) }
+          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) }
         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(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[selected]").first.content).to eq(selection_3.name) }
-          it("has no blank option") { expect(Nokogiri::HTML(SelectionTag.new(form, ticket, :priority, {}, {}).to_tag).search("option[value='']").count).to eq(0) }
+          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) }
         end
       end
       it "returns valid html" do
-        expect(SelectionTag.new(form, ticket, :priority, {}, {}).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>"
+        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
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selections
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord