power_enum 0.5.3 → 0.5.4

data/README.md

@@ -324,12 +324,13 @@ the `has_enumerated` macro behaves more like an aggregation than an association.
                                :foreign_key       => 'status_id',
                                :on_lookup_failure => :optional_instance_method,
                                :permit_empty_name => true,  #Setting this to true disables automatic conversion of empty strings to nil.  Default is false.
-                               :default           => :unconfirmed  #Default value of the attribute.
+                               :default           => :unconfirmed,  #Default value of the attribute.
+                               :create_scope      => false  #Setting this to false disables the automatic creation of the 'with_status' scope.
     end
 
 By default, the foreign key is interpreted to be the name of your has\_enumerated field (in this case 'booking_status') plus '\_id'.  Since we
 chose to make the column name 'status\_id' for the sake of brevity, we must explicitly designate it.  Additionally, the default value for
-`:class_name` is the camel-ized version of the name for your has\_enumerated field. `:on_lookup_failure` is explained below.  `:permit_empty_name`
+`:class_name` is the camelized version of the name for your has\_enumerated field. `:on_lookup_failure` is explained below.  `:permit_empty_name`
 is an optional flag to disable automatic conversion of empty strings to nil.  It is typically desirable to have `booking.update_attributes(:status => '')`
 assign status_id to a nil rather than raise an Error, as you'll be often calling `update_attributes` with form data, but
 the choice is yours.  Setting a `:default` option will generate an after_initialize callback to set a default value on the
@@ -374,9 +375,26 @@ for all has\_enumerated fields if you happen to have more than one defined in yo
 NOTE: A `nil` is always considered to be a valid value for `status=(arg)` since it's assumed you're trying to null out the foreign key.
 The `:on_lookup_failure` will be bypassed.
 
+#### with\_enumerated\_attribute scope
+
+Unless the `:create\_scope` option is set to `false`, a scope is automatically created that takes a list of enums as arguments.  This
+allows us to say things like:
+
+    Booking.with_status :confirmed, :received
+
+Strings, symbols, ids, or enum instances are all valid arguments.  For example, the following would be valid, though not recommended
+for obvious reasons.
+
+    Booking.with_status 1, 'confirmed', BookingStatus[:rejected]
+
+### ActiveRecord::Base Extensions
+
+The following methods are added to ActiveRecord::Base as class methods.
+
 #### has\_enumerated?(attr)
 
-Returns true if the given attr is an enumerated attributes, false otherwise.  `attr` can be a string or a symbol.
+Returns true if the given attr is an enumerated attributes, false otherwise.  `attr` can be a string or a symbol.  This
+is a class method.
 
 #### enumerated\_attributes
 

data/lib/active_record/aggregations/has_enumerated.rb

@@ -46,6 +46,8 @@ module ActiveRecord
         # [:default]
         #   Setting this option will generate an after_initialize callback to set a default value on the attribute
         #   unless a non-nil one already exists.
+        # [:create_scope]
+        #   Setting this option to 'false' will disable automatically creating a 'with_enum_attribute' scope.
         #
         # === Example
         #  class Booking < ActiveRecord::Base
@@ -53,22 +55,29 @@ module ActiveRecord
         #                    :class_name        => 'BookingStatus',
         #                    :foreign_key       => 'status_id',
         #                    :on_lookup_failure => :optional_instance_method,
-        #                    :permit_empty_name => true
-        #                    :default           => :unconfirmed
+        #                    :permit_empty_name => true,
+        #                    :default           => :unconfirmed,
+        #                    :create_cope       => false
         #  end
         def has_enumerated(part_id, options = {})
-          options.assert_valid_keys(:class_name, :foreign_key, :on_lookup_failure, :permit_empty_name, :default)
+          options.assert_valid_keys( :class_name,
+                                     :foreign_key,
+                                     :on_lookup_failure,
+                                     :permit_empty_name,
+                                     :default,
+                                     :create_scope )
 
           reflection = PowerEnum::Reflection::EnumerationReflection.new(part_id, options, self)
           self.reflections.merge! part_id => reflection
 
-          name        = part_id.to_s
-          class_name  = reflection.class_name
-          foreign_key = reflection.foreign_key
-          failure     = options[:on_lookup_failure]
-          empty_name  = options[:permit_empty_name]
+          name         = part_id.to_s
+          class_name   = reflection.class_name
+          foreign_key  = reflection.foreign_key
+          failure      = options[:on_lookup_failure]
+          empty_name   = options[:permit_empty_name]
+          create_scope = options[:create_scope]
 
-          module_eval <<-end_eval
+          module_eval( <<-end_eval, __FILE__, __LINE__ )
             def #{name}
               rval = #{class_name}.lookup_id(self.#{foreign_key})
               if rval.nil? && #{!failure.nil?}
@@ -120,6 +129,15 @@ module ActiveRecord
             private set_default_method
           end
 
+          unless create_scope == false
+            module_eval( <<-end_eval, __FILE__, __LINE__)
+              scope :with_#{name}, lambda { |*args|
+                ids = args.map{|arg| #{class_name}[arg] }
+                where(:#{foreign_key} => ids)
+              }
+            end_eval
+          end
+
         end #has_enumerated
 
       end #module MacroMethods

metadata

@@ -1,10 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: power_enum
-version: !ruby/object:Gem::Version
-  version: 0.5.3
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 4
+  version: 0.5.4
 platform: ruby
-authors:
+authors: 
 - Trevor Squires
 - Pivotal Labs
 - Arthur Shagall
@@ -12,82 +17,98 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &26849560 !ruby/object:Gem::Requirement
+
+date: 2012-01-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
-  type: :runtime
+  version_requirements: *id001
+  name: rails
   prerelease: false
-  version_requirements: *26849560
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &26848800 !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: jeweler
   prerelease: false
-  version_requirements: *26848800
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &26848100 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: *26848100
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &26847160 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: rspec
+  prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: sqlite3
   prerelease: false
-  version_requirements: *26847160
-- !ruby/object:Gem::Dependency
-  name: genspec
-  requirement: &26846180 !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
         version: 0.2.1
-  type: :development
+  version_requirements: *id005
+  name: genspec
   prerelease: false
-  version_requirements: *26846180
-description: ! 'Power Enum allows you to treat instances of your ActiveRecord models
-  as though they were an enumeration of values.
-
-  It allows you to cleanly solve many of the problems that the traditional Rails alternatives
-  handle poorly if at all.
-
-  It is particularly suitable for scenarios where your Rails application is not the
-  only user of the database, such as
-
-  when it''s used for analytics or reporting.
+  type: :development
+description: |
+  Power Enum allows you to treat instances of your ActiveRecord models as though they were an enumeration of values.
+  It allows you to cleanly solve many of the problems that the traditional Rails alternatives handle poorly if at all.
+  It is particularly suitable for scenarios where your Rails application is not the only user of the database, such as
+  when it's used for analytics or reporting.
 
-'
 email: arthur.shagall@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.md
-files:
+files: 
 - examples/virtual_enumerations_sample.rb
 - lib/active_record/acts/enumerated.rb
 - lib/active_record/aggregations/has_enumerated.rb
@@ -105,27 +126,36 @@ files:
 - README.md
 homepage: http://github.com/albertosaurus/enumerations_mixin
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Allows you to treat instances of your ActiveRecord models as though they
-  were an enumeration of values
+summary: Allows you to treat instances of your ActiveRecord models as though they were an enumeration of values
 test_files: []
+