selections 0.1.3 → 0.1.4

data/README.md

@@ -35,7 +35,7 @@ can change the name), and should be generated such as:
 rails generate model Selection name parent_id:integer system_code position_value:integer is_default:boolean is_system:boolean archived_at:datetime
 ```
 
-### Model
+### Selection Model 
 And next, edit this class to look like:
 
 ```ruby
@@ -66,7 +66,7 @@ Selection.user_role
 Dynamic lookups support pluralization and will then return the children:
 
 ```ruby
-Selection.priorities => [high,med,low] records
+Selection.priorities  -> [high,med,low] records
 ```
 
 #### Form Helper
@@ -97,23 +97,48 @@ within the _form.html.erb just use the selections helper method:
 <% end %>
 ```
 
-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
+### Form Helper Options
 
-user form file
+```ruby
+  f.selections :fieldname, options = {}, html_options = {}
+```
+
+The selections method excepts all the standard Ruby on Rails form helper options and html formatting - http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select
+
+#### System Code Override
+
+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 :category
+<%= f.selections :variety, :system_code => :category %>
 ```
 
-this will automatically look up the user_category selections.
+### Scoped System Code
+
+If you have naming conflicts/duplicates system_codes (parent codes) eg. category_id field for user and ticket models
 
-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.
+Selections Data example
+
+* user_category
+ - civilian
+ - programmer
+* ticket_category
+ - high
+ - low
+
+The fieldname within the user and ticket form can both be :category as the form helper will search for
+either 'category' or 'user_category' in the selections model.
+
+users/_form.html.erb
 
 ```ruby
-f.selections :variety, :system_code => :category
+  <%= f.selections :category %>
 ```
 
+This will automatically look up the 'user_category' selections if 'category' does not exist
+
+## Related Models
+
 Next, you need to tell models that have a selectable association. These are `belongs_to` associations
 which pull their values from the selections model. Assuming you have a `Ticket` model with a foreign key of priority_id,
 you can set this up like so:
@@ -130,18 +155,19 @@ From an instance of a ticket within a view the belongs_to selection will return
 eg: show.html.erb
 
 ```ruby
-  ticket.priority.try(:name) # don't need to do this
-
-  ticket.priority # will default to return name
+<p>
+  <b>Priority:</b>
+  <%= @ticket.priority %>  # Instead of this @ticket.priority.try(:name)
+</p>
 ```
 
-### Automatic Features
+## Automatic Features
 #### 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.
 
-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. Use the options :include_blank => true option to overrided.
 
 #### Archived Item
 
@@ -154,6 +180,9 @@ eg. A ticket has a priority set to high, later the high selection list item was
 
 The list will by default display in alphanumeric order, unless you add position values and then it will display in the values.
 
+#### system_code generation
+On creation of a new item in Selections the system_code field will be automatically generated based on parent and item name if left blank.
+
 ## Configuration
 
 If you use a class name other than `Selection` as your selection model, you must
@@ -167,6 +196,7 @@ Selections.model { YourSelectionModel }
 
 * Add model generators
 * Add selections management scaffold/generator
+* Add Radio Button support
 
 ## Contributing
 
@@ -176,7 +206,7 @@ Selections.model { YourSelectionModel }
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## example selections.yml
+## example selections.yml to import into DB
 
 ```yaml
 priority:

data/lib/selections/form_builder_extensions.rb

@@ -43,8 +43,8 @@ module Selections
       end
 
       def system_code
-        @system_code ||= selection.where(system_code: system_code_name.to_s).first
         @system_code ||= selection.where(system_code: "#{form.object_name}_#{system_code_name}").first
+        @system_code ||= selection.where(system_code: system_code_name.to_s).first
       end
 
       def items
@@ -59,7 +59,7 @@ module Selections
           options[:selected] = selected_item
           form.select field_id, items.map { |item| [item.name, item.id] }, options, html_options
         else
-          "Invalid system_code of '#{system_code_name}'"
+          "Could not find system_code of '#{system_code_name}' or '#{form.object_name}_#{system_code_name}'"
         end
       end
 

data/lib/selections/version.rb

@@ -1,3 +1,3 @@
 module Selections
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/selections/selections_tag_spec.rb

@@ -41,6 +41,13 @@ describe SelectionTag do
       before { parent }
       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 }
+      context "when more explicit route should found first" do
+        before { model_parent }
+        it("should find more explicit route of model parent") { expect(edit_form.system_code).to eq(model_parent) }
+        it "should use priority system_code when model is not ticket" do
+          expect(edit_form(form: ActionView::Helpers::FormBuilder.new(:user, :user, ActionView::Base.new, {}, Proc.new {}) ).system_code).to eq(parent)
+        end
+      end
     end
 
     it "finds with form model prefixed" do
@@ -178,8 +185,13 @@ describe SelectionTag do
   end
 
   describe ".to_tag" do
-    it "displays warning when system_code does not exist" do
-      expect(edit_form.to_tag).to eq("Invalid system_code of 'priority'")
+    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
     end
     context "valid system_code" do
       before { all_selections }

metadata

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