has_enumeration 0.3.1 → 0.4.0

data/Gemfile

@@ -3,7 +3,8 @@ source 'http://rubygems.org'
 if  ENV['AR_VERSION'] == '2.3'
   gem 'activerecord', '~> 2.3.8'
 else
-  gem 'activerecord', '~> 3.0.0.rc2'
+  gem 'activerecord', '= 3.0.0'
+  gem 'meta_where'
 end
 
 gem 'rspec', '~> 2.0.0.beta.19'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    gherkin (2.1.5)
+      trollop (~> 1.16.2)
+    i18n (0.4.1)
+    json_pure (1.4.6)
+    meta_where (0.9.2)
+      activerecord (~> 3.0.0.rc2)
+      activesupport (~> 3.0.0.rc2)
+      arel (~> 1.0.0.rc1)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    sqlite3-ruby (1.3.1)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.0)
+  activerecord-jdbcsqlite3-adapter (~> 0.9.7)
+  cucumber (~> 0.8.5)
+  jdbc-sqlite3
+  meta_where
+  rspec (~> 2.0.0.beta.19)
+  sqlite3-ruby

data/HISTORY.txt

@@ -1,3 +1,7 @@
+Version 0.4.0:
+- MetaWhere interoperability
+- Tested with Rails 3.0.0
+
 Version 0.3.1:
 - Re-release of 0.3.0 to pick up missed files
 

data/README.txt

@@ -27,6 +27,9 @@ TestObject.where(:color => :red)
 attr = TestObject.arel_table[:color]
 TestObject.where(attr.not_in([:red, :green]))
 
+# Querying with MetaWhere (ActiveRecord 3 only, with MetaWhere gem)
+TestObject.where(:color.not_in => [:red, :green])
+
 == Installation
 gem install has_enumeration
 
@@ -41,7 +44,7 @@ has_enumeration has been tested with all combinations for the following:
   Rubies:
     - 1.8.7-p302
     - 1.9.2-p0
-    - JRuby 1.5.1
+    - JRuby 1.5.2
   ActiveRecord:
     - 2.3.8
-    - 3.0.0.rc2
+    - 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.rc2.
+Ruby 1.9.2, JRuby 1.5.1, ActiveRecord 2.3.8, and ActiveRecord 3.0.0.
 EOF
     gemspec.email = "greg@rujubu.com"
     gemspec.homepage = "http://github.com/gregspurrier/has_enumeration"
@@ -37,7 +37,7 @@ namespace :features do
   end
 
   Cucumber::Rake::Task.new(:rails3) do |t|
-    features = %w(arel_attributes)
+    features = %w(arel_attributes meta_where_queries)
     feature_files = features.map {|f| "features/#{f}.feature"}.join(' ')
     t.cucumber_opts = feature_files
   end

data/TODO

@@ -1,5 +1,4 @@
 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.3.1
+0.4.0

data/features/meta_where_queries.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 MetaWhere queries for a model
+  So that I can write pretty, concise code.
+
+
+  Scenario Outline: find objects with a specific enumerated value via MetaWhere
+    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 MetaWhere
+    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

@@ -55,6 +55,11 @@ When /^I query for objects with the value :([a-z_]+) via arel$/ do |value|
   @results = @model_class.where(arel_attr.eq(@desired_color)).order(:id)
 end
 
+When /^I query for objects with the value :([a-z_]+) via MetaWhere$/ do |value|
+  @desired_color = value.to_sym
+  @results = @model_class.where(:color.eq => @desired_color).order(:id)
+end
+
 Then /^I should get all of the objects having that value$/ do
   @results.should == @all_objects.select {|x| x.color.value == @desired_color}
 end

data/features/support/env.rb

@@ -6,6 +6,10 @@ require 'rubygems'
 require 'bundler/setup'
 require 'has_enumeration'
 
+if ENV['AR_VERSION'] == '3.0'
+  require 'meta_where'
+end
+
 ActiveRecord::Base.establish_connection(
   :adapter => defined?(JRUBY_VERSION) ? 'jdbcsqlite3': 'sqlite3',
   :database => File.expand_path('../database', __FILE__)

data/lib/has_enumeration/arel/table_extensions.rb

@@ -0,0 +1,63 @@
+module HasEnumeration
+  module Arel
+    module TableExtensions
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :attributes, :has_enumeration
+
+          def self.has_enumeration_mappings
+            @has_enumeration_mappings ||= Hash.new {|h,k| h[k] = Hash.new}
+          end
+        end
+      end
+
+      def attributes_with_has_enumeration
+        return @attributes if @attributes
+        attrs = attributes_without_has_enumeration
+        mappings = self.class.has_enumeration_mappings[name]
+        if mappings
+          mappings.each do |attr_name, mapping|
+            attr = attrs[attr_name]
+            install_has_enumeration_attribute_mapping(attr, mapping)
+          end
+        end
+        attrs
+      end
+
+    private
+      def install_has_enumeration_attribute_mapping(arel_attr, mapping)
+        # For this attribute only, override all of the methods defined
+        # in Arel::Attribute::PREDICATES so that they will perform the
+        # symbol-to-underlying-value mapping before proceeding with their work.
+        (class <<arel_attr;self;end).class_eval do
+          define_method :map_enumeration_arg do |arg|
+            if arg.is_a?(Symbol)
+              mapping[arg]
+            elsif arg.is_a?(Array)
+              arg.map {|a| map_enumeration_arg(a)}
+            else
+              arg
+            end
+          end
+
+          ::Arel::Attribute::PREDICATES.each do |method_name|
+            # Preserve the arity of the method we are overriding
+            arity = ::Arel::Attribute.instance_method(method_name).arity
+            case arity
+            when 1
+              define_method method_name do |arg|
+                super(map_enumeration_arg(arg))
+              end
+            when -1
+              define_method method_name do |*args|
+                super(map_enumeration_arg(args))
+              end
+            else
+              raise "Unexpected arity #{arity} for #{method_name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_enumeration/class_methods.rb

@@ -33,9 +33,9 @@ module HasEnumeration
       end
 
       if respond_to?(:arel_table)
-        # Patch the enumeration's underlying arel attribute to make it
-        # aware of the mapping.
-        install_arel_attribute_mapping(attribute, mapping)
+        # Install this attributes mapping for use later when extending
+        # Arel attributes on the fly.
+        ::Arel::Table.has_enumeration_mappings[table_name][attribute] = mapping
       end
     end
 
@@ -69,40 +69,5 @@ module HasEnumeration
         end
       end
     end
-
-    def install_arel_attribute_mapping(attribute, mapping)
-      # For this attribute only, override all of the methods defined
-      # in Arel::Attribute::Predications so that they will perform the
-      # symbol-to-underlying-value mapping before proceeding with their work.
-      arel_attr = arel_table[attribute]
-      (class <<arel_attr;self;end).class_eval do
-        define_method :map_enumeration_arg do |arg|
-          if arg.is_a?(Symbol)
-            mapping[arg]
-          elsif arg.is_a?(Array)
-            arg.map {|a| map_enumeration_arg(a)}
-          else
-            arg
-          end
-        end
-
-        Arel::Attribute::PREDICATES.each do |method_name|
-          # Preserve the arity of the method we are overriding
-          arity = Arel::Attribute.instance_method(method_name).arity
-          case arity
-          when 1
-            define_method method_name do |arg|
-              super(map_enumeration_arg(arg))
-            end
-          when -1
-            define_method method_name do |*args|
-              super(map_enumeration_arg(args))
-            end
-          else
-            raise "Unexpected arity #{arity} for #{method_name}"
-          end
-        end
-      end
-    end
   end
 end

data/lib/has_enumeration.rb

@@ -3,5 +3,11 @@ require 'active_record'
 require 'has_enumeration/class_methods'
 require 'has_enumeration/aggregate_conditions_override'
 
-# Install our class methods.
+# Install our ActiveRecord extentions
 ActiveRecord::Base.extend(HasEnumeration::ClassMethods)
+
+# If Arel is present, extend it
+if defined? Arel::Table
+  require 'has_enumeration/arel/table_extensions'
+  Arel::Table.send(:include, HasEnumeration::Arel::TableExtensions)
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_enumeration
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Greg Spurrier
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-28 00:00:00 -07:00
+date: 2010-09-01 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.rc2.
+  Ruby 1.9.2, JRuby 1.5.1, ActiveRecord 2.3.8, and ActiveRecord 3.0.0.
 
 email: greg@rujubu.com
 executables: []
@@ -40,6 +40,7 @@ extra_rdoc_files:
 - TODO
 files: 
 - Gemfile
+- Gemfile.lock
 - HISTORY.txt
 - LICENSE.txt
 - README.txt
@@ -49,12 +50,14 @@ files:
 - features/arel_attributes.feature
 - features/explicitly_mapped_enumeration.feature
 - features/implicitly_mapped_enumeration.feature
+- features/meta_where_queries.feature
 - features/step_definitions/has_enumeration_steps.rb
 - features/support/env.rb
 - features/support/explicitly_mapped_model.rb
 - features/support/implicitly_mapped_model.rb
 - lib/has_enumeration.rb
 - lib/has_enumeration/aggregate_conditions_override.rb
+- lib/has_enumeration/arel/table_extensions.rb
 - lib/has_enumeration/class_methods.rb
 has_rdoc: true
 homepage: http://github.com/gregspurrier/has_enumeration