enumerize 0.5.1 → 0.6.0

data/.gitignore

@@ -3,7 +3,9 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+.idea/
+enumerize.iml
+Gemfile*.lock
 gemfiles/Gemfile-*.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -3,8 +3,12 @@ services:
   - mongodb
 before_install:
   - gem install bundler
+gemfile:
+  - Gemfile
+  - Gemfile.rails4
 rvm:
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - jruby-19mode
   - rbx-19mode

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.6.0 (May 16, 2013) ##
+
+### enhancements
+  * Use inclusion error message for invalid values (by [@lest](https://github.com/lest))
+  * Add `:only` and `except` options to the `Attribute#options` method. (by [@thehappycoder](https://github.com/thehappycoder))
+  * ActiveRecord scopes. (by [@lest](https://github.com/lest), [@banyan](https://github.com/banyan) and [@nashby](https://github.com/nashby))
+  * Support for RailsAdmin (by [@drewda](https://github.com/drewda))
+
+### bug fix
+  * Return correct default value for enumerized attribute using `default_scope` with generated scope [@nashby](https://github.com/nashby)
+  * Allow either key or value as valid (by [aghull](https://github.com/aghull) and [@lest](https://github.com/lest))
+  * Use default enum value from db column (by [@lest](https://github.com/lest))
+
 ## 0.5.1 (December 10, 2012) ##
 
 ### bug fix

data/Gemfile.rails4

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'minitest', '~> 4.1'
+
+gem 'activerecord', '4.0.0.rc1'
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+
+gem 'mongoid', github: 'mongoid/mongoid'
+gem 'simple_form', '3.0.0.beta1'
+gem 'formtastic', github: 'justinfrench/formtastic'

data/README.md

@@ -85,7 +85,7 @@ get all values for enumerized attribute:
 User.sex.values # or User.enumerized_attributes[:sex].values
 ```
 
-use it with forms:
+use it with forms (it supports `:only` and `:except` options):
 
 ```erb
 <%= form_for @user do |f| %>
@@ -164,6 +164,25 @@ class User < ActiveRecord::Base
 end
 ```
 
+ActiveRecord scopes:
+
+```ruby
+class User < ActiveRecord::Base
+  extend Enumerize
+  enumerize :sex, :in => [:male, :female], scope: true
+  enumerize :status, :in => { active: 1, blocked: 2 }, scope: :having_status
+end
+
+User.with_sex(:female)
+# SELECT "users".* FROM "users" WHERE "users"."sex" IN ('female')
+
+User.without_sex(:male)
+# SELECT "users".* FROM "users" WHERE "users"."sex" NOT IN ('male')
+
+User.having_status(:blocked).with_sex(:male, :female)
+# SELECT "users".* FROM "users" WHERE "users"."status" IN (2) AND "users"."sex" IN ('male', 'female')
+```
+
 Array-like attributes with plain ruby objects:
 
 ```ruby
@@ -225,6 +244,13 @@ and if you want it as radio buttons:
 <% end %>
 ```
 
+### Other Integrations
+
+Enumerize integrates with the following automatically:
+
+* [RailsAdmin](https://github.com/sferik/rails_admin/)
+
+
 ## Contributing
 
 1. Fork it

data/enumerize.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |gem|
   gem.name          = "enumerize"
   gem.require_paths = ["lib"]
   gem.version       = Enumerize::VERSION
+  
+  gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency('activesupport', '>= 3.2')
 end

data/lib/enumerize.rb

@@ -7,6 +7,7 @@ module Enumerize
   autoload :Value,        'enumerize/value'
   autoload :Set,          'enumerize/set'
   autoload :Base,         'enumerize/base'
+  autoload :Module,       'enumerize/module'
   autoload :ActiveRecord, 'enumerize/activerecord'
   autoload :Predicates,   'enumerize/predicates'
   autoload :ModuleAttributes, 'enumerize/module_attributes'
@@ -19,12 +20,14 @@ module Enumerize
   def self.extended(base)
     base.send :include, Enumerize::Base
     base.extend Enumerize::Predicates
+    base.extend Enumerize::ActiveRecord
 
-    if defined?(::ActiveRecord::Base) && base < ::ActiveRecord::Base
-      base.extend Enumerize::ActiveRecord
+    if defined?(::RailsAdmin)
+      require 'enumerize/integrations/rails_admin'
+      base.extend Enumerize::Integrations::RailsAdmin
     end
 
-    if Module === base
+    if ::Module === base
       base.extend Enumerize::Base::ClassMethods
       base.extend Enumerize::ModuleAttributes
     end

data/lib/enumerize/activerecord.rb

@@ -2,6 +2,29 @@ require 'active_support/concern'
 
 module Enumerize
   module ActiveRecord
+    def enumerize(name, options={})
+      super
 
+      if options[:scope]
+        _enumerize_module.dependent_eval do
+          if defined?(::ActiveRecord::Base) && self < ::ActiveRecord::Base
+            scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
+            define_singleton_method scope_name do |*values|
+              values = values.map { |value| enumerized_attributes[name].find_value(value).value }
+              values = values.first if values.size == 1
+
+              where(name => values)
+            end
+
+            if options[:scope] == true
+              define_singleton_method "without_#{name}" do |*values|
+                values = values.map { |value| enumerized_attributes[name].find_value(value).value }
+                where(arel_table[name].not_in(values))
+              end
+            end
+          end
+        end
+      end
+    end
   end
 end

data/lib/enumerize/attribute.rb

@@ -27,8 +27,25 @@ module Enumerize
       @klass.model_name.i18n_key if @klass.respond_to?(:model_name)
     end
 
-    def options
-      @values.map { |v| [v.text, v.to_s] }
+    def options(options = {})
+      values = if options.empty?
+        @values
+      else
+        raise ArgumentError, 'Options cannot have both :only and :except' if options[:only] && options[:except]
+
+        only = Array(options[:only]).map(&:to_s)
+        except = Array(options[:except]).map(&:to_s)
+
+        @values.reject do |value|
+          if options[:only]
+            !only.include?(value)
+          elsif options[:except]
+            except.include?(value)
+          end
+        end
+      end
+
+      values.map { |v| [v.text, v.to_s] }
     end
 
     def define_methods!(mod)
@@ -36,6 +53,8 @@ module Enumerize
         def #{name}
           if defined?(super)
             self.class.enumerized_attributes[:#{name}].find_value(super)
+          elsif respond_to?(:read_attribute)
+            self.class.enumerized_attributes[:#{name}].find_value(read_attribute(:#{name}))
           else
             if defined?(@#{name})
               self.class.enumerized_attributes[:#{name}].find_value(@#{name})
@@ -53,6 +72,8 @@ module Enumerize
 
           if defined?(super)
             super allowed_value_or_nil
+          elsif respond_to?(:write_attribute, true)
+            write_attribute '#{name}', allowed_value_or_nil
           else
             @#{name} = allowed_value_or_nil
           end
@@ -92,6 +113,8 @@ module Enumerize
 
           if defined?(super)
             super string_values
+          elsif respond_to?(:write_attribute, true)
+            write_attribute '#{name}', string_values
           else
             @#{name} = string_values
           end

data/lib/enumerize/base.rb

@@ -12,6 +12,8 @@ module Enumerize
 
     module ClassMethods
       def enumerize(name, options={})
+        raise ArgumentError, "Enumerized attribute #{name} is already defined" if enumerized_attributes[name]
+
         attr = Attribute.new(self, name, options)
         enumerized_attributes << attr
 
@@ -39,14 +41,8 @@ module Enumerize
 
       def _enumerize_module
         @_enumerize_module ||= begin
-          mod = Module.new do
-            @_class_methods = Module.new
-            class << self
-              attr_reader :_class_methods
-            end
-          end
+          mod = Module.new
           include mod
-          extend mod._class_methods
           mod
         end
       end
@@ -55,7 +51,9 @@ module Enumerize
     def initialize(*)
       super
       self.class.enumerized_attributes.each do |attr|
-        public_send("#{attr.name}=", attr.default_value) unless _enumerized_values_for_validation.key?(attr.name)
+        if !public_send(attr.name) && !_enumerized_values_for_validation.key?(attr.name)
+          public_send("#{attr.name}=", attr.default_value)
+        end
       end
     end
 
@@ -78,12 +76,10 @@ module Enumerize
         value = read_attribute_for_validation(attr.name)
         next if value.blank?
 
-        allowed = attr.values
-
         if attr.kind_of? Multiple
-          errors.add attr.name unless value.respond_to?(:all?) && value.all? { |v| v.blank? || allowed.include?(v) }
+          errors.add attr.name unless value.respond_to?(:all?) && value.all? { |v| v.blank? || attr.find_value(v) }
         else
-          errors.add attr.name unless allowed.include?(value)
+          errors.add attr.name, :inclusion unless attr.find_value(value)
         end
       end
     end

data/lib/enumerize/form_helper.rb

@@ -1,25 +1,21 @@
 # backport of https://github.com/rails/rails/commit/3be9e8a0c2187744b6c9879ca2836cef5ebed693
-module ActionView
-  module Helpers
-    module FormHelper
-      InstanceTag.class_eval do
-        def self.check_box_checked?(value, checked_value)
-          case value
-          when TrueClass, FalseClass
-            value
-          when NilClass
-            false
-          when Integer
-            value != 0
-          when String
-            value == checked_value
-          else
-            if value.respond_to?(:include?)
-              value.include?(checked_value)
-            else
-              value.to_i != 0
-            end
-          end
+if defined?(ActionView::Helpers::InstanceTag)
+  ActionView::Helpers::InstanceTag.class_eval do
+    def self.check_box_checked?(value, checked_value)
+      case value
+      when TrueClass, FalseClass
+        value
+      when NilClass
+        false
+      when Integer
+        value != 0
+      when String
+        value == checked_value
+      else
+        if value.respond_to?(:include?)
+          value.include?(checked_value)
+        else
+          value.to_i != 0
         end
       end
     end

data/lib/enumerize/integrations/rails_admin.rb

@@ -0,0 +1,16 @@
+module Enumerize
+  module Integrations
+    module RailsAdmin
+
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}_enum
+            self.class.enumerized_attributes[:#{name}].options
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/enumerize/module.rb

@@ -0,0 +1,31 @@
+module Enumerize
+  class Module < ::Module
+    attr_reader :_class_methods
+
+    def initialize
+      super
+
+      @_class_methods   = ::Module.new
+      @_dependents      = []
+      @_dependent_evals = []
+    end
+
+    def included(klass)
+      klass.extend _class_methods
+
+      @_dependent_evals.each do |block|
+        klass.instance_eval(&block)
+      end
+
+      @_dependents << klass
+    end
+
+    def dependent_eval(&block)
+      @_dependents.each do |klass|
+        klass.instance_eval(&block)
+      end
+
+      @_dependent_evals << block
+    end
+  end
+end

data/lib/enumerize/module_attributes.rb

@@ -3,7 +3,6 @@ module Enumerize
     def included(base)
       base.extend Enumerize
       base.send :include, _enumerize_module
-      base.extend _enumerize_module._class_methods
       enumerized_attributes.add_dependant base.enumerized_attributes
       super
     end

data/lib/enumerize/predicates.rb

@@ -36,7 +36,7 @@ module Enumerize
       super
 
       if options[:predicates]
-        Builder.new(enumerized_attributes[name], options[:predicates]).build(self)
+        Builder.new(enumerized_attributes[name], options[:predicates]).build(_enumerize_module)
       end
     end
 

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/test/activerecord_test.rb

@@ -14,18 +14,42 @@ ActiveRecord::Base.connection.instance_eval do
     t.string :role
     t.string :name
     t.string :interests
+    t.string :status
+    t.string :account_type, :default => :basic
+  end
+
+  create_table :documents do |t|
+    t.string :visibility
   end
 end
 
+class BaseEntity < ActiveRecord::Base
+  self.abstract_class = true
+
+  extend Enumerize
+  enumerize :visibility, :in => [:public, :private, :protected], :scope => true, :default => :public
+end
+
+class Document < BaseEntity
+end
+
+module RoleEnum
+  extend Enumerize
+  enumerize :role, :in => [:user, :admin], :default => :user, scope: :having_role
+end
+
 class User < ActiveRecord::Base
   extend Enumerize
+  include RoleEnum
 
   enumerize :sex, :in => [:male, :female]
 
-  enumerize :role, :in => [:user, :admin], :default => :user
-
   serialize :interests, Array
   enumerize :interests, :in => [:music, :sports, :dancing, :programming], :multiple => true
+
+  enumerize :status, :in => { active: 1, blocked: 2 }, scope: true
+
+  enumerize :account_type, :in => [:basic, :premium]
 end
 
 describe Enumerize::ActiveRecord do
@@ -58,10 +82,24 @@ describe Enumerize::ActiveRecord do
     User.new.attributes['role'].must_equal 'user'
   end
 
+  it 'uses default value from db column' do
+    User.new.account_type.must_equal 'basic'
+  end
+
+  it 'has default value with default scope' do
+    UserWithDefaultScope = Class.new(User) do
+      default_scope -> { having_role(:user) }
+    end
+
+    UserWithDefaultScope.new.role.must_equal 'user'
+    UserWithDefaultScope.new.attributes['role'].must_equal 'user'
+  end
+
   it 'validates inclusion' do
     user = User.new
     user.role = 'wrong'
     user.wont_be :valid?
+    user.errors[:role].must_include 'is not included in the list'
   end
 
   it 'validates inclusion on mass assignment' do
@@ -127,4 +165,45 @@ describe Enumerize::ActiveRecord do
     user.interests = ['music', '']
     user.must_be :valid?
   end
+
+  it 'adds scope' do
+    user_1 = User.create!(status: :active, role: :admin)
+    user_2 = User.create!(status: :blocked)
+
+    User.with_status(:active).must_equal [user_1]
+    User.with_status(:blocked).must_equal [user_2]
+    User.with_status(:active, :blocked).to_set.must_equal [user_1, user_2].to_set
+
+    User.without_status(:active).must_equal [user_2]
+    User.without_status(:active, :blocked).must_equal []
+
+    User.having_role(:admin).must_equal [user_1]
+  end
+
+  it 'allows either key or value as valid' do
+    user_1 = User.new(status: :active)
+    user_2 = User.new(status: 1)
+    user_3 = User.new(status: '1')
+
+    user_1.status.must_equal 'active'
+    user_2.status.must_equal 'active'
+    user_3.status.must_equal 'active'
+
+    user_1.must_be :valid?
+    user_2.must_be :valid?
+    user_3.must_be :valid?
+  end
+
+  it 'supports defining enumerized attributes on abstract class' do
+    document = Document.new
+    document.visibility = :protected
+    document.visibility.must_equal 'protected'
+  end
+
+  it 'supports defining enumerized scopes on abstract class' do
+    document_1 = Document.create!(visibility: :public)
+    document_2 = Document.create!(visibility: :private)
+
+    Document.with_visibility(:public).must_equal [document_1]
+  end
 end

data/test/attribute_test.rb

@@ -19,10 +19,37 @@ describe Enumerize::Attribute do
     attr.name.must_equal :foo
   end
 
-  it 'returns options for select' do
-    store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
-      build_attr nil, :foo, :in => %w[a b]
-      attr.options.must_equal [['a text', 'a'], ['b text', 'b']]
+  describe 'options for select' do
+    it 'returns all options for select' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options.must_equal [['a text', 'a'], ['b text', 'b']]
+      end
+    end
+
+    it 'returns requested options for select via :only' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options(:only => :a).must_equal [['a text', 'a']]
+        attr.options(:only => [:b]).must_equal [['b text', 'b']]
+        attr.options(:only => []).must_equal []
+      end
+    end
+
+    it 'returns requested options for select via :except' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        attr.options(:except => :a).must_equal [['b text', 'b']]
+        attr.options(:except => :b).must_equal [['a text', 'a']]
+        attr.options(:except => []).must_equal [['a text', 'a'], ['b text', 'b']]
+      end
+    end
+
+    it 'does not work with both :only and :except' do
+      store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+        build_attr nil, :foo, :in => %w[a b]
+        proc { attr.options(:except => [], :only => []) }.must_raise ArgumentError
+      end
     end
   end
 

data/test/base_test.rb

@@ -179,4 +179,11 @@ describe Enumerize::Base do
     object.instance_variable_get(:@foo).must_equal 2
     object.foo.must_equal 'b'
   end
+
+  it 'raises exception when enumerized attribute is already defined' do
+    klass.enumerize :foo, in: %w(a b)
+    proc {
+      klass.enumerize :foo, in: %w(a b)
+    }.must_raise ArgumentError
+  end
 end

data/test/rails_admin_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class RailsAdminSpec < MiniTest::Spec
+  let(:klass) do
+    Class.new do
+      extend Enumerize
+    end
+  end
+
+  let(:object) { klass.new }
+
+  it 'defines enum method' do
+    store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}}) do
+      klass.enumerize(:foo, in: [:a, :b])
+      object.foo_enum.must_equal [['a text', 'a'], ['b text', 'b']]
+    end
+  end
+end

data/test/support/mock_controller.rb

@@ -17,5 +17,9 @@ class MockController
     self
   end
 
-  def hash_for_users_path(*args); end
+  def url_options
+    {}
+  end
+
+  def hash_for_users_path(*); end
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'active_support/core_ext/kernel/reporting'
+require 'active_model'
 
 $VERBOSE=true
 
@@ -12,6 +13,15 @@ module SimpleForm
   end
 end
 
+module Formtastic
+  module Rails
+    VERSION = ActiveSupport::VERSION
+  end
+end
+
+module RailsAdmin
+end
+
 require 'enumerize'
 
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
-  prerelease: false
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
     none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.2'
+    none: false
+  prerelease: false
+  name: activesupport
 description: Enumerated attributes with I18n and ActiveRecord/Mongoid support
 email: team@brainspec.com
 executables: []
@@ -37,6 +37,7 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
+- Gemfile.rails4
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -49,6 +50,8 @@ files:
 - lib/enumerize/form_helper.rb
 - lib/enumerize/hooks/formtastic.rb
 - lib/enumerize/hooks/simple_form.rb
+- lib/enumerize/integrations/rails_admin.rb
+- lib/enumerize/module.rb
 - lib/enumerize/module_attributes.rb
 - lib/enumerize/predicates.rb
 - lib/enumerize/set.rb
@@ -63,6 +66,7 @@ files:
 - test/mongoid_test.rb
 - test/multiple_test.rb
 - test/predicates_test.rb
+- test/rails_admin_test.rb
 - test/set_test.rb
 - test/simple_form_test.rb
 - test/support/mock_controller.rb
@@ -76,42 +80,24 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -178434692500399788
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: 1.9.3
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      hash: -277888819637979361
+      version: '0'
       segments:
       - 0
-      hash: -178434692500399788
-      version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Enumerated attributes with I18n and ActiveRecord/Mongoid support
-test_files:
-- test/activerecord_test.rb
-- test/attribute_map_test.rb
-- test/attribute_test.rb
-- test/base_test.rb
-- test/formtastic_test.rb
-- test/module_attributes_test.rb
-- test/mongoid_test.rb
-- test/multiple_test.rb
-- test/predicates_test.rb
-- test/set_test.rb
-- test/simple_form_test.rb
-- test/support/mock_controller.rb
-- test/support/view_test_helper.rb
-- test/test_helper.rb
-- test/value_test.rb
+test_files: []