enumerated_field 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README

@@ -0,0 +1,37 @@
+EnumeratedField is a library that provides some nice methods when a string column is used like an enumeration, meaning there is a list of allowable values for the string column. Typically you want the display value as seen by the end user to differ from the stored value, allowing you to easily change the display value at anytime without migrating data, and this little gem helps you with that.
+
+Example Usage:
+This example demonstrates usage within an ActiveRecord::Base object, however this gem does not depend on ActiveRecord.
+
+class Hike < ActiveRecord::Base
+   
+  include EnumeratedField
+  
+  enum_field :trail, [['Pacific Crest Trail', 'pct'],
+                      ['Continental Divide Trail', 'cdt'],
+                      ['Superior Hiking Trail', 'sht']]
+
+end
+
+> hike = Hike.create(:trail => 'pct')
+
+> hike.trail_sht?
+=> false
+
+> hike.trail_pct?
+=> true
+
+> hike.trail_display
+=> "Pacific Crest Trail"
+
+> hike.trail_values   # useful to provide to options_for_select when constructing forms
+=> [['Pacific Crest Trail', 'pct'], ['Continental Divide Trail', 'cdt'], ['Superior Hiking Trail', 'sht']]
+
+
+These methods are all prefixed with the field name by design, which allows multiple fields on a model to exist which potentially have the same values.
+
+Run tests by:  ruby test/enumerated_field_test.rb
+
+TODO:
+* Provide option to enum_field to setup validation methods that validate the value of the field against the allowed values.
+* Provide any support needed for defining columns on MySQL databases as enum columns instead of string columns.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/enumerated_field.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "enumerated_field/version"
+
+Gem::Specification.new do |s|
+  s.name        = "enumerated_field"
+  s.version     = EnumeratedField::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luke Ludwig"]
+  s.email       = ["luke.ludwig@tstmedia.com"]
+  s.homepage    = "https://github.com/tstmedia/enumerated_field"
+  s.summary     = %q{EnumeratedField is a library that provides some nice methods when a string column is used like an enumeration.}
+  s.description = %q{EnumeratedField is a library that provides some nice methods when a string column is used like an enumeration, meaning there is a list of allowable values for the string column.}
+
+  s.rubyforge_project = "enumerated_field"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/enumerated_field.rb

@@ -0,0 +1,56 @@
+module EnumeratedField
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    # ex. enum_field(:league, [['National Football League', :nfl], ['Major League Baseball', :mlb]])
+    # field_name typically corresponds to the database column name
+    # values_array is a double array (not a hash to preserve order for when order matters.. ie select options)    
+    def enum_field(field_name, values_array)
+      values_hash = {}
+      values_array.each { |value, key| values_hash[key] = value }
+      
+      class_eval do
+
+        # returns the values_array for this field, useful for providing to 
+        # options_for_select when constructing forms
+        define_method("#{field_name}_values") do |*options|
+          options = options.first || {}
+          if options[:first_option]
+            [[options[:first_option], '']] + values_array
+          else
+            values_array
+          end
+        end
+
+        # returns display value for the current value of the field
+        define_method("#{field_name}_display") do
+          values_hash[send(field_name)]
+        end
+
+        # returns display value for the given value of the field
+        define_method("#{field_name}_display_for") do |key|
+          values_hash[key]
+        end
+        
+        define_method("#{field_name}_value_for") do |key|
+          values_hash.invert[key]
+        end
+
+        # defines question methods for each possible value of the field
+        # ex.  object.league_nfl?  which returns true if the objects league 
+        # field is currently set to nfl otherwise false
+        values_hash.keys.each do |key|
+          define_method("#{field_name}_#{key}?") { send(field_name) == key }
+        end
+
+      end
+    end
+
+  end
+  
+end
+

data/lib/enumerated_field/version.rb

@@ -0,0 +1,3 @@
+module EnumeratedField
+  VERSION = "0.0.1"
+end

data/test/enumerated_field_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Apple
+  include EnumeratedField
+
+  attr_accessor :color, :kind
+  
+  enum_field :color, [['Red', :red], ['Green', :green]]
+  enum_field :kind, [['Fuji Apple', :fuji], ['Delicious Red Apple', :delicious]]
+
+  def initialize(color, kind)
+    self.color = color
+    self.kind = kind
+  end
+  
+end
+
+class EnumeratedFieldTest < Test::Unit::TestCase
+
+  def test_color_display
+    apple = Apple.new(:red, :fuji)
+    assert apple.color_display, 'Red'
+  end
+
+  def test_color_display_for
+    apple = Apple.new(:red, :fuji)
+    assert apple.color_display_for(:green), 'Green'    
+  end
+
+  def test_two_enum_fields_in_one_class
+    apple = Apple.new(:green, :delicious)
+    assert apple.color_display, 'Green'
+    assert apple.kind_display, 'Delicious Red Apple'
+  end
+
+  def test_question_methods
+    apple = Apple.new(:green, :delicious)
+    assert apple.color_green?
+    assert !apple.color_red?
+    assert apple.kind_delicious?
+    assert !apple.kind_fuji?
+  end
+
+  def test_values_without_first_option
+    apple = Apple.new(:red, :fuji)
+    assert apple.color_values.length, 2
+  end
+
+  def test_values_with_first_option
+    apple = Apple.new(:red, :fuji)
+    assert apple.color_values(:first_option => "Select Color").length, 3
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "test/unit"
+require "lib/enumerated_field"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: enumerated_field
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Luke Ludwig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: EnumeratedField is a library that provides some nice methods when a string column is used like an enumeration, meaning there is a list of allowable values for the string column.
+email: 
+- luke.ludwig@tstmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- enumerated_field.gemspec
+- lib/enumerated_field.rb
+- lib/enumerated_field/version.rb
+- test/enumerated_field_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/tstmedia/enumerated_field
+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: enumerated_field
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: EnumeratedField is a library that provides some nice methods when a string column is used like an enumeration.
+test_files: 
+- test/enumerated_field_test.rb
+- test/test_helper.rb