active_enum 0.5.1 → 0.6.0

data/README.rdoc

@@ -3,7 +3,7 @@
 Define enum classes in Rails and use them to enumerate ActiveRecord attributes. Brings together some ideas
 of similar plugins that I liked and does it they way I prefer.
 
-Enum values are stored in memory at the moment but I plan to add database and yaml. 
+Enum values are stored in memory at the moment but I plan to add database and yaml.
 
 == Install
 
@@ -63,10 +63,11 @@ Skip the with option if the enum can be implied from the attribute
     enumerate :sex
   end
 
-Define enum class implicitly in enumerate block
+Define enum class implicitly from enumerate block. Enum class is namespaced by model class.
 
   class User < ActiveRecord::Base
-    # defines UserSex enum
+
+    # defines User::Sex
     enumerate :sex do
       value :name => 'Male'
     end
@@ -86,7 +87,7 @@ Access the enum values and the enum class using the attribute method with a symb
 
   user.sex(:id)    # => 1
   user.sex(:name)  # => 'Male'
-  user.sex(:enum)  # => Sex 
+  user.sex(:enum)  # => Sex
 
 You can check if the attribute value matches a particular enum value by passing the enum value as an argument to the question method
 
@@ -114,7 +115,7 @@ Define enum classes in bulk without class files, in an initializer file for exam
       value :name => 'Female'
     end
 
-    # defines Language 
+    # defines Language
     enum(:language) do
       value :name => 'English'
       value :name => 'German'
@@ -136,6 +137,22 @@ Giving you the familiar enum methods
   User['Dave']
   User.to_select
 
+=== Formtastic
+
+If you are a formtastic user you can use the extension for an enum input.
+
+In an initialiser:
+
+  require 'active_enum/formtastic'
+
+Then in a form you can use the :enum type for attribute inputs which are enumerated.
+
+  <% semantic_form_for(@person) do |f| %>
+    <%= f.input :sex, :as => :enum %>
+  <% end %>
+
+This will output a select with the option values taken from the enum class for the attribute.
+
 
 == TODO
 * more docs
@@ -143,7 +160,5 @@ Giving you the familiar enum methods
 * use custom method name for the enumerated attribute
 * named_scopes
 * question methods for enum names e.g. user.male?
-* possibly allow string enum values to assigned to attributes
-* add enum value class for instances if there is a need
 
 Copyright (c) 2009 Adam Meehan, released under the MIT license

data/lib/active_enum/extensions.rb

@@ -12,12 +12,12 @@ module ActiveEnum
     module ClassMethods
 
       # Declare an attribute to be enumerated by an enum class
-      # 
+      #
       #   class Person < ActiveRecord::Base
       #     enumerate :sex, :with => Sex
       #     enumerate :sex # implies a Sex enum class exists
       #
-      #     # Pass a block to create implicit enum class as ModelAttribute e.g. PersonSex 
+      #     # Pass a block to create implicit enum class namespaced by model e.g. Person::Sex
       #     enumerate :sex do
       #       value :id => 1, :name => 'Male'
       #     end
@@ -30,9 +30,10 @@ module ActiveEnum
 				attributes.each do |attribute|
 					begin
 						if block_given?
-							enum_name = "#{self.to_s.underscore}_#{attribute}"
-							ActiveEnum.define { enum(enum_name, &block) }
-							enum = enum_name.classify.constantize
+              enum_class_name = "#{self.name}::#{attribute.to_s.camelize}"
+              eval("class #{enum_class_name} < ActiveEnum::Base; end")
+						  enum = enum_class_name.constantize
+              enum.class_eval &block
 						else
 							enum = options[:with] || attribute.to_s.classify.constantize
 						end

data/lib/active_enum/formtastic.rb

@@ -0,0 +1,12 @@
+module ActiveEnum
+  module Formtastic
+
+    def enum_input(method, options)
+      raise "Attribute '#{method}' has no enum class" unless enum = @object.class.enum_for(method)
+      select_input(method, options.merge(:collection => enum.to_select))
+    end
+
+  end
+end
+
+Formtastic::SemanticFormBuilder.send :include, ActiveEnum::Formtastic

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/active_enum/extensions_spec.rb

@@ -12,12 +12,6 @@ class Accepted < ActiveEnum::Base
 end
 
 describe ActiveEnum::Extensions do
-  before do
-    Person.class_eval do
-      enumerate :sex, :with => Sex
-    end
-    @person = Person.new(:sex =>1)
-  end
 
   it 'should add class :enumerate method to ActiveRecord' do
     ActiveRecord::Base.should respond_to(:enumerate)
@@ -42,13 +36,13 @@ describe ActiveEnum::Extensions do
     Person.enum_for(:sex).should == Sex
   end
 
-  it 'should allow implicit enumeration class from block' do
+  it 'should create enum namespaced enum class from block' do
     Person.class_eval do
       enumerate :sex do
         value :id => 1, :name => 'Male'
       end
     end
-    Person.enum_for(:sex).should == PersonSex
+    Person.enum_for(:sex).should == Person::Sex
   end
 
   it 'should raise error if implicit enumeration class cannot be found' do
@@ -57,121 +51,134 @@ describe ActiveEnum::Extensions do
     end.should raise_error(ActiveEnum::EnumNotFound)
   end
 
-  describe "attribute with value" do
-    it 'should return value with no arg' do
-      @person.sex.should == 1
+  describe "attribute" do
+    before(:all) do
+      reset_class Person do
+        enumerate :sex, :with => Sex
+      end
     end
 
-    it 'should return enum id for value' do
-      @person.sex(:id).should == 1
+    before do
+      @person = Person.new(:sex =>1)
     end
 
-    it 'should return enum name for value' do
-      @person.sex(:name).should == 'Male'
-    end
+    describe "with value" do
+      it 'should return value with no arg' do
+        @person.sex.should == 1
+      end
 
-    it 'should return enum class for attribute' do
-      @person.sex(:enum).should == Sex
-    end
-  end
+      it 'should return enum id for value' do
+        @person.sex(:id).should == 1
+      end
 
-  describe "nil attribute value" do
-    before do
-      @person.sex = nil
-    end
+      it 'should return enum name for value' do
+        @person.sex(:name).should == 'Male'
+      end
 
-    it 'should return nil with no arg' do
-      @person.sex.should be_nil
+      it 'should return enum class for attribute' do
+        @person.sex(:enum).should == Sex
+      end
     end
 
-    it 'should return nil enum id' do
-      @person.sex(:id).should be_nil
-    end
+    describe "with nil value" do
+      before do
+        @person.sex = nil
+      end
 
-    it 'should return nil enum name' do
-      @person.sex(:name).should be_nil
-    end
+      it 'should return nil with no arg' do
+        @person.sex.should be_nil
+      end
 
-    it 'should return enum class for attribute' do
-      @person.sex(:enum).should == Sex
-    end
-  end
+      it 'should return nil enum id' do
+        @person.sex(:id).should be_nil
+      end
 
-  describe "attribute with undefined value" do
-    before do
-      @person.sex = -1
-    end
+      it 'should return nil enum name' do
+        @person.sex(:name).should be_nil
+      end
 
-    it 'should return value with no arg' do
-      @person.sex.should == -1
+      it 'should return enum class for attribute' do
+        @person.sex(:enum).should == Sex
+      end
     end
 
-    it 'should return nil enum id' do
-      @person.sex(:id).should be_nil
-    end
+    describe "with undefined value" do
+      before do
+        @person.sex = -1
+      end
 
-    it 'should return nil enum name' do
-      @person.sex(:name).should be_nil
-    end
+      it 'should return value with no arg' do
+        @person.sex.should == -1
+      end
 
-    it 'should return enum class for attribute' do
-      @person.sex(:enum).should == Sex
-    end
-  end
+      it 'should return nil enum id' do
+        @person.sex(:id).should be_nil
+      end
 
-  describe "attribute question method" do
-    before do
-      @person.sex = 1
-    end
+      it 'should return nil enum name' do
+        @person.sex(:name).should be_nil
+      end
 
-    it 'should return normal value without arg' do
-      @person.sex?.should be_true
-      @person.sex = nil
-      @person.sex?.should be_false
+      it 'should return enum class for attribute' do
+        @person.sex(:enum).should == Sex
+      end
     end
 
-    it 'should return true if string name matches for id value' do
-      @person.sex?("Male").should be_true
-    end
+    describe "question method" do
+      before do
+        @person.sex = 1
+      end
 
-    it 'should return true if symbol name matches for id value' do
-      @person.sex?(:male).should be_true
-      @person.sex?(:Male).should be_true
-    end
+      it 'should return normal value without arg' do
+        @person.sex?.should be_true
+        @person.sex = nil
+        @person.sex?.should be_false
+      end
 
-    it 'should return false if name does not match for id value' do
-      @person.sex?("Female").should be_false
-      @person.sex?(:female).should be_false
-      @person.sex?(:Female).should be_false
-    end
-  end
+      it 'should return true if string name matches for id value' do
+        @person.sex?("Male").should be_true
+      end
 
-  describe "assigning enum name symbol to attribute" do
+      it 'should return true if symbol name matches for id value' do
+        @person.sex?(:male).should be_true
+        @person.sex?(:Male).should be_true
+      end
 
-    it 'should store id value when valid enum name' do
-      @person.sex = :female
-      @person.sex.should == 2
+      it 'should return false if name does not match for id value' do
+        @person.sex?("Female").should be_false
+        @person.sex?(:female).should be_false
+        @person.sex?(:Female).should be_false
+      end
     end
 
-    it 'should store nil value when invalid enum name' do
-      @person.sex = :invalid
-      @person.sex.should == nil
-    end
+    describe "with value as enum name symbol" do
 
-  end
+      it 'should store id value when valid enum name' do
+        @person.sex = :female
+        @person.sex.should == 2
+      end
 
-  describe "use enum name as attribute value" do
-    before(:all) do
-      ActiveEnum.use_name_as_value = true
-    end
+      it 'should store nil value when invalid enum name' do
+        @person.sex = :invalid
+        @person.sex.should == nil
+      end
 
-    it 'should return text name value for attribute' do
-      @person.sex.should == 'Male'
     end
 
-    after(:all) do
-      ActiveEnum.use_name_as_value = false
+    describe "with value as enum name" do
+      before(:all) do
+        ActiveEnum.use_name_as_value = true
+      end
+
+      it 'should return text name value for attribute' do
+        @person.sex.should == 'Male'
+      end
+
+      after(:all) do
+        ActiveEnum.use_name_as_value = false
+      end
     end
+
   end
 
 end

data/spec/active_enum/formtastic_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'action_controller'
+require 'action_view'
+require 'formtastic'
+require 'rspec_tag_matchers'
+require 'active_enum/formtastic'
+
+describe ActiveEnum::Formtastic do
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::FormOptionsHelper
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::ActiveRecordHelper
+  include ActionView::Helpers::RecordIdentificationHelper
+  include ActionView::Helpers::CaptureHelper
+  include ActionController::PolymorphicRoutes
+  include Formtastic::SemanticFormHelper
+  include RspecTagMatchers
+
+  attr_accessor :output_buffer
+
+  before do
+    reset_class Person do
+      enumerate :sex do
+        value :id => 1, :name => 'Male'
+        value :id => 2, :name => 'Female'
+      end
+    end
+
+    @output_buffer = ''
+  end
+
+  it "should use enum class for select option values for enum input type" do
+    semantic_form_for(Person.new) do |f|
+      concat f.input(:sex, :as => :enum)
+    end
+    output_buffer.should have_tag('select#person_sex') do |inner|
+      inner.should have_tag('//option[@value=1]', 'Male')
+      inner.should have_tag('//option[@value=2]', 'Female')
+    end
+  end
+
+  it "should raise error if attribute for enum input is not enumerated" do
+    lambda do
+      semantic_form_for(Person.new) {|f| f.input(:attending, :as => :enum) }
+    end.should raise_error "Attribute 'attending' has no enum class"
+  end
+
+  def protect_against_forgery?
+    false
+  end
+
+  def people_path
+    '/people'
+  end
+end

data/spec/spec_helper.rb

@@ -17,7 +17,13 @@ require 'schema'
 class Person < ActiveRecord::Base; end
 
 module SpecHelper
-
+  def reset_class(klass, &block)
+    name = klass.name.to_sym
+    Object.send(:remove_const, name)
+    Object.const_set(name, Class.new(ActiveRecord::Base))
+    new_klass = Object.const_get(name)
+    new_klass.class_eval &block if block_given?
+  end
 end
 
 Spec::Runner.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Adam Meehan
@@ -9,7 +9,7 @@ autorequire: active_enum
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 +11:00
+date: 2009-12-28 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -28,11 +28,13 @@ files:
 - lib/active_enum/acts_as_enum.rb
 - lib/active_enum/base.rb
 - lib/active_enum/extensions.rb
+- lib/active_enum/formtastic.rb
 - lib/active_enum/version.rb
 - lib/active_enum.rb
 - spec/active_enum/acts_as_enum_spec.rb
 - spec/active_enum/base_spec.rb
 - spec/active_enum/extensions_spec.rb
+- spec/active_enum/formtastic_spec.rb
 - spec/active_enum_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb