enumerize 1.0.0 → 1.1.0

data/lib/enumerize/scope/sequel.rb

@@ -0,0 +1,40 @@
+module Enumerize
+  module Scope
+    module Sequel
+      def enumerize(name, options={})
+        super
+
+        _enumerize_module.dependent_eval do
+          if defined?(::Sequel::Model) && self < ::Sequel::Model
+            if options[:scope]
+              _define_sequel_scope_methods!(name, options)
+            end
+
+            require 'enumerize/hooks/sequel_dataset'
+          end
+        end
+      end
+
+      private
+
+      def _define_sequel_scope_methods!(name, options)
+        klass = self
+        scope_name = options[:scope] == true ? "with_#{name}" : options[:scope]
+
+        def_dataset_method scope_name do |*values|
+          values = values.map { |value| klass.enumerized_attributes[name].find_value(value).value }
+          values = values.first if values.size == 1
+
+          where(name => values)
+        end
+
+        if options[:scope] == true
+          def_dataset_method "without_#{name}" do |*values|
+            values = values.map { |value| klass.enumerized_attributes[name].find_value(value).value }
+            exclude(name => values)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/sequel.rb

@@ -0,0 +1,57 @@
+module Enumerize
+  module SequelSupport
+    def enumerize(name, options={})
+      super
+
+      _enumerize_module.dependent_eval do
+        if defined?(::Sequel::Model) && self < ::Sequel::Model
+          include InstanceMethods
+
+          require 'enumerize/hooks/sequel_dataset'
+        end
+      end
+    end
+
+    private
+
+    module InstanceMethods
+      def validate
+        super
+        
+        self.class.enumerized_attributes.each do |attr|
+          value = read_attribute_for_validation(attr.name)
+          next if value.blank?
+
+          if attr.kind_of? Multiple
+            errors.add attr.name, "is invalid" unless value.respond_to?(:all?) && value.all? { |v| v.blank? || attr.find_value(v) }
+          else
+            errors.add attr.name, "is not included in the list" unless attr.find_value(value)
+          end
+        end
+      end
+
+      def _set_default_value_for_enumerized_attributes
+        _enumerized_values_for_validation.delete_if do |k, v|
+          v.nil?
+        end
+
+        if defined?(Sequel::Plugins::Serialization::InstanceMethods)
+          modules = self.class.ancestors
+          plugin_idx = modules.index(Sequel::Plugins::Serialization::InstanceMethods)
+          
+          if plugin_idx && plugin_idx < modules.index(Enumerize::SequelSupport::InstanceMethods)
+            abort "ERROR: You need to enable the Sequel serialization plugin before calling any enumerize methods on a model."
+          end
+          
+          plugin_idx = modules.index(Sequel::Plugins::ValidationHelpers::InstanceMethods)
+          
+          if plugin_idx && plugin_idx < modules.index(Enumerize::SequelSupport::InstanceMethods)
+            abort "ERROR: You need to enable the Sequel validation_helpers plugin before calling any enumerize methods on a model."
+          end
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/enumerize/set.rb

@@ -37,12 +37,13 @@ module Enumerize
     end
 
     def texts
-      @values.collect { |value| value.text }
+      @values.map(&:text)
     end
 
     delegate :join, to: :to_ary
 
     def ==(other)
+      return false unless other.respond_to?(:each)
       other.size == size && other.all? { |v| @values.include?(@attr.find_value(v)) }
     end
 

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/enumerize/integrations/rspec/matcher_spec.rb

@@ -0,0 +1,254 @@
+require 'active_record'
+
+silence_warnings do
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Base.logger = Logger.new(nil)
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+end
+
+ActiveRecord::Base.connection.instance_eval do
+  create_table :users do |t|
+    t.string :sex
+    t.string :role
+    t.string :account_type
+  end
+end
+
+class User < ActiveRecord::Base
+  extend Enumerize
+
+  enumerize :sex, :in => [:male, :female], scope: true
+  enumerize :role, :in => [:user, :admin], scope: :having_role
+  enumerize :account_type, :in => [:basic, :premium]
+end
+
+RSpec.describe Enumerize::Integrations::RSpec::Matcher do
+
+  let(:model) do
+    Class.new do
+      extend Enumerize
+
+      def self.name
+        'Model'
+      end
+    end
+  end
+
+  subject do
+    model.new
+  end
+
+  describe 'without qualifier' do
+
+    it 'accepts when has defined a enumerize' do
+      model.enumerize(:sex, :in => [:male, :female])
+      expect(subject).to enumerize(:sex)
+    end
+
+    it 'rejects when has not defined a enumerize' do
+      message = 'Expected Model to define enumerize :sex'
+      expect do
+        expect(subject).to enumerize(:sex)
+      end.to fail_with(message)
+    end
+  end
+
+  describe '#in' do
+
+    context 'defined as array' do
+
+      before do
+        model.enumerize(:sex, :in => [:male, :female])
+      end
+
+      it 'accepts the right params as a array' do
+        expect(subject).to enumerize(:sex).in(:male, :female)
+      end
+
+      it 'accepts the the right params in a different order' do
+        expect(subject).to enumerize(:sex).in(:female, :male)
+      end
+
+      it 'rejects wrong params' do
+        message = 'Expected Model to define enumerize :sex in: "boy", "girl"'
+        expect do
+          expect(subject).to enumerize(:sex).in(:boy, :girl)
+        end.to fail_with(message)
+      end
+
+      it 'has the right message when negated' do
+        message = 'Did not expect Model to define enumerize :sex in: "female", "male"'
+        expect do
+          expect(subject).to_not enumerize(:sex).in(:male, :female)
+        end.to fail_with(message)
+      end
+    end
+
+    context 'defined as hash' do
+
+      before do
+        model.enumerize(:sex, :in => { male: 0, female: 1 })
+      end
+
+      it 'accepts the right params as a array' do
+        expect(subject).to enumerize(:sex).in(:male, :female)
+      end
+
+      it 'accepts the right params as a hash' do
+        expect(subject).to enumerize(:sex).in(male: 0, female: 1)
+      end
+
+      it 'accepts the right params as a hash in a different order' do
+        expect(subject).to enumerize(:sex).in(female: 1, male: 0)
+      end
+
+      it 'rejects wrong keys' do
+        message = 'Expected Model to define enumerize :sex in: "{:boy=>0, :girl=>1}"'
+        expect do
+          expect(subject).to enumerize(:sex).in(boy: 0, girl: 1)
+        end.to fail_with(message)
+      end
+
+      it 'rejects wrong values' do
+        message = 'Expected Model to define enumerize :sex in: "{:male=>2, :female=>3}"'
+        expect do
+        expect(subject).to enumerize(:sex).in(male: 2, female: 3)
+        end.to fail_with(message)
+      end
+    end
+
+    it 'has the right description' do
+      matcher = enumerize(:sex).in(:male, :female)
+      expect(matcher.description).to eq('define enumerize :sex in: "female", "male"')
+    end
+  end
+
+  describe '#with_default' do
+
+    before do
+      model.enumerize(:sex, :in => [:male, :female], default: :female)
+    end
+
+    it 'accepts the right default value' do
+      expect(subject).to enumerize(:sex).in(:male, :female).with_default(:female)
+    end
+
+    it 'rejects the wrong default value' do
+      message = 'Expected Model to define enumerize :sex in: "female", "male" with "male" as default value'
+      expect do
+        expect(subject).to enumerize(:sex).in(:male, :female).with_default(:male)
+      end.to fail_with(message)
+    end
+
+    it 'rejects if the `in` is wrong with a correct default value' do
+      message = 'Expected Model to define enumerize :sex in: "boy", "girl" with "female" as default value'
+      expect do
+        expect(subject).to enumerize(:sex).in(:boy, :girl).with_default(:female)
+      end.to fail_with(message)
+    end
+
+    it 'has the right description' do
+      matcher = enumerize(:sex).in(:male, :female).with_default(:female)
+      message = 'define enumerize :sex in: "female", "male" with "female" as default value'
+      expect(matcher.description).to eq(message)
+    end
+  end
+
+  describe '#with_i18n_scope' do
+
+    context 'defined as string' do
+
+      before do
+        model.enumerize(:sex, :in => [:male, :female], i18n_scope: 'sex')
+      end
+
+      it 'accepts the right i18n_scope' do
+        expect(subject).to enumerize(:sex).in(:male, :female).with_i18n_scope('sex')
+      end
+
+      it 'rejects the wrong i18n_scope' do
+        message = 'Expected Model to define enumerize :sex in: "female", "male" i18n_scope: "gender"'
+        expect do
+          expect(subject).to enumerize(:sex).in(:male, :female).with_i18n_scope('gender')
+        end.to fail_with(message)
+      end
+    end
+
+    context 'defined as array' do
+
+      before do
+        model.enumerize(:sex, :in => [:male, :female], i18n_scope: ['sex', 'more.sex'])
+      end
+
+      it 'accepts the wrong i18n_scope' do
+        expect(subject).to enumerize(:sex).in(:male, :female).with_i18n_scope(['sex', 'more.sex'])
+      end
+
+      it 'rejects the wrong i18n_scope' do
+        message = 'Expected Model to define enumerize :sex in: "female", "male" i18n_scope: ["sex"]'
+        expect do
+          expect(subject).to enumerize(:sex).in(:male, :female).with_i18n_scope(['sex'])
+        end.to fail_with(message)
+      end
+    end
+  end
+
+  describe '#with_predicates' do
+
+    it 'accepts when predicates is defined as a boolean' do
+      model.enumerize(:sex, :in => [:male, :female], predicates: true)
+      expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(true)
+    end
+
+    it 'accepts when predicates is defined as a hash' do
+      model.enumerize(:sex, :in => [:male, :female], predicates: { prefix: true })
+      expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(prefix: true)
+    end
+
+    it 'rejects when predicates is not defined' do
+      model.enumerize(:sex, :in => [:male, :female])
+      message = 'Expected Model to define enumerize :sex in: "female", "male" predicates: true'
+      expect do
+        expect(subject).to enumerize(:sex).in(:male, :female).with_predicates(true)
+      end.to fail_with(message)
+    end
+  end
+
+  describe '#with_multiple' do
+
+    it 'accepts when has defined the multiple' do
+      model.enumerize(:sex, :in => [:male, :female], multiple: true)
+      expect(subject).to enumerize(:sex).in(:male, :female).with_multiple(true)
+    end
+
+    it 'rejects when has not defined the multiple' do
+      model.enumerize(:sex, :in => [:male, :female])
+      message = 'Expected Model to define enumerize :sex in: "female", "male" multiple: true'
+      expect do
+        expect(subject).to enumerize(:sex).in(:male, :female).with_multiple(true)
+      end.to fail_with(message)
+    end
+  end
+
+  describe '#with_scope' do
+
+    subject do
+      User.new
+    end
+
+    it 'accepts when scope is defined as a boolean' do
+      expect(subject).to enumerize(:sex).in(:male, :female).with_scope(true)
+    end
+
+    it 'accepts when scope is defined as a hash' do
+      expect(subject).to enumerize(:role).in(:user, :admin).with_scope(scope: :having_role)
+    end
+
+    it 'rejects when scope is not defined' do
+      message = 'Expected User to define enumerize :account_type in: "basic", "premium" scope: true'
+      expect do
+        expect(subject).to enumerize(:account_type).in(:basic, :premium).with_scope(true)
+      end.to fail_with(message)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rails'
+require 'enumerize'
+require 'rspec/matchers/fail_matchers'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+  config.warnings = true
+  config.include RSpec::Matchers::FailMatchers
+end

data/test/sequel_test.rb

@@ -0,0 +1,291 @@
+require 'test_helper'
+require 'sequel'
+require 'logger'
+require 'jdbc/sqlite3' if RUBY_PLATFORM == 'java'
+
+module SequelTest
+  silence_warnings do
+    DB = if RUBY_PLATFORM == 'java'
+      Sequel.connect('jdbc:sqlite::memory:')
+    else
+      Sequel.sqlite
+    end
+    DB.loggers << Logger.new(nil)
+  end
+
+  DB.create_table :users do
+    primary_key :id
+    String :sex
+    String :role
+    String :lambda_role
+    String :name
+    String :interests
+    String :status
+    String :account_type, default: "basic"
+  end
+
+  DB.create_table :documents do
+    primary_key :id
+    String :visibility
+    Time :created_at
+    Time :updated_at
+  end
+
+  class Document < Sequel::Model
+    extend Enumerize
+    enumerize :visibility, :in => [:public, :private, :protected], :scope => true, :default => :public
+  end
+
+  module RoleEnum
+    extend Enumerize
+    enumerize :role, :in => [:user, :admin], :default => :user, scope: :having_role
+    enumerize :lambda_role, :in => [:user, :admin], :default => lambda { :admin }
+  end
+
+  class User < Sequel::Model
+    plugin :serialization, :json, :interests
+    plugin :dirty
+    plugin :defaults_setter
+    plugin :validation_helpers
+    extend Enumerize
+    include RoleEnum
+
+    enumerize :sex, :in => [:male, :female]
+
+    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
+
+  class UniqStatusUser < User
+    def validate
+      super
+      validates_unique :status
+      validates_presence :sex
+    end
+  end
+
+  describe Enumerize::SequelSupport do
+    it 'sets nil if invalid value is passed' do
+      user = User.new
+      user.sex = :invalid
+      user.sex.must_equal nil
+    end
+
+    it 'saves value' do
+      User.filter.delete
+      user = User.new
+      user.sex = :female
+      user.save
+      user.sex.must_equal 'female'
+    end
+
+    it 'loads value' do
+      User.filter.delete
+      User.create(:sex => :male)
+      store_translations(:en, :enumerize => {:sex => {:male => 'Male'}}) do
+        user = User.first
+        user.sex.must_equal 'male'
+        user.sex_text.must_equal 'Male'
+      end
+    end
+
+    it 'has default value' do
+      User.new.role.must_equal 'user'
+      User.new.values[:role].must_equal 'user'
+    end
+
+    it 'does not set default value for not selected attributes' do
+      User.filter.delete
+      User.create(:sex => :male)
+
+      assert_equal [:id], User.select(:id).first.values.keys
+    end
+
+    it 'has default value with lambda' do
+      User.new.lambda_role.must_equal 'admin'
+      User.new.values[:lambda_role].must_equal 'admin'
+    end
+    it 'uses after_initialize callback to set default value' do
+      User.filter.delete
+      User.create(sex: 'male', lambda_role: nil)
+
+      user = User.where(:sex => 'male').first
+      user.lambda_role.must_equal 'admin'
+    end
+
+    it 'uses default value from db column' do
+      User.new.account_type.must_equal 'basic'
+    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
+      assert_raises Sequel::ValidationFailed do
+        User.create(role: 'wrong')
+      end
+    end
+
+    it "uses persisted value for validation if it hasn't been set" do
+      user = User.create :sex => :male
+      User[user.id].read_attribute_for_validation(:sex).must_equal 'male'
+    end
+
+    it 'is valid with empty string assigned' do
+      user = User.new
+      user.role = ''
+      user.must_be :valid?
+    end
+
+    it 'stores nil when empty string assigned' do
+      user = User.new
+      user.role = ''
+      user.values[:role].must_equal nil
+    end
+
+    it 'supports multiple attributes' do
+      user = User.new
+      user.interests ||= []
+      user.interests.must_be_empty
+      user.interests << "music"
+      user.interests.must_equal %w(music)
+      user.save
+
+      user = User[user.id]
+      user.interests.must_be_instance_of Enumerize::Set
+      user.interests.must_equal %w(music)
+      user.interests << "sports"
+      user.interests.must_equal %w(music sports)
+
+      user.interests = []
+      interests = user.interests
+      interests << "music"
+      interests.must_equal %w(music)
+      interests << "dancing"
+      interests.must_equal %w(music dancing)
+    end
+
+    it 'returns invalid multiple value for validation' do
+      user = User.new
+      user.interests << :music
+      user.interests << :invalid
+      values = user.read_attribute_for_validation(:interests)
+      values.must_equal %w(music invalid)
+    end
+
+    it 'validates multiple attributes' do
+      user = User.new
+      user.interests << :invalid
+      user.wont_be :valid?
+
+      user.interests = Object.new
+      user.wont_be :valid?
+
+      user.interests = ['music', '']
+      user.must_be :valid?
+    end
+
+    it 'stores custom values for multiple attributes' do
+      User.filter.delete
+
+      klass = Class.new(User)
+      klass.enumerize :interests, in: { music: 0, sports: 1, dancing: 2, programming: 3}, multiple: true
+
+      user = klass.new
+      user.interests << :music
+      user.interests.must_equal %w(music)
+      user.save
+
+      user = klass[user.id]
+      user.interests.must_equal %w(music)
+    end
+
+    it 'adds scope' do
+      User.filter.delete
+
+      user_1 = User.create(status: :active, role: :admin)
+      user_2 = User.create(status: :blocked)
+
+      User.with_status(:active).to_a.must_equal [user_1]
+      User.with_status(:blocked).to_a.must_equal [user_2]
+      User.with_status(:active, :blocked).to_set.must_equal [user_1, user_2].to_set
+
+      User.without_status(:active).to_a.must_equal [user_2]
+      User.without_status(:active, :blocked).to_a.must_equal []
+
+      User.having_role(:admin).to_a.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.filter.delete
+
+      document = Document.new
+      document.visibility = :protected
+      document.visibility.must_equal 'protected'
+    end
+
+    it 'supports defining enumerized scopes on abstract class' do
+      Document.filter.delete
+
+      document_1 = Document.create(visibility: :public)
+      document_2 = Document.create(visibility: :private)
+
+      Document.with_visibility(:public).to_a.must_equal [document_1]
+    end
+
+    it 'validates uniqueness' do
+      user = User.create(status: :active, sex: "male")
+
+      user = UniqStatusUser.new
+      user.sex = "male"
+      user.status = :active
+      user.valid?.must_equal false
+
+      user.errors[:status].wont_be :empty?
+    end
+
+    it "doesn't update record" do
+      Document.filter.delete
+
+      expected = Time.new(2010, 10, 10)
+
+      document = Document.new
+      document.updated_at = expected
+      document.save
+
+      document = Document.last
+      document.save
+
+      assert_equal expected, document.updated_at
+    end
+
+    it 'changes from dirty should be serialized as scalar values' do
+      user = User.create(:status => :active)
+      user.status = :blocked
+
+      expected = { status: [1, 2] }.to_yaml
+      assert_equal expected, user.column_changes.to_yaml
+    end
+  end
+end