power_enum 0.3.1 → 0.4.0

data/README.md

@@ -37,7 +37,10 @@ then run
 
 ## Gem Contents
 
-This package adds two mixins and a helper to Rails' ActiveRecord, as well as methods to migrations to simplify the creation of backing tables.
+This package adds:
+- Two mixins and a helper to ActiveRecord
+- Methods to migrations to simplify the creation of backing tables
+- A generator to make generating enums easy
 
 `acts_as_enumerated` provides capabilities to treat your model and its records as an enumeration.
 At a minimum, the database table for an acts\_as\_enumerated must contain an 'id' column and a column
@@ -54,16 +57,62 @@ cluttering up your models directory with acts\_as\_enumerated classes.
 
 ## How to use it
 
-In the following example, we'll look at a Booking that can have several types of statuses.
+In the following example, we'll look at a Booking that can have several types of statuses, encapsulated by BookingStatus enums.
+
+### generator
+
+Invoke the generator to create a basic enum:
+
+`rails generate enum booking_status`
+
+You should see output similar to this:
+
+    create  app/models/booking_status.rb
+    create  db/migrate/20110926012928_create_enum_booking_status.rb
+    invoke  test_unit
+    create    test/unit/booking_status_test.rb
+
+That's all you need to get started.  In many cases, no further work on the enum is necessary.  You can run `rails generate enum --help`
+to see a description of the generator options.  Notice, that while a unit tests is generated by default, a fixture isn't.  That is because
+fixtures are not an ideal way to test acts\_as\_enumerated models.  I generally prefer having a hook to seed the database from seeds.rb
+from a pre-test Rake task.
 
 ### migration
 
+If you're using Rails prior to 3.1, your migration file will look something like this:
+
+    class CreateEnumBookingStatus < ActiveRecord::Migration
+    
+      def self.up
+        create_enum :booking_status
+      end
+      
+      def self.down
+        create_enum :booking_status
+      end
+    
+    end
+    
+If you're using Rails 3.1, it will look something like this:
+
+    class CreateEnumBookingStatus < ActiveRecord::Migration
+    
+      def change
+        create_enum :booking_status
+      end
+    
+    end
+
+You can now customize it.
+    
     create_enum :booking_status, :name_limit => 50
     # The above is equivalent to saying
     # create_table :booking_statuses do |t|
     #   t.string :name, :limit => 50, :null => false
     # end
 
+Now, when you create your Booking model, your migration should create a reference column for status id's and a foreign key relationship to the booking_statuses table.
+    
     create_table :bookings do |t|
       t.integer :status_id
 
@@ -229,8 +278,9 @@ the `has_enumerated` macro behaves more like an aggregation than an association.
                                :on_lookup_failure => :optional_instance_method
     end
 
-By default, the foreign key is interpreted to be the name of your has\_enumerated field (in this case 'status') plus '\_id'.  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.
+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.
 
 With that, your Booking class will have the following methods defined:
 

data/lib/generators/enum/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Create the Rails files for a PowerEnum enum.
+
+Example:
+    rails generate enum booking_status
+
+    This will create:
+        BookingStatus model: app/models/booking_status.rb
+        Migration to create tables: db/migrate/db/migrate/20110925195833_create_enum_booking_status.rb
+        Unit test for model: test/unit/booking_status_test.rb

data/lib/generators/enum/enum_generator.rb

@@ -0,0 +1,59 @@
+# Generator for PowerEnum
+class EnumGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :enum_name, :type => :string
+  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'
+
+  def generate_model
+    template 'model.rb.erb', "app/models/#{file_name}.rb"
+  end
+  
+  def generate_migration
+    template migration_template, "db/migrate/#{migration_file_name}.rb" if options.migration?
+  end
+
+  hook_for :test_framework, :as => :model do |enum_generator_instance, test_generator_class|
+    # Need to do this because I'm changing the default value of the 'fixture' option.
+    enum_generator_instance.invoke( test_generator_class, [enum_generator_instance.enum_name], { 'fixture' => enum_generator_instance.options.fixture? } )
+  end
+  
+  no_tasks do
+
+    def file_name
+      enum_name.underscore
+    end
+  
+    def enum_class_name
+      file_name.camelize
+    end
+    
+    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
+    
+    def next_migration_number
+      ActiveRecord::Migration.next_migration_number( current_migration_number + 1 )
+    end
+    
+    def migration_name
+      "create_enum_#{file_name}"
+    end
+    
+    def migration_class_name
+      migration_name.camelize
+    end
+    
+    def migration_file_name
+      "#{next_migration_number}_#{migration_name}"
+    end
+    
+    def migration_template
+      Rails.version < '3.1' ? 'rails30_migration.rb.erb' : 'rails31_migration.rb.erb'
+    end
+
+  end
+end

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

@@ -0,0 +1,3 @@
+class <%= enum_class_name %> < ActiveRecord::Base
+  acts_as_enumerated
+end

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

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

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

@@ -0,0 +1,7 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+
+  def change
+    create_enum :<%=enum_name%>
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_enum
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-25 00:00:00.000000000Z
+date: 2011-09-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &28153380 !ruby/object:Gem::Requirement
+  requirement: &17555480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *28153380
+  version_requirements: *17555480
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &28152380 !ruby/object:Gem::Requirement
+  requirement: &17555000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28152380
+  version_requirements: *17555000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &28151860 !ruby/object:Gem::Requirement
+  requirement: &17554500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28151860
+  version_requirements: *17554500
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &28151280 !ruby/object:Gem::Requirement
+  requirement: &17553880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,7 +57,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *28151280
+  version_requirements: *17553880
+- !ruby/object:Gem::Dependency
+  name: genspec
+  requirement: &17553200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *17553200
 description: ! 'Power Enum allows you to treat instances of your ActiveRecord models
   as though they were an enumeration of values.
 
@@ -81,6 +92,11 @@ files:
 - lib/active_record/acts/enumerated.rb
 - lib/active_record/aggregations/has_enumerated.rb
 - lib/active_record/virtual_enumerations.rb
+- 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/power_enum.rb
 - lib/power_enum/migration/command_recorder.rb
 - lib/power_enum/schema/schema_statements.rb