selection_options_for 0.0.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.5
+
+* initial release as a rubygem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in selection_options_for.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2006 Mark Windholtz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,135 @@
+# SelectionOptionsFor
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'selection_options_for'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install selection_options_for
+
+## Usage
+
+
+SelectionOptionsFor
+===================
+
+ 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
+
+ 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
+
+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
+
+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_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) 
+  
+  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 
+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
+
+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
+
+$  <% Article.payment_method_option_hash.each do | key, value | %>
+$    <%=  radio_button :article, :payment_method_option, key %> <%= value %><br />
+$  <% end %>
+
+Example #3 in a java_script list
+    payment_method_option_js_list
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/selection_options_for.rb

@@ -0,0 +1,7 @@
+require "selection_options_for/version"
+require "selection_options_for/model_additions"
+require "selection_options_for/railtie" if defined? Rails
+
+module SelectionOptionsFor # :nodoc:
+end
+

data/lib/selection_options_for/model_additions.rb

@@ -0,0 +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}'
+        end
+        def #{id}_#{label[0].to_s}!
+          self.#{id} = '#{letter}'
+        end
+      EOF2
+    end # opts.each
+  end # selection_options_for
+end 

data/lib/selection_options_for/railtie.rb

@@ -0,0 +1,9 @@
+module SelectionOptionsFor  
+  class Railtie < Rails::Railtie
+    initializer "selection_options_for.model_additions" do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end    
+    end # initializer  
+  end # class 
+end # module

data/lib/selection_options_for/version.rb

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

data/selection_options_for.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/selection_options_for/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Windholtz"]
+  gem.email         = ["mark@agiledna.com"]
+  gem.summary       = %q{Display labels and symbolic references }
+  gem.description   = %q{
+   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
+   
+   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    
+  }
+  gem.homepage      = "https://github.com/mwindholtz/selection_options_for"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "selection_options_for"
+  gem.require_paths = ["lib"]
+  gem.version       = SelectionOptionsFor::VERSION
+end

data/test/selection_options_for_ex_test.rb

@@ -0,0 +1,66 @@
+## ruby -Itest test/selection_options_for_ex_test.rb
+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
+    
+  begin  
+    selection_options_for :price_option,
+            [:basic,  'Basic' ],
+            [:cash,   'Cash Account '],
+            [:cc, 'R','Credit Card Account'],
+            123            
+            
+  rescue RuntimeError => ex
+    @@exception_num = ex
+  end
+
+   def self.exception_num
+     @@exception_num
+   end
+
+  begin  
+    selection_options_for :status_option,
+            [:basic,  'Basic' ],
+            'Cash Account',
+            [:cc, 'R','Credit Card Account']
+            
+  rescue RuntimeError => ex
+    @@exception_string = ex
+  end
+
+   def self.exception_string
+     @@exception_string
+   end
+
+
+end
+
+class TranslateOptionsForExTest < Test::Unit::TestCase
+  def setup
+    @model  = ModelUnderTest
+  end
+
+  def test_invalid_num
+    assert_equal RuntimeError, ModelUnderTest.exception_num.class
+    assert_equal "Invalid item [123] in :price_option of type [Fixnum]. Expected Array",
+                  ModelUnderTest.exception_num.message
+  end
+
+  def test_invalid_string
+    assert_equal RuntimeError, ModelUnderTest.exception_string.class
+    assert_equal "Invalid item [Cash Account] in :status_option of type [String]. Expected Array",
+                  ModelUnderTest.exception_string.message
+  end
+
+
+end

data/test/selection_options_for_test.rb

@@ -0,0 +1,167 @@
+## ruby -Itest test/selection_options_for_test.rb
+require 'test_helper'
+
+#
+# setup three classes for these tests
+#
+# 1. ModelUnderTest  -- declare selection_options_for to be tested
+# 2. SiblingOfModelUnderTest -- make sure that no meta-level leaks occur
+# 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
+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
+    
+  selection_options_for :status_option,
+            [:partial,             'Partial Registration'],
+            [:active,              'Active'],
+            [:changing_email, 'E', 'Active, Changing Email'],  
+            [:inactive,            'Inactive'],
+            [:forgot_pw,      'F', 'Active, Forgot Password' ]
+
+  selection_options_for :payment_method_option,
+            [:basic,    'Basic'],
+            [:cash,     'Cash Account'],
+            [:cc,   'R','Credit Card Account']
+            
+  selection_options_for :sorted_option,
+            [:none,         'H', 'Honorary Member'],
+            [:member,       'M', 'CSM - Certified ScrumMaster'],
+            [:pract,        'P', 'CSP - Certified Scrum Practitioner'],
+            [:cst,      'T', 'CST - Certified Scrum Trainer'],
+            [:icst, 'I', 'ICST - Certified Scrum Trainer (inactive)']
+            
+ end
+
+class SubClassOfModel < ModelUnderTest
+  selection_options_for :payment_method_option,
+            [:advanced, 'Advanced'],
+            [:ecash,    'ECash Account']
+end
+
+class SelectionOptionsForTest < Test::Unit::TestCase
+  def setup
+    @model  = ModelUnderTest
+  end  
+
+  def test_should_provide_symbols
+    expected = {"Basic"=>:basic, "Cash Account"=>:cash, "R"=>:cc}
+    assert_equal expected, ModelUnderTest.payment_method_option_symbols
+  end
+
+  def test_should_provide_symbol
+    target =  @model.new
+    target.status_option_forgot_pw!
+    assert_equal :forgot_pw, @model.status_option_symbols[target.status_option]
+    assert_equal :forgot_pw, target.status_option_symbol
+  end
+  
+  def test_symbol_generation
+    target =  @model.new
+    # forget PW
+    target.status_option_forgot_pw!
+    assert target.status_option_forgot_pw?
+    assert !target.status_option_active?
+    assert !target.status_option_changing_email?
+    assert !target.status_option_inactive?
+    assert !target.status_option_partial?
+    # active
+    target.status_option_active!
+    assert !target.status_option_forgot_pw?
+    assert target.status_option_active?
+    assert !target.status_option_changing_email?
+    assert !target.status_option_inactive?
+    assert !target.status_option_partial?
+    # active
+    target.status_option_inactive!
+    assert !target.status_option_forgot_pw?
+    assert !target.status_option_active?
+    assert !target.status_option_changing_email?
+    assert target.status_option_inactive?
+    assert !target.status_option_partial?
+  end
+
+  def test_sibling_of_target_not_effected_by_calss_methods
+      SiblingOfModelUnderTest.payment_method_options
+      flunk "Should throw Exception" 
+      rescue NoMethodError => ex
+         assert true
+      rescue
+        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 ,
+                  SubClassOfModel.payment_method_options.sort 
+  end
+
+  def test_payment_method_option_array
+    
+    assert_equal [["Basic", "Basic"],
+                  ["Cash Account", "Cash Account"],
+                  ["Credit Card Account", "R"]].sort ,  
+                @model.payment_method_options.sort 
+  end
+
+  def test_default_status
+    target =  @model.new
+    target.status_option_forgot_pw!
+    assert_equal 'Active, Forgot Password', target.status_option_label
+    target.status_option = 'Active'
+    assert_equal 'Active', target.status_option_label
+  end
+
+  def test_status_option_array
+    
+    assert_equal [["Active", "Active"],
+     ["Active, Changing Email", "E"],
+     ["Active, Forgot Password", "F"],
+     ["Inactive", "Inactive"],
+     ["Partial Registration", "Partial Registration"]].sort ,  
+     @model.status_options.sort    
+  end
+
+  def test_default_payment_method_option_hash
+    expected = {"Cash Account"=>"Cash Account", "R"=>"Credit Card Account", "Basic"=>"Basic"}
+    assert_equal expected, @model.payment_method_option_hash
+  end
+  
+  def test_status_option_js_list
+    assert_equal "['Active', 'Active, Changing Email', 'Active, Forgot Password', 'Inactive', 'Partial Registration']",
+                 @model.status_option_js_list
+  end
+  
+  def test_sorted_option_array
+    assert_equal [["CSM - Certified ScrumMaster", "M"],
+                  ["CSP - Certified Scrum Practitioner", "P"],
+                  ["CST - Certified Scrum Trainer", "T"],
+                  ["Honorary Member", "H"],
+                  ["ICST - Certified Scrum Trainer (inactive)", "I"]] ,  
+                  @model.sorted_options 
+  end 
+  
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: selection_options_for
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Mark Windholtz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-09 00:00:00 Z
+dependencies: []
+
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .DS_Store
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/selection_options_for.rb
+- lib/selection_options_for/model_additions.rb
+- lib/selection_options_for/railtie.rb
+- lib/selection_options_for/version.rb
+- selection_options_for.gemspec
+- test/selection_options_for_ex_test.rb
+- test/selection_options_for_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mwindholtz/selection_options_for
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Display labels and symbolic references
+test_files: 
+- test/selection_options_for_ex_test.rb
+- test/selection_options_for_test.rb
+- test/test_helper.rb
+has_rdoc: