mcommons-enum_for 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mal McKay and Justin S. Leitgeb
+
+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,63 @@
+= Enum For
+
+enum_for makes your ActiveRecord-backed class work with an enumerable type.  Instead of existing 
+ActiveRecord plugins such as enum_fu, which store the enumerable attribute as an integer, enum_for 
+stores the content of the enumerable attribute in a varchar column of the database.
+
+It also defines certain useful methods on your model.  For example, if you declare :state to be
+an enumerable column, enum_fu allow you to see the valid states by calling the method "states"
+(note the automatically pluralized form) on the class.
+
+enum_fu defines constants corresponding to each of the valid enumerable types on your model.  For example, 
+if you have an enumerable column called "states" with valid states :starting and :finished, enum_fu would
+define constants on your model Model::STATE_STARTING and Model::STATE_FINISHED with the contents of these 
+constants :starting and :finished respectively.
+
+enum_fu also creates predicate methods on instances of your class so that you can ask if they have any
+of the given enumerable states.  For example, if a Taco class has an enumerable type :taste with values
+:good and :bad, taco.good? would return a boolean value indicating whether or not the taste is good.
+
+Finally, enum_fu creates named scopes on your model, so that you can easily find all records belonging to 
+a given enumerable type.  Following the above example, Taco.taste_good would return all tacos that taste
+good.
+
+== Installation
+
+enum_for is available as a gem available on GitHub.  Install with:
+
+  sudo gem install mcommons-enum_for
+
+You'll probable want a line like the following in your environment.rb:
+
+  config.gem "enum_for"
+
+== Examples
+
+Sets up a basic enumerable attribute on an ActiveRecord model.  This assumes that a previous
+migration has created a column of type VARCHAR on the table "taco".
+
+  class Taco < ActiveRecord::Base
+    enum_for :state, :has => [ :new, :composed, :served, :eaten ]
+  end
+  
+To query all eaten tacos using the automatically-generated named scopes:
+
+  Taco.state_eaten
+  
+To find out valid states on a model:
+
+  Taco.states
+  
+To create an enumerable type on a model, overriding the default prefix given to named_scopes:
+
+  class Taco < ActiveRecord::Base
+    enum_for :state, :has => [ :new, :composed, :served, :eaten ], :prefix => 'wacky'
+  end
+  
+This makes Taco respond to named scopes like Taco.wacky_composed instead of the default, which
+would have prefixed the named_scopes with the name of the attribute.  Note that this feature 
+also allows for the prefix to be omitted entirely if the value 'nil' is given instead of a String.
+
+== Authors
+
+Mal McKay, Justin Leitgeb and Ben Stein

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+desc 'Test the plugin.'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.verbose = true
+end
+
+desc "Run all the tests"
+task :default => :spec
+
+desc 'Generate documentation for the enum_for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Enum For'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/enum_for.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{enum_for}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mal McKay and Justin Leitgeb"]
+  s.date = %q{2009-06-17}
+  s.description = %q{Adds an enumerable attribute to an ActiveRecord-backed class}
+  s.email = %q{justin@mobilecommons.com}
+  
+  s.files = ["enum_for.gemspec", "lib/enum_for.rb", "LICENSE", "Rakefile", "README.rdoc", "spec/enum_for_spec.rb", "spec/spec_helper.rb"]
+  
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/mcommons/enum_for}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Adds an enumerable attribute to an ActiveRecord-backed class}
+  s.test_files = ["spec/enum_for_spec.rb", "spec/spec_helper.rb"]
+
+  s.extra_rdoc_files = [ "README.rdoc" ]
+  
+  s.rdoc_options += [
+    '--title', 'Enum For',
+    '--main', 'README.rdoc',
+    '--line-numbers',
+    '--inline-source'
+   ]
+
+  %w[ activerecord activesupport ].each do |dep|
+    s.add_dependency(dep)
+  end
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+  end
+end

data/lib/enum_for.rb

@@ -0,0 +1,55 @@
+module EnumFor
+
+  def self.included(base)
+    base.extend(SingletonMethods)
+  end
+
+  module SingletonMethods
+
+    # Creates an enumerable attribute on an ActiveRecord model.  Usage is as follows:
+    #   enum_for :state, :has => [ :new, :composed, :served, :eaten ]
+    # Any additional options will be passed directly to the ActiveRecord method 
+    # :validates_inclusion_of, which is used to validate the assigned values to this
+    # attribute.  Requires a column of type VARCHAR with the name of the first argument
+    # to +enum_for+.
+    def enum_for(*args)
+      options   = args.extract_options!
+      attribute = args.first
+      
+      plural_attribute = attribute.to_s.pluralize
+      validates_inclusion_of attribute, options.except(:has, :prefix).merge(:in => options[:has].map{|v| v.to_s})
+      const_set(plural_attribute.upcase, options[:has])
+      
+      prefix = options.has_key?(:prefix) ? options[:prefix] : attribute.to_s
+      
+      prefixed_values = options[:has].map{|v| [[prefix, v].compact.join('_'), v] }
+      
+      prefixed_values.each do |pv, v|
+        # Set constants for values
+        const_set(pv.upcase, v)
+        
+        # Create named scope for this value
+        named_scope pv, :conditions => { attribute => v.to_s }
+
+        # Create predicate methods for values
+        unless self.instance_methods.include?(pv)
+          define_method("#{pv}?") do
+            read_attribute(attribute) == v.to_s
+          end
+        end
+      end
+
+      # Define a custom setter method which casts input to a String.  Since we present the configuration
+      # of enum_fu using Symbols, this makes sense to provide to the user.
+      define_method("#{attribute}=") do |other|
+        self[attribute] = other.to_s
+      end
+      
+      cattr_reader plural_attribute.to_sym
+      class_variable_set(:"@@#{plural_attribute}", options[:has])    
+    end
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, EnumFor)

data/spec/enum_for_spec.rb

@@ -0,0 +1,120 @@
+require 'rubygems'
+require 'activerecord'
+
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :dbfile => ":memory:"
+)
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Schema.define do
+    create_table :tacos do |table|
+      table.string :state
+    end
+  end
+end
+
+class Taco < ActiveRecord::Base
+  enum_for :state, :has => [ :new, :composed, :served, :eaten ]
+end
+
+describe EnumFor do
+  before do
+    @taco = Taco.new(:state => 'new')
+  end
+  
+  it "should make a valid model when given a valid state" do
+    @taco.should be_valid
+  end
+  
+  it "should be valid when an attribute is set to a valid symbol" do
+    Taco.new(:state => :composed).should be_valid
+  end
+  
+  it "should not be valid when an attribute is set to an invalid symbol" do
+    Taco.new(:state => :bogus).should_not be_valid
+  end
+  
+  it "should not create a valid model when given an invalid state" do
+    Taco.create(:state => 'barfed').should_not be_valid
+  end
+  
+  it "should return all possible states when plural of the attribute is called" do
+    Taco::STATES.should == [ :new, :composed, :served, :eaten ]
+  end
+  
+  it "should return all possible states when plural of attribute is called as class method" do
+    Taco.states.should == [ :new, :composed, :served, :eaten ]
+  end
+  
+  it "should define constants for each type" do
+    Taco::STATE_EATEN.should == :eaten
+  end
+  
+  it "should define predicate methods for each valid state" do
+    @taco.state_eaten?
+  end
+
+  class Food < ActiveRecord::Base
+    set_table_name "tacos"
+    enum_for :state, :has => [:stuff, :morestuff], :prefix => nil
+  end
+  
+  it "should not prefix predicate methods if asked not to" do
+    Food.new(:state => :stuff).stuff?.should be_true
+  end
+  
+  it "should allow strings for attribute values even when initialized with symbols" do
+    Food.new(:state => 'stuff').should be_valid
+  end
+  
+  class Balloon < ActiveRecord::Base
+    set_table_name "tacos"
+    enum_for :state, :has => [:stuff, :morestuff], :prefix => nil
+    
+    def stuff?
+      "not a boolean"
+    end
+  end
+  
+  it "should not define a predicate method when a one already exists" do
+    Balloon.new(:state => :stuff).stuff?.should == "not a boolean"
+  end
+
+  describe "with validation options" do   
+    class Food2 < ActiveRecord::Base
+      set_table_name "tacos"
+      enum_for :state, :has => ['stuff', 'morestuff'], :prefix => nil, :allow_nil => true, :message => "is great!"
+    end
+
+    it "should allow validation message to be set" do
+      Food2.create(:state => :junk).errors.full_messages.should include('State is great!')
+    end
+    
+    it "should respect :allow_nil setting" do
+      Food2.new.should be_valid
+    end
+  end
+  
+  describe "named scope creation" do
+    before do
+      Taco.delete_all
+      
+      2.times { Taco.create(:state => 'new') }
+      3.times { Taco.create(:state => 'composed') }
+    end
+    
+    it "should have two new tacos" do
+      Taco.state_new.size.should == 2
+    end
+    
+    it "should have two composed tacos" do
+      Taco.state_composed.size.should == 3
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'mocha'
+require 'spec'
+
+require File.join(File.dirname(__FILE__), %w[.. lib enum_for])
+
+Spec::Runner.configure do |config|
+  config.mock_with(:mocha)
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: mcommons-enum_for
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Mal McKay and Justin Leitgeb
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Adds an enumerable attribute to an ActiveRecord-backed class
+email: justin@mobilecommons.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- enum_for.gemspec
+- lib/enum_for.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+- spec/enum_for_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mcommons/enum_for
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --title
+- Enum For
+- --main
+- README.rdoc
+- --line-numbers
+- --inline-source
+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: Adds an enumerable attribute to an ActiveRecord-backed class
+test_files: 
+- spec/enum_for_spec.rb
+- spec/spec_helper.rb