simple_enum 1.4.1 → 1.5.0

data/.gitignore

@@ -2,4 +2,3 @@ doc
 pkg
 *.rbc
 .*.sw?
-Gemfile.lock

data/.travis.yml

@@ -1,6 +1,10 @@
+env:
+  - ORM=active_record
+  - ORM=mongoid
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - rbx
-  - ree
+gemfile:
+  - gemfiles/rails-3.0.gemfile
+  - gemfiles/rails-3.1.gemfile
+  - gemfiles/rails-3.2.gemfile

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails-3.0" do
+  gem 'activesupport', '~> 3.0.9'
+  gem 'activerecord',  '~> 3.0.9'
+end
+
+appraise "rails-3.1" do
+  gem 'activesupport', '~> 3.1.0'
+  gem 'activerecord',  '~> 3.1.0'
+end
+
+appraise "rails-3.2" do
+  gem 'activesupport', '~> 3.2.0'
+  gem 'activerecord',  '~> 3.2.0'
+end

data/Gemfile

@@ -1,3 +1,9 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec
+
+# some development deps
+gem 'jdbc-sqlite3', :platform => :jruby
+
+gem 'sqlite3', :platform => :ruby
+gem 'bson_ext', :platform => :ruby

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    simple_enum (1.5.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+    activerecord (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.0)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.0)
+      bundler
+      rake
+    arel (3.0.0)
+    bson (1.5.2)
+    bson (1.5.2-java)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    jdbc-sqlite3 (3.7.2)
+    minitest (2.10.1)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.1)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  appraisal (>= 0.4)
+  bson_ext
+  jdbc-sqlite3
+  minitest (>= 2.3.0)
+  mongoid (~> 2.0)
+  rake (>= 0.9.2)
+  simple_enum!
+  sqlite3

data/README.rdoc

@@ -1,14 +1,14 @@
 = SimpleEnum - unobtrusive enum-like fields for ActiveRecord
 
 A Rails plugin which brings easy-to-use enum-like functionality to
-ActiveRecord models (now compatible with rails 3.1, ruby 1.9 and jruby).
+ActiveRecord and Mongoid models (now compatible with rails 3.1, ruby 1.9 and jruby).
 
 Since version 1.4, simple_enum is no longer compatible with activerecord 2.x, use
 version 1.3.2 instead: <https://github.com/lwe/simple_enum/tree/v1.3.2>.
 
 *Note*: a recent search on github for `enum` turned out, that there are many, many similar solutions.
 
-== Quick start
+== ActiveRecord Quick start
 
 Add this to a model:
 
@@ -16,7 +16,7 @@ Add this to a model:
       as_enum :gender, :female => 1, :male => 0
     end
 
-Then create the new column using migrations:
+Then create the required `gender_cd` column using migrations:
 
     class AddGenderColumnToUser < ActiveRecord::Migration
       def self.up
@@ -28,6 +28,24 @@ Then create the new column using migrations:
       end
     end
 
+== Mongoid Quick start
+
+Add this to an initializer
+
+     # load mongoid support
+     require 'simple_enum/mongoid'
+
+Add this to a model:
+
+    class User
+      include Mongoid::Document
+      include SimpleEnum::Mongoid
+
+      as_enum :gender, :female => 1, :male => 0
+    end
+
+== Working with enums
+
 *Done*. Now it's possible to pull some neat tricks on the new column, yet
 the original db column (+gender_cd+) is still intact and not touched by
 any fancy metaclass or similar.
@@ -64,6 +82,14 @@ useful when creating queries, displaying option elements or similar:
   *Disclaimer*: if you _ever_ decide to reorder this array, beaware that any previous mapping is lost. So it's recommended
   to create mappings (that might change) using hashes instead of arrays. For stuff like gender it might be probably perfectly
   fine to use arrays though.
+* Want to use `SimpleEnum` in an ActiveModel, or other class, just do:
+
+        class MyModel
+          include SimpleEnum
+          attr_accessor :gender_cd
+          as_enum :gender, [:male, :female]
+        end
+
 * Maybe you've columns named differently than the proposed <tt>{column}_cd</tt> naming scheme, feel free to use any column name
   by providing an option:
 
@@ -71,6 +97,15 @@ useful when creating queries, displaying option elements or similar:
           as_enum :gender, [:male, :female], :column => 'sex'
         end
 
+* Need to provide custom options for the mongoid field, or skip the automatically generated field?
+
+        # skip field generation
+        field :gender_cd # <- create field manually (!)
+        as_enum :gender, [:male, :female], :field => false
+
+        # custom field options (directly passed to Mongoid::Document#field)
+        as_enum :gender, [:male, :female], :field => { :type => Integer, :default => 1 }
+
 * To make it easier to create dropdowns with values use:
 
         <%= select(:user, :gender, User.genders.keys) %>
@@ -99,7 +134,8 @@ useful when creating queries, displaying option elements or similar:
   The <tt>:prefix</tt> option not only takes a boolean value as an argument, but instead can also be supplied a custom
   prefix (i.e. any string or symbol), so with <tt>:prefix => 'foo'</tt> all shortcut methods would look like: <tt>foo_<symbol>...</tt>
   *Note*: if the <tt>:slim => true</tt> is defined, this option has no effect whatsoever (because no shortcut methods are generated).
-* Sometimes it might be useful to disable the generation of the shortcut methods (<tt><symbol>?</tt>, <tt><symbol>!</tt> and <tt>Klass.<symbol></tt>), to do so just add the option <tt>:slim => true</tt>:
+* Sometimes it might be useful to disable the generation of the shortcut methods (<tt><symbol>?</tt>, <tt><symbol>!</tt> and <tt>Klass.<symbol></tt>),
+  to do so just add the option <tt>:slim => true</tt>:
 
         class User < ActiveRecord::Base
           as_enum :gender, [:male, :female], :slim => true
@@ -171,6 +207,14 @@ deprecated starting with version 1.4.1, e.g.
     # GOOD
     as_enum :project_status, [:active, :inactive, :archived], :column => "status"
 
+Do not use states named after existing, or well known method names, like `new` or `create`, e.g.
+
+    # BAD, conflicts with Rails ActiveRecord Methods (!)
+    as_enum :handle, [:new, :create, :update]
+
+    # BETTER, prefixes all methods
+    as_enum :handle, [:new, :create, :update], :prefix => true
+
 Searching for certain values by using the finder methods:
 
     User.where(:gender_cd => User.female)

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
-require 'bundler'
+require 'bundler/setup'
+require 'appraisal'
 require 'rake/testtask'
 
 include Rake::DSL
@@ -9,9 +10,8 @@ Bundler::GemHelper.install_tasks
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the simple_enum plugin.'
+desc 'Run unit tests, use ORM=...'
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
   t.test_files = Dir.glob('test/**/*_test.rb')
   t.verbose = true

data/gemfiles/rails-3.0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "jdbc-sqlite3", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "bson_ext", :platform=>:ruby
+gem "activesupport", "~> 3.0.9"
+gem "activerecord", "~> 3.0.9"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.0.gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: /Users/lukas/Projects/_github/simple_enum
+  specs:
+    simple_enum (1.5.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.11)
+    appraisal (0.4.0)
+      bundler
+      rake
+    arel (2.0.10)
+    bson (1.5.2)
+    bson (1.5.2-java)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (2.1.2)
+    i18n (0.5.0)
+    jdbc-sqlite3 (3.7.2)
+    minitest (2.10.1)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.2.5)
+      activemodel (~> 3.0)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    rake (0.9.2.2)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.9)
+  activesupport (~> 3.0.9)
+  appraisal (>= 0.4)
+  bson_ext
+  jdbc-sqlite3
+  minitest (>= 2.3.0)
+  mongoid (~> 2.0)
+  rake (>= 0.9.2)
+  simple_enum!
+  sqlite3

data/gemfiles/rails-3.1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "jdbc-sqlite3", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "bson_ext", :platform=>:ruby
+gem "activesupport", "~> 3.1.0"
+gem "activerecord", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.1.gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: /Users/lukas/Projects/_github/simple_enum
+  specs:
+    simple_enum (1.5.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    appraisal (0.4.0)
+      bundler
+      rake
+    arel (2.2.1)
+    bson (1.5.2)
+    bson (1.5.2-java)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    jdbc-sqlite3 (3.7.2)
+    minitest (2.10.1)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.1)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.1.0)
+  activesupport (~> 3.1.0)
+  appraisal (>= 0.4)
+  bson_ext
+  jdbc-sqlite3
+  minitest (>= 2.3.0)
+  mongoid (~> 2.0)
+  rake (>= 0.9.2)
+  simple_enum!
+  sqlite3

data/gemfiles/rails-3.2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "jdbc-sqlite3", :platform=>:jruby
+gem "sqlite3", :platform=>:ruby
+gem "bson_ext", :platform=>:ruby
+gem "activesupport", "~> 3.2.0"
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.2.gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: /Users/lukas/Projects/_github/simple_enum
+  specs:
+    simple_enum (1.5.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
+      builder (~> 3.0.0)
+    activerecord (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.0)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.0)
+      bundler
+      rake
+    arel (3.0.0)
+    bson (1.5.2)
+    bson (1.5.2-java)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    jdbc-sqlite3 (3.7.2)
+    minitest (2.10.1)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.1)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.0)
+  activesupport (~> 3.2.0)
+  appraisal (>= 0.4)
+  bson_ext
+  jdbc-sqlite3
+  minitest (>= 2.3.0)
+  mongoid (~> 2.0)
+  rake (>= 0.9.2)
+  simple_enum!
+  sqlite3