enumerize 0.3.0 → 0.4.0

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
+services:
+  - mongodb
 before_install:
   - gem install bundler
 rvm:
-  - 1.9.2
   - 1.9.3
-gemfile:
-  - gemfiles/Gemfile-ar-3.1.x
-  - Gemfile
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.4.0 (September 6, 2012) ##
+
+Legacy support was dropped. The following versions are supported:
+
+* Ruby 1.9.3+ (including JRuby and Rubinius)
+* Rails 3.2+
+* Formtastic 2.2+
+* SimpleForm 2+
+* Mongoid 3+
+
+### enchancements
+  * Ability to define predicate methods on enumerized object. (by [@lest](https://github.com/lest))
+
 ## 0.3.0 (July 9, 2012) ##
 
 ### enhancements

data/Gemfile

@@ -6,7 +6,8 @@ gem 'rake'
 gem 'minitest', '~> 3.1'
 
 gem 'activerecord', '~> 3.2.0'
-gem 'sqlite3'
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
 gem 'mongoid'
 gem 'simple_form'

data/README.md

@@ -101,6 +101,39 @@ user.sex.male? #=> true
 user.sex.female? #=> false
 ```
 
+Predicate methods:
+
+```ruby
+class User
+  include Enumerize
+  enumerize :sex, in: %w(male female), predicates: true
+end
+
+user = User.new
+
+user.male?   # => false
+user.female? # => false
+
+user.sex = 'male'
+
+user.male?   # => true
+user.female? # => false
+```
+
+Using prefix:
+
+```ruby
+class User
+  include Enumerize
+  enumerize :sex, in: %w(male female), predicates: { prefix: true }
+end
+
+user = User.new
+user.sex = 'female'
+user.sex_female? # => true
+```
+Use `:only` and `:except` options to specify what values create predicate methods for.
+
 To make some attributes shared across different classes it's possible to define them in a separate module and then include it into classes:
 
 ```ruby

data/enumerize.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Enumerize::VERSION
 
-  gem.add_dependency('activesupport', '>= 3.1.3')
+  gem.add_dependency('activesupport', '>= 3.2')
 end

data/lib/enumerize.rb

@@ -7,10 +7,13 @@ module Enumerize
   autoload :Value,        'enumerize/value'
   autoload :Base,         'enumerize/base'
   autoload :ActiveRecord, 'enumerize/activerecord'
+  autoload :Predicates,   'enumerize/predicates'
   autoload :ModuleAttributes, 'enumerize/module_attributes'
 
   def self.included(base)
     base.send :include, Enumerize::Base
+    base.extend Enumerize::Predicates
+
     if defined?(::ActiveRecord::Base) && base < ::ActiveRecord::Base
       base.extend Enumerize::ActiveRecord
     end

data/lib/enumerize/base.rb

@@ -26,7 +26,7 @@ module Enumerize
         RUBY
 
         if respond_to?(:validates)
-          validates name, :inclusion => {:in => enumerized_attributes[name].values.map(&:to_s), :allow_nil => true, :allow_blank => true}
+          validates name, :inclusion => { :in => enumerized_attributes[name].values, :allow_nil => true, :allow_blank => true }
         end
       end
 
@@ -60,8 +60,6 @@ module Enumerize
           def #{attr.name}
             if defined?(super)
               self.class.enumerized_attributes[:#{attr.name}].find_value(super)
-            elsif respond_to?(:read_attribute, true)
-              self.class.enumerized_attributes[:#{attr.name}].find_value(read_attribute(:#{attr.name}))
             else
               if defined?(@#{attr.name})
                 self.class.enumerized_attributes[:#{attr.name}].find_value(@#{attr.name})
@@ -79,8 +77,6 @@ module Enumerize
 
             if defined?(super)
               super allowed_value_or_nil
-            elsif respond_to?(:write_attribute, true)
-              write_attribute :#{attr.name}, allowed_value_or_nil
             else
               @#{attr.name} = allowed_value_or_nil
             end

data/lib/enumerize/hooks/formtastic.rb

@@ -21,8 +21,4 @@ module Enumerize
   end
 end
 
-if defined? ::Formtastic::SemanticFormBuilder
-  ::Formtastic::SemanticFormBuilder.send :include, Enumerize::Hooks::FormtasticFormBuilderExtension
-else
-  ::Formtastic::FormBuilder.send :include, Enumerize::Hooks::FormtasticFormBuilderExtension
-end
+::Formtastic::FormBuilder.send :include, Enumerize::Hooks::FormtasticFormBuilderExtension

data/lib/enumerize/predicates.rb

@@ -0,0 +1,72 @@
+module Enumerize
+  # Predicate methods.
+  #
+  # Basic usage:
+  #
+  #     class User
+  #       include Enumerize
+  #       enumerize :sex, in: %w(male female), predicates: true
+  #     end
+  #
+  #     user = User.new
+  #
+  #     user.male?   # => false
+  #     user.female? # => false
+  #
+  #     user.sex = 'male'
+  #
+  #     user.male?   # => true
+  #     user.female? # => false
+  #
+  # Using prefix:
+  #
+  #     class User
+  #       include Enumerize
+  #       enumerize :sex, in: %w(male female), predicates: { prefix: true }
+  #     end
+  #
+  #     user = User.new
+  #     user.sex = 'female'
+  #     user.sex_female? # => true
+  #
+  # Use <tt>only</tt> and <tt>except</tt> options to specify what values create
+  # predicate methods for.
+  module Predicates
+    def enumerize(name, options={})
+      super
+
+      if options[:predicates]
+        Builder.new(enumerized_attributes[name], options[:predicates]).build(self)
+      end
+    end
+
+    class Builder
+      def initialize(attr, options)
+        @attr    = attr
+        @options = options.is_a?(Hash) ? options : {}
+      end
+
+      def values
+        values = @attr.values
+
+        if @options[:only]
+          values &= Array(@options[:only]).map(&:to_s)
+        end
+
+        if @options[:except]
+          values -= Array(@options[:except]).map(&:to_s)
+        end
+
+        values
+      end
+
+      def names
+        values.map { |v| "#{v}?" }
+      end
+
+      def build(klass)
+        klass.delegate(*names, to: @attr.name, prefix: @options[:prefix], allow_nil: true)
+      end
+    end
+  end
+end

data/lib/enumerize/value.rb

@@ -18,7 +18,7 @@ module Enumerize
     end
 
     def method_missing(method, *args, &block)
-      if method[-1] == '?' && @attr.values.include?(method[0..-2])
+      if boolean_method?(method)
         define_query_methods
         send(method, *args, &block)
       else
@@ -26,13 +26,8 @@ module Enumerize
       end
     end
 
-    def respond_to?(method, include_private=false)
-      if super
-        true
-      elsif method[-1] == '?' && @attr.values.include?(method[0..-2])
-        define_query_methods
-        super
-      end
+    def respond_to_missing?(method, include_private=false)
+      boolean_method?(method)
     end
 
     private
@@ -65,5 +60,9 @@ module Enumerize
     def i18n_suffix
       "#{@attr.i18n_suffix}." if @attr.i18n_suffix
     end
+
+    def boolean_method?(method)
+      method[-1] == '?' && @attr.values.include?(method[0..-2])
+    end
   end
 end

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/formtastic_test.rb

@@ -1,13 +1,11 @@
 require 'test_helper'
 
-if defined? Formtastic::Helpers::InputHelper
-  module Formtastic
-    module Helpers
-      module InputHelper
-        remove_method :input_class
-        def input_class(as)
-          input_class_with_const_defined(as)
-        end
+module Formtastic
+  module Helpers
+    module InputHelper
+      remove_method :input_class
+      def input_class(as)
+        input_class_with_const_defined(as)
       end
     end
   end
@@ -15,11 +13,7 @@ end
 
 class FormtasticSpec < MiniTest::Spec
   include ViewTestHelper
-  if defined? Formtastic::SemanticFormHelper
-    include Formtastic::SemanticFormHelper
-  else
-    include Formtastic::Helpers::FormHelper
-  end
+  include Formtastic::Helpers::FormHelper
 
   class User < Struct.new(:sex, :age)
     extend ActiveModel::Naming

data/test/mongoid_test.rb

@@ -5,7 +5,7 @@ silence_warnings do
 end
 
 Mongoid.configure do |config|
-  config.master  = Mongo::Connection.new('127.0.0.1', 27017).db('enumerize-test-suite')
+  config.sessions = { :default => { :database => 'enumerize-test-suite', hosts: ['127.0.0.1:27017'] } }
   config.use_utc = true
   config.include_root_in_json = true
 end

data/test/predicates_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+describe Enumerize::Predicates do
+  let(:klass) do
+    Class.new do
+      include Enumerize
+    end
+  end
+
+  let(:object) { klass.new }
+
+  it 'creates predicate methods' do
+    klass.enumerize(:foo, in: %w(a b), predicates: true)
+    object.must_respond_to :a?
+    object.must_respond_to :b?
+  end
+
+  it 'checks values' do
+    klass.enumerize(:foo, in: %w(a b), predicates: true)
+    object.foo = 'a'
+    object.a?.must_equal true
+    object.b?.must_equal false
+  end
+
+  it 'prefixes methods' do
+    klass.enumerize(:foo, in: %w(a b), predicates: { prefix: 'bar' })
+    object.wont_respond_to :a?
+    object.wont_respond_to :b?
+    object.must_respond_to :bar_a?
+    object.must_respond_to :bar_b?
+  end
+
+  it 'accepts only option' do
+    klass.enumerize(:foo, in: %w(a b), predicates: { only: :a })
+    object.must_respond_to :a?
+    object.wont_respond_to :b?
+  end
+
+  it 'accepts except option' do
+    klass.enumerize(:foo, in: %w(a b), predicates: { except: :a })
+    object.wont_respond_to :a?
+    object.must_respond_to :b?
+  end
+end

data/test/value_test.rb

@@ -42,6 +42,10 @@ describe Enumerize::Value do
       value.must_respond_to :other_value?
     end
 
+    it 'returns a method object' do
+      value.method(:test_value?).must_be_instance_of Method
+    end
+
     it "doesn't respond to a method for not existing value" do
       value.wont_respond_to :some_method?
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '3.2'
 description: Enumerated attributes with I18n and ActiveRecord/Mongoid support
 email: team@brainspec.com
 executables: []
@@ -41,7 +41,6 @@ files:
 - README.md
 - Rakefile
 - enumerize.gemspec
-- gemfiles/Gemfile-ar-3.1.x
 - lib/enumerize.rb
 - lib/enumerize/activerecord.rb
 - lib/enumerize/attribute.rb
@@ -50,6 +49,7 @@ files:
 - lib/enumerize/hooks/formtastic.rb
 - lib/enumerize/hooks/simple_form.rb
 - lib/enumerize/module_attributes.rb
+- lib/enumerize/predicates.rb
 - lib/enumerize/value.rb
 - lib/enumerize/version.rb
 - test/activerecord_test.rb
@@ -59,6 +59,7 @@ files:
 - test/formtastic_test.rb
 - test/module_attributes_test.rb
 - test/mongoid_test.rb
+- test/predicates_test.rb
 - test/simple_form_test.rb
 - test/support/mock_controller.rb
 - test/support/view_test_helper.rb
@@ -78,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3692164922268239392
+      hash: 1785538232513352876
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3692164922268239392
+      hash: 1785538232513352876
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -102,6 +103,7 @@ test_files:
 - test/formtastic_test.rb
 - test/module_attributes_test.rb
 - test/mongoid_test.rb
+- test/predicates_test.rb
 - test/simple_form_test.rb
 - test/support/mock_controller.rb
 - test/support/view_test_helper.rb

data/gemfiles/Gemfile-ar-3.1.x

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'enumerize', :path => '..'
-
-gem 'rake'
-gem 'minitest', '~> 3.0.0'
-
-gem 'activerecord', '~> 3.1.0'
-gem 'sqlite3'
-
-gem 'mongoid'
-gem 'simple_form', '~> 1.5.2'
-gem 'formtastic',  '~> 1.2.4'