enumerize 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a571fc9e3b62621d40cfddd9ba755389dda8115
-  data.tar.gz: e6a8a7e2043a36b8072a2f28cc547efab248770a
+  metadata.gz: a5f9d4b829c7ef4c4f41e2a96e041a4a66771268
+  data.tar.gz: b961d9d0ebe14b4d0f2eadc334fef61cc348283f
 SHA512:
-  metadata.gz: bda0563e282a121e0b5e0a26144a81efc8bde072ebf1a56a357da909421f272cc02b5c7dd85dac6cf7780b42a88e302f7aef020434255682dc9a7d7840e21e9a
-  data.tar.gz: 5c0d858c82b33958edd3a3c8e2b347822641966e6765ad87c7fae7158b1fee0ddaac08ecbc5b88849e392b928c474435e372ceeb2beec7a9c0b3052f937073a3
+  metadata.gz: 53ee726338ce9d36c152691073e5bae144e6fbb665c8d03511a7e66772e116d90dd1a74c8d7b1fa100e7855e9336d45ef5d3afdeb05053f398ee3a073bd854c2
+  data.tar.gz: f3ac55edcb00daeca98564a1da87c4df44c5c32a76e422ad206d50ee7fa0821964c572eefc030b4fec4edb7710582730f43435a57ec452284a235bb39e7e7db5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -4,6 +4,15 @@
 
 ### bug fix
 
+## 1.1.0 (November 15, 2015)
+
+### enhancements
+ * Add Sequel support. (by [@mrbrdo](https://github.com/mrbrdo)) 
+ * Add qualifiers to RSpec matcher. (by [@maurogeorge](https://github.com/maurogeorge))
+ * Support hash in the RSpec matcher. (by [@maurogeorge](https://github.com/maurogeorge))
+
+### bug fix
+
 ## 1.0.0 (August 2, 2015)
 
 ### enhancements

data/Gemfile

@@ -1,22 +1,5 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-gem 'minitest', '~> 5.5.1'
-gem 'rspec', :require => false
-
-gem 'rails', '4.2.0', :require => false
-gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'rubinius-developer_tools'
-  gem 'rubysl-test-unit'
-end
+eval_gemfile('Gemfile.global')
 
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.4', :require => false
 gem 'mongoid'
-gem 'simple_form'
-gem 'formtastic'

data/Gemfile.global

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec', :require => false
+
+gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+gem 'sequel'
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+  gem 'rubinius-developer_tools'
+  gem 'rubysl-test-unit'
+end
+
+gem 'simple_form'
+gem 'formtastic'

data/Gemfile.mongo_mapper

@@ -1,22 +1,5 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-gem 'minitest', '~> 5.5.1'
-gem 'rspec', :require => false
-
-gem 'rails', '4.2.0', :require => false
-gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'rubinius-developer_tools'
-  gem 'rubysl-test-unit'
-end
+eval_gemfile('Gemfile.global')
 
+gem 'minitest', '~> 5.8'
+gem 'rails',    '4.2.4', :require => false
 gem 'mongo_mapper'
-gem 'simple_form'
-gem 'formtastic'

data/Gemfile.rails40

@@ -1,22 +1,5 @@
-source 'https://rubygems.org'
+eval_gemfile('Gemfile.global')
 
-gemspec
-
-gem 'rake'
 gem 'minitest', '~> 4.1'
-gem 'rspec', :require => false
-
-gem 'rails', '4.0.1', :require => false
-gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'rubinius-developer_tools'
-  gem 'rubysl-test-unit'
-end
-
+gem 'rails',    '4.0.13', :require => false
 gem 'mongoid'
-gem 'simple_form'
-gem 'formtastic'

data/README.md

@@ -1,6 +1,6 @@
 # Enumerize [![TravisCI](https://secure.travis-ci.org/brainspec/enumerize.png?branch=master)](http://travis-ci.org/brainspec/enumerize) [![Gemnasium](https://gemnasium.com/brainspec/enumerize.png)](https://gemnasium.com/brainspec/enumerize)
 
-Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper support
+Enumerated attributes with I18n and ActiveRecord/Mongoid/MongoMapper/Sequel support
 
 ## Installation
 
@@ -100,7 +100,7 @@ en:
         female: "Female"
 ```
 
-You can also pass `i18n_scope` option to specify scope (or array of scopes) storring the translations. Note that `i18n_scope` option does not accept scope as array:
+You can also pass `i18n_scope` option to specify scope (or array of scopes) storing the translations.
 
 
 ```ruby
@@ -322,15 +322,155 @@ Also you can use builtin RSpec matcher:
 class User
   extend Enumerize
 
-  enumerize :sex, in: [:male, :female], default: :male
+  enumerize :sex, in: [:male, :female]
 end
 
 describe User do
-  it { should enumerize(:sex).in(:male, :female) }
-  it { should enumerize(:sex).in(:male, :female).with_default(:male) }
+  it { should enumerize(:sex) }
 
   # or with RSpec 3 expect syntax
-  it { is_expected.to enumerize(:sex).in(:male, :female) }
+  it { is_expected.to enumerize(:sex) }
+end
+```
+
+#### Qualifiers
+
+##### in
+
+Use `in` to test usage of the `:in` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female]
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female) }
+end
+```
+
+You can test enumerized attribute value using custom values with the `in`
+qualifier.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: { male: 0, female: 1 }
+end
+
+describe User do
+  it { should enumerize(:sex).in(male: 0, female: 1) }
+end
+```
+
+##### with_default
+
+Use `with_default` to test usage of the `:default` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], default: :female
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_default(:female) }
+end
+```
+
+##### with_i18n_scope
+
+Use `with_i18n_scope` to test usage of the `:i18n_scope` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], i18n_scope: 'sex'
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_i18n_scope('sex') }
+end
+```
+
+##### with_predicates
+
+Use `with_predicates` to test usage of the `:predicates` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], predicates: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_predicates(true) }
+end
+```
+
+You can text prefixed predicates with the `with_predicates` qualifiers.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], predicates: { prefix: true }
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_predicates(prefix: true) }
+end
+```
+
+##### with_scope
+
+Use `with_scope` to test usage of the `:scope` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], scope: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_scope(true) }
+end
+```
+
+You can text custom scope with the `with_scope` qualifiers.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], scope: :having_sex
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_scope(scope: :having_sex) }
+end
+```
+
+##### with_multiple
+
+Use `with_multiple` to test usage of the `:multiple` option.
+
+```ruby
+class User
+  extend Enumerize
+
+  enumerize :sex, in: [:male, :female], multiple: true
+end
+
+describe User do
+  it { should enumerize(:sex).in(:male, :female).with_multiple(true) }
 end
 ```
 

data/Rakefile

@@ -10,8 +10,6 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-RSpec::Core::RakeTask.new('default') do |t|
-  t.pattern = 'test/rspec_spec.rb'
-end
+RSpec::Core::RakeTask.new
 
-task :default => :test
+task :default => [:test, :spec]

data/lib/enumerize.rb

@@ -13,10 +13,12 @@ module Enumerize
   autoload :ModuleAttributes, 'enumerize/module_attributes'
 
   autoload :ActiveRecordSupport, 'enumerize/activerecord'
+  autoload :SequelSupport, 'enumerize/sequel'
   autoload :MongoidSupport,      'enumerize/mongoid'
 
   module Scope
     autoload :ActiveRecord, 'enumerize/scope/activerecord'
+    autoload :Sequel, 'enumerize/scope/sequel'
     autoload :Mongoid,      'enumerize/scope/mongoid'
   end
 
@@ -39,6 +41,11 @@ module Enumerize
       base.extend Enumerize::Scope::Mongoid
     end
 
+    if defined?(::Sequel::Model)
+      base.extend Enumerize::SequelSupport
+      base.extend Enumerize::Scope::Sequel
+    end
+
     if defined?(::RailsAdmin)
       require 'enumerize/integrations/rails_admin'
       base.extend Enumerize::Integrations::RailsAdmin

data/lib/enumerize/base.rb

@@ -65,8 +65,10 @@ module Enumerize
 
       if _enumerized_values_for_validation.has_key?(key)
         _enumerized_values_for_validation[key]
-      else
+      elsif defined?(super)
         super
+      else
+        send(key)
       end
     end
 

data/lib/enumerize/hooks/sequel_dataset.rb

@@ -0,0 +1,19 @@
+module Enumerize
+  module Hooks
+    module SequelDataset
+      def self.included(klass)
+        klass.alias_method_chain :literal_append, :enumerize
+      end
+
+      def literal_append_with_enumerize(sql, v)
+        if v.is_a?(Enumerize::Value)
+          literal_append(sql, v.value)
+        else
+          literal_append_without_enumerize(sql, v)
+        end
+      end
+    end
+  end
+end
+
+::Sequel::Dataset.send :include, Enumerize::Hooks::SequelDataset

data/lib/enumerize/integrations/rspec/matcher.rb

@@ -2,37 +2,57 @@ module Enumerize
   module Integrations
     module RSpec
       class Matcher
-        attr_accessor :attr, :values, :subject, :default
 
-        def initialize(attr)
-          self.attr = attr
+        def initialize(expected_attr)
+          self.expected_attr = expected_attr
         end
 
-        def in(*values)
-          self.values = values.map(&:to_s).sort
+        def in(*expected_values)
+          self.expected_values = expected_values
           self
         end
 
-        def with_default(default)
-          self.default = default.to_s
+        def with_default(expected_default)
+          self.expected_default = expected_default.to_s
           self
         end
 
-        def failure_message
-          message  = " expected :#{attr} to allow value#{values.size == 1 ? nil : 's'}: #{quote_values(values)},"
-          message += " but it allows #{quote_values(enumerized_values)} instead"
+        def with_i18n_scope(expected_i18n_scope)
+          self.expected_i18n_scope = expected_i18n_scope
+          self
+        end
 
-          if default && !matches_default_value?
-            message  = " expected :#{attr} to have #{default.inspect} as default value,"
-            message += " but it sets #{enumerized_default.inspect} instead"
-          end
+        def with_predicates(expected_predicates)
+          self.expected_predicates = expected_predicates
+          self
+        end
+
+        def with_multiple(expected_multiple)
+          self.expected_multiple = expected_multiple
+          self
+        end
+
+        def with_scope(expected_scope)
+          self.expected_scope = expected_scope
+          self
+        end
+
+        def failure_message
+          "Expected #{expectation}"
+        end
 
-          message
+        def failure_message_when_negated
+          "Did not expect #{expectation}"
         end
 
         def description
-          description  = "enumerize :#{attr} in: #{quote_values(values)}"
-          description += " with #{default.inspect} as default value" if default
+          description  = "define enumerize :#{expected_attr}"
+          description += " in: #{quote_values(expected_values)}" if expected_values
+          description += " with #{expected_default.inspect} as default value" if expected_default
+          description += " i18n_scope: #{expected_i18n_scope.inspect}" if expected_i18n_scope
+          description += " predicates: #{expected_predicates.inspect}" if expected_predicates
+          description += " multiple: #{expected_multiple.inspect}" if expected_multiple
+          description += " scope: #{expected_scope.inspect}" if expected_scope
 
           description
         end
@@ -41,36 +61,97 @@ module Enumerize
           self.subject = subject
           matches      = true
 
-          matches &= matches_attributes?
-          matches &= matches_default_value? if default
+          matches &= matches_attribute?
+          matches &= matches_values? if expected_values
+          matches &= matches_default_value? if expected_default
+          matches &= matches_i18n_scope? if expected_i18n_scope
+          matches &= matches_predicates? if expected_predicates
+          matches &= matches_multiple? if expected_multiple
+          matches &= matches_scope? if expected_scope
 
           matches
         end
 
         private
+        attr_accessor :expected_attr, :expected_values, :subject, :expected_default,
+                      :expected_i18n_scope, :expected_predicates, :expected_multiple,
+                      :expected_scope
 
-        def matches_attributes?
-          values == enumerized_values
+        def expectation
+          "#{subject.class.name} to #{description}"
+        end
+
+        def matches_attribute?
+          attributes.present?
+        end
+
+        def matches_values?
+          matches_array_values? || matches_hash_values?
+        end
+
+        def matches_array_values?
+          sorted_values == enumerized_values
+        end
+
+        def matches_hash_values?
+          return unless expected_values.first.is_a?(Hash)
+          expected_values.first.all? { |k, v| enumerized_value_hash[k.to_s] == v; }
         end
 
         def matches_default_value?
-          default == enumerized_default
+          expected_default == enumerized_default
+        end
+
+        def matches_i18n_scope?
+          attributes.i18n_scope == expected_i18n_scope
+        end
+
+        def matches_predicates?
+          if expected_predicates.is_a?(TrueClass)
+            subject.respond_to?("#{sorted_values.first}?")
+          else
+            subject.respond_to?("#{expected_attr}_#{attributes.values.first}?")
+          end
+        end
+
+        def matches_multiple?
+          subject.instance_variable_defined?("@_#{expected_attr}_enumerized_set")
+        end
+
+        def matches_scope?
+          if expected_scope.is_a?(TrueClass)
+            subject_class.respond_to?("with_#{expected_attr}")
+          else
+            subject_class.respond_to?(expected_scope[:scope])
+          end
+        end
+
+        def sorted_values
+          @sorted_values ||=expected_values.map(&:to_s).sort
         end
 
         def enumerized_values
-          @enumerized_values ||= attributes[attr.to_s].values.sort
+          @enumerized_values ||= attributes.values.sort
         end
 
         def enumerized_default
-          @enumerized_default ||= attributes[attr.to_s].default_value
+          @enumerized_default ||= attributes.default_value
+        end
+
+        def enumerized_value_hash
+          @enumerized_value_hash ||= attributes.instance_variable_get('@value_hash')
         end
 
         def attributes
-          subject.class.enumerized_attributes.attributes
+          subject_class.enumerized_attributes.attributes[expected_attr.to_s]
+        end
+
+        def subject_class
+          @subject_class ||= subject.class
         end
 
         def quote_values(values)
-          values.map(&:inspect).join(', ')
+          sorted_values.map(&:inspect).join(', ')
         end
       end
     end