has_enumeration 0.2.0 → 0.2.1

data/Gemfile

@@ -1,5 +1,19 @@
 source 'http://rubygems.org'
 
-gem 'activerecord', '>= 3.0.0.rc'
+if  ENV['AR_VERSION'] == '2.3'
+  gem 'activerecord', '2.3.8'
+else
+  gem 'activerecord', '>= 3.0.0.rc'
+end
+
 gem 'rspec', '>= 2.0.0.beta.19'
 gem 'cucumber', '>= 0.8.5'
+
+platforms :ruby do
+  gem 'sqlite3-ruby', :require => 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'jdbc-sqlite3'
+  gem 'activerecord-jdbcsqlite3-adapter', '>= 0.9.7'
+end

data/README.txt

@@ -23,17 +23,25 @@ obj.color.green?                   # => false
 # Querying
 TestObject.where(:color => :red)
 
-# Querying with arel predicates
+# Querying with arel predicates (ActiveRecord 3 only)
 attr = TestObject.arel_table[:color]
 TestObject.where(attr.not_in([:red, :green]))
 
+== Installation
+gem install has_enumeration
+
 == Getting the Latest Version
 The repository for has_enumeration is hosted at GitHub:
   Web page:   http://github.com/gregspurrier/has_enumeration
   Clone URL:  git://github.com/gregspurrier/has_enumeration.git
 
 == Supported Versions
-has_enumeration has been tested with:
-  - ActiveRecord 3.0.0rc
-  - Ruby 1.8.7-p299
-  - Ruby 1.9.2-head (revision 28788)
+has_enumeration has been tested with all combinations for the following:
+
+  Rubies:
+    - 1.8.7-p302
+    - 1.9.2-p0
+    - JRuby 1.5.1
+  ActiveRecord:
+    - 2.3.8
+    - 3.0.0.rc

data/Rakefile

@@ -1,17 +1,70 @@
-require 'jeweler'
-
-Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "has_enumeration"
-  gemspec.summary = "Support for symbol-based enumerations in ActiveRecord"
-  gemspec.description = <<-EOF
-    Extends ActiveRecord with the has_enumeration method that allows an
-    attribute to be declared as storing an enumeration.  The enumeration
-    is specified as a mapping between symbols and their underlying
-    representation in the database.  Predicates are provided for each
-    symbol in the enumeration and the symbols may be used in finder methods.
-  EOF
-  gemspec.email = "greg@rujubu.com"
-  gemspec.homepage = "http://github.com/gregspurrier/has_enumeration"
-  gemspec.author = "Greg Spurrier"
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "has_enumeration"
+    gemspec.summary = "Support for symbol-based enumerations in ActiveRecord"
+    gemspec.description = <<-EOF
+Extends ActiveRecord with the has_enumeration method allowing a symbolic
+enumeration to be stored in an ActiveRecord attribute.  The enumeration is
+specified as a mapping between symbols and their underlying representation
+in the database.  Predicates are provided for each symbol in the enumeration
+and the symbols may be used in finder methods.  For example:
+
+  class TrafficLight < ActiveRecord::Base
+    # Implicit mapping when the attribute is a string storing the string
+    # version of the symbol:
+    has_enumeration :color, [:red, :yellow, :green]
+
+    # Explicit mappings between symbols and underlying values are also
+    # supported.  E.g.:
+    #   has_enumeration :color, :red => 1, :yellow => 2, :green => 3
+  end
+
+  tl = TrafficLight.new
+  tl.color = :red
+  tl.color.value          # ==>  :red
+  tl.color.red?           # ==>  true
+  tl.color.yellow?        # ==>  false
+
+  TrafficLight.all(:conditions => {:color => :red}) # ==> all red traffic lights
+
+When using ActiveRecord 3, the symbolic values can also be used when interacting
+with the underlying Arel attributes for a model:
+
+  attr = TrafficLight.arel_table[:color]
+  TrafficLight.where(attr.in([:yellow, :green]))  # ==> yellow or green lights
+
+has_enumeration has been tested with:
+
+  Rubies: Ruby 1.8.7, Ruby 1.9.2, and JRuby 1.5.1.
+  ActiveRecord: 2.3.8 and 3.0.0.rc
+    EOF
+    gemspec.email = "greg@rujubu.com"
+    gemspec.homepage = "http://github.com/gregspurrier/has_enumeration"
+    gemspec.author = "Greg Spurrier"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+task :features => 'features:all'
+namespace :features do
+  task :all => [:common, :rails3]
+
+  Cucumber::Rake::Task.new(:common) do |t|
+    features = %w(explicitly_mapped_enumeration implicitly_mapped_enumeration)
+    feature_files = features.map {|f| "features/#{f}.feature"}.join(' ')
+    t.cucumber_opts = feature_files
+  end
+
+  Cucumber::Rake::Task.new(:rails3) do |t|
+    features = %w(arel_attributes)
+    feature_files = features.map {|f| "features/#{f}.feature"}.join(' ')
+    t.cucumber_opts = feature_files
+  end
 end
-Jeweler::GemcutterTasks.new

data/TODO

@@ -0,0 +1,5 @@
+Prior to 1.0.0:
+- Raise exception when assigning an invalid value
+- meta_where interoperability (?)
+- rdoc documentation for has_enumeration 
+- Rake task to automate testing the supported Rubies and ActiveRecord versions

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/features/arel_attributes.feature

@@ -0,0 +1,20 @@
+Feature:
+
+  As a programmer using has_enumeration in Rails 3
+  I want to be able to refer to the enumeration symbolically when working with
+  the underlying arel attributes for a model
+  So that I can write pretty, concise code.
+
+
+  Scenario Outline: find objects with a specific enumerated value via arel
+    Given a model with an explicitly-mapped enumeration of red, green, and blue
+    And a set of objects with a variety of values for the enumeration
+    When I query for objects with the value <value> via arel
+    Then I should get all of the objects having that value
+    And I should not get any objects having other values
+
+    Scenarios: querying various values
+      | value  |
+      | :red   |
+      | :green |
+      | :blue  |

data/features/explicitly_mapped_enumeration.feature

@@ -49,16 +49,3 @@ Feature:
       | :red   |
       | :green |
       | :blue  |
-
-  Scenario Outline: find objects with a specific enumerated value via arel
-    Given a model with an explicitly-mapped enumeration of red, green, and blue
-    And a set of objects with a variety of values for the enumeration
-    When I query for objects with the value <value> via arel
-    Then I should get all of the objects having that value
-    And I should not get any objects having other values
-
-    Scenarios: querying various values
-      | value  |
-      | :red   |
-      | :green |
-      | :blue  |

data/features/implicitly_mapped_enumeration.feature

@@ -49,16 +49,3 @@ Feature:
       | :red   |
       | :green |
       | :blue  |
-
-  Scenario Outline: find objects with a specific enumerated value via arel
-    Given a model with an implicitly-mapped enumeration of red, green, and blue
-    And a set of objects with a variety of values for the enumeration
-    When I query for objects with the value <value> via arel
-    Then I should get all of the objects having that value
-    And I should not get any objects having other values
-
-    Scenarios: querying various values
-      | value  |
-      | :red   |
-      | :green |
-      | :blue  |

data/features/step_definitions/has_enumeration_steps.rb

@@ -46,7 +46,7 @@ end
 
 When /^I query for objects with the value :([a-z_]+)$/ do |value|
   @desired_color = value.to_sym
-  @results = @model_class.where(:color => @desired_color).order(:id)
+  @results = @model_class.all(:conditions => {:color => @desired_color}, :order => :id)
 end
 
 When /^I query for objects with the value :([a-z_]+) via arel$/ do |value|

data/features/support/env.rb

@@ -1,8 +1,13 @@
 $LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+
+ENV['AR_VERSION'] ||= '3_0'
+
+require 'rubygems'
+require 'bundler/setup'
 require 'has_enumeration'
 
 ActiveRecord::Base.establish_connection(
-  :adapter => 'sqlite3',
+  :adapter => defined?(JRUBY_VERSION) ? 'jdbcsqlite3': 'sqlite3',
   :database => File.expand_path('../database', __FILE__)
 )
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_enumeration
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Greg Spurrier
@@ -15,11 +15,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 -07:00
+date: 2010-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: "    Extends ActiveRecord with the has_enumeration method that allows an\n    attribute to be declared as storing an enumeration.  The enumeration\n    is specified as a mapping between symbols and their underlying\n    representation in the database.  Predicates are provided for each\n    symbol in the enumeration and the symbols may be used in finder methods.\n"
+description: |
+  Extends ActiveRecord with the has_enumeration method allowing a symbolic
+  enumeration to be stored in an ActiveRecord attribute.  The enumeration is
+  specified as a mapping between symbols and their underlying representation
+  in the database.  Predicates are provided for each symbol in the enumeration
+  and the symbols may be used in finder methods.  For example:
+  
+    class TrafficLight < ActiveRecord::Base
+      # Implicit mapping when the attribute is a string storing the string
+      # version of the symbol:
+      has_enumeration :color, [:red, :yellow, :green]
+  
+      # Explicit mappings between symbols and underlying values are also
+      # supported.  E.g.:
+      #   has_enumeration :color, :red => 1, :yellow => 2, :green => 3
+    end
+  
+    tl = TrafficLight.new
+    tl.color = :red
+    tl.color.value          # ==>  :red
+    tl.color.red?           # ==>  true
+    tl.color.yellow?        # ==>  false
+  
+    TrafficLight.all(:conditions => {:color => :red}) # ==> all red traffic lights
+  
+  When using ActiveRecord 3, the symbolic values can also be used when interacting
+  with the underlying Arel attributes for a model:
+  
+    attr = TrafficLight.arel_table[:color]
+    TrafficLight.where(attr.in([:yellow, :green]))  # ==> yellow or green lights
+  
+  has_enumeration has been tested with:
+  
+    Rubies: Ruby 1.8.7, Ruby 1.9.2, and JRuby 1.5.1.
+    ActiveRecord: 2.3.8 and 3.0.0.rc
+
 email: greg@rujubu.com
 executables: []
 
@@ -28,12 +63,15 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE.txt
 - README.txt
+- TODO
 files: 
 - Gemfile
 - LICENSE.txt
 - README.txt
 - Rakefile
+- TODO
 - VERSION
+- features/arel_attributes.feature
 - features/explicitly_mapped_enumeration.feature
 - features/implicitly_mapped_enumeration.feature
 - features/step_definitions/has_enumeration_steps.rb