enumerated_field 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby
+  - ruby-head
+  - rbx-2.0
+notifications:
+  # overriding this so billing@teamsporttech.com (who owns the repo) doesn't get spammed
+  # anyone, feel free to add yourselves
+  email:
+    - patrick.byrne@tstmedia.com
+    - jon.karna@tstmedia.com

data/README.md

@@ -1,4 +1,9 @@
-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.
+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.
 
 ## Usage
 
@@ -13,8 +18,8 @@ Available options are:
 * `:allow_blank`, whether a blank (nil, "") value passes validation.
   Defaults to false.
 
-The default validation uses ActiveModel's inclusion validations. If using on a
-class without ActiveModel use `:validate => false` to disable
+The default validation uses ActiveModel's inclusion validations. If
+using on a class without ActiveModel use `:validate => false` to disable
 these.
 
 ## Example
@@ -82,7 +87,9 @@ these.
     > Hike::TRAIL_SHT
     => :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.
+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.
 
 ## TESTS
 
@@ -92,3 +99,4 @@ daring).
 ## TODO
 
 * Provide any support needed for defining columns on MySQL databases as enum columns instead of string columns.
+

data/Rakefile

@@ -8,3 +8,5 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
   # test.warning = true
 end
+
+task :default => :test

data/enumerated_field.gemspec

@@ -2,12 +2,18 @@
 $:.push File.expand_path("../lib", __FILE__)
 require "enumerated_field/version"
 
+AUTHORS = {
+  "Luke Ludwig" => "luke.ludwig@tstmedia.com",
+  "Patrick Byrne" => "patrick.byrne@tstmedia.com",
+  "Jon Karna" => "jon.karna@tstmedia.com",
+}
+
 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.authors     = AUTHORS.keys
+  s.email       = AUTHORS.values
   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.}
@@ -19,10 +25,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('activemodel')
-
+  s.add_dependency 'activemodel'
+  s.add_dependency 'activesupport'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'turn'
   s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3'
 end

data/lib/enumerated_field.rb

@@ -25,7 +25,7 @@ module EnumeratedField
       # returns the values_array for this field, useful for providing to
       # options_for_select when constructing forms
       enumerated_class = class << self; self; end
-      enumerated_class.instance_eval do
+      enumerated_class.class_eval do
         define_method("#{field_name}_values") do |*options|
           options = options.first || {}
           if options[:first_option]
@@ -81,6 +81,12 @@ module EnumeratedField
           define_method("#{field_name}_#{key}?") { send(field_name).to_s == key.to_s }
         end
 
+        if defined? ActiveRecord::Base and ancestors.include? ActiveRecord::Base
+          values_hash.keys.each do |key|
+            scope "#{field_name}_#{key}", where(field_name => key)
+          end
+        end
+
       end
     end
 

data/lib/enumerated_field/version.rb

@@ -1,3 +1,3 @@
 module EnumeratedField
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/enumerated_field_test.rb

@@ -1,43 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class Apple
-  include EnumeratedField
-
-  attr_accessor :color, :kind
-  
-  enum_field :color, [['Red', :red], ['Green', :green]], :validate => false
-  enum_field :kind, [['Fuji Apple', :fuji], ['Delicious Red Apple', :delicious]], :validate => false
-
-  def initialize(color, kind)
-    self.color = color
-    self.kind = kind
-  end
-
-end
-
-class Banana
-  include EnumeratedField
-  include ActiveModel::Validations
-
-  attr_accessor :brand
-  attr_accessor :color
-  attr_accessor :tastiness
-
-  enum_field :brand, [["Chiquita", :chiquita], ["Del Monte", :delmonte]]
-  enum_field :color, [["Awesome Yellow", :yellow], ["Icky Green", :green]], :allow_nil => true
-  # stressing the constantizing of the keys
-  enum_field :tastiness, [
-    ["Great", "great!"],
-    ["Good", "it's good"],
-    ["Bad", "hate-hate"],
-  ], :validate => false
-
-  def initialize(brand, color)
-    self.brand = brand
-    self.color = color
-  end
-end
-
 class EnumeratedFieldTest < Test::Unit::TestCase
 
   context 'EnumeratedField class' do
@@ -64,13 +26,14 @@ class EnumeratedFieldTest < Test::Unit::TestCase
       assert_equal "it's good", Banana::TASTINESS_IT_S_GOOD
       assert_equal "hate-hate", Banana::TASTINESS_HATE_HATE
     end
+
   end
 
   context 'EnumeratedField instance' do
 
     setup do
-      @red_apple = Apple.new(:red, :fuji)
-      @green_apple = Apple.new(:green, :delicious)
+      @red_apple = Apple.new(:color => :red, :kind => :fuji)
+      @green_apple = Apple.new(:color => :green, :kind => :delicious)
     end
 
     should 'have color_display method' do
@@ -125,13 +88,38 @@ class EnumeratedFieldTest < Test::Unit::TestCase
 
     should 'not occur if passed :validate => false' do
       # no validations, accepts any choice
-      apple = Apple.new(:orange, :macintosh)
+      apple = Apple.new(:color => :orange, :kind => :macintosh)
       assert !apple.respond_to?(:valid)
     end
 
     should 'accept valid string equivalent to symbol in list' do
       banana = Banana.new('chiquita', :green)
-      assert banana.valid?, banana.errors[:brand][0]
+      assert banana.valid?, banana.errors[:brand][0].to_s
+    end
+  end
+
+  context 'ActiveRecord' do
+    context 'instance' do
+      subject { Apple.new }
+
+      should have_db_column :color
+      should have_db_column :kind
+    end
+
+    context 'class' do
+      subject { Apple }
+
+      should 'have scopes for each enumerated value' do
+        assert_equal 4, subject.count
+        ['color', 'kind'].each do |column|
+          subject.send("#{column}_values").each do |a,b|
+            assert subject.respond_to? "#{column}_#{b}"
+            assert subject.send("#{column}_#{b}").any?
+            assert_equal 2, subject.send("#{column}_#{b}").size
+          end
+        end
+      end
     end
   end
+
 end

data/test/fixtures/apples.yml

@@ -0,0 +1,12 @@
+green_fuji:
+  color: green
+  kind: fuji
+red_delicious:
+  color: red
+  kind: delicious
+green_delicious:
+  color: green
+  kind: delicious
+red_fuji:
+  color: red
+  kind: fuji

data/test/test_helper.rb

@@ -1,4 +1,49 @@
 require 'test/unit'
 require 'turn'
+require 'active_record'
+require 'active_record/fixtures'
+require 'yaml'
+require 'sqlite3'
+require 'enumerated_field'
 require 'shoulda'
-require 'lib/enumerated_field'
+require 'shoulda/active_record'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Schema.define do
+  create_table :apples, :force => true do |t|
+    t.string :color
+    t.string :kind
+  end
+end
+
+class Apple < ActiveRecord::Base
+  include EnumeratedField
+
+  enum_field :color, [['Red', :red], ['Green', :green]], :validate => false
+  enum_field :kind, [['Fuji Apple', :fuji], ['Delicious Red Apple', :delicious]], :validate => false
+end
+
+class Banana
+  include EnumeratedField
+  include ActiveModel::Validations
+
+  attr_accessor :brand
+  attr_accessor :color
+  attr_accessor :tastiness
+
+  enum_field :brand, [["Chiquita", :chiquita], ["Del Monte", :delmonte]]
+  enum_field :color, [["Awesome Yellow", :yellow], ["Icky Green", :green]], :allow_nil => true
+  # stressing the constantizing of the keys
+  enum_field :tastiness, [
+    ["Great", "great!"],
+    ["Good", "it's good"],
+    ["Bad", "hate-hate"],
+  ], :validate => false
+
+  def initialize(brand, color)
+    self.brand = brand
+    self.color = color
+  end
+end
+
+Fixtures.create_fixtures 'test/fixtures', :apples

metadata

@@ -1,104 +1,120 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: enumerated_field
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Luke Ludwig
+- Patrick Byrne
+- Jon Karna
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-27 00:00:00 -05:00
+date: 2011-08-30 00:00:00.000000000 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activemodel
+  requirement: &2157839460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2157839460
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2157838800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157838800
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: &2157838060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *2157838060
+- !ruby/object:Gem::Dependency
   name: bundler
+  requirement: &2157837460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *2157837460
+- !ruby/object:Gem::Dependency
   name: turn
+  requirement: &2157836860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *2157836860
+- !ruby/object:Gem::Dependency
   name: shoulda
+  requirement: &2157836200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157836200
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2157835540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157835540
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157834860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  requirement: *id005
-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: 
+  version_requirements: *2157834860
+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
+- patrick.byrne@tstmedia.com
+- jon.karna@tstmedia.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -106,41 +122,41 @@ files:
 - lib/enumerated_field.rb
 - lib/enumerated_field/version.rb
 - test/enumerated_field_test.rb
+- test/fixtures/apples.yml
 - test/test_helper.rb
 has_rdoc: true
 homepage: https://github.com/tstmedia/enumerated_field
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1613582628289302536
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1613582628289302536
 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: 
+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/fixtures/apples.yml
 - test/test_helper.rb