simple_enum 1.4.0 → 1.4.1

data/README.rdoc

@@ -162,6 +162,15 @@ 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.
+
+    # BAD
+    as_enum :status, [:active, :inactive, :archived], :column => "status"
+
+    # GOOD
+    as_enum :project_status, [:active, :inactive, :archived], :column => "status"
+
 Searching for certain values by using the finder methods:
 
     User.where(:gender_cd => User.female)

data/lib/simple_enum/version.rb

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

data/lib/simple_enum.rb

@@ -15,6 +15,8 @@ require 'simple_enum/enum_hash'
 require 'simple_enum/object_support'
 require 'simple_enum/validation'
 
+require 'active_support/deprecation'
+
 # Base module which gets included in <tt>ActiveRecord::Base</tt>. See documentation
 # of +SimpleEnum::ClassMethods+ for more details.
 module SimpleEnum
@@ -33,6 +35,8 @@ module SimpleEnum
     # * <tt>:whiny</tt> - Boolean value which if set to <tt>true</tt> will throw an <tt>ArgumentError</tt>
     #   if an invalid value is passed to the setter (e.g. a value for which no enumeration exists). if set to
     #   <tt>false</tt> no exception is thrown and the internal value is set to <tt>nil</tt> (default is <tt>true</tt>)
+    # * <tt>:dirty</tt> - Boolean value which if set to <tt>true</tt> generates <tt>..._was</tt> and <tt>..._changed?</tt>
+    #   methods for the enum, which delegate to the internal column.
     def default_options
       @default_options ||= {
         :whiny => true,
@@ -67,7 +71,7 @@ module SimpleEnum
     #   # or use a hash:
     #
     #   class User < ActiveRecord::Base
-    #     as_enum :status, { :active => 1, :inactive => 0, :archived => 2, :deleted => 3 }, :column => 'status'
+    #     as_enum :user_status, { :active => 1, :inactive => 0, :archived => 2, :deleted => 3 }, :column => 'status'
     #   end
     #
     # Now it's possible to access the enumeration and the internally stored value like:
@@ -149,9 +153,11 @@ module SimpleEnum
     # * <tt>:whiny</tt> - Boolean value which if set to <tt>true</tt> will throw an <tt>ArgumentError</tt>
     #   if an invalid value is passed to the setter (e.g. a value for which no enumeration exists). if set to
     #   <tt>false</tt> no exception is thrown and the internal value is set to <tt>nil</tt> (default is <tt>true</tt>)
+    # * <tt>:dirty</tt> - Boolean value which if set to <tt>true</tt> generates <tt>..._was</tt> and <tt>..._changed?</tt>
+    #   methods for the enum, which delegate to the internal column (default is <tt>false</tt>)
     def as_enum(enum_cd, values, options = {})
       options = SimpleEnum.default_options.merge({ :column => "#{enum_cd}_cd" }).merge(options)
-      options.assert_valid_keys(:column, :whiny, :prefix, :slim, :upcase)
+      options.assert_valid_keys(:column, :whiny, :prefix, :slim, :upcase, :dirty)
 
       metaclass = (class << self; self; end)
 
@@ -163,6 +169,9 @@ module SimpleEnum
       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
+
       # generate getter
       define_method("#{enum_cd}") do
         id = read_attribute options[:column]
@@ -176,6 +185,17 @@ module SimpleEnum
         write_attribute options[:column], v
       end
 
+      # support dirty attributes by delegating to column, currently opt-in
+      if options[:dirty]
+        define_method("#{enum_cd}_changed?") do
+          self.send("#{options[:column]}_changed?")
+        end
+
+        define_method("#{enum_cd}_was") do
+          values_inverted[self.send("#{options[:column]}_was")]
+        end
+      end
+
       # allow access to defined values hash, e.g. in a select helper or finder method.
       attr_name = enum_cd.to_s.pluralize
       enum_attr = :"#{attr_name.downcase}_enum_hash"

data/test/class_methods_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ClassMethodsTest < ActiveSupport::TestCase  
+class ClassMethodsTest < ActiveSupport::TestCase
   def setup
     reload_db
   end
@@ -12,7 +12,7 @@ class ClassMethodsTest < ActiveSupport::TestCase
     assert_nil Dummy.genders[:inexistent]
     assert_not_nil Dummy.genders[:female]
   end
-  
+
   test "inheritance of `genders` to subclasses (#issue/3)" do
     assert_equal({ :female => 1, :male => 0}, SpecificDummy.genders)
   end
@@ -26,19 +26,24 @@ class ClassMethodsTest < ActiveSupport::TestCase
     assert_equal [0, 1], Dummy.genders(:male, :female)
     assert_equal [1, 0], Dummy.genders(:female, :male)
   end
-    
+
+  test "inverted Hash returns synonym by code" do
+    assert_equal :male, Dummy.genders.invert[0]
+    assert_equal :female, Dummy.genders.invert[1]
+  end
+
   test "generation of value shortcuts on class" do
     g = Dummy.new
-    
+
     assert_equal 0, Dummy.male
     assert_equal 1, Dummy.female
     assert_equal 'alpha', Dummy.alpha
     assert_respond_to Dummy, :male
     assert_respond_to Dummy, :female
     assert_respond_to Dummy, :beta
-    assert_respond_to Dummy, :foobar            
+    assert_respond_to Dummy, :foobar
   end
-  
+
   test "that no Klass.shortcut are created if :slim => true" do
     class Dummy1 < ActiveRecord::Base
       set_table_name 'dummies'
@@ -47,59 +52,59 @@ class ClassMethodsTest < ActiveSupport::TestCase
     with_slim = Dummy1
 
     assert !with_slim.respond_to?(:male)
-    assert !with_slim.respond_to?(:female)    
+    assert !with_slim.respond_to?(:female)
     assert_respond_to with_slim, :genders
   end
-  
+
   test "that no Klass.shortcut's are created if :slim => :class, though instance shortcuts are" do
     class Dummy2 < ActiveRecord::Base
       set_table_name 'dummies'
       as_enum :gender, [:male, :female], :slim => :class
     end
     with_slim_class = Dummy2
-    
+
     jane = with_slim_class.new
-    
+
     assert_respond_to jane, :male!
     assert_respond_to jane, :female!
     assert !with_slim_class.respond_to?(:male)
-    assert !with_slim_class.respond_to?(:female)    
+    assert !with_slim_class.respond_to?(:female)
     assert_respond_to with_slim_class, :genders
     assert_same 0, with_slim_class.genders.male
     assert_same 1, with_slim_class.genders[:female]
   end
-  
+
   test "that Klass.shortcut respect :prefix => true and are prefixed by \#{enum_cd}" do
     class Dummy3 < ActiveRecord::Base
       set_table_name 'dummies'
       as_enum :gender, [:male, :female], :prefix => true
     end
     with_prefix = Dummy3
-    
+
     assert !with_prefix.respond_to?(:male)
-    assert !with_prefix.respond_to?(:female)    
+    assert !with_prefix.respond_to?(:female)
     assert_respond_to with_prefix, :gender_male
     assert_respond_to with_prefix, :gender_female
     assert_equal 0, with_prefix.gender_male
     assert_respond_to with_prefix, :genders
   end
-  
+
   test "to ensure that Klass.shortcut also work with custom prefixes" do
     class Dummy4 < ActiveRecord::Base
       set_table_name 'dummies'
       as_enum :gender, [:male, :female], :prefix => :g
     end
     with_custom_prefix = Dummy4
-    
+
     assert !with_custom_prefix.respond_to?(:male)
-    assert !with_custom_prefix.respond_to?(:female)    
-    assert !with_custom_prefix.respond_to?(:gender_female)        
+    assert !with_custom_prefix.respond_to?(:female)
+    assert !with_custom_prefix.respond_to?(:gender_female)
     assert_respond_to with_custom_prefix, :g_male
     assert_respond_to with_custom_prefix, :g_female
-    assert_equal 1, with_custom_prefix.g_female    
-    assert_respond_to with_custom_prefix, :genders    
+    assert_equal 1, with_custom_prefix.g_female
+    assert_respond_to with_custom_prefix, :genders
   end
-    
+
   test "that the human_enum_name method returns translated/humanized values" do
     assert_equal :male.to_s.humanize, Dummy.human_enum_name(:genders, :male)
     assert_equal "Girl", Dummy.human_enum_name(:genders, :female)
@@ -114,10 +119,10 @@ class ClassMethodsTest < ActiveSupport::TestCase
     assert_equal ["Male", :male], for_select.first
     assert_equal ["Girl", :female], for_select.last
   end
-  
+
   test "enum_for_select(:value) class method" do
     for_select = Dummy.genders_for_select(:value)
     assert_equal ["Male", 0], for_select.first
-    assert_equal ["Girl", 1], for_select.last    
+    assert_equal ["Girl", 1], for_select.last
   end
 end

data/test/dirty_attributes_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class DirtyDummy < ActiveRecord::Base
+  set_table_name 'dummies'
+  as_enum :gender, [:male, :female], :dirty => true
+end
+
+class DirtyAttributesTest < ActiveSupport::TestCase
+  def setup
+    reload_db
+  end
+
+  test "setting using changed? on enum" do
+    jane = DirtyDummy.create!(:gender => :female)
+    assert_equal 1, jane.gender_cd
+    jane.gender = :male # operation? =)
+    assert_equal :male, jane.gender
+    assert_equal true, jane.gender_cd_changed?
+    assert_equal true, jane.gender_changed?
+  end
+
+  test "access old value via gender_was" do
+    john = DirtyDummy.create!(:gender => :male)
+    assert_equal 0, john.gender_cd
+    john.gender = :female
+    assert_equal :female, john.gender
+    assert_equal 0, john.gender_cd_was
+    assert_equal :male, john.gender_was
+  end
+
+  test "dirty methods are disabled by default (opt-in)" do
+    no_dirty = Dummy.new
+    assert !no_dirty.respond_to?(:gender_was), "should not respond_to :gender_was"
+    assert !no_dirty.respond_to?(:gender_changed?), "should not respond_to :gender_changed?"
+    assert !no_dirty.respond_to?(:word_was), "should not respond_to :word_was"
+    assert !no_dirty.respond_to?(:word_changed?), "should not respond_to :word_changed?"
+  end
+end

data/test/simple_enum_test.rb

@@ -203,4 +203,20 @@ class SimpleEnumTest < ActiveSupport::TestCase
     d.gender = ''
     assert_nil(d.gender)
   end
+
+  test "deprecation warning when using enum name == column name" do
+    original_behavior = ActiveSupport::Deprecation.behavior
+    begin
+      expected = 0
+      ActiveSupport::Deprecation.silenced = false
+      ActiveSupport::Deprecation.behavior = Proc.new { |msg, cb| expected += 1 if msg =~ /\[simple_enum\].+gender_cd/ }
+      invalid_dummy = Class.new(ActiveRecord::Base) do
+        as_enum :gender_cd, [:male, :female], :column => "gender_cd"
+      end
+
+      assert expected == 1, "deprecation message not displayed"
+    ensure
+      ActiveSupport::Deprecation.behavior = original_behavior
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Lukas Westermann
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-09 00:00:00 +02:00
+date: 2011-09-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,7 @@ files:
 - simple_enum.gemspec
 - test/array_conversions_test.rb
 - test/class_methods_test.rb
+- test/dirty_attributes_test.rb
 - test/enum_hash_test.rb
 - test/finders_test.rb
 - test/locales.yml
@@ -154,6 +155,7 @@ summary: Simple enum-like field support for active records.
 test_files: 
 - test/array_conversions_test.rb
 - test/class_methods_test.rb
+- test/dirty_attributes_test.rb
 - test/enum_hash_test.rb
 - test/finders_test.rb
 - test/locales.yml