power_enum 1.3.1 → 1.3.2

data/lib/active_record/virtual_enumerations.rb

@@ -114,7 +114,9 @@ module ActiveRecord # :nodoc:
       end
     end
 
-    def self.inject_class_options( virtual_enum_class, options ) # :nodoc:
+    # Evals the given set of options within the context of the given class
+    # @private
+    def self.inject_class_options( virtual_enum_class, options )
       # Declare it acts_as_enumerated
       virtual_enum_class.class_eval do
         acts_as_enumerated :conditions        => options[:conditions],

data/lib/generators/enum/enum_generator_helpers/migration_number.rb

@@ -1,8 +1,10 @@
+# Helper logic for the enum generator
 module EnumGeneratorHelpers
   # Helper methods to figure out the migration number.
   module MigrationNumber
 
     # Returns the number of the last migration.
+    # @return [Fixnum]
     def current_migration_number
       dirname = "#{Rails.root}/db/migrate/[0-9]*_*.rb"
       Dir.glob(dirname).collect do |file|
@@ -12,6 +14,7 @@ module EnumGeneratorHelpers
 
     # Returns the next upcoming migration number.  Sadly, Rails has no API for
     # this, so we're reduced to copying from ActiveRecord::Generators::Migration
+    # @return [Fixnum]
     def next_migration_number
       # Lifted directly from ActiveRecord::Generators::Migration
       # Unfortunately, no API is provided by Rails at this time.

data/lib/generators/virtual_enumerations_initializer/virtual_enumerations_initializer_generator.rb

@@ -7,6 +7,7 @@ class VirtualEnumerationsInitializerGenerator < Rails::Generators::Base
 
   argument :initializer_name, :type => :string, :default => 'virtual_enumerations'
 
+  # Writes the virtual enumerations initializer to config/initializers
   def generate_virtual_enum_initializer
     template 'virtual_enumerations.rb.erb', "config/initializers/#{initializer_name}.rb"
   end

data/lib/power_enum.rb

@@ -1,6 +1,12 @@
 require "rails"
 require 'testing/rspec'
 
+# 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.
 class PowerEnum < Rails::Engine
   config.autoload_paths << File.expand_path(File.join(__FILE__, "../"))
 

data/lib/power_enum/enumerated.rb

@@ -2,9 +2,11 @@
 # Copyright (c) 2012 Arthur Shagall
 # Released under the MIT License.  See the LICENSE file for more details.
 
+# Implementation of acts_as_enumerated
 module PowerEnum::Enumerated
   extend ActiveSupport::Concern
 
+  # Class level methods injected into ActiveRecord.
   module ClassMethods
 
     # Returns false for ActiveRecord models that do not act as enumerated.
@@ -129,6 +131,8 @@ module PowerEnum::Enumerated
     private :get_name_column
   end
 
+  # These are class level methods which are patched into classes that act as
+  # enumerated
   module EnumClassMethods
     attr_accessor :enumeration_model_updates_permitted
 
@@ -277,8 +281,8 @@ module PowerEnum::Enumerated
 
     def load_all
       conditions = self.acts_enumerated_conditions
-      order = self.acts_enumerated_order
-      where(conditions).order(order)
+      order      = self.acts_enumerated_order
+      unscoped.where(conditions).order(order)
     end
     private :load_all
 
@@ -336,7 +340,7 @@ module PowerEnum::Enumerated
     end
     private :all_by_name
 
-    def all_by_attribute(attr)
+    def all_by_attribute(attr) # :nodoc:
       aba = all.inject({}) { |memo, item|
         memo[item.send(attr)] = item
         memo
@@ -346,34 +350,36 @@ module PowerEnum::Enumerated
     end
     private :all_by_attribute
 
-    def enforce_none(arg)
+    def enforce_none(arg) # :nodoc:
       nil
     end
     private :enforce_none
 
-    def enforce_strict(arg)
+    def enforce_strict(arg) # :nodoc:
       raise_record_not_found(arg)
     end
     private :enforce_strict
 
-    def enforce_strict_literals(arg)
+    def enforce_strict_literals(arg) # :nodoc:
       raise_record_not_found(arg) if (Fixnum === arg) || (Symbol === arg)
       nil
     end
     private :enforce_strict_literals
 
-    def enforce_strict_ids(arg)
+    def enforce_strict_ids(arg) # :nodoc:
       raise_record_not_found(arg) if Fixnum === arg
       nil
     end
     private :enforce_strict_ids
 
-    def enforce_strict_symbols(arg)
+    def enforce_strict_symbols(arg) # :nodoc:
       raise_record_not_found(arg) if Symbol === arg
       nil
     end
     private :enforce_strict_symbols
 
+    # raise the {ActiveRecord::RecordNotFound} error.
+    # @private
     def raise_record_not_found(arg)
       raise ActiveRecord::RecordNotFound, "Couldn't find a #{self.name} identified by (#{arg.inspect})"
     end
@@ -381,6 +387,7 @@ module PowerEnum::Enumerated
 
   end
 
+  # These are instance methods for objects which are enums.
   module EnumInstanceMethods
     # Behavior depends on the type of +arg+.
     #
@@ -465,4 +472,4 @@ module PowerEnum::Enumerated
     end
     private :enumeration_model_update
   end # module EnumInstanceMethods
-end # module PowerEnum::Enumerated
+end # module PowerEnum::Enumerated

data/lib/power_enum/has_enumerated.rb

@@ -2,10 +2,12 @@
 # Copyright (c) 2012 Arthur Shagall
 # Released under the MIT License.  See the LICENSE file for more details.
 
-module PowerEnum::HasEnumerated # :nodoc:
+# Implementation of has_enumerated
+module PowerEnum::HasEnumerated
 
   extend ActiveSupport::Concern
 
+  # Class-level behavior injected into ActiveRecord to support has_enumerated
   module ClassMethods
 
     # Returns a list of all the attributes on the ActiveRecord model which are enumerated.

data/lib/power_enum/migration/command_recorder.rb

@@ -1,17 +1,23 @@
 # Copyright (c) 2011 Arthur Shagall
 # Released under the MIT license.  See LICENSE for details.
 
-module PowerEnum::Migration
+module PowerEnum::Migration # :nodoc:
 
+  # Extensions for CommandRecorder
   module CommandRecorder
+    # Records create_enum
     def create_enum(*args)
       record(:create_enum, args)
     end
 
+    # Records remove_enum
     def remove_enum(*args)
       record(:remove_enum, args)
     end
 
+    # The inversion of create_enum is remove_enum
+    # @param [Array] args Arguments to create_enum
+    # @return [Array] [:remove_enum, [enum_name]]
     def invert_create_enum(args)
       enum_name = args[0]
       [:remove_enum, [enum_name]]

data/lib/power_enum/reflection.rb

@@ -7,20 +7,25 @@
 module PowerEnum::Reflection
   extend ActiveSupport::Concern
 
+  # Class-level extensions injected into ActiveRecord
   module ClassMethods
-    def self.extended(base)
+    def self.extended(base) # :nodoc:
       class << base
         alias_method_chain :reflect_on_all_associations, :enumeration
         alias_method_chain :reflect_on_association, :enumeration
       end
     end
 
+    # All {PowerEnum::Reflection::EnumerationReflection} reflections
     def reflect_on_all_enumerated
       # Need to give it a full namespace to avoid getting Rails confused in development
       # mode where all objects are reloaded on every request.
       reflections.values.grep(PowerEnum::Reflection::EnumerationReflection)
     end
 
+    # If the reflection of the given name is an EnumerationReflection, returns
+    # the reflection, otherwise returns nil.
+    # @return [PowerEnum::Reflection::EnumerationReflection]
     def reflect_on_enumerated( enumerated )
       reflections[enumerated.to_sym].is_a?(PowerEnum::Reflection::EnumerationReflection) ? reflections[enumerated.to_sym] : nil
     end

data/lib/power_enum/schema/schema_statements.rb

@@ -1,10 +1,12 @@
 # Copyright (c) 2011 Arthur Shagall
 # Released under the MIT license.  See LICENSE for details.
 
+# Extensions to the migrations DSL
 module PowerEnum::Schema
+  # Patches AbstractAdapter with {PowerEnum::Schema::AbstractAdapter}
   module SchemaStatements
 
-    def self.included(base)
+    def self.included(base) # :nodoc:
       base::AbstractAdapter.class_eval do
         include PowerEnum::Schema::AbstractAdapter
       end
@@ -12,6 +14,7 @@ module PowerEnum::Schema
 
   end
 
+  # Implementation of the PowerEnum extensions to the migrations DSL.
   module AbstractAdapter
 
     # Creates a new enum table.  +enum_name+ will be automatically pluralized.

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: power_enum
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
+  prerelease: 
 platform: ruby
 authors:
 - Trevor Squires
@@ -39,11 +40,12 @@ cert_chain:
   amZaYUtWM2wwYTFkR2wyUVNMa2pScFFaRDFiRCtVSDdnT3F5N1piZGNzUkJM
   NEg3VTV6VQpibEtkZEg2dXhDckRTTTdLYWJrelNPVmYKLS0tLS1FTkQgQ0VS
   VElGSUNBVEUtLS0tLQo=
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -51,6 +53,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -58,6 +61,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -65,6 +69,23 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -72,6 +93,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -79,6 +101,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,6 +109,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -93,6 +117,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -100,6 +125,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: genspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -107,6 +133,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,26 +177,28 @@ files:
 - README.markdown
 homepage: http://github.com/albertosaurus/power_enum
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Allows you to treat instances of your ActiveRecord models as though they
   were an enumeration of values
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjcwMzlkY2EyNzFmMzAwYjc4ZTEwNDdjMWMwMWI4NjE0MDQzMjBjYg==
-  data.tar.gz: !binary |-
-    OTZiODFjYTg2NjkzZWU1OTUzZTA1NTMxN2U5YWVmMjEzM2Q4ODc2Mg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OTk1NTY2ZTViZTdjZDljZjIzZDA0ZTc2NDlkZGJhMzMyMWIyOGVmMDgyNDdj
-    NDVmZTUwYmFjMzI1ZGUwYzY1NjcyZDg2ZTA2ZjA3NzZhNjUyOWE4N2IzZDAx
-    MDE2NTA5ZjZiZDNiZGE4MzdmM2Q2MmMwYWYyODMwOTJjMmI3YWY=
-  data.tar.gz: !binary |-
-    OGY4ZGE4ZTQ5OGIxYzE0YjJjMzA5MTAxNTIxZjI2ZWM3MjNjYjE5ZTM3MWRl
-    YjE3MjgzOGFjZGI2NmY1NWUxZjRmMTFkNTM3NzVjNzc2MGZmYTYyZWU2MzJk
-    Y2ZiYzNlNjBlYmQwMGE2Y2M5ODk1ZTVlY2VlMDhjNjZlMDljNjc=

checksums.yaml.gz.sig

@@ -1 +0,0 @@
-���