classy_enum 0.1.0 → 0.2.0

data/README.textile

@@ -16,14 +16,46 @@ h2. Example Usage
 
 The most common use for ClassyEnum is to replace database lookup tables where the content and behavior is mostly static and has multiple "types". In this example, I have an ActiveRecord model called @Alarm@ with an attribute called @priority@. Priority is stored as a string (VARCHAR) type in the database and is converted to an enum value when requested. 
 
+The fastest way to get up and running with ClassyEnum is to use the built-in Rails generator like so:
+
+@script/generate classy_enum AlarmPriority low medium high@
+
+A new file will be created at app/enums/alarm_priority.rb that will look like:
+
+<pre>
+  module AlarmPriority
+
+    OPTIONS = [:low, :medium, :high]
+
+    module Defaults
+   
+    end
+
+    include ClassyEnum
+  end
+
+  class AlarmPriorityLow
+
+  end
+
+  class AlarmPriorityMedium
+
+  end
+
+  class AlarmPriorityHigh
+
+  end
+</pre>
+
+That is the default setup, but can be changed to fit your needs, like so...
+
 Using the OPTIONS constant, I have defined three priority levels: low, medium, and high. Each priority level can have different properties and methods associated with it. In my example, each enum value has a method called @email?@. By default this method returns false, but is overridden for high priority alarms and returns true.
 
 *It is important that you include ClassyEnum AFTER declaring your OPTIONS and Default methods because they are used when creating the enum classes*
 
-Create a file in app/models called alarm_priority.rb 
-
 <pre>
   module AlarmPriority
+
     OPTIONS = [:low, :medium, :high]
 
     module Defaults

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Brown"]
-  s.date = %q{2010-09-30}
+  s.date = %q{2010-10-01}
   s.description = %q{A utility that adds class based enum functionaltiy to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [

data/generators/templates/enum.erb

@@ -1,15 +1,15 @@
 module <%= class_name %>
-
   OPTIONS = [<%= args.map {|a| ":#{a}"}.join(", ") %>]
 
-  module Defaults
+  module InstanceMethods
+  end
 
+  module ClassMethods
   end
 
   include ClassyEnum
 end
 <% args.each do |arg| %>
 class <%= class_name + arg.camelize %>
-
 end
 <% end %> 

data/lib/classy_enum.rb

@@ -53,9 +53,11 @@ module ClassyEnum
     other.const_set("OPTION_HASH", Hash.new)
 
     other::OPTIONS.each do |option|
-      klass = Class.new(ClassyEnumValue) {
-        include other::Defaults if other.const_defined?("Defaults")
-      }
+
+      klass = Class.new(ClassyEnumValue) do
+        include other::InstanceMethods if other.const_defined?("InstanceMethods")
+        extend other::ClassMethods if other.const_defined?("ClassMethods")
+      end
 
       Object.const_set("#{other}#{option.to_s.camelize}", klass)
     

data/spec/classy_enum_spec.rb

@@ -3,8 +3,14 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 module TestEnum 
   OPTIONS = [:one, :two, :three]
   
-  module Defaults
-    def do_something?
+  module InstanceMethods
+    def test_instance_method?
+      false
+    end
+  end
+
+  module ClassMethods
+    def test_class_method?
       false
     end
   end
@@ -13,7 +19,11 @@ module TestEnum
 end
 
 class TestEnumTwo
-  def do_something?
+  def self.test_class_method?
+    true
+  end
+
+  def test_instance_method?
     true
   end
 end
@@ -73,8 +83,12 @@ describe "An ClassyEnumValue" do
     @enum.name.should == "One"
   end
   
-  it "should inherit the Default methods" do
-    @enum.do_something?.should be_false
+  it "should inherit the default instance methods" do
+    @enum.test_instance_method?.should be_false
+  end
+
+  it "should inherit the default class methods" do
+    TestEnumOne.test_class_method?.should be_false
   end
   
   it "should create the same instance with a string or symbol" do
@@ -87,7 +101,11 @@ end
 describe "An ClassyEnumValue" do
   before(:each) { @enum = TestEnum.new(:two) }
   
-  it "should override the Default methods" do
-    @enum.do_something?.should be_true
+  it "should override the default instance methods" do
+    @enum.test_instance_method?.should be_true
   end
-end
+
+  it "should override the default class methods" do
+    TestEnumTwo.test_class_method?.should be_true
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: classy_enum
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Peter Brown
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-30 00:00:00 -04:00
+date: 2010-10-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency