power_enum 0.11.1 → 1.0.0

data/README.markdown

@@ -2,7 +2,10 @@
 
 https://github.com/albertosaurus/power_enum
 
-Enumerations for Rails 3.X Done Right.
+Enumerations for Rails 3.1/3.2 Done Right.
+
+NOTICE: Version 1.0 removes support from Rails 3.0, as that version of Rails has no longer been supported for
+some time.  The last version to support Rails 3.0 was 0.11.1.
 
 ## What is this?:
 
@@ -40,7 +43,7 @@ See "How to use it" below for more information.
 ## Requirements
 
 * Ruby 1.8.7, 1.9.2, 1.9.3, JRuby 1.6+
-* Rails 3.0, 3.1, 3.2
+* Rails 3.1, 3.2
 
 ## Installation
 
@@ -100,23 +103,7 @@ from a pre-test Rake task.
 
 ### migration
 
-If you're using Rails 3.0, your migration file will look something like this:
-
-```ruby
-class CreateEnumBookingStatus < ActiveRecord::Migration
-
-  def self.up
-    create_enum :booking_status
-  end
-
-  def self.down
-    remove_enum :booking_status
-  end
-
-end
-```
-    
-If you're using Rails 3.1 or later, it will look something like this:
+When you open your migration file, it will look something like this:
 
 ```ruby
 class CreateEnumBookingStatus < ActiveRecord::Migration
@@ -150,6 +137,8 @@ end
 
 # It's highly recommended to add a foreign key constraint here.
 # Ideally, you would use a gem of some sort to handle this.
+# I have been using PgPower https://rubygems.org/gems/pg_power with much
+# success.
 execute "ALTER TABLE bookings ADD 'bookings_bookings_status_id_fk'"\
     " FOREIGN KEY (status_id) REFERENCES booking_statuses (id);"
 ```
@@ -762,7 +751,7 @@ And finally run tests:
 * Initial Version Copyright (c) 2005 Trevor Squires
 * Rails 3 Updates Copyright (c) 2010 Pivotal Labs
 * Initial Test Suite Copyright (c) 2011 Sergey Potapov
-* Subsequent Updates Copyright (c) 2011-2012 Arthur Shagall
+* Subsequent Updates Copyright (c) 2011-2013 Arthur Shagall
 
 Released under the MIT License.  See the LICENSE file for more details.
 

data/lib/generators/enum/enum_generator.rb

@@ -8,10 +8,12 @@ class EnumGenerator < Rails::Generators::Base
   class_option :migration, :type => :boolean, :default => true, :desc => 'Generate migration for the enum'
   class_option :fixture, :type => :boolean, :default => false, :desc => 'Generate fixture for the enum'
 
+  # Generates the enum ActiveRecord model.
   def generate_model
     template 'model.rb.erb', "app/models/#{file_name}.rb"
   end
-  
+
+  # Generates the migration to create the enum table.
   def generate_migration
     template migration_template, "db/migrate/#{migration_file_name}.rb" if options.migration?
   end
@@ -23,21 +25,26 @@ class EnumGenerator < Rails::Generators::Base
   
   no_tasks do
 
+    # Returns the file name of the enum model without the .rb extension.
     def file_name
       enum_name.underscore
     end
-  
+
+    # Returns the class name of the enum.
     def enum_class_name
       file_name.camelize
     end
-    
+
+    # Returns the number of the last migration.
     def current_migration_number
       dirname = "#{Rails.root}/db/migrate/[0-9]*_*.rb"
       Dir.glob(dirname).collect do |file|
         File.basename(file).split("_").first.to_i
       end.max.to_i
     end
-    
+
+    # Returns the next upcoming migration number.  Sadly, Rails has no API for
+    # this, so we're reduced to copying from ActiveRecord::Generators::Migration
     def next_migration_number
       # Lifted directly from ActiveRecord::Generators::Migration
       # Unfortunately, no API is provided by Rails at this time.
@@ -48,21 +55,25 @@ class EnumGenerator < Rails::Generators::Base
         "%.3d" % next_migration_number
       end
     end
-    
+
+    # Derives the name for the migration, something like 'create_enum_fruit'
     def migration_name
       "create_enum_#{file_name}"
     end
-    
+
+    # Returns the class name of our migration
     def migration_class_name
       migration_name.camelize
     end
-    
+
+    # Generates and returns the filename of our migration
     def migration_file_name
       "#{next_migration_number}_#{migration_name}"
     end
-    
+
+    # Returns the name of the template file for the migration.
     def migration_template
-      Rails.version < '3.1' ? 'rails30_migration.rb.erb' : 'rails31_migration.rb.erb'
+      'rails31_migration.rb.erb'
     end
 
   end

data/lib/power_enum/has_enumerated.rb

@@ -85,6 +85,7 @@ module PowerEnum::HasEnumerated # :nodoc:
                                  :default,
                                  :create_scope )
 
+      # Add a reflection for the enumerated attribute.
       reflection = PowerEnum::Reflection::EnumerationReflection.new(part_id, options, self)
       self.reflections = self.reflections.merge(part_id => reflection)
 
@@ -212,6 +213,7 @@ module PowerEnum::HasEnumerated # :nodoc:
 
     end #has_enumerated
 
+    # If the lookup failure handler is a method name, wraps it in a lambda.
     def get_lookup_failure_handler(failure_opt) # :nodoc:
       if failure_opt.nil?
         nil

data/lib/power_enum/reflection.rb

@@ -1,6 +1,9 @@
 # Copyright (c) 2011 Artem Kuzko
+# Copyright (c) 2013 Zach Belzer
+# Copyright (c) 2013 Arthur Shagall
 # Released under the MIT license.  See LICENSE for details.
 
+# Used to patch ActiveRecord reflections.
 module PowerEnum::Reflection
   extend ActiveSupport::Concern
 
@@ -33,6 +36,7 @@ module PowerEnum::Reflection
     end
   end
 
+  # Reflection class for enum reflections.  See ActiveRecord::Reflection
   class EnumerationReflection < ActiveRecord::Reflection::MacroReflection
     attr_reader :counter_cache_column
 

data/lib/testing/rspec.rb

@@ -59,6 +59,7 @@ if defined? RSpec
       end
     end
 
+    # Returns the class of <tt>enum</tt>, or enum if it's a class.
     def get_enum_class(enum)
       if enum.is_a?(Class)
          enum
@@ -67,6 +68,7 @@ if defined? RSpec
        end
     end
 
+    # Validates the given enum.
     def validate_enum(enum_class, item)
       case item
       when String, Symbol, Fixnum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_enum
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,24 +12,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-09 00:00:00.000000000 Z
+date: 2013-01-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
-        version: 3.0.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,6 @@ files:
 - lib/generators/enum/USAGE
 - lib/generators/enum/enum_generator.rb
 - lib/generators/enum/templates/model.rb.erb
-- lib/generators/enum/templates/rails30_migration.rb.erb
 - lib/generators/enum/templates/rails31_migration.rb.erb
 - lib/generators/virtual_enumerations_initializer/USAGE
 - lib/generators/virtual_enumerations_initializer/templates/virtual_enumerations.rb.erb
@@ -145,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3615049416970020221
+      hash: 796684312632035672
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/generators/enum/templates/rails30_migration.rb.erb

@@ -1,11 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-
-  def self.up
-    create_enum :<%=file_name%>
-  end
-  
-  def self.down
-    remove_enum :<%=file_name%>
-  end
-
-end