selection_options_for 0.0.5 → 0.0.6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.0.6
+
+* Better support for Rails 3.2
+* Better Module namespaces
+* Unit tests no longer depend on ActiveRecord
+
 ## v0.0.5
 
 * initial release as a rubygem

data/README.md

@@ -16,115 +16,117 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install selection_options_for
-
-## Usage
 
+    gem install selection_options_for
 
-SelectionOptionsFor
-===================
+## Usage
 
  This code allows you to keep the display labels in the model 
  when the DB holds only a 1 character flag.
  and when the code requires symbolic references to the value to use in algorithms
 
- element 0 of the array passed in is always the logical symbol
- If a 2-element Array is passed in, [key, label] and the first letter of label is the DB value
- If a 3-element Array is passed in, [key, DB value, label] 
- Any other type passed in throws an error
+* element 0 of the array passed in is always the logical symbol
+* If a 2-element Array is passed in, [key, label] and the first letter of label is the DB value
+* If a 3-element Array is passed in, [key, DB value, label] 
+* Any other type passed in throws an error
 
- Limitations: Don't use this if you will run reports directly against the DB 
+## Limitations: 
+ Don't use this if you will run reports directly against the DB 
  In that case, the reports will not have access to the display labels
 
+ 
+    class Article < ActiveRecord::Base
+            selection_options_for :file_type_option,
+               [:pdf,    'PDF'],
+               [:html,   'HTML'],
+               [:msword, 'MS-Word']
+               [:text,   'X', 'Textfile']
+    end
+    
 
-class Article < ActiveRecord::Base
-        selection_options_for :file_type_option,
-           [:pdf,    'PDF'],
-           [:html,   'HTML'],
-           [:msword, 'MS-Word']
-           [:text,   'X', 'Textfile']
-end
-
-adds the following CLASS METHODS to Article
+### adds the following CLASS METHODS to Article
 
 * file_type_options
   returns a array of 2-value arrays suitable to fill a select tag
   The second example shows how to start the selection on a blank
-$  <%= select :article, :file_type_option, Article.file_type_options %>
-$  <%= select :article, :file_type_option,  [['','']] + Article.file_type_options %>
-
-$  assert_equal  ["MS-Word", "PDF", "HTML"],   Article.file_type_option_hash.values
-$  assert_equal "['MS-Word', 'PDF', 'HTML']",  Article.file_type_option_js_list
- 
-$ file_type_option_symbols
-  returns hash of symbols
+    
+     <%= select :article, :file_type_option, Article.file_type_options %>
+     <%= select :article, :file_type_option,  [['','']] + Article.file_type_options %>
+    
+     assert_equal  ["MS-Word", "PDF", "HTML"],   Article.file_type_option_hash.values
+     assert_equal "['MS-Word', 'PDF', 'HTML']",  Article.file_type_option_js_list
+    
+    file_type_option_symbols  #  returns hash of symbols
 
 adds the following INSTANCE METHODS to Article
 
-$ file_type_option_hash
-$ file_type_option
-  returns the single character value as in the db
-
-$ file_type_option_label
-  returns the current values label
+    file_type_option_hash
+    file_type_option #  returns the single character value as in the db    
+    file_type_option_label  # returns the current values label    
+    file_type_option_symbol  # returns the current values symbol
 
-$ file_type_option_symbol
-  returns the current values symbol
-
-methods ending in '?' return boolean if the value is set
-methods ending in '!' set the value
-  
-$ file_type_option_pdf?  
-$ file_type_option_pdf! 
-
-$ file_type_option_html?
-$ file_type_option_html!
-
-$ file_type_option_msword?
-$ file_type_option_msword!
-
-example #1: Selection list
-
-  article = Article.new
-  article.file_type_option_pdf!
-  assert_equal 'P',   article.file_type_option
-  assert_equal :pdf,  article.file_type_symbol
-  assert_equal true,  article.file_type_option_pdf?
-  assert_equal 'PDF', article.file_type_option_label
-  assert_equal [["MS-Word", "M"], ["PDF", "P"], ["HTML", "H"]], 
-               Article.file_type_options
-  assert_equal({"M"=>"MS-Word", "P"=>"PDF", "H"=>"HTML"}, 
-               Article.file_type_option_hash) 
+* methods ending in '?' return boolean if the value is set
+* methods ending in '!' set the value
   
-  assert_equals({'P'=>:pdf, 'H'=>:html, 'W'=>:msword, 'T'=>:text},
-                Article.file_type_option_symbols) 
-
-By default the first letter of the label is used as the one character value 
+      
+    file_type_option_pdf?  
+    file_type_option_pdf! 
+    
+    file_type_option_html?
+    file_type_option_html!
+    
+    file_type_option_msword?
+    file_type_option_msword!
+
+### example #1: Selection list
+
+    article = Article.new
+    article.file_type_option_pdf!
+    assert_equal 'P',   article.file_type_option
+    assert_equal :pdf,  article.file_type_symbol
+    assert_equal true,  article.file_type_option_pdf?
+    assert_equal 'PDF', article.file_type_option_label
+    assert_equal [["MS-Word", "M"], ["PDF", "P"], ["HTML", "H"]], 
+                Article.file_type_options
+    assert_equal({"M"=>"MS-Word", "P"=>"PDF", "H"=>"HTML"}, 
+                   Article.file_type_option_hash) 
+      
+    assert_equals({'P'=>:pdf, 'H'=>:html, 'W'=>:msword, 'T'=>:text},
+                    Article.file_type_option_symbols) 
+    
+
+By default the value first letter of the label is used as the one character value 
 in the database field.  When there are duplicate first letters
 you can specify a different letter to be stored in the database
 In the example below 'R' is stored in the database when
 'Credit Card Account' is selected.
 
-Example #1: Selection list
+### Example #2: Selection list
 
-class Article < ActiveRecord::Base
- selection_options_for :payment_method_option,
-     [:basic,  'Basic'],
-     [:cash,   'Cash Account'],
-     [:cc, 'R','Credit Card Account']
-end
+    class Article < ActiveRecord::Base
+     selection_options_for :payment_method_option,
+         [:basic,  'Basic'],
+         [:cash,   'Cash Account'],
+         [:cc, 'R','Credit Card Account']
+    end
+    
 
-$ <%=  select :article, :payment_method_option, Article.payment_method_options %> 
 
-Example #2: Radio button labels
+    <%=  select :article, :payment_method_option, Article.payment_method_options %> 
+    
 
-$  <% Article.payment_method_option_hash.each do | key, value | %>
-$    <%=  radio_button :article, :payment_method_option, key %> <%= value %><br />
-$  <% end %>
+### Example #3: Radio button labels
 
-Example #3 in a java_script list
-    payment_method_option_js_list
+    <% Article.payment_method_option_hash.each do | key, value | %>
+        <%=  radio_button :article, :payment_method_option, key %> <%= value %><br />
+    <% end %>
+    
 
+### Example #4 in a java_script list
+
+    
+    payment_method_option_js_list
+    
 
 ## Contributing
 
@@ -133,3 +135,7 @@ Example #3 in a java_script list
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Thanks To
+* Scott Baron - for helping with the unit tests.

data/lib/selection_options_for/model_additions.rb

@@ -1,62 +1,62 @@
-module ModelAdditions
-
-  def selection_options_for(id, *opts)  # :nodoc:
-    id = id.to_s
-    id_hash = id + '_hash'
-    id_symbols = id + '_symbols'
-    class_eval <<-EOF
-      write_inheritable_attribute("#{id_hash}".to_sym, {})
-      write_inheritable_attribute("#{id_symbols}".to_sym, {})
-      def self.#{id_hash}()
-        read_inheritable_attribute("#{id_hash}".to_sym)
-      end
-      def self.#{id_symbols}()
-        read_inheritable_attribute("#{id_symbols}".to_sym)
-      end
-      def self.#{id}s   
-        #{id_hash}.map { |key, value| [value,key] }.sort
-      end
-      def #{id}_label
-        #{self}.#{id_hash}[#{id}]
-      end
-      def self.#{id}_js_list
-        result = '['
-        #{id_hash}.values.sort.each{ |e| result = result + "'"+ e + "', "}
-        result.chop!.chop! if result.size > 2
-        result + ']'
-      end
-      def #{id}_symbol
-        #{self}.#{id_symbols}[self.#{id}]
-      end
-    EOF
-    # load the labels into the class id_hash variable
-    opts.each do |label|
-      unless label.class == Array
-        raise "Invalid item ["+ label.to_s + "] in :" + id + " of type [" + label.class.to_s + "]. Expected Array"
-      end          
-      case label.size
-      when 2
-        letter, display_text = label[1].first,  label[1]
-      when 3
-        letter, display_text = label[1], label[2]
-      else
-        raise "Invalid number of items in selection_options_for :" + id + " ["   +
-               label.class.to_s + "]."
-      end
-      if(send(id_hash).has_key?(letter))
-        raise "Duplicate key during selection_options_for :" + id + ".  key: " + 
-               letter + ' for text: ' + display_text
-      end
-      send(id_hash)[letter] = display_text
-      send(id_symbols)[letter] = label[0]
-      module_eval <<-EOF2
-        def #{id}_#{label[0].to_s}?
-          self.#{id} == '#{letter}'
+module SelectionOptionsFor
+  module ModelAdditions
+  
+    def selection_options_for(id, *opts)  # :nodoc:
+      id = id.to_s
+      id_hash = id + '_hash'
+      id_symbols = id + '_symbols'
+      class_eval <<-EOF
+        class_attribute "#{id_hash}".to_sym
+        send("#{id_hash}=".to_sym, {})
+        
+        class_attribute "#{id_symbols}".to_sym
+        send("#{id_symbols}=".to_sym, {})             
+        
+        def self.#{id}s   
+          #{id_hash}.map { |key, value| [value,key] }.sort
         end
-        def #{id}_#{label[0].to_s}!
-          self.#{id} = '#{letter}'
+        def #{id}_label
+          #{self}.#{id_hash}[#{id}]
         end
-      EOF2
-    end # opts.each
-  end # selection_options_for
-end 
+        def self.#{id}_js_list
+          result = '['
+          #{id_hash}.values.sort.each{ |e| result = result + "'"+ e + "', "}
+          result.chop!.chop! if result.size > 2
+          result + ']'
+        end
+        def #{id}_symbol
+          #{self}.#{id_symbols}[self.#{id}]
+        end
+      EOF
+      # load the labels into the class id_hash variable
+      opts.each do |label|
+        unless label.class == Array
+          raise "Invalid item ["+ label.to_s + "] in :" + id + " of type [" + label.class.to_s + "]. Expected Array"
+        end          
+        case label.size
+        when 2
+          letter, display_text = label[1].first,  label[1]
+        when 3
+          letter, display_text = label[1], label[2]
+        else
+          raise "Invalid number of items in selection_options_for :" + id + " ["   +
+                 label.class.to_s + "]."
+        end
+        if(send(id_hash).has_key?(letter))
+          raise "Duplicate key during selection_options_for :" + id + ".  key: " + 
+                 letter + ' for text: ' + display_text
+        end
+        send(id_hash)[letter] = display_text
+        send(id_symbols)[letter] = label[0]
+        module_eval <<-EOF2
+          def #{id}_#{label[0].to_s}?
+            self.#{id} == '#{letter}'
+          end
+          def #{id}_#{label[0].to_s}!
+            self.#{id} = '#{letter}'
+          end
+        EOF2
+      end # opts.each
+    end # selection_options_for
+  end  # ModelAdditions
+end # SelectionOptionsFor

data/lib/selection_options_for/version.rb

@@ -1,3 +1,3 @@
 module SelectionOptionsFor
-  VERSION = "0.0.5"  unless defined? SelectionOptionsFor::VERSION
+  VERSION = "0.0.6"  unless defined? SelectionOptionsFor::VERSION
 end

data/selection_options_for.gemspec

@@ -26,4 +26,8 @@ Gem::Specification.new do |gem|
   gem.name          = "selection_options_for"
   gem.require_paths = ["lib"]
   gem.version       = SelectionOptionsFor::VERSION
+  
+  gem.add_development_dependency "supermodel"
+  gem.add_runtime_dependency     "activerecord"
 end
+

data/test/selection_options_for_ex_test.rb

@@ -5,13 +5,8 @@ require 'test_helper'
 # test bad data and exceptions
 #
 
-class ModelUnderTest < ActiveRecord::Base
-  def self.columns() @columns ||= []; end
-  def self.column(name, sql_type = nil, default = nil, null = true)
-    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
-  end
-
-  column :price_option,             :string
+class ModelUnderTest < SuperModel::Base
+  extend ModelAdditions
     
   begin  
     selection_options_for :price_option,

data/test/selection_options_for_test.rb

@@ -9,22 +9,13 @@ require 'test_helper'
 # 3. SubClassOfModel -- should have it's own copy of class variables
 #
 
-class SiblingOfModelUnderTest < ActiveRecord::Base
-  def self.columns() @columns ||= []; end
-  def self.column(name, sql_type = nil, default = nil, null = true)
-    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
-  end
+class SiblingOfModelUnderTest < SuperModel::Base
+  extend ModelAdditions
 end
 
-class ModelUnderTest < ActiveRecord::Base
-  def self.columns() @columns ||= []; end
-  def self.column(name, sql_type = nil, default = nil, null = true)
-    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
-  end
-
-  column :status_option,            :string
-  column :payment_method_option,    :string
-    
+class ModelUnderTest < SuperModel::Base
+  extend ModelAdditions
+      
   selection_options_for :status_option,
             [:partial,             'Partial Registration'],
             [:active,              'Active'],
@@ -94,7 +85,7 @@ class SelectionOptionsForTest < Test::Unit::TestCase
     assert !target.status_option_partial?
   end
 
-  def test_sibling_of_target_not_effected_by_calss_methods
+  def test_sibling_of_target_not_effected_by_class_methods
       SiblingOfModelUnderTest.payment_method_options
       flunk "Should throw Exception" 
       rescue NoMethodError => ex
@@ -103,16 +94,6 @@ class SelectionOptionsForTest < Test::Unit::TestCase
         flunk "wrong exception thrown"
   end
 
-  def test_sibling_of_target_not_effected_by_instance_methods
-      sib = SiblingOfModelUnderTest.new
-      sib.status_option_partial?
-      flunk "Should throw Exception" 
-      rescue NoMethodError => ex
-         assert true
-      rescue
-        flunk "wrong exception thrown"
-  end
-
   def test_each_subclass_has_own_symbols
     
     assert_equal [["Advanced", "Advanced"], ["ECash Account", "ECash Account"]].sort ,

data/test/test_helper.rb

@@ -1,4 +1,4 @@
 require 'rubygems'
 require 'test/unit'
-require 'active_record'
+require 'supermodel'
 require File.dirname(__FILE__) +  '/../lib/selection_options_for'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: selection_options_for
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Mark Windholtz
@@ -15,9 +15,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-09 00:00:00 Z
-dependencies: []
-
+date: 2012-03-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: supermodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: "\n   This code allows you to keep the display labels in the model \n   when the DB holds only a 1 character flag.\n   and when the code requires symbolic references to the value to use in algorithms\n   \n   element 0 of the array passed in is always the logical symbol\n   If a 2-element Array is passed in, [key, label] and the first letter of label is the DB value\n   If a 3-element Array is passed in, [key, DB value, label] \n   Any other type passed in throws an error\n   \n   Limitations: Don't use this if you will run reports directly against the DB \n   In that case, the reports will not have access to the display labels    \n  "
 email: 
 - mark@agiledna.com
@@ -38,6 +65,7 @@ files:
 - lib/selection_options_for/model_additions.rb
 - lib/selection_options_for/railtie.rb
 - lib/selection_options_for/version.rb
+- pkg/selection_options_for-0.0.5.gem
 - selection_options_for.gemspec
 - test/selection_options_for_ex_test.rb
 - test/selection_options_for_test.rb