daeltar-enum_field 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+pkg
+rdoc
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 James Golick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the enum_field plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "enum_field"
+    s.summary = %Q{ActiveRecord enum fields on steroid}
+    s.email = "james@giraffesoft.ca"
+    s.homepage = "http://github.com/giraffesoft/enum_field"
+    s.description = "enum_field encapsulates a bunch of common idioms around ActiveRecord validates_inclusion_of"
+    s.authors = ["James Golick", "Mathieu Martin"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Generate documentation for the enum_field plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'enum_field'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+

data/VERSION.yml

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

data/enum_field.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enum_field}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick", "Mathieu Martin"]
+  s.date = %q{2009-06-26}
+  s.description = %q{enum_field encapsulates a bunch of common idioms around ActiveRecord validates_inclusion_of}
+  s.email = %q{james@giraffesoft.ca}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "enum_field.gemspec",
+     "init.rb",
+     "lib/enum_field.rb",
+     "rails/init.rb",
+     "test/enum_field_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/giraffesoft/enum_field}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{ActiveRecord enum fields on steroid}
+  s.test_files = [
+    "test/enum_field_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.class_eval { include EnumField }

data/lib/enum_field.rb

@@ -0,0 +1,45 @@
+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] || I18n.translate('activerecord.errors.messages.invalid')
+      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
+      end
+  
+      validates_inclusion_of field, :in => possible_values, :message => message
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include EnumField }

data/rails/init.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Base.class_eval { include EnumField }
+

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 => "is invalid")
+      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,64 @@
+--- !ruby/object:Gem::Specification 
+name: daeltar-enum_field
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- James Golick
+- Mathieu Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-26 00:00:00 -07: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: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- enum_field.gemspec
+- init.rb
+- lib/enum_field.rb
+- rails/init.rb
+- test/enum_field_test.rb
+has_rdoc: true
+homepage: http://github.com/giraffesoft/enum_field
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 2
+summary: ActiveRecord enum fields on steroid
+test_files: 
+- test/enum_field_test.rb