selections 0.1.13 → 0.1.14

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.14
+* https://github.com/nigelr/selections/issues/7 - add selection items as booleans method names to attached model
+
 ## 0.1.13
 
 * https://github.com/nigelr/selections/issues/4 - selections-4 create selection Management scaffold generator

data/README.md

@@ -10,6 +10,7 @@ Selection list management and form and view helpers.
  - f.selections :priorities # dropdowns
  - f.radios :priorities # radio buttons
 * Model helpers for joining tables ( eg. belongs_to_selection :priority )
+* Matchers eg. @ticket.priority_high?
 * Handling of archived items ( displaying if selected only )
 * Ordering of lists based on alpha or numbered
 * Default item handling
@@ -44,19 +45,17 @@ can change the name), and should be generated such as:
 
 ```ruby
 rails generate model Selection name parent_id:integer system_code position_value:integer is_default:boolean is_system:boolean archived_at:datetime
-```
 
-### Selection Model 
-And next, edit this class to look like:
 
-```ruby
 class Selection < ActiveRecord::Base
   selectable
 end
 ```
 
+## Selections
+
 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).
+meta example: (see below for example YML file).
 
 * priority
  - high
@@ -180,6 +179,20 @@ eg: show.html.erb
 </p>
 ```
 
+## Matchers
+
+Selections supports lookup using the boolean ? method, as an example:
+
+instead of needing to do
+```ruby
+  if @ticket.priority == Selection.ticket_priority_high
+```
+you can check directly on the instance:
+```ruby
+  if @ticket.priority_high?
+```
+Thanks to @mattconnolly
+
 ## Automatic Features
 #### Include Blank
 

data/lib/selections/belongs_to_selection.rb

@@ -3,13 +3,42 @@ module Selections
 
     # Helper for belongs_to and accepts all the standard rails options
     #
-    #Example
-    #   belongs_to_selection :priority
+    # Example
+    #   class Thing < ActiveRecord::Base
+    #     belongs_to_selection :priority
     #
     # by default adds - class_name: "Selection"
-
+    #
+    # This macro also adds a number of methods onto the class if there is a selection
+    # named as the class underscore name (eg: "thing_priority"), then methods are created
+    # for all of the selection values under that parent. For example:
+    #
+    #   thing = Thing.find(x)
+    #   thing.priority = Selection.thing_priority_high
+    #   thing.priority_high? #=> true
+    #   thing.priority_low?  #=> false
+    #
+    # thing.priority_high? is equivalent to thing.priority == Selection.thing_priority_high
+    # except that the id of the selection is cached at the time the class is loaded.
+    #
+    # Note that this is only appropriate to use for system selection values that are known
+    # at development time, and not to values that the users can edit in the live system.
     def belongs_to_selection(target, options={})
       belongs_to target, options.merge(:class_name => "Selection")
+
+      prefix = self.name.downcase
+      parent = Selection.where(system_code: "#{prefix}_#{target}").first
+      if parent
+        target_id = "#{target}_id".to_sym
+        parent.children.each do |s|
+          method_name = "#{s.system_code.sub("#{prefix}_", '')}?".to_sym
+          class_eval do
+            define_method method_name do
+              send(target_id) == s.id
+            end
+          end
+        end
+      end
     end
 
     ActiveSupport.on_load :active_record do
@@ -17,4 +46,4 @@ module Selections
     end
 
   end
-end
+end

data/lib/selections/version.rb

@@ -1,3 +1,3 @@
 module Selections
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 end

data/selections.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'nokogiri'
-
+  gem.add_development_dependency "shoulda-matchers", "~> 2.4.0"
 end

data/spec/selections/belongs_to_selection_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'shoulda/matchers'
+
+describe Selections::BelongsToSelection do
+
+  let(:parent) { Selection.create(name: "priority", system_code: "ticket_priority") }
+  let(:selection_1) { Selection.create(name: "low", parent_id: parent.id, system_code: "ticket_priority_low") }
+  let(:selection_2) { Selection.create(name: "medium", parent_id: parent.id, system_code: "ticket_priority_medium") }
+  let(:selection_3) { Selection.create(name: "high", parent_id: parent.id, system_code: "ticket_priority_high") }
+
+  let(:ticket_class) do
+    # create the priority records *before* using belongs_to_selection on the class.
+    selection_1; selection_2; selection_3
+
+    Class.new(ActiveRecord::Base) do
+      self.table_name = "tickets"
+
+      # anonymous class has no name, so fake the "Ticket" name
+      def self.name
+        "Ticket"
+      end
+
+      belongs_to_selection :priority
+    end
+  end
+
+  before do
+    ticket_class
+  end
+
+  context 'relationships' do
+    it "creates a belongs to relationship" do
+      expect(ticket_class.new).to belong_to(:priority)
+    end
+  end
+
+  context 'dynamic methods' do
+    subject { ticket_class.new }
+    %w{low medium high}.each do |p|
+      it "creates the method #priority_#{p}?" do
+        expect(subject.respond_to? "priority_#{p}?".to_sym).to be_true
+      end
+    end
+
+    context 'high priority' do
+      before { subject.priority = selection_3 }
+
+      it("#priority_high? is true") do
+        expect(subject.priority_high?).to be_true
+      end
+      it("#priority_medium? is false") do
+        expect(subject.priority_medium?).to be_false
+      end
+      it("#priority_low? is false") do
+        expect(subject.priority_low?).to be_false
+      end
+    end
+
+    context 'with no matching selections' do
+      it "does not create any methods" do
+        expect(ticket_class).not_to receive(:define_method).with { |x|
+          # the relationship will define this method, but there should be no others.
+          x != :autosave_associated_records_for_wrong
+        }
+        ticket_class.belongs_to_selection :wrong
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selections
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -123,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 description: ! "Selection list management and form and view helpers.\n Manages one
   table to hold all selections items/dropdown lists ( tree ).\n Dynamic lookup to
   find parent or children ( eg. Selection.priorities ).\n Form helper to display lists
@@ -141,7 +157,6 @@ files:
 - README.md
 - Rakefile
 - lib/generators/selections_scaffold/selections_scaffold_generator.rb
-- lib/generators/selections_scaffold/templates/.DS_Store
 - lib/generators/selections_scaffold/templates/_form.html.haml
 - lib/generators/selections_scaffold/templates/create_selections.rb
 - lib/generators/selections_scaffold/templates/edit.html.erb
@@ -162,6 +177,7 @@ files:
 - lib/selections/selectable.rb
 - lib/selections/version.rb
 - selections.gemspec
+- spec/selections/belongs_to_selection_spec.rb
 - spec/selections/selectable_spec.rb
 - spec/selections/selections_tag_spec.rb
 - spec/spec_helper.rb
@@ -193,6 +209,7 @@ summary: Selection list management and form and view helpers. Manages one table
   or children ( eg. Selection.priorities ). Form helper to display lists ( eg. f.selections
   :priorities ). Handling of archived items ( displaying if selected only ).
 test_files:
+- spec/selections/belongs_to_selection_spec.rb
 - spec/selections/selectable_spec.rb
 - spec/selections/selections_tag_spec.rb
 - spec/spec_helper.rb