power_enum 0.5.2 → 0.5.3

data/README.md

@@ -133,7 +133,7 @@ It's easier to use the `references` method if you intend to stick to the default
     
 There are two methods added to Rails migrations:
 
-##### `create_enum(enum_name, options = {}, &block)`
+##### create_enum(enum\_name, options = {}, &block)
 
 Creates a new enum table.  `enum_name` will be automatically pluralized.  The following options are supported:
 
@@ -192,7 +192,7 @@ is the equivalent of
 
 Notice that a unique index is automatically created on the specified name column.
 
-##### `remove_enum(enum_name)`
+##### remove\_enum(enum\_name)
 
 Drops the enum table.  `enum_name` will be automatically pluralized.
 
@@ -217,11 +217,12 @@ With that, your BookingStatus class will have the following methods defined:
 
 #### Class Methods
 
-##### `[](arg)`
+##### [](arg)
 
 `BookingStatus[arg]` performs a lookup for the BookingStatus instance for the given arg.  The arg value can be a 'string' or a :symbol,
 in which case the lookup will be against the BookingStatus.name field.  Alternatively arg can be a Fixnum,
-in which case the lookup will be against the BookingStatus.id field.
+in which case the lookup will be against the BookingStatus.id field.  Since version 0.5.3, it returns the arg
+if arg is an instance of the enum (in this case BookingStatus) as a convenience.
 
 The `:on_lookup_failure` option specifies the name of a *class* method to invoke when the `[]` method is unable to locate a BookingStatus record for arg.
 The default is the built-in `:enforce_none` which returns nil. There are also built-ins for `:enforce_strict` (raise and exception regardless of the type for arg),
@@ -231,15 +232,15 @@ and `:enforce_strict_symbols` (raises an exception if the arg is a Symbol).
 The purpose of the `:on_lookup_failure` option is that a) under some circumstances a lookup failure is a Bad Thing and action should be taken,
 therefore b) a fallback action should be easily configurable.
 
-##### `all`
+##### all
 
 `BookingStatus.all` returns an array of all BookingStatus records that match the `:conditions` specified in `acts_as_enumerated`, in the order specified by `:order`.
 
-##### `active`
+##### active
 
 `BookingStatus.active` returns an array of all BookingStatus records that are marked active.  See the `active?` instance method.
 
-##### `inactive`
+##### inactive
 
 `BookingStatus.inactive` returns an array of all BookingStatus records that are inactive.  See the `inactive?` instance method.
 
@@ -247,7 +248,7 @@ therefore b) a fallback action should be easily configurable.
 
 Each enumeration model gets the following instance methods.
 
-##### `===(arg)`
+##### ===(arg)
 
 Behavior depends on the type of `arg`.
 
@@ -268,7 +269,7 @@ You should note that defining an `:on_lookup_failure` method that raises an exce
 
 `like?` is aliased to `===`
 
-##### `in?(*list)`
+##### in?(*list)
 
 Returns true if any element in the list returns true for `===(arg)`, false otherwise.
 
@@ -276,21 +277,21 @@ Example:
 
     BookingStatus[:foo].in? :foo, :bar, :baz #Returns true
 
-##### `name`
+##### name
 
 Returns the 'name' of the enum, i.e. the value in the `:name_column` attribute of the enumeration model.
 
-##### `name_sym`
+##### name\_sym
 
 Returns the symbol representation of the name of the enum.  `BookingStatus[:foo].name_sym` returns :foo.
 
-##### `active?`
+##### active?
 
 Returns true if the instance is active, false otherwise.  If it has an attribute 'active',
 returns the attribute cast to a boolean, otherwise returns true.  This method is used by the `active`
 class method to select active enums.
 
-##### `inactive?`
+##### inactive?
 
 Returns true if the instance is inactive, false otherwise.  Default implementations returns `!active?`
 This method is used by the `inactive` class method to select inactive enums.
@@ -336,11 +337,11 @@ attribute unless a non-nil value has already been set.
 
 With that, your Booking class will have the following methods defined:
 
-#### `status`
+#### status
 
 Returns the BookingStatus with an id that matches the value in the Booking.status_id.
 
-#### `status=(arg)`
+#### status=(arg)
 
 Sets the value for Booking.status_id using the id of the BookingStatus instance passed as an argument.  As a
 short-hand, you can also pass it the 'name' of a BookingStatus instance, either as a 'string' or :symbol, or pass in the id directly.
@@ -373,11 +374,11 @@ 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.
 
-#### `has_enumerated?(attr)`
+#### has\_enumerated?(attr)
 
 Returns true if the given attr is an enumerated attributes, false otherwise.  `attr` can be a string or a symbol.
 
-#### `enumerated_attributes`
+#### enumerated\_attributes
 
 Returns an array of attributes which are enumerated.
 

data/lib/active_record/acts/enumerated.rb

@@ -66,7 +66,8 @@ module ActiveRecord
           @all_inactive = all.select{ |enum| !enum.active? }.freeze
         end
 
-        # Enum lookup by Symbol, String, or id.
+        # Enum lookup by Symbol, String, or id.  Returns <tt>arg<tt> if arg is
+        # an enum instance.
         def [](arg)
           case arg
           when Symbol
@@ -75,6 +76,8 @@ module ActiveRecord
             return_val = lookup_name(arg) and return return_val
           when Fixnum
             return_val = lookup_id(arg) and return return_val
+          when self
+            return arg
           when nil
             nil
           else

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: power_enum
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 0.5.3
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 2
-  version: 0.5.2
 platform: ruby
-authors: 
+authors:
 - Trevor Squires
 - Pivotal Labs
 - Arthur Shagall
@@ -17,98 +12,82 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-01-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &26849560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
-  version_requirements: *id001
-  name: rails
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
-  name: jeweler
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *26849560
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &26848800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id003
-  name: rspec
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *26848800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &26848100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id004
-  name: sqlite3
+    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
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *26847160
+- !ruby/object:Gem::Dependency
+  name: genspec
+  requirement: &26846180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 0
-        - 2
-        - 1
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.2.1
-  version_requirements: *id005
-  name: genspec
-  prerelease: false
   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.
+  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.
+
+'
 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
@@ -126,36 +105,27 @@ 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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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: []
-