active_enum 0.6.6 → 0.7.0

data/README.rdoc

@@ -7,13 +7,13 @@ Enum values are stored in memory at the moment but I plan to add database and ya
 
 == Install
 
-For Rails 2.x only
+From version 0.7 onwards this plugin will only have Rails 3 support. If you need Rails 2 compatibility, check the 0.6 branch.
 
-  gem install active_enum --version '~> 0.6.0'
+  gem install active_enum 
 
-And add to your Rails environment.rb
+Put this in your Gemfile
 
-  config.gem 'active_enum', :version => '~> 0.6.0'
+  gem 'active_enum'
 
 
 == Example
@@ -124,7 +124,7 @@ You can check if the attribute value matches a particular enum value by passing
 
 A convenience method on the class is available to the enum class of any enumerated attribute
 
-  User.active_enum_for(:sex) # => Sex
+  User.enum_for(:sex) # => Sex
 
 === Bulk definition
 
@@ -162,21 +162,36 @@ 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.
+=== Form Helpers
+
+There is support for Formtastic[http://github.com/justinfrench/formtastic] and SimpleForm[http://github.com/plataformatec/simple_form]
+to make it easier to use the enum values as select options. The plugins have an almost identical API which is handy.
+Instructions for each are below.
+
+==== Formtastic
 
 In an initialiser:
 
-  require 'active_enum/formtastic'
+  require 'active_enum/form_helpers/formtastic'
 
-Then in a form you can use the :enum type for attribute inputs which are enumerated.
+Then declare the input for an enumerated attribute as the :enum type.
 
   <% 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.
+==== SimpleForm
+
+In an initialiser:
+
+  require 'active_enum/form_helpers/simple_form'
+
+Then declare the input for an enumerated attribute as the :enum type.
+
+  <% simple_form_for(@person) do |f| %>
+    <%= f.input :sex, :as => :enum %>
+  <% end %>
 
 
 == TODO

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rubygems/specification'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 require 'lib/active_enum/version'
 
 GEM_NAME = "active_enum"
@@ -29,19 +29,15 @@ end
 desc 'Default: run specs.'
 task :default => :spec
 
-spec_files = Rake::FileList["spec/**/*_spec.rb"]
-
 desc "Run specs"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = spec_files
-  t.spec_opts = ["-c"]
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
 end
 
 desc "Generate code coverage"
-Spec::Rake::SpecTask.new(:coverage) do |t|
-  t.spec_files = spec_files
+RSpec::Core::RakeTask.new(:coverage) do |t|
   t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+  t.rcov_opts = ['--exclude', 'spec']
 end
 
 desc 'Generate documentation for plugin.'

data/lib/active_enum/acts_as_enum.rb

@@ -12,10 +12,9 @@ module ActiveEnum
         extend ClassMethods
         class_inheritable_accessor :active_enum_options
         self.active_enum_options = options.reverse_merge(:name_column => 'name')
-        named_scope :enum_values,
-                      :select     => "#{primary_key}, #{active_enum_options[:name_column]}",
-                      :conditions => active_enum_options[:conditions],
-                      :order      => "#{primary_key} #{active_enum_options[:order]}"
+        scope :enum_values, select("#{primary_key}, #{active_enum_options[:name_column]}").
+                            where(active_enum_options[:conditions]).
+                            order("#{primary_key} #{active_enum_options[:order]}")
       end
 
     end
@@ -51,7 +50,7 @@ module ActiveEnum
       end
 
       def lookup_by_name(index)
-        enum_values.find(:first, :conditions => ["#{active_enum_options[:name_column]} like ?", index.to_s])
+        enum_values.where("#{active_enum_options[:name_column]} like ?", index.to_s).first
       end
 
     end

data/lib/active_enum/extensions.rb

@@ -50,7 +50,7 @@ module ActiveEnum
 				end
       end
 
-      def active_enum_for(attribute)
+      def enum_for(attribute)
         self.enumerated_attributes[attribute.to_sym]
       end
 
@@ -62,13 +62,11 @@ module ActiveEnum
       #   user.sex(:enum)
       #
       def define_active_enum_read_method(attribute)
-        define_read_method(attribute, attribute.to_s, columns_hash[attribute.to_s]) unless instance_method_already_implemented?(attribute.to_s)
-        old_method = "#{attribute}_without_enum"
-        define_method("#{attribute}_with_enum") do |*arg|
+        define_method("#{attribute}") do |*arg|
           arg = arg.first
-          value = send(old_method)
+          value = super()
 
-          enum = self.class.active_enum_for(attribute)
+          enum = self.class.enum_for(attribute)
           case arg
           when :id
             value if enum[value]
@@ -80,8 +78,6 @@ module ActiveEnum
             ActiveEnum.use_name_as_value ? enum[value] : value
           end
         end
-
-        alias_method_chain attribute, :enum
       end
 
       # Define write method to also handle enum value
@@ -90,19 +86,15 @@ module ActiveEnum
       #   user.sex = :male
       #
       def define_active_enum_write_method(attribute)
-        define_write_method(attribute) unless instance_method_already_implemented?("#{attribute}")
-        old_method = "#{attribute}_without_enum="
-        define_method("#{attribute}_with_enum=") do |arg|
-          enum = self.class.active_enum_for(attribute)
+        define_method("#{attribute}=") do |arg|
+          enum = self.class.enum_for(attribute)
           if arg.is_a?(Symbol)
             value = enum[arg]
-            send(old_method, value)
+            super(value)
           else
-            send(old_method, arg)
+            super(arg)
           end
         end
-
-        alias_method_chain :"#{attribute}=", :enum
       end
 
       # Define question method to check enum value against attribute value
@@ -110,18 +102,14 @@ module ActiveEnum
       #   user.sex?(:male)
       #
       def define_active_enum_question_method(attribute)
-        define_question_method(attribute) unless instance_method_already_implemented?("#{attribute}?")
-
-        old_method = "#{attribute}_without_enum?"
-        define_method("#{attribute}_with_enum?") do |*arg|
+        define_method("#{attribute}?") do |*arg|
           arg = arg.first
           if arg
-            send(attribute) == self.class.active_enum_for(attribute)[arg]
+            send(attribute) == self.class.enum_for(attribute)[arg]
           else
-            send(old_method)
+            super
           end
         end
-        alias_method_chain :"#{attribute}?", :enum
       end
 
     end

data/lib/active_enum/form_helpers/formtastic.rb

@@ -0,0 +1,14 @@
+module ActiveEnum
+  module FormHelpers
+    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
+end
+
+Formtastic::SemanticFormBuilder.send :include, ActiveEnum::FormHelpers::Formtastic

data/lib/active_enum/form_helpers/simple_form.rb

@@ -0,0 +1,18 @@
+module ActiveEnum
+  module FormHelpers
+    class SimpleForm < SimpleForm::Inputs::CollectionInput
+
+      def initialize(builder)
+        super
+        raise "Attribute '#{attribute_name}' has no enum class" unless enum = object.class.enum_for(attribute_name)
+        builder.options[:collection] = enum.to_select
+      end
+      
+    end
+  end
+end
+
+SimpleForm::FormBuilder.class_eval do
+  map_type :enum, :to => ActiveEnum::FormHelpers::SimpleForm
+  alias_method :collection_enum, :collection_select
+end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.6.6'
+  VERSION = '0.7.0'
 end

data/spec/active_enum/extensions_spec.rb

@@ -17,23 +17,23 @@ describe ActiveEnum::Extensions do
     ActiveRecord::Base.should respond_to(:enumerate)
   end
 
-  it 'should add class :active_enum_for method to ActiveRecord' do
-    ActiveRecord::Base.should respond_to(:active_enum_for)
+  it 'should add class :enum_for method to ActiveRecord' do
+    ActiveRecord::Base.should respond_to(:enum_for)
   end
 
   it 'should allow multiple attributes to be enumerated with same enum' do
     Person.class_eval do
       enumerate :attending, :staying, :with => Accepted
     end
-    Person.active_enum_for(:attending).should == Accepted
-    Person.active_enum_for(:staying).should == Accepted
+    Person.enum_for(:attending).should == Accepted
+    Person.enum_for(:staying).should == Accepted
   end
 
   it 'should allow implicit enumeration class from attribute name' do
     Person.class_eval do
       enumerate :sex
     end
-    Person.active_enum_for(:sex).should == Sex
+    Person.enum_for(:sex).should == Sex
   end
 
   it 'should create enum namespaced enum class from block' do
@@ -42,7 +42,7 @@ describe ActiveEnum::Extensions do
         value :id => 1, :name => 'Male'
       end
     end
-    Person.active_enum_for(:sex).should == ::Person::Sex
+    Person.enum_for(:sex).should == Person::Sex
   end
 
   it 'should raise error if implicit enumeration class cannot be found' do

data/spec/active_enum/form_helpers/formtastic_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'formtastic'
+require 'active_enum/form_helpers/formtastic'
+
+describe ActiveEnum::FormHelpers::Formtastic do
+  include RSpec::Rails::HelperExampleGroup
+  include Formtastic::SemanticFormHelper
+
+  before do
+    reset_class Person do
+      enumerate :sex do
+        value :id => 1, :name => 'Male'
+        value :id => 2, :name => 'Female'
+      end
+    end
+  end
+
+  it "should use enum class for select option values for enum input type" do
+    output = semantic_form_for(Person.new, :url => people_path) do |f|
+      concat f.input(:sex, :as => :enum)
+    end
+    output.should have_selector('select#person_sex')
+    output.should have_xpath('//option[@value=1]', :content => 'Male')
+    output.should have_xpath('//option[@value=2]', :content => 'Female')
+  end
+
+  it "should raise error if attribute for enum input is not enumerated" do
+    lambda {
+      semantic_form_for(Person.new, :url => people_path) {|f| f.input(:attending, :as => :enum) }
+    }.should raise_error "Attribute 'attending' has no enum class"
+  end
+
+  def people_path
+    '/people'
+  end
+end

data/spec/active_enum/form_helpers/simple_form_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'simple_form'
+require 'active_enum/form_helpers/simple_form'
+
+describe ActiveEnum::FormHelpers do
+  include RSpec::Rails::HelperExampleGroup
+  include SimpleForm::ActionViewExtensions::FormHelper
+
+  before do
+    controller.stub!(:action_name).and_return('new')
+    reset_class Person do
+      enumerate :sex do
+        value :id => 1, :name => 'Male'
+        value :id => 2, :name => 'Female'
+      end
+    end
+  end
+
+  it "should use enum class for select option values for enum input type" do
+    output = simple_form_for(Person.new, :url => people_path) do |f|
+      concat f.input(:sex, :as => :enum)
+    end
+    output.should have_selector('select#person_sex')
+    output.should have_xpath('//option[@value=1]', :content => 'Male')
+    output.should have_xpath('//option[@value=2]', :content => 'Female')
+  end
+
+  it "should raise error if attribute for enum input is not enumerated" do
+    lambda {
+      simple_form_for(Person.new, :url => people_path) {|f| f.input(:attending, :as => :enum) }
+    }.should raise_error(StandardError, "Attribute 'attending' has no enum class")
+  end
+
+  def people_path
+    '/people'
+  end
+end

data/spec/spec_helper.rb

@@ -2,7 +2,8 @@ $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'spec'))
 
 require 'rubygems'
-require 'spec/autorun'
+require 'rspec/autorun'
+require 'rspec/rails'
 
 require 'active_record'
 require 'active_enum'
@@ -27,6 +28,6 @@ module SpecHelper
   end
 end
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.include SpecHelper
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 6
-  version: 0.6.6
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,7 +15,7 @@ autorequire: active_enum
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +10:00
+date: 2010-06-24 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -34,13 +34,15 @@ 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/form_helpers/formtastic.rb
+- lib/active_enum/form_helpers/simple_form.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/form_helpers/formtastic_spec.rb
+- spec/active_enum/form_helpers/simple_form_spec.rb
 - spec/active_enum_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/lib/active_enum/formtastic.rb

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

data/spec/active_enum/formtastic_spec.rb

@@ -1,59 +0,0 @@
-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