power_enum 0.5.1 → 0.5.2

data/README.md

@@ -322,14 +322,17 @@ the `has_enumerated` macro behaves more like an aggregation than an association.
       has_enumerated  :status, :class_name        => 'BookingStatus',
                                :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.
+                               :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.
     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`
 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.
+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
+attribute unless a non-nil value has already been set.
 
 With that, your Booking class will have the following methods defined:
 
@@ -399,7 +402,7 @@ Run migrations for test environment:
 
     RAILS_ENV=test rake db:migrate
 
-If you're using Rails 3.1, you should do this instead:
+You may need to use `bundle exec` if you have gem conflicts:
 
     RAILS_ENV=test bundle exec rake db:migrate
 

data/lib/active_record/aggregations/has_enumerated.rb

@@ -4,12 +4,14 @@
 module ActiveRecord
   module Aggregations # :nodoc:
     module HasEnumerated # :nodoc:
+
       def self.append_features(base)
         super      
         base.extend(MacroMethods)
       end
 
       module MacroMethods
+
         def enumerated_attributes
           @enumerated_attributes ||= []
         end
@@ -19,8 +21,43 @@ module ActiveRecord
           enumerated_attributes.include? attribute.to_s
         end
 
+        # Defines an enumerated attribute with the given name on the model.  Also accepts a hash of options as an
+        # optional second argument.
+        #
+        # === Supported options
+        # [:class_name]
+        #   Name of the enum class.  By default it is the camel-ized version of the has_enumerated attribute.
+        # [:foreign_key]
+        #   Explicitly set the foreign key column.  By default it's assumed to be your_enumerated_attribute_name_id.
+        # [:on_lookup_failure]
+        #   The :on_lookup_failure option in has_enumerated is there because you may want to create an error handler for
+        #   situations where the argument passed to status=(arg) is invalid. By default, an invalid value will cause an
+        #   ArgumentError to be raised.  Since this may not be optimal in your situation, you can specify an instance
+        #   method to be called in the case of a lookup failure. The method signature is as follows:
+        #     <tt>your_lookup_handler(operation, name, name_foreign_key, acts_enumerated_class_name, lookup_value)</tt>
+        #   The 'operation' arg will be either :read or :write.  In the case of :read you are expected to return
+        #   something or raise an exception, while in the case of a :write you don't have to return anything.  Note that
+        #   there's enough information in the method signature that you can specify one method to handle all lookup
+        #   failures for all has_enumerated fields if you happen to have more than one defined in your model.
+        #   '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 method will be bypassed.
+        # [:permit_empty_name]
+        #   Setting this to 'true' disables automatic conversion of empty strings to nil.  Default is 'false'.
+        # [: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.
+        #
+        # === Example
+        #  class Booking < ActiveRecord::Base
+        #    has_enumerated  :status,
+        #                    :class_name        => 'BookingStatus',
+        #                    :foreign_key       => 'status_id',
+        #                    :on_lookup_failure => :optional_instance_method,
+        #                    :permit_empty_name => true
+        #                    :default           => :unconfirmed
+        #  end
         def has_enumerated(part_id, options = {})
-          options.assert_valid_keys(:class_name, :foreign_key, :on_lookup_failure, :permit_empty_name)
+          options.assert_valid_keys(:class_name, :foreign_key, :on_lookup_failure, :permit_empty_name, :default)
 
           reflection = PowerEnum::Reflection::EnumerationReflection.new(part_id, options, self)
           self.reflections.merge! part_id => reflection
@@ -71,8 +108,22 @@ module ActiveRecord
 
           enumerated_attributes << name
 
-        end
-      end
-    end
-  end
+          if options.has_key?(:default)
+            default = options[:default]
+            set_default_method = "set_default_value_for_#{name}".to_sym
+
+            after_initialize set_default_method
+
+            define_method set_default_method do
+              self.send("#{name}=", default) if self.send(name).nil?
+            end
+            private set_default_method
+          end
+
+        end #has_enumerated
+
+      end #module MacroMethods
+
+    end #module HasEnumerated
+  end #module Aggregations
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: power_enum
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Trevor Squires
@@ -18,10 +18,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-02 00:00:00 Z
+date: 2012-01-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,12 +32,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
+  version_requirements: *id001
   name: rails
   prerelease: false
   type: :runtime
-  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +46,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id002
   name: jeweler
   prerelease: false
   type: :development
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +60,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id003
   name: rspec
   prerelease: false
   type: :development
-  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +74,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id004
   name: sqlite3
   prerelease: false
   type: :development
-  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -90,10 +90,10 @@ dependencies:
         - 2
         - 1
         version: 0.2.1
+  version_requirements: *id005
   name: genspec
   prerelease: false
   type: :development
-  requirement: *id005
 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.