has_enumeration 0.4.0 → 0.5.0

data/Gemfile.lock

@@ -10,6 +10,10 @@ GEM
       activesupport (= 3.0.0)
       arel (~> 1.0.0)
       tzinfo (~> 0.3.23)
+    activerecord-jdbc-adapter (0.9.7-java)
+    activerecord-jdbcsqlite3-adapter (0.9.7-java)
+      activerecord-jdbc-adapter (= 0.9.7)
+      jdbc-sqlite3 (>= 3.6.3.054)
     activesupport (3.0.0)
     arel (1.0.1)
       activesupport (~> 3.0.0)
@@ -23,7 +27,10 @@ GEM
     diff-lcs (1.1.2)
     gherkin (2.1.5)
       trollop (~> 1.16.2)
+    gherkin (2.1.5-java)
+      trollop (~> 1.16.2)
     i18n (0.4.1)
+    jdbc-sqlite3 (3.6.3.054)
     json_pure (1.4.6)
     meta_where (0.9.2)
       activerecord (~> 3.0.0.rc2)
@@ -43,6 +50,7 @@ GEM
     tzinfo (0.3.23)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/HISTORY.txt

@@ -1,3 +1,8 @@
+Version 0.5.0:
+- Default name of underlying attribute can be overridden with the :attribute
+  option
+- Internal cleanup: removed some unnecessary code and patching for Rails 3
+
 Version 0.4.0:
 - MetaWhere interoperability
 - Tested with Rails 3.0.0

data/README.txt

@@ -7,9 +7,12 @@ class TestObject < ActiveRecord::Base
   # Integer attribute with explicit value mapping
   has_enumeration :color, :red => 1, :green => 2, :blue => 3
 
-
   # String attribute with implicit value mapping
   # has_enumeration :color, [:red, :green, :blue]
+
+  # Attribute with a name other than the enumeration's name
+  # has_enumeration :color, {:red => 1, :green => 2, :blue => 3},
+  #   :attribute => :hue
 end
 
 # Value and predicates
@@ -44,7 +47,7 @@ has_enumeration has been tested with all combinations for the following:
   Rubies:
     - 1.8.7-p302
     - 1.9.2-p0
-    - JRuby 1.5.2
+    - JRuby 1.5.3
   ActiveRecord:
-    - 2.3.8
+    - 2.3.9
     - 3.0.0

data/Rakefile

@@ -15,7 +15,7 @@ in the database.  Predicates are provided for each symbol in the enumeration
 and the symbols may be used in finder methods.  When using ActiveRecord 3,
 the symbols may also be used when interacting with the underlying Arel attribute
 for the enumeration.  has_enumeration has been tested with Ruby 1.8.7,
-Ruby 1.9.2, JRuby 1.5.1, ActiveRecord 2.3.8, and ActiveRecord 3.0.0.
+Ruby 1.9.2, JRuby 1.5.3, ActiveRecord 2.3.9, and ActiveRecord 3.0.0.
 EOF
     gemspec.email = "greg@rujubu.com"
     gemspec.homepage = "http://github.com/gregspurrier/has_enumeration"
@@ -31,7 +31,8 @@ namespace :features do
   task :all => [:common, :rails3]
 
   Cucumber::Rake::Task.new(:common) do |t|
-    features = %w(explicitly_mapped_enumeration implicitly_mapped_enumeration)
+    features = %w(explicitly_mapped_enumeration implicitly_mapped_enumeration
+        nonstandard_attribute_enumeration)
     feature_files = features.map {|f| "features/#{f}.feature"}.join(' ')
     t.cucumber_opts = feature_files
   end

data/TODO

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

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/features/nonstandard_attribute_enumeration.feature

@@ -0,0 +1,51 @@
+Feature:
+
+  As a programmer using an ActiveRecord model with an integer column
+  representing an enumerated value
+  I want to be able to refer to the enumeration symbolically and have
+  predicates to test its value
+  So that I can write pretty, concise code.
+
+  Scenario Outline: set an enumerated value on an unsaved object
+    Given a model with an nonstandard-attribute enumeration of red, green, and blue
+    And an unsaved instance of that model
+    When I assign a symbolic value <assigned> to the enumeration
+    Then it should have the assigned value as its value
+    And the red? predicate should be <red?>
+    And the green? predicate should be <green?>
+    And the blue? predicate should be <blue?>
+
+    Scenarios: setting various values
+      | assigned | red?  | green? | blue? |
+      | :red     | true  | false  | false |
+      | :green   | false | true   | false |
+      | :blue    | false | false  | true  |
+
+  Scenario Outline: set an enumerated value then save and reload
+    Given a model with an nonstandard-attribute enumeration of red, green, and blue
+    And an unsaved instance of that model
+    When I assign a symbolic value <assigned> to the enumeration
+    And I save and reload the object
+    Then it should have the assigned value as its value
+    And the red? predicate should be <red?>
+    And the green? predicate should be <green?>
+    And the blue? predicate should be <blue?>
+
+    Scenarios: setting various values
+      | assigned | red?  | green? | blue? |
+      | :red     | true  | false  | false |
+      | :green   | false | true   | false |
+      | :blue    | false | false  | true  |
+
+  Scenario Outline: find objects with a specific enumerated value
+    Given a model with an nonstandard-attribute 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>
+    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

@@ -6,6 +6,10 @@ Given /^a model with an implicitly-mapped enumeration of red, green, and blue$/
   @model_class = ImplicitlyMappedModel
 end
 
+Given /^a model with an nonstandard-attribute enumeration of red, green, and blue$/ do
+  @model_class = NonstandardAttributeModel
+end
+
 Given /^an unsaved instance of that model$/ do
   @object = @model_class.new
 end

data/features/support/env.rb

@@ -23,4 +23,8 @@ class CreateTables < ActiveRecord::Migration
   create_table :implicitly_mapped_models, :force => true do |t|
     t.string :color
   end
+
+  create_table :nonstandard_attribute_models, :force => true do |t|
+    t.integer :hue
+  end
 end

data/features/support/nonstandard_attribute_model.rb

@@ -0,0 +1,4 @@
+class NonstandardAttributeModel < ActiveRecord::Base
+  has_enumeration :color, {:red => 1, :green => 2, :blue => 3},
+      :attribute => :hue
+end

data/lib/has_enumeration/class_methods.rb

@@ -1,6 +1,6 @@
 module HasEnumeration
   module ClassMethods
-    def has_enumeration(attribute, mapping)
+    def has_enumeration(enumeration, mapping, options = {})
       unless mapping.is_a?(Hash)
         # Recast the mapping as a symbol -> string hash
         mapping_hash = {}
@@ -8,34 +8,36 @@ module HasEnumeration
         mapping = mapping_hash
       end
 
+      # The underlying attribute
+      attribute = options[:attribute] || enumeration
+
       # ActiveRecord's composed_of method will do most of the work for us.
       # All we have to do is cons up a class that implements the bidirectional
       # mapping described by the provided hash.
       klass = create_enumeration_mapping_class(mapping)
-      attr_enumeration_mapping_classes[attribute] = klass
+      attr_enumeration_mapping_classes[enumeration] = klass
 
       # Bind the class to a name within the scope of this class
-      attribute_name = attribute.to_s
-      mapping_class_name = attribute_name.camelize
+      mapping_class_name = enumeration.to_s.camelize
       const_set(mapping_class_name, klass)
       scoped_class_name = [self.name, mapping_class_name].join('::')
 
-      composed_of(attribute,
+      composed_of(enumeration,
         :class_name => scoped_class_name,
-        :mapping => [attribute_name, 'raw_value'],
+        :mapping => [attribute.to_s, 'raw_value'],
         :converter => :from_sym
       )
 
-      # Install our aggregate condition handling override, but only once
-      unless @aggregate_conditions_override_installed
-        extend HasEnumeration::AggregateConditionsOverride
-        @aggregate_conditions_override_installed = true
-      end
-
-      if respond_to?(:arel_table)
+      if ActiveRecord::VERSION::MAJOR >= 3
         # Install this attributes mapping for use later when extending
         # Arel attributes on the fly.
         ::Arel::Table.has_enumeration_mappings[table_name][attribute] = mapping
+      else
+        # Install our aggregate condition handling override, but only once
+        unless @aggregate_conditions_override_installed
+          extend HasEnumeration::AggregateConditionsOverride
+          @aggregate_conditions_override_installed = true
+        end
       end
     end
 

data/lib/has_enumeration.rb

@@ -1,13 +1,14 @@
 require 'active_record'
 
+# Install our common ActiveRecord extentions
 require 'has_enumeration/class_methods'
-require 'has_enumeration/aggregate_conditions_override'
-
-# Install our ActiveRecord extentions
 ActiveRecord::Base.extend(HasEnumeration::ClassMethods)
 
-# If Arel is present, extend it
-if defined? Arel::Table
+# For ActiveRecord 3, extend Arel::Table, otherwise we'll need
+# our specialization of aggregate_conditions_override
+if ActiveRecord::VERSION::MAJOR >= 3
   require 'has_enumeration/arel/table_extensions'
   Arel::Table.send(:include, HasEnumeration::Arel::TableExtensions)
+else
+  require 'has_enumeration/aggregate_conditions_override'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_enumeration
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Greg Spurrier
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 -07:00
+date: 2010-10-05 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -27,7 +27,7 @@ description: |
   and the symbols may be used in finder methods.  When using ActiveRecord 3,
   the symbols may also be used when interacting with the underlying Arel attribute
   for the enumeration.  has_enumeration has been tested with Ruby 1.8.7,
-  Ruby 1.9.2, JRuby 1.5.1, ActiveRecord 2.3.8, and ActiveRecord 3.0.0.
+  Ruby 1.9.2, JRuby 1.5.3, ActiveRecord 2.3.9, and ActiveRecord 3.0.0.
 
 email: greg@rujubu.com
 executables: []
@@ -51,10 +51,12 @@ files:
 - features/explicitly_mapped_enumeration.feature
 - features/implicitly_mapped_enumeration.feature
 - features/meta_where_queries.feature
+- features/nonstandard_attribute_enumeration.feature
 - features/step_definitions/has_enumeration_steps.rb
 - features/support/env.rb
 - features/support/explicitly_mapped_model.rb
 - features/support/implicitly_mapped_model.rb
+- features/support/nonstandard_attribute_model.rb
 - lib/has_enumeration.rb
 - lib/has_enumeration/aggregate_conditions_override.rb
 - lib/has_enumeration/arel/table_extensions.rb