classy_enum 0.2.0 → 0.3.0

data/README.textile

@@ -18,33 +18,33 @@ The most common use for ClassyEnum is to replace database lookup tables where th
 
 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@
+<pre>
+script/generate classy_enum AlarmPriority low medium high
+</pre>
 
 A new file will be created at app/enums/alarm_priority.rb that will look like:
 
 <pre>
-  module AlarmPriority
-
-    OPTIONS = [:low, :medium, :high]
+module AlarmPriority
+  OPTIONS = [:low, :medium, :high]
 
-    module Defaults
-   
-    end
-
-    include ClassyEnum
+  module InstanceMethods
   end
 
-  class AlarmPriorityLow
-
+  module ClassMethods
   end
 
-  class AlarmPriorityMedium
+  include ClassyEnum
+end
 
-  end
+class AlarmPriorityLow
+end
 
-  class AlarmPriorityHigh
+class AlarmPriorityMedium
+end
 
-  end
+class AlarmPriorityHigh
+end
 </pre>
 
 That is the default setup, but can be changed to fit your needs, like so...
@@ -54,24 +54,23 @@ Using the OPTIONS constant, I have defined three priority levels: low, medium, a
 *It is important that you include ClassyEnum AFTER declaring your OPTIONS and Default methods because they are used when creating the enum classes*
 
 <pre>
-  module AlarmPriority
-
-    OPTIONS = [:low, :medium, :high]
+module AlarmPriority
+  OPTIONS = [:low, :medium, :high]
 
-    module Defaults
-      def email?
-        false
-      end
+  module InstanceMethods
+    def email?
+      false
     end
-
-    include ClassyEnum
   end
 
-  class AlarmPriorityHigh
-    def email?
-      true
-    end
+  include ClassyEnum
+end
+
+class AlarmPriorityHigh
+  def email?
+    true
   end
+end
 </pre>
 
 Then in my ActiveRecord model, Alarm, I've added a line that calls @classy_enum_attr@. The first argument is required, and is the name of the module defined above. The second argument is optional and specifies which Alarm attribute will be used as an enumerable. 
@@ -79,27 +78,37 @@ Then in my ActiveRecord model, Alarm, I've added a line that calls @classy_enum_
 In this case, I am using the module AlarmPriority, but the name of my attribute is priority. By default, it will use the name of module as the attribute name. If I wanted to do @alarm.alarm_priority@, I would not have included the second argument.
 
 <pre>
-  class Alarm < ActiveRecord::Base
-    classy_enum_attr :alarm_priority, :priority
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :alarm_priority, :priority
     
-    delegate :email?, :to => :priority
-  end
+  delegate :email?, :to => :priority
+end
 </pre>
 
 With this setup, I can now do the following:
 
 <pre>
-  @alarm = Alarm.create(:priority => :medium)
+@alarm = Alarm.create(:priority => :medium)
   
-  @alarm.priority => AlarmPriorityMedium
+@alarm.priority => AlarmPriorityMedium
   
-  @alarm.email? => false
+@alarm.email? => false
   
-  @alarm.update_attribute(:priority, :high)
+@alarm.update_attribute(:priority, :high)
   
-  @alarm.email? => true
+@alarm.email? => true
+</pre>
+
+h2. Formtastic Support
+
+To add ClassyEnum support to Formtastic, add the following to your formtastic.rb initializer (config/initializers/formtastic.rb):
+
+<pre>
+Formtastic::SemanticFormHelper.builder = ClassyEnumHelper::SemanticFormBuilder
 </pre>
 
+Then in your Formtastic view forms, use this syntax: @<%= f.input :priority, :as => :enum_select %>@
+
 h2. Notes
 
 An ActiveRecord validator @validates_inclusion_of :field, :in => ENUM.all@ is automatically added to your model when you use @classy_enum_attr@. 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Brown"]
-  s.date = %q{2010-10-01}
+  s.date = %q{2010-10-04}
   s.description = %q{A utility that adds class based enum functionaltiy to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/classy_enum.rb",
      "lib/classy_enum/classy_enum_attributes.rb",
+     "lib/classy_enum/classy_enum_helper.rb",
      "spec/classy_enum_attributes_spec.rb",
      "spec/classy_enum_spec.rb",
      "spec/spec.opts",

data/lib/classy_enum.rb

@@ -1,12 +1,15 @@
 require "classy_enum/classy_enum_attributes"
+require 'classy_enum/classy_enum_helper'
 
 class ClassyEnumValue < Object 
- 
-  attr_reader :to_s, :index
 
-  def initialize(option, index)
+  attr_reader :to_s, :to_sym, :index, :base_class
+
+  def initialize(base_class, option, index)
     @to_s = option.to_s.downcase
+    @to_sym = @to_s.to_sym
     @index = index + 1
+    @base_class = base_class
   end
   
   def name
@@ -61,7 +64,7 @@ module ClassyEnum
 
       Object.const_set("#{other}#{option.to_s.camelize}", klass)
     
-      instance = klass.new(option, other::OPTIONS.index(option))
+      instance = klass.new(other, option, other::OPTIONS.index(option))
       
       other::OPTION_HASH[option] = other::OPTION_HASH[option.to_s.downcase] = instance
       

data/lib/classy_enum/classy_enum_helper.rb

@@ -0,0 +1,14 @@
+module ClassyEnumHelper
+  class SemanticFormBuilder < Formtastic::SemanticFormBuilder
+    def enum_select_input(method, options)
+      enum_class = object.send(method)
+
+      raise "#{method} does not refer to a defined ClassyEnum object" unless enum_class.respond_to? :base_class
+
+      options[:collection] = enum_class.base_class.all_with_name
+      options[:selected] = enum_class.to_s
+
+      select_input(method, options)
+    end
+  end
+end

data/spec/classy_enum_attributes_spec.rb

@@ -1,29 +1,20 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+class Dog < ActiveRecord::Base
+  classy_enum_attr :breed
+end
 
-ActiveRecord::Schema.define(:version => 1) do
-  create_table :dogs, :force => true do |t|
-    t.string :breed
-  end
+describe "A Dog Collection" do
+  before(:each) do
+    dog1 = Dog.new(:breed => :golden_retriever)
+    dog2 = Dog.new(:breed => :snoop)
 
-  create_table :things, :force => true do |t|
-    t.string :dog_breed
+    @dogs = [dog1, dog2]
   end
-end
 
-module Breed
-  OPTIONS = [:golden_retriever, :snoop]
-  
-  module Defaults
-    
+  it "should sort by breed" do
+    @dogs.sort_by(&:breed).should == @dogs
   end
-  
-  include ClassyEnum
-end
-
-class Dog < ActiveRecord::Base
-  classy_enum_attr :breed
 end
 
 describe "A Dog" do
@@ -33,6 +24,10 @@ describe "A Dog" do
   it "should have an enumerable breed" do
     @dog.breed.class.should == BreedGoldenRetriever
   end
+
+  it "should have a base class of Breed" do
+    @dog.breed.base_class.should == Breed
+  end
   
 end
 
@@ -46,4 +41,8 @@ describe "A Thing" do
   it "should have an enumerable dog breed as breed" do
     @thing.dog_breed.class.should == BreedSnoop
   end
+
+  it "should have a base class of Breed" do
+    @thing.dog_breed.base_class.should == Breed
+  end
 end

data/spec/classy_enum_spec.rb

@@ -79,6 +79,14 @@ end
 describe "An ClassyEnumValue" do
   before(:each) { @enum = TestEnum.new(:one) }
   
+  it "should convert to a string" do
+    @enum.to_s.should == "one"
+  end
+  
+  it "should convert to a symbol" do
+    @enum.to_sym.should == :one
+  end
+
   it "should have a name" do
     @enum.name.should == "One"
   end

data/spec/spec_helper.rb

@@ -2,6 +2,27 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
+require 'spec'
+
 require 'active_record'
+require 'action_view'
+require 'formtastic'
 require 'classy_enum'
-require 'spec'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :dogs, :force => true do |t|
+    t.string :breed
+  end
+
+  create_table :things, :force => true do |t|
+    t.string :dog_breed
+  end
+end
+
+module Breed
+  OPTIONS = [:golden_retriever, :snoop]
+  
+  include ClassyEnum
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: classy_enum
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Peter Brown
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-01 00:00:00 -04:00
+date: 2010-10-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - init.rb
 - lib/classy_enum.rb
 - lib/classy_enum/classy_enum_attributes.rb
+- lib/classy_enum/classy_enum_helper.rb
 - spec/classy_enum_attributes_spec.rb
 - spec/classy_enum_spec.rb
 - spec/spec.opts