markcatley-enum_field 0.1.1.0.1

data/README.rdoc

@@ -0,0 +1,32 @@
+= EnumField
+
+Macro to emulate a MySQL enum_field type thing.
+
+== Usage
+
+This plugin encapsulates a validates_inclusion_of and automatically gives you a 
+few more goodies automatically. That's it!
+
+    class Computer < ActiveRecord:Base
+      enum_field :status, ['on', 'off', 'standby', 'sleep', 'out of this world']
+
+      # Optionally with a message to replace the default one
+      # enum_field :status, ['on', 'off', 'standby', 'sleep', 'out of this world'], :message => "incorrect status"
+
+      #...
+    end
+
+This will give you a few things:
+
+- add a validates_inclusion_of with a simple error message ("invalid #{field}") or your custom message
+- define the following query methods, in the name of expressive code:
+  - on?
+  - off?
+  - standby?
+  - sleep?
+  - out_of_this_world?
+- define the STATUSES constant, which contains the acceptable values
+
+= License
+
+Copyright (c) 2008 James Golick, released under the MIT license

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/lib/enum_field.rb

@@ -0,0 +1,47 @@
+module EnumField
+  def self.included(klass)
+    klass.class_eval { extend EnumField::ClassMethods }
+  end
+  
+  module ClassMethods
+    # enum_field encapsulates a validates_inclusion_of and automatically gives you a 
+    # few more goodies automatically.
+    # 
+    #     class Computer < ActiveRecord:Base
+    #       enum_field :status, ['on', 'off', 'standby', 'sleep', 'out of this world']
+    # 
+    #       # Optionally with a message to replace the default one
+    #       # enum_field :status, ['on', 'off', 'standby', 'sleep'], :message => "incorrect status"
+    # 
+    #       #...
+    #     end
+    # 
+    # This will give you a few things:
+    # 
+    # - add a validates_inclusion_of with a simple error message ("invalid #{field}") or your custom message
+    # - define the following query methods, in the name of expressive code:
+    #   - on?
+    #   - off?
+    #   - standby?
+    #   - sleep?
+    #   - out_of_this_world?
+    # - define the STATUSES constant, which contains the acceptable values
+    def enum_field(field, possible_values, options={})
+      message = options[:message] || "invalid #{field}"
+      const_set field.to_s.pluralize.upcase, possible_values unless const_defined?(field.to_s.pluralize.upcase)
+  
+      possible_values.each do |current_value|
+        method_name = current_value.downcase.gsub(/[-\s]/, '_')
+        define_method("#{method_name}?") do
+          self.send(field) == current_value
+        end
+        
+        if respond_to? :named_scope
+          named_scope method_name, :conditions => {field => current_value}
+        end
+      end
+  
+      validates_inclusion_of field, :in => possible_values, :message => message
+    end
+  end
+end

data/test/enum_field_test.rb

@@ -0,0 +1,104 @@
+$LOAD_PATH.reject! { |path| path.include?('TextMate') }
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'mocha'
+require 'shoulda'
+require 'active_record'
+require File.dirname(__FILE__)+'/../lib/enum_field'
+require File.dirname(__FILE__)+'/../init'
+
+class MockedModel; include EnumField; end;
+
+class EnumFieldTest < Test::Unit::TestCase
+  context "with a simple gender enum" do
+    setup do
+      @possible_values = %w( male female )
+      MockedModel.expects(:validates_inclusion_of).with(:gender, :in => @possible_values, :message => "invalid gender")
+      MockedModel.send(:enum_field, :gender, @possible_values)
+    end
+  
+    should "create constant with possible values named as pluralized field" do
+      assert_equal @possible_values, MockedModel::GENDERS
+    end
+    
+    should "create query methods for each enum type" do
+      model = MockedModel.new
+      
+      model.stubs(:gender).returns("male")
+      assert model.male?
+      assert !model.female?
+      model.stubs(:gender).returns("female")
+      assert !model.male?
+      assert model.female?
+    end
+    
+    should "extend active record base with method" do
+      assert_respond_to ActiveRecord::Base, :enum_field
+    end
+  end
+
+  context "Specifying a message" do
+    setup do
+      @possible_values = %w(on off)
+      MockedModel.expects(:validates_inclusion_of).with(:status, :in => @possible_values, :message => "custom insult")
+    end
+
+    should "override the default message" do
+      MockedModel.send(:enum_field, :status, @possible_values, :message => 'custom insult')
+    end
+  end
+
+  context "With an enum containing multiple word choices" do
+    setup do
+      MockedModel.stubs(:validates_inclusion_of)
+      MockedModel.send :enum_field, :field, ['choice one', 'choice-two', 'other']
+      @model = MockedModel.new
+    end
+
+    should "define an underscored query method for the multiple word choice" do
+      assert_respond_to @model, :choice_one?
+    end
+
+    should "define an underscored query method for the dasherized choice" do
+      assert_respond_to @model, :choice_two?
+    end
+  end
+
+  context "With an enum containing mixed case choices" do
+    setup do
+      MockedModel.stubs(:validates_inclusion_of)
+      MockedModel.send :enum_field, :field, ['Choice One', 'ChoiceTwo', 'Other']
+      @model = MockedModel.new
+    end
+
+    should "define a lowercase, underscored query method for the multiple word choice" do
+      assert_respond_to @model, :choice_one?
+    end
+
+    should "define a lowercase query method for the camelcase choice" do
+      assert_respond_to @model, :choicetwo?
+    end
+  end
+
+  context "With an enum containing strange characters" do
+    setup do
+      MockedModel.stubs(:validates_inclusion_of)
+      MockedModel.send :enum_field, :field, ['choice%one', 'choice☺two', 'other.']
+      @model = MockedModel.new
+    end
+
+    should "define a normal query method for the unicode choice" do
+      assert_respond_to @model, :choice_two?
+    end
+
+    should "define a normal query method for the % choice" do
+      assert_respond_to @model, :choice_one?
+    end
+
+    should "define a query method without the trailing punctuation for the other choice" do
+      assert_respond_to @model, :other?
+    end
+  end
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: markcatley-enum_field
+version: !ruby/object:Gem::Version 
+  version: 0.1.1.0.1
+platform: ruby
+authors: 
+- James Golick
+- Mathieu Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-01 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: enum_field encapsulates a bunch of common idioms around ActiveRecord validates_inclusion_of
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/enum_field.rb
+- test/enum_field_test.rb
+has_rdoc: false
+homepage: http://github.com/giraffesoft/enum_field
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ActiveRecord enum fields on steroid
+test_files: []
+