enum_simulator 1.0.4

data/Gemfile

@@ -0,0 +1,8 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'echoe'
+gem 'rspec'
+gem 'activerecord'
+gem 'sqlite3'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,15 @@
+Gemfile
+MIT-LICENSE
+README.rdoc
+Rakefile
+enum_simulator.gemspec
+init.rb
+install.rb
+lib/enum_simulator.rb
+spec/enum_simulator_spec.rb
+spec/resources/schema
+spec/spec_helper.rb
+spec/support/models/other_thingies.rb
+spec/support/models/thingy.rb
+uninstall.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,29 @@
+= EnumSimulator
+
+A simple plugin for abstracting out standard ActiveRecord enumerated attributes
+
+== Installation
+
+Let bundler do all the work for you by adding this to your Gemfile:
+
+  gem 'enum_simulator'
+
+And then execute:
+
+  bundle install
+
+Or install it manually:
+
+  sudo gem install enum_simulator
+
+== Example
+
+In order to mark an AR attribute as enumerated, make sure the column in question is a string and large enough to accommodate the string representation of your largest possible value. Then, in the model file, just call "enum", passing it the symbol of the attribute and an array of symbols you'd like to describe as the possible values:
+
+  class IceCream < ActiveRecord::Base
+    enum :flavor, [:chocolate, :vanilla, :strawberry, :rockyroad]
+  end
+
+enum_simulator will handle validation of inclusion and conversion of the attribute values from symbols to strings and back internally. Honestly, that's really all it does - it's just such a common pattern that I figured we might as well have a more succinct way of using it.  It will infer whether or not to allow assignment of nil to your attribute from the column definition.
+
+Copyright (c) 2012 Centresource, released under the MIT license

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'echoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the enum_simulator plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the enum_simulator plugin.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EnumSimulator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Echoe.new('enum_simulator', '1.0.4') do |p|
+  p.description     = 'A simple plugin for abstracting out standard ActiveRecord enumerated attributes.'
+  p.url             = 'https://github.com/centresource/enum_simulator.git'
+  p.author          = ['Jeremy Holland', 'Brandon Valentine']
+  p.email           = ['jeremy@jeremypholland.com', 'brandon@brandonvalentine.com']
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/enum_simulator.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "enum_simulator"
+  s.version = "1.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Holland, Brandon Valentine"]
+  s.date = "2012-09-15"
+  s.description = "A simple plugin for abstracting out standard ActiveRecord enumerated attributes."
+  s.email = ["jeremy@jeremypholland.com", "brandon@brandonvalentine.com"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/enum_simulator.rb"]
+  s.files = ["Gemfile", "MIT-LICENSE", "README.rdoc", "Rakefile", "enum_simulator.gemspec", "init.rb", "install.rb", "lib/enum_simulator.rb", "spec/enum_simulator_spec.rb", "spec/resources/schema", "spec/spec_helper.rb", "spec/support/models/other_thingies.rb", "spec/support/models/thingy.rb", "uninstall.rb", "Manifest"]
+  s.homepage = "https://github.com/centresource/enum_simulator.git"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Enum_simulator", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "enum_simulator"
+  s.rubygems_version = "1.8.24"
+  s.summary = "A simple plugin for abstracting out standard ActiveRecord enumerated attributes."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:active_record) do
+  include EnumSimulator
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/enum_simulator.rb

@@ -0,0 +1,34 @@
+# EnumSimulator
+module EnumSimulator
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def enum(attr, values)
+      values << nil if self.columns_hash[attr.to_s].respond_to? :null and self.columns_hash[attr.to_s].null
+      @enumerated_attributes ||= {}
+      @enumerated_attributes[attr] = values
+      validates_inclusion_of attr, :in => values
+
+      class_eval <<RUBY
+        def #{attr}
+          read_attribute(:#{attr}).to_sym if read_attribute(:#{attr})
+        end
+
+        def #{attr}=(value)
+          value = value.to_s unless value.nil?
+          write_attribute(:#{attr},value)
+        end
+RUBY
+    end
+
+    def enumerated_attributes
+      @enumerated_attributes
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include EnumSimulator
+end

data/spec/enum_simulator_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe EnumSimulator do
+  describe "enum" do
+    it "should define an enum method on all classes" do
+      Thingy.should respond_to(:enum)
+      OtherThingy.should respond_to(:enum)
+    end
+
+    it "should cast incoming assignments of symbols to strings" do
+      x = Thingy.new
+      x.flavor = :cork
+      x.send(:read_attribute,:flavor).should == 'cork'
+    end
+
+    it "should cast internal representation of strings to symbols" do
+      x = Thingy.new
+      x.send(:write_attribute,:flavor,'basket')
+      x.flavor.should == :basket
+    end
+
+    it "should return nil if the value is nil" do
+      x = Thingy.new
+      x.flavor.should == nil
+    end
+
+    it "should require the symbolized value of the attribute specified in the first argument to be a member of the array passed as the second argument" do
+      x = Thingy.new
+      x.should { validate_inclusion_of :flavor, :in => [:sweet, :sour, :salty, :bitter, :umami] }
+    end
+
+    it "should require a value for the attribute if the column definition does not allow null" do
+      lambda { x = Thingy.create! }.should raise_error ActiveRecord::RecordInvalid
+    end
+
+    it "should allow the setting of an attribute to nil if the column definition allows null" do
+      lambda { x = Thingy.create! :flavor => :sweet }.should_not raise_error
+    end
+  end
+
+  describe "enumerated_attributes" do
+    it "should define an enumerated_attributes method on all classes" do
+      Thingy.should respond_to(:enumerated_attributes)
+      OtherThingy.should respond_to(:enumerated_attributes)
+    end
+
+    it "should be nil for a class without any enumerated attributes" do
+      OtherThingy.enumerated_attributes.should be_nil
+    end
+
+    it "should return a hash, keyed with the names of all enumerated attributes" do
+      Thingy.enumerated_attributes.should be_a(Hash)
+      Thingy.enumerated_attributes.should have_key(:flavor)
+    end
+
+    describe "each item" do
+      it "should be an array of all possible enumerable values for the key in question" do
+        Thingy.enumerated_attributes[:flavor].should include(:sweet)
+        Thingy.enumerated_attributes[:flavor].should include(:salty)
+        Thingy.enumerated_attributes[:flavor].should include(:sour)
+        Thingy.enumerated_attributes[:flavor].should include(:bitter)
+        Thingy.enumerated_attributes[:flavor].should include(:umami)
+        Thingy.enumerated_attributes[:flavor].should_not include(:magic)
+        Thingy.enumerated_attributes[:flavor].should_not include(:corned_beef)
+      end
+
+      it "should conditionally include nil in array of possible enumerable values when column allows null" do
+        Thingy.enumerated_attributes[:flavor].should_not include(nil)
+        Thingy.enumerated_attributes[:smell].should include(nil)
+      end
+    end
+  end
+end

data/spec/resources/schema

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :thingies, :force => true do |t|
+    t.string :flavor, :null => false
+    t.string :smell
+    t.timestamps
+  end
+  create_table :other_thingies, :force => true do |t|
+    t.string :taste
+    t.timestamps
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+
+def prep_db
+  dir = File.dirname(__FILE__)
+  ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ":memory:"}}
+  ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+  ActiveRecord::Migration.verbose = false
+
+  load "#{dir}/resources/schema"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'active_record'
+require 'enum_simulator'
+
+prep_db
+
+require File.dirname(__FILE__)+'/../init.rb'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/models/other_thingies.rb

@@ -0,0 +1,2 @@
+class OtherThingy < ActiveRecord::Base
+end

data/spec/support/models/thingy.rb

@@ -0,0 +1,4 @@
+class Thingy < ActiveRecord::Base
+  enum :flavor, [:salty, :sweet, :bitter, :sour, :umami]
+  enum :smell, [:floral, :sulphorous, :smoky, :stale]
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: enum_simulator
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Holland, Brandon Valentine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-15 00:00:00.000000000 Z
+dependencies: []
+description: A simple plugin for abstracting out standard ActiveRecord enumerated
+  attributes.
+email:
+- jeremy@jeremypholland.com
+- brandon@brandonvalentine.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- lib/enum_simulator.rb
+files:
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- enum_simulator.gemspec
+- init.rb
+- install.rb
+- lib/enum_simulator.rb
+- spec/enum_simulator_spec.rb
+- spec/resources/schema
+- spec/spec_helper.rb
+- spec/support/models/other_thingies.rb
+- spec/support/models/thingy.rb
+- uninstall.rb
+- Manifest
+homepage: https://github.com/centresource/enum_simulator.git
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Enum_simulator
+- --main
+- README.rdoc
+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: '1.2'
+requirements: []
+rubyforge_project: enum_simulator
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple plugin for abstracting out standard ActiveRecord enumerated attributes.
+test_files: []