simple_enum 1.5.1 → 1.6.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_enum (1.5.1)
+    simple_enum (1.6.1)
       activesupport (>= 3.0.0)
 
 GEM

data/README.rdoc

@@ -1,4 +1,4 @@
-= SimpleEnum - unobtrusive enum-like fields for ActiveRecord
+= SimpleEnum - unobtrusive enum-like fields for ActiveRecord {<img src="https://secure.travis-ci.org/lwe/simple_enum.png" />}[http://travis-ci.org/lwe/simple_enum]
 
 A Rails plugin which brings easy-to-use enum-like functionality to
 ActiveRecord and Mongoid models (now compatible with rails 3.1, ruby 1.9 and jruby).
@@ -97,6 +97,20 @@ useful when creating queries, displaying option elements or similar:
           as_enum :gender, [:male, :female], :column => 'sex'
         end
 
+  It's not allowed to use the same column name as the enum name, this has been deprecated since 1.4.x and will be
+  removed in 1.6.x.
+* Want support for ActiveRecords dirty attributes, provide <tt>:dirty => true</tt> as option, which automatically adds both
+  the <tt>{enum}_changed?</tt> and <tt>{enum}_was</tt> methods, which delegate to ActiveRecord.
+
+        class User < ActiveRecord::Base
+            as_enum :gender, [:male, :female], :dirty => true
+        end
+
+        @user = User.where(:gender_cd => User.male).first
+        @user.gender = :female
+        @user.gender_was
+        # => :male
+
 * Need to provide custom options for the mongoid field, or skip the automatically generated field?
 
         # skip field generation
@@ -106,10 +120,6 @@ useful when creating queries, displaying option elements or similar:
         # 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) %>
-
 * It's possible to validate the internal enum values, just like any other ActiveRecord validation:
 
         class User < ActiveRecord::Base
@@ -172,6 +182,10 @@ useful when creating queries, displaying option elements or similar:
           as_enum :gender, [:male, :female], :whiny => false
         end
 
+* To make it easier to create dropdowns with values use:
+
+        <%= select(:user, :gender, User.genders.keys) %>
+
 * Need translated keys et al in your forms? SimpleEnum provides a <tt><enum>_for_select</tt> method:
 
        # on the gender field
@@ -199,9 +213,9 @@ useful when creating queries, displaying option elements or similar:
 == Best practices
 
 Do not use the same name for the enum as for the column, note that this mode of use is
-deprecated starting with version 1.4.1, e.g.
+deprecated since version 1.4.1 and raises an ArgumentError starting from version 1.6.0:
 
-    # BAD
+    # BAD: raises ArgumentError
     as_enum :status, [:active, :inactive, :archived], :column => "status"
 
     # GOOD
@@ -252,7 +266,7 @@ or <em>b)</em> a custom method to convert an object to a symbolized form named +
 == Known issues/Open items
 
 * Maybe the <tt>:whiny</tt> option should default to <tt>false</tt>, so that generally no exceptions are thrown if a user fakes a request?
-* Clean-up code and tests -> bring down LOC ;) (but maintain Code LOC vs. Test LOC ratio which is currently 1:2.9)
+* Convert to RSpec and clean up tests
 * Make `:slim => true` the default option...?
 
 == Contributors

data/gemfiles/rails-3.0.gemfile.lock

@@ -1,46 +1,43 @@
 PATH
   remote: /Users/lukas/Projects/_github/simple_enum
   specs:
-    simple_enum (1.5.0)
+    simple_enum (1.6.1)
       activesupport (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.11)
-      activesupport (= 3.0.11)
+    activemodel (3.0.15)
+      activesupport (= 3.0.15)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.11)
-      activemodel (= 3.0.11)
-      activesupport (= 3.0.11)
+    activerecord (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
       arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.11)
-    appraisal (0.4.0)
+    activesupport (3.0.15)
+    appraisal (0.4.1)
       bundler
       rake
     arel (2.0.10)
-    bson (1.5.2)
-    bson (1.5.2-java)
-    bson_ext (1.5.2)
-      bson (= 1.5.2)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
     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)
+    minitest (3.2.0)
+    mongo (1.6.4)
+      bson (~> 1.6.4)
+    mongoid (2.2.6)
+      activemodel (~> 3.0.0)
       mongo (~> 1.3)
       tzinfo (~> 0.3.22)
     rake (0.9.2.2)
-    sqlite3 (1.3.5)
-    tzinfo (0.3.31)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/gemfiles/rails-3.1.gemfile.lock

@@ -1,48 +1,45 @@
 PATH
   remote: /Users/lukas/Projects/_github/simple_enum
   specs:
-    simple_enum (1.5.0)
+    simple_enum (1.6.1)
       activesupport (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
+    activemodel (3.1.6)
+      activesupport (= 3.1.6)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      arel (~> 2.2.1)
+    activerecord (3.1.6)
+      activemodel (= 3.1.6)
+      activesupport (= 3.1.6)
+      arel (~> 2.2.3)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    appraisal (0.4.0)
+    activesupport (3.1.6)
+      multi_json (>= 1.0, < 1.3)
+    appraisal (0.4.1)
       bundler
       rake
-    arel (2.2.1)
-    bson (1.5.2)
-    bson (1.5.2-java)
-    bson_ext (1.5.2)
-      bson (= 1.5.2)
+    arel (2.2.3)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
     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)
+    minitest (3.2.0)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.11)
       activemodel (~> 3.1)
-      mongo (~> 1.3)
+      mongo (<= 1.6.2)
       tzinfo (~> 0.3.22)
-    multi_json (1.0.4)
+    multi_json (1.2.0)
     rake (0.9.2.2)
-    sqlite3 (1.3.5)
-    tzinfo (0.3.31)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/gemfiles/rails-3.2.gemfile.lock

@@ -1,48 +1,45 @@
 PATH
   remote: /Users/lukas/Projects/_github/simple_enum
   specs:
-    simple_enum (1.5.0)
+    simple_enum (1.6.1)
       activesupport (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.0)
-      activesupport (= 3.2.0)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
-    activerecord (3.2.0)
-      activemodel (= 3.2.0)
-      activesupport (= 3.2.0)
-      arel (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.0)
+    activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    appraisal (0.4.0)
+    appraisal (0.4.1)
       bundler
       rake
-    arel (3.0.0)
-    bson (1.5.2)
-    bson (1.5.2-java)
-    bson_ext (1.5.2)
-      bson (= 1.5.2)
+    arel (3.0.2)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
     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)
+    minitest (3.2.0)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.11)
       activemodel (~> 3.1)
-      mongo (~> 1.3)
+      mongo (<= 1.6.2)
       tzinfo (~> 0.3.22)
-    multi_json (1.0.4)
+    multi_json (1.3.6)
     rake (0.9.2.2)
-    sqlite3 (1.3.5)
-    tzinfo (0.3.31)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/lib/simple_enum.rb

@@ -45,8 +45,7 @@ module SimpleEnum
     end
 
     def included(base) #:nodoc:
-      base.send :class_attribute, :enum_definitions, :instance_write => false, :instance_reader => false
-      base.enum_definitions = {}
+      base.send :class_attribute, :simple_enum_definitions, :instance_writer => false, :instance_reader => false
       base.send :extend, ClassMethods
     end
   end
@@ -166,11 +165,10 @@ module SimpleEnum
       values_inverted = values.invert
 
       # store info away
-      self.enum_definitions = {} if self.enum_definitions.nil?
       self.enum_definitions[enum_cd] = self.enum_definitions[options[:column]] = { :name => enum_cd, :column => options[:column], :options => options }
 
-      # display deprecation warning if enum_cd == column
-      ActiveSupport::Deprecation.warn "[simple_enum] use different names for #{enum_cd}'s name and column name (support for this will be dropped in 1.5)" if enum_cd.to_s == options[:column].to_s
+      # raise error if enum_cd == column
+      raise ArgumentError, "[simple_enum] use different names for #{enum_cd}'s name and column name." if enum_cd.to_s == options[:column].to_s
 
       # generate getter
       define_method("#{enum_cd}") do
@@ -180,9 +178,10 @@ module SimpleEnum
 
       # generate setter
       define_method("#{enum_cd}=") do |new_value|
-        v = new_value.blank? ? nil : values[new_value.to_sym]
-        raise(ArgumentError, "Invalid enumeration value: #{new_value}") if (options[:whiny] and v.nil? and !new_value.blank?)
-        respond_to?(:write_attribute) ? write_attribute(options[:column], v) : send("#{options[:column]}=", v)
+        real = new_value.blank? ? nil : values[EnumHash.symbolize(new_value)]
+        real = new_value if real.nil? && values_inverted[new_value].present?
+        raise(ArgumentError, "Invalid enumeration value: #{new_value}") if (options[:whiny] and real.nil? and !new_value.blank?)
+        respond_to?(:write_attribute) ? write_attribute(options[:column], real) : send("#{options[:column]}=", real)
       end
 
       # generate checker
@@ -213,7 +212,7 @@ module SimpleEnum
       end
 
       class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        class_attribute #{enum_attr.inspect}, :instance_write => false, :instance_reader => false
+        class_attribute #{enum_attr.inspect}, :instance_writer => false, :instance_reader => false
 
         def self.#{attr_name}(*args)
           return #{enum_attr} if args.first.nil?
@@ -272,6 +271,10 @@ module SimpleEnum
       options.reverse_merge! :count => 1, :default => defaults
       I18n.translate(defaults.shift, options)
     end
+
+    def enum_definitions
+      self.simple_enum_definitions ||= {}
+    end
   end
 end
 

data/lib/simple_enum/enum_hash.rb

@@ -12,7 +12,8 @@ module SimpleEnum
       return sym.to_enum_sym if sym.respond_to?(:to_enum_sym)
       return sym.to_sym if sym.respond_to?(:to_sym)
       return sym.name.to_s.parameterize('_').to_sym if sym.respond_to?(:name)
-      sym.to_param.to_sym unless sym.blank?
+      sym.to_param.to_sym if sym.present? && sym.respond_to?(:to_param)
+      sym unless sym.blank?
     end
 
     def initialize(args = [])

data/lib/simple_enum/mongoid.rb

@@ -27,8 +27,7 @@ module SimpleEnum
 
     included do
       # create class level methods
-      class_attribute :enum_definitions, :instance_write => false, :instance_reader => false
-      enum_definitions = {}
+      class_attribute :simple_enum_definitions, :instance_writer => false, :instance_reader => false
     end
 
     module ClassMethods
@@ -49,4 +48,4 @@ module SimpleEnum
       alias_method_chain :as_enum, :mongoid
     end
   end
-end
+end

data/lib/simple_enum/version.rb

@@ -1,5 +1,5 @@
 module SimpleEnum
 
   # +SimpleEnum+ version string.
-  VERSION = "1.5.1"
+  VERSION = "1.6.1"
 end

data/test/orm/active_record.rb

@@ -67,13 +67,12 @@ end
 def named_dummy(class_name, &block)
   begin
     return class_name.constantize
-  rescue NameError  
+  rescue NameError
     klass = Object.const_set(class_name, Class.new(ActiveRecord::Base))
     klass.module_eval do
       ar32? ? self.table_name = 'dummies' : set_table_name('dummies')
       instance_eval &block
     end
-  
     klass
   end
 end
@@ -81,7 +80,7 @@ end
 class Dummy < ActiveRecord::Base
   as_enum :gender, [:male, :female]
   as_enum :word, { :alpha => 'alpha', :beta => 'beta', :gamma => 'gamma'}
-  as_enum :didum, [ :foo, :bar, :foobar ], :column => 'other'  
+  as_enum :didum, [ :foo, :bar, :foobar ], :column => 'other'
 end
 
 class Gender < ActiveRecord::Base

data/test/simple_enum_test.rb

@@ -9,6 +9,15 @@ class SimpleEnumTest < MiniTest::Unit::TestCase
     assert_equal "gender_cd", Dummy.enum_definitions[:gender][:column]
   end
 
+  def test_enum_definitions_only_available_from_class
+    assert_raises(NoMethodError) { Dummy.new.enum_definitions }
+    assert_raises(NoMethodError) { Dummy.new.enum_definitions= {} }
+  end
+
+  def test_enum_definitions_local_to_model
+    assert_equal nil, Computer.enum_definitions[:gender]
+  end
+
   def test_getting_the_correct_integer_values_when_setting_to_symbol
     d = Dummy.new
     d.gender = :male
@@ -28,6 +37,19 @@ class SimpleEnumTest < MiniTest::Unit::TestCase
     assert_equal(false, d.female?)
   end
 
+  def test_setting_value_as_key
+    d = Dummy.new
+    d.gender = 1
+    assert_equal(:female, d.gender)
+    assert_equal(1, d.gender_cd)
+  end
+
+  def test_setting_value_as_key_in_constructor
+    d = Dummy.new :gender => 1
+    assert_equal(:female, d.gender)
+    assert_equal(1, d.gender_cd)
+  end
+
   def test_enum_comparisons
     d = Dummy.new
     assert_equal(false, d.gender?)
@@ -217,19 +239,14 @@ class SimpleEnumTest < MiniTest::Unit::TestCase
     assert_nil(d.gender)
   end
 
-  def test_deprecation_warning_when_using_enum_name_eq_column_name
-    original_behavior = ActiveSupport::Deprecation.behavior
+  def test_argument_error_is_raised_when_using_enum_name_eq_column_name
     begin
-      expected = 0
-      ActiveSupport::Deprecation.silenced = false
-      ActiveSupport::Deprecation.behavior = Proc.new { |msg, cb| expected += 1 if msg =~ /\[simple_enum\].+gender_cd/ }
       invalid_dummy = anonymous_dummy do
         as_enum :gender_cd, [:male, :female], :column => "gender_cd"
       end
-
-      assert expected == 1, "deprecation message not displayed"
-    ensure
-      ActiveSupport::Deprecation.behavior = original_behavior
+      assert false, "no error raised"
+    rescue ArgumentError => e
+      assert e.to_s =~ /use different names for/, "invalid ArgumentError raised"
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_enum
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 13
   prerelease: 
   segments: 
   - 1
-  - 5
+  - 6
   - 1
-  version: 1.5.1
+  version: 1.6.1
 platform: ruby
 authors: 
 - Lukas Westermann
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-26 00:00:00 Z
+date: 2012-06-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +30,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
+  requirement: *id001
+  type: :runtime
   name: activesupport
-  version_requirements: *id001
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +46,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
+  requirement: *id002
+  type: :development
   name: rake
-  version_requirements: *id002
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -61,12 +61,12 @@ dependencies:
         - 0
         - 4
         version: "0.4"
+  requirement: *id003
+  type: :development
   name: appraisal
-  version_requirements: *id003
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,12 +77,12 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
+  requirement: *id004
+  type: :development
   name: minitest
-  version_requirements: *id004
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,12 +93,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
+  requirement: *id005
+  type: :development
   name: activerecord
-  version_requirements: *id005
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -108,12 +108,12 @@ dependencies:
         - 2
         - 0
         version: "2.0"
+  requirement: *id006
+  type: :development
   name: mongoid
-  version_requirements: *id006
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,9 +122,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id007
+  type: :development
   name: sqlite3
-  version_requirements: *id007
-  prerelease: false
 description: Provides enum-like fields for ActiveRecord, ActiveModel and Mongoid models.
 email: 
 - lukas.westermann@gmail.com
@@ -162,7 +162,6 @@ files:
 - test/enum_hash_test.rb
 - test/finders_test.rb
 - test/locales.yml
-- test/models.rb
 - test/mongoid_test.rb
 - test/object_backed_test.rb
 - test/orm/active_record.rb
@@ -217,7 +216,6 @@ test_files:
 - test/enum_hash_test.rb
 - test/finders_test.rb
 - test/locales.yml
-- test/models.rb
 - test/mongoid_test.rb
 - test/object_backed_test.rb
 - test/orm/active_record.rb

data/test/models.rb

@@ -1,18 +0,0 @@
-class Dummy < ActiveRecord::Base
-  as_enum :gender, [:male, :female]
-  as_enum :word, { :alpha => 'alpha', :beta => 'beta', :gamma => 'gamma'}
-  as_enum :didum, [ :foo, :bar, :foobar ], :column => 'other'
-end
-
-class Gender < ActiveRecord::Base
-end
-
-class Computer < ActiveRecord::Base
-  as_enum :manufacturer, [:dell, :compaq, :apple]
-  as_enum :operating_system, [:windows, :osx, :linux, :bsd]
-end
-
-# Used to test STI stuff
-class SpecificDummy < Dummy
-  set_table_name 'dummies'
-end