magic_enum 0.0.3 → 0.9.0

data/.gitignore

@@ -1,4 +1,7 @@
-/pkg
-.bundle
+.yardoc
 .DS_Store
-
+.bundle
+.rvmrc
+Gemfile.lock
+doc
+pkg

data/.travis.yml

@@ -0,0 +1,31 @@
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+
+env:
+  - "RAILS_VERSION=2.2.0"
+  - "RAILS_VERSION=2.3.0"
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+
+matrix:
+  exclude:
+    - rvm: ree
+      env: "RAILS_VERSION=4.0.0"
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=4.0.0"
+    - rvm: 1.9.3
+      env: "RAILS_VERSION=2.2.0"
+    - rvm: 1.9.3
+      env: "RAILS_VERSION=2.3.0"
+    - rvm: 2.0.0
+      env: "RAILS_VERSION=2.2.0"
+    - rvm: 2.0.0
+      env: "RAILS_VERSION=2.3.0"
+
+notifications:
+  recipients:
+    - kpumuk@kpumuk.info

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in magic_enum.gemspec
+gemspec
+
+if ENV['RAILS_VERSION']
+  gem 'activerecord', "~> #{ENV['RAILS_VERSION']}"
+end

data/lib/magic_enum/class_methods.rb

@@ -98,7 +98,7 @@ module MagicEnum
         else
           a <=> b
         end
-      end.first unless opts[:default]
+      end.first unless opts.key?(:default)
 
       const_set(enum_inverted, const_get(enum).invert)
 
@@ -112,10 +112,11 @@ module MagicEnum
 
       define_method "#{name}=" do |value|
         value = value.to_sym if value.is_a?(String)
-        raise ArgumentError, "Invalid value \"#{value}\" for :#{name} attribute of the #{self.class} model" if opts[:raise_on_invalid] and self.class.const_get(enum)[value].nil?
         if value.is_a?(Integer)
+          raise ArgumentError, "Invalid value \"#{value}\" for :#{name} attribute of the #{self.class} model" if opts[:raise_on_invalid] and !self.class.const_get(enum_inverted).key?(value)
           self[name] = value
         else
+          raise ArgumentError, "Invalid value \"#{value}\" for :#{name} attribute of the #{self.class} model" if opts[:raise_on_invalid] and !self.class.const_get(enum).key?(value)
           self[name] = self.class.const_get(enum)[value] || opts[:default]
         end
       end
@@ -130,20 +131,49 @@ module MagicEnum
 
       # Create named scopes for each enum value
       if opts[:named_scopes]
-        const_get(enum).keys.each do |key|
-          named_scope key.to_s.pluralize.to_sym, :conditions => ["#{name} = ?", const_get(enum)[key]] do
-            opts[:scope_extensions].each do |ext_name, ext_block|
-              define_method ext_name, ext_block
-            end if opts[:scope_extensions] and opts[:scope_extensions].is_a?(Hash)
-          end
+        scope_definition_method = respond_to?(:named_scope) ? :named_scope : :scope
+
+        const_get(enum).each do |key, value|
+          define_enum_scope(enum, key.to_s.pluralize, name, key, opts[:scope_extensions])
+        end
+
+        define_enum_scope(enum, "of_#{name}", name, nil, opts[:scope_extensions])
+      end
+
+    end
+
+    private
+
+    def define_enum_scope(enum, scope_name, name, key, scope_extensions)
+      if respond_to?(:named_scope)
+        # Rails 2.2 - 2.3
+
+        where_clause = if key
+          { :conditions => { name => const_get(enum)[key] } }
+        else
+          lambda { |t| { :conditions => { name => const_get(enum)[t] } } }
         end
-        named_scope "of_#{name}".to_sym, lambda { |t| { :conditions => ["#{name} = ?", const_get(enum)[t]] } } do
-          opts[:scope_extensions].each do |ext_name, ext_block|
+
+        named_scope scope_name.to_sym, where_clause do
+          scope_extensions.each do |ext_name, ext_block|
             define_method ext_name, ext_block
-          end if opts[:scope_extensions] and opts[:scope_extensions].is_a?(Hash)
+          end if Hash === scope_extensions
+        end
+      else
+        # Rails 3+
+
+        where_clause = if key
+          lambda { where(name => const_get(enum)[key]) }
+        else
+          lambda { |t| where(name => const_get(enum)[t]) }
         end
-      end
 
+        scope scope_name.to_sym, where_clause do
+          scope_extensions.each do |ext_name, ext_block|
+            define_method ext_name, ext_block
+          end if Hash === scope_extensions
+        end
+      end
     end
   end
 end

data/lib/magic_enum/version.rb

@@ -2,8 +2,8 @@
 module MagicEnum
   module Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 3
+    MINOR = 9
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/magic_enum.rb

@@ -1,4 +1,5 @@
 require 'magic_enum/version'
 require 'magic_enum/class_methods'
+require 'active_record'
 
 ActiveRecord::Base.extend(MagicEnum::ClassMethods)

data/magic_enum.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = [ 'LICENSE', 'README.rdoc' ]
 
   # Dependencies
-  s.add_dependency 'activerecord', '< 3.3'
+  s.add_dependency 'activerecord'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'yard'
 end

data/spec/magic_enum_spec.rb

@@ -1,11 +1,9 @@
-require 'rubygems'
-require 'active_record'
-
-require File.dirname(__FILE__) + '/../init'
+require 'bundler/setup'
+require 'magic_enum'
 
 module MagicEnumHelper
   class TestModelBase
-    include MagicEnum
+    extend MagicEnum::ClassMethods
     Statuses = { :unknown => 0, :draft => 1, :published => 2 }
 
     def [](attr_name)
@@ -21,20 +19,20 @@ end
 describe 'Model with magic enum' do
   include MagicEnumHelper
 
-  class TestModel1 < MagicEnumHelper::TestModelBase
+  class TestModelSimple < MagicEnumHelper::TestModelBase
     define_enum :status
   end
 
   before do
-    @model = TestModel1.new
+    @model = TestModelSimple.new
   end
 
-  specify 'should define methods to get and set enum field' do
-    TestModel1.should be_method_defined(:status)
-    TestModel1.should be_method_defined(:status=)
+  it 'should define methods to get and set enum field' do
+    TestModelSimple.should be_method_defined(:status)
+    TestModelSimple.should be_method_defined(:status=)
   end
 
-  specify 'should store enum value using [] operation on model' do
+  it 'should store enum value using [] operation on model' do
     @model.status = :draft
     @model[:status].should == 1
     @model.status.should == :draft
@@ -43,7 +41,7 @@ describe 'Model with magic enum' do
     @model.status.should == :unknown
   end
 
-  specify 'should store enum value if key is given as string' do
+  it 'should store enum value if key is given as string' do
     @model.status = 'draft'
     @model[:status].should == 1
     @model.status.should == :draft
@@ -52,7 +50,7 @@ describe 'Model with magic enum' do
     @model.status.should == :unknown
   end
 
-  specify 'should store enum value if key is given as integer equivalent' do
+  it 'should store enum value if key is given as integer equivalent' do
     @model.status = 1
     @model[:status].should == 1
     @model.status.should == :draft
@@ -61,17 +59,17 @@ describe 'Model with magic enum' do
     @model.status.should == :unknown
   end
 
-  specify 'should not define simple accessors by default' do
-    @model.methods.should_not include('unknown?')
-    @model.methods.should_not include('draft?')
-    @model.methods.should_not include('published?')
+  it 'should not define simple accessors by default' do
+    @model.should_not respond_to(:unknown?)
+    @model.should_not respond_to(:draft?)
+    @model.should_not respond_to(:published?)
   end
 
-  specify 'should not raise error when invalid value received' do
-    lambda { @model.status = :invalid }.should_not raise_error(ArgumentError)
+  it 'should not raise error when invalid value received' do
+    lambda { @model.status = :invalid }.should_not raise_error
   end
 
-  specify 'should use default value 0 when invalid value received or current state invalid' do
+  it 'should use default value 0 when invalid value received or current state invalid' do
     @model[:status] = -1
     @model.status.should == :unknown
     @model.status = :published
@@ -81,14 +79,15 @@ describe 'Model with magic enum' do
     @model.status.should == :unknown
   end
 
-  specify 'should return string value when _name method called' do
+  it 'should return string value when _name method called' do
     @model.status_name.should == 'unknown'
     @model.status = :published
     @model.status_name.should == 'published'
   end
 
-  specify 'should not define named scopes by default' do
-    TestModel1.should_not_receive(:named_scope)
+  it 'should not define named scopes by default' do
+    TestModelSimple.should_not_receive(:named_scope)
+    TestModelSimple.should_not_receive(:scope)
   end
 
 end
@@ -96,20 +95,20 @@ end
 describe 'Model with magic enum and default value specified' do
   include MagicEnumHelper
 
-  class TestModel2 < MagicEnumHelper::TestModelBase
+  class TestModelWithDefault < MagicEnumHelper::TestModelBase
     define_enum :status, :default => 2
   end
 
   before do
-    @model = TestModel2.new
+    @model = TestModelWithDefault.new
   end
 
-  specify 'should use default value when current state is invalid' do
+  it 'should use default value when current state is invalid' do
     @model[:status] = -1
     @model.status.should == :published
   end
 
-  specify 'should use default value when invalid value received' do
+  it 'should use default value when invalid value received' do
     @model.status = nil
     @model.status.should == :published
     @model.status = :invalid
@@ -117,7 +116,7 @@ describe 'Model with magic enum and default value specified' do
     @model[:status].should == 2
   end
 
-  specify 'should not interpret nil in the same way as 0' do
+  it 'should not interpret nil in the same way as 0' do
     @model[:status].should be_nil
     @model.status.should == :published
     @model[:status] = 0
@@ -125,26 +124,83 @@ describe 'Model with magic enum and default value specified' do
   end
 end
 
+describe 'Model with magic enum and default value specified as nil' do
+  include MagicEnumHelper
+
+  class TestModelWithDefaultNil < MagicEnumHelper::TestModelBase
+    SimpleStatuses = { :unknown => 0, :draft => 1, :published => 2, :simple => nil }
+    define_enum :simple_status, :default => nil
+  end
+
+  before do
+    @model = TestModelWithDefaultNil.new
+  end
+
+  it 'should use default value when current state is invalid' do
+    @model[:simple_status] = -1
+    @model.simple_status.should == :simple
+  end
+
+  it 'should use default value when invalid value received' do
+    @model.simple_status = nil
+    @model.simple_status.should == :simple
+    @model.simple_status = :invalid
+    @model.simple_status.should == :simple
+    @model[:simple_status].should be_nil
+  end
+
+  it 'should not interpret nil in the same way as 0' do
+    @model[:simple_status].should be_nil
+    @model.simple_status.should == :simple
+    @model[:simple_status] = 0
+    @model.simple_status.should == :unknown
+  end
+end
+
 describe 'Model with magic enum and raise_on_invalid option specified' do
   include MagicEnumHelper
 
-  class TestModel3 < MagicEnumHelper::TestModelBase
+  class TestModelWithRaiseOnInvalid < MagicEnumHelper::TestModelBase
     define_enum :status, :raise_on_invalid => true
   end
 
   before do
-    @model = TestModel3.new
+    @model = TestModelWithRaiseOnInvalid.new
   end
 
-  specify 'should raise error when invalid value received' do
-    lambda { @model.status = :invalid }.should raise_error(ArgumentError)
+  context 'with symbol value' do
+    it 'should not raise error when valid value received' do
+      lambda { @model.status = :draft }.should_not raise_error
+    end
+
+    it 'should raise error when invalid value received' do
+      lambda { @model.status = :invalid }.should raise_error(ArgumentError)
+    end
+
+    it 'should show error description when invalid value received' do
+      begin
+        @model.status = :invalid
+      rescue => e
+        e.message.should == 'Invalid value "invalid" for :status attribute of the TestModelWithRaiseOnInvalid model'
+      end
+    end
   end
 
-  specify 'should show error description when invalid value received' do
-    begin
-      @model.status = :invalid
-    rescue => e
-      e.message.should == 'Invalid value "invalid" for :status attribute of the TestModel3 model'
+  context 'with integer value' do
+    it 'should not raise error when valid value received' do
+      lambda { @model.status = 1 }.should_not raise_error
+    end
+
+    it 'should raise error when invalid value received' do
+      lambda { @model.status = 4 }.should raise_error(ArgumentError)
+    end
+
+    it 'should show error description when invalid value received' do
+      begin
+        @model.status = 4
+      rescue => e
+        e.message.should == 'Invalid value "4" for :status attribute of the TestModelWithRaiseOnInvalid model'
+      end
     end
   end
 end
@@ -153,41 +209,41 @@ end
 describe 'Model with magic enum and simple_accessors option specified' do
   include MagicEnumHelper
 
-  class TestModel4 < MagicEnumHelper::TestModelBase
+  class TestModelWithSimpleAccessors < MagicEnumHelper::TestModelBase
     define_enum :status, :simple_accessors => true
   end
 
   before do
-    @model = TestModel4.new
+    @model = TestModelWithSimpleAccessors.new
   end
 
-  specify 'should define simple accessors by default' do
-    @model.methods.should include('unknown?')
-    @model.methods.should include('draft?')
-    @model.methods.should include('published?')
+  it 'should define simple accessors by default' do
+    @model.should respond_to(:unknown?)
+    @model.should respond_to(:draft?)
+    @model.should respond_to(:published?)
   end
 end
 
 describe 'Model with magic enum and named_scopes option specified' do
   include MagicEnumHelper
 
-  class TestModel5 < MagicEnumHelper::TestModelBase
+  class TestModelWithNamedScopes < ActiveRecord::Base
+    Statuses = { :unknown => 0, :draft => 1, :published => 2 }
+    define_enum :status, :named_scopes => true
   end
 
-  specify 'should define named_scopes' do
-    TestModel5.should_receive(:named_scope).with(:unknowns, {:conditions=>["status = ?", 0]}).once
-    TestModel5.should_receive(:named_scope).with(:drafts, {:conditions=>["status = ?", 1]}).once
-    TestModel5.should_receive(:named_scope).with(:publisheds, {:conditions=>["status = ?", 2]}).once
-    TestModel5.should_receive(:named_scope).once # to handle the :of_status named_scope,
-                                                 # since we can't set an expectation with a Proc argument
-    TestModel5.send(:define_enum, :status, :named_scopes => true)
+  it 'should define named_scopes' do
+    TestModelWithNamedScopes.should respond_to(:unknowns)
+    TestModelWithNamedScopes.should respond_to(:drafts)
+    TestModelWithNamedScopes.should respond_to(:publisheds)
+    TestModelWithNamedScopes.should respond_to(:of_status)
   end
 end
 
 describe 'Model with magic enum and enum option specified' do
   include MagicEnumHelper
 
-  class TestModel7 < MagicEnumHelper::TestModelBase
+  class TestModelEnumOption < MagicEnumHelper::TestModelBase
     Roles = {
       :user => 'u',
       :admin => 'a'
@@ -196,10 +252,10 @@ describe 'Model with magic enum and enum option specified' do
   end
 
   before do
-    @model = TestModel7.new
+    @model = TestModelEnumOption.new
   end
 
-  specify 'should use custom enum' do
+  it 'should use custom enum' do
     @model.status = :user
     @model.status.should == :user
     @model[:status].should == 'u'
@@ -208,14 +264,14 @@ describe 'Model with magic enum and enum option specified' do
     @model[:status].should == 'a'
   end
 
-  specify 'should use option with min value as default' do
+  it 'should use option with min value as default' do
     @model.status = :invalid
     @model.status.should == :admin
   end
 end
 
 describe 'ActiveRecord::Base class' do
-  specify 'should include MagicEnum module' do
-    ActiveRecord::Base.included_modules.should include(MagicEnum)
+  it 'should include MagicEnum methods' do
+    ActiveRecord::Base.should respond_to(:define_enum)
   end
 end

metadata

@@ -1,81 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: magic_enum
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.9.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Dmytro Shteflyuk
 - Oleksiy Kovyrin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 3
-        version: "3.3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: MagicEnum is a simple ActiveRecord plugin that makes it easier to maintain ENUM-like attributes in your models.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MagicEnum is a simple ActiveRecord plugin that makes it easier to maintain
+  ENUM-like attributes in your models.
 email: alexey@kovyrin.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - .gitignore
+- .travis.yml
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- init.rb
 - lib/magic_enum.rb
 - lib/magic_enum/class_methods.rb
 - lib/magic_enum/version.rb
@@ -83,36 +114,29 @@ files:
 - spec/magic_enum_spec.rb
 homepage: https://github.com/kovyrin/magic-enum
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ActiveRecord plugin that makes it easier to maintain ENUM-like attributes in your models
+summary: ActiveRecord plugin that makes it easier to maintain ENUM-like attributes
+  in your models
 test_files: []
-
+has_rdoc: 

data/init.rb

@@ -1,2 +0,0 @@
-require 'magic_enum'
-