enumitation 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in enumitation.gemspec
+gemspec

data/README.md

@@ -0,0 +1,87 @@
+# Enumitation
+
+<img src="http://upload.wikimedia.org/wikipedia/commons/c/c7/Kanikama.jpg" width="400" height="300"/>
+
+## What is it?
+
+**enum + imitation = Enumitation**
+
+## Why?
+
+Ever wanted to restrict an ActiveRecord attribute to specific values, but thought a
+join table to contain the values and a foreign key constraint were overkill?  Well, you
+could opt for an enum field, but maybe your DBMS doesn't support enums.  Or maybe it does,
+but you just aren't in the mood for an enum field today.
+
+Also, do you need to provide these values for options in a select field
+in a form?
+
+Enumitation exists to allow restrictions on ActiveRecord attribute values without
+the need for a join table or enum field, while also providing those values for
+the purpose of options in a select field in a form.
+
+## Example
+
+    class Publisher < ActiveRecord::Base
+      enumitation :location, %w[US CA]
+    end
+
+Here we've specified that we want the `location` attribute to be an enum
+with the values *US* and *CA*.  The `enumitation` method does two
+important things:
+
+* it adds a `validates_inclusion_of` validation to the model, using the
+  values specified when declaring the enumitation
+* it provides a `select_options_for` method that can be used to provide
+  a select tag with options
+
+In the console:
+
+    publisher = Publisher.new location: 'MX'
+    publisher.valid?   #=> false
+    publisher.errors   #=> {:location=>["is not included in the list"]}
+    publisher.location = 'US'   #=> "US"
+    publisher.valid?   #=> true
+
+    Publisher.select_options_for :location   #=> [["US", "US"], ["CA", "CA"]]
+
+## Custom Labels (i18n)
+
+You can provide alternate labels for your values in your locale files.
+These labels will be returned from the `select_options_for` method.
+
+In *config/locales/en.yml*:
+
+    en:
+      enumitation:
+        models:
+          publisher:
+            location:
+              US: 'United States'
+              CA: 'Canada'
+
+Now when calling the `select_options_for` method:
+
+    Publisher.select_options_for :location   #=> [["United States", "US"], ["Canada", "CA"]]
+
+So, from your view:
+
+    = form_for :publisher do |f|
+      = f.select :location, Publisher.select_options_for(:location)
+
+### But this is no big deal!
+
+I know.  It really isn't that big of a deal, and it wouldn't take that
+much effort to reproduce by hand what Enumitation provides.  But why do
+all that work when you can get it from a one-liner?
+
+
+### There are other gems that practically do the same thing.
+
+True, but the ones I found either didn't fit my needs or they did so much more than I needed.
+I wanted something that fit my needs exactly and nothing more.
+
+## Contributing
+
+If you think Enumitation could be better, fork away and send a pull
+request!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/enumitation.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "enumitation/version"
+
+Gem::Specification.new do |s|
+  s.name        = "enumitation"
+  s.version     = Enumitation::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chad Boyd"]
+  s.email       = ["hoverlover@gmail.com"]
+  s.homepage    = "http://github.com/hoverlover/enumitation"
+  s.summary     = %q{Fake enums for ActiveModel}
+  s.description = <<DESC
+Ever wanted to restrict an attribute to specific values, but not wanted to
+create a join table to hold the values, and didn't want (or couldn't) create
+an enum field?  Now you can, with enumitation!
+DESC
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_development_dependency('rspec', '> 2')
+  s.add_development_dependency('rr', '>= 1.0.2')
+  s.add_development_dependency('activerecord', '> 3')
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/enumitation/class_methods.rb

@@ -0,0 +1,39 @@
+module Enumitation
+  module ClassMethods
+
+    def self.extended(base)
+      class << base
+        attr_accessor :enumitation_values
+      end
+
+      base.enumitation_values = {}
+    end
+
+    def enumitation(attribute, values)
+      enumitation_values[attribute] = Array(values)
+      add_inclusion_validation(attribute, values)
+    end
+
+    def select_options_for(attribute)
+      return [] if enumitation_values.empty?
+
+      enumitation_values[attribute].map do |val|
+        [display_value(attribute, val), val]
+      end
+    end
+
+    private
+
+    def display_value(attribute, val)
+      # Try looking up using i18n.  If nothing found, just return the val.
+
+      I18n.t(val,
+             :scope => "enumitation.models.#{self.name.underscore}.#{attribute.to_s.underscore}",
+             :default => val)
+    end
+
+    def add_inclusion_validation(attribute, values)
+      self.validates_inclusion_of attribute, :in => values
+    end
+  end
+end

data/lib/enumitation/version.rb

@@ -0,0 +1,3 @@
+module Enumitation
+  VERSION = "0.0.1"
+end

data/lib/enumitation.rb

@@ -0,0 +1,10 @@
+module Enumitation
+  autoload :ClassMethods, 'enumitation/class_methods'
+
+  ActiveRecord::Base.class_eval do
+    def self.inherited(subclass)
+      subclass.extend ClassMethods
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: enumitation
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chad Boyd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "2"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :development
+  version_requirements: *id003
+description: |
+  Ever wanted to restrict an attribute to specific values, but not wanted to
+  create a join table to hold the values, and didn't want (or couldn't) create
+  an enum field?  Now you can, with enumitation!
+
+email: 
+- hoverlover@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- enumitation.gemspec
+- lib/enumitation.rb
+- lib/enumitation/class_methods.rb
+- lib/enumitation/version.rb
+has_rdoc: true
+homepage: http://github.com/hoverlover/enumitation
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Fake enums for ActiveModel
+test_files: []
+