active_enum 1.0.0.rc2 → 1.0.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0463e9528b9a2ec019caf593cfc2becaa1767a116d4657d93de5462c8fb5475
-  data.tar.gz: 2cd9be66544fa2bd00cf2ace406c4c5010411f02d53f1c926d0f197609e89993
+  metadata.gz: 5c79754f5d68c12d7955e1a77e870612ffb1fdb62cc65681e50efc137da125ba
+  data.tar.gz: e0604ad18f10935d8111491b18481e3b273b7d6d064c0284c41c02836cadff3c
 SHA512:
-  metadata.gz: efd7a02386a9e3a6a45812b35e8c509ac60d47249238bee485b00fc8d0a1598ed8a0ae5319e02d76f59ca06ccce5e22dfd25ad0b217ee29f7471510a8deeb15c
-  data.tar.gz: d69b2b354382981ba79af48b3d0306839a1f218d7e7bf01136a2021fdc7026a4b0eedfc40e00e5d63c24deaf2eccf00b5727083a8a2023947a29a00ed579a5ec
+  metadata.gz: '07383e22c02937744c155c72e0c35333c03169f7f3807dfd54765f490a225035ecd24017664fe7b1274c134422e164b12d4fc1a18f57b227f649b93bb166c3b2'
+  data.tar.gz: 8bd02a86d9a478ec1bf1cbdf76f28fa6d673b00c61f2edddf6a9c3d90782a33986087ff8a3cf789ab439ab58b60227f3f7c36c4ab5ab097ee6b6430bff119119

data/.travis.yml

@@ -1,8 +1,8 @@
-env:
-  - "RAILS_VERSION=3.1.0"
-  - "RAILS_VERSION=3.2.0"
-  - "RAILS_VERSION=4.0.0"
-  - "RAILS_VERSION=master"
+gemfile:
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.5.8
+  - 2.6.6

data/README.rdoc

@@ -15,7 +15,7 @@ From gem version 1.0 onwards this plugin will only have Rails 4+ support. If you
 
 Put this in your Gemfile
 
-  gem 'active_enum', '~> 1.0.0.pre'
+  gem 'active_enum', '~> 1.0.0.rc4'
 
 Then generate the config initializer file
 

data/Rakefile

@@ -24,8 +24,3 @@ end
 
 desc 'Default: run specs.'
 task :default => :spec
-
-task :all do
-  sh "export FORMTASTIC=2.0 && bundle install && bundle exec rake"
-  sh "export FORMTASTIC=1.2 && bundle install && bundle exec rake"
-end

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 4.2.11"
+
+gem 'sqlite3', '~> 1.3.0'
+
+gem 'rake'
+gem 'simple_form', '~> 3.0'
+gem 'byebug'
+gem 'rspec', '~> 3.4'
+gem 'rspec-rails', '~> 3.4'
+gem 'capybara'
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+gem 'sqlite3', '~> 1.3.0'
+
+gem 'rake'
+gem 'simple_form', '~> 5.0'
+gem 'byebug'
+gem 'rspec', '~> 3.4'
+gem 'rspec-rails', '~> 3.4'
+gem 'capybara'
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+
+gem 'sqlite3', '~> 1.3.0'
+
+gem 'rake'
+gem 'simple_form', '~> 5.0'
+gem 'byebug'
+gem 'rspec', '~> 3.4'
+gem 'rspec-rails', '~> 3.4'
+gem 'capybara'
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gem 'sqlite3', '~> 1.3.0'
+
+gem 'rake'
+gem 'simple_form', '~> 5.0'
+gem 'byebug'
+gem 'rspec', '~> 3.4'
+gem 'rspec-rails', '~> 3.4'
+gem 'capybara'
+
+gemspec path: "../"

data/lib/active_enum/acts_as_enum.rb

@@ -7,15 +7,19 @@ module ActiveEnum
         extend ClassMethods
         class_attribute :active_enum_options
         self.active_enum_options = options.reverse_merge(:name_column => 'name')
-        scope :enum_values, proc { select("#{primary_key}, #{active_enum_options[:name_column]}").
+        scope :enum_values, proc { select(Arel.sql("#{primary_key}, #{active_enum_options[:name_column]}")).
                                    where(active_enum_options[:conditions]).
-                                   order("#{primary_key} #{active_enum_options[:order]}") }
+                                   order(Arel.sql("#{primary_key} #{active_enum_options[:order]}")) }
       end
 
     end
 
     module ClassMethods
 
+      def values
+        enum_values.map { |v| [ v.id, v.send(active_enum_options[:name_column]) ] }
+      end
+
       def ids
         enum_values.map { |v| v.id }
       end
@@ -42,6 +46,8 @@ module ActiveEnum
 
       # Enables use as a delimiter in inclusion validation
       def include?(value)
+        return super if value.is_a?(Module)
+
         !self[value].nil?
       end
 
@@ -57,7 +63,7 @@ module ActiveEnum
         if index.is_a?(Integer)
           enum_values.where(id: index)
         else
-          enum_values.where("#{active_enum_options[:name_column]} like lower(?)", index.to_s)
+          enum_values.where("lower(#{active_enum_options[:name_column]}) = lower(?)", Arel.sql(index.to_s))
         end
       end
     end

data/lib/active_enum/base.rb

@@ -34,9 +34,11 @@ module ActiveEnum
         @order = order
       end
 
-      def all
+      # Array of arrays of stored values defined id, name, meta values hash
+      def values
         store.values
       end
+      alias_method :all, :values
 
       def each(&block)
         all.each(&block)
@@ -54,7 +56,14 @@ module ActiveEnum
 
       # Return enum values in an array suitable to pass to a Rails form select helper.
       def to_select
-        store.values.map { |v| [v[1], v[0]] }
+        store.values.map { |v| [v[1].html_safe, v[0]] }
+      end
+
+      # Return enum values in a nested array suitable to pass to a Rails form grouped select helper.
+      def to_grouped_select(group_by)
+        store.values.group_by { |(_id, _name, meta)| (meta || {})[group_by] }.map { |group, collection|
+          [ group, collection.map { |(id, name, _meta)| [ name.html_safe, id ] } ]
+        }
       end
 
       # Access id or name value. Pass an id number to retrieve the name or

data/lib/active_enum/extensions.rb

@@ -110,9 +110,9 @@ module ActiveEnum
         class_eval <<-DEF
           def #{attribute}=(arg)
             if arg.is_a?(Symbol)
-              super self.class.active_enum_for(:#{attribute})[arg]
+              super(self.class.active_enum_for(:#{attribute})[arg])
             else
-              super arg
+              super
             end
           end
         DEF
@@ -127,7 +127,7 @@ module ActiveEnum
         class_eval <<-DEF
           def #{attribute}?(arg=nil)
             if arg
-              self.#{attribute}(:id) == self.class.active_enum_for(:#{attribute})[arg]
+              self.#{attribute}(:id).present? && self.#{attribute}(:id) == self.class.active_enum_for(:#{attribute})[arg]
             else
               super()
             end

data/lib/active_enum/form_helpers/simple_form.rb

@@ -23,9 +23,21 @@ class ActiveEnum::FormHelpers::SimpleForm::EnumInput < ::SimpleForm::Inputs::Col
   end
 end
 
+class ActiveEnum::FormHelpers::SimpleForm::GroupedEnumInput < ::SimpleForm::Inputs::GroupedCollectionSelectInput
+  def initialize(*args)
+    super
+    raise "Attribute '#{attribute_name}' has no enum class" unless enum = object.class.active_enum_for(attribute_name)
+
+    input_options[:collection] = enum.to_grouped_select(input_options[:group_by])
+    input_options[:group_method] = :last
+  end
+end
+
 SimpleForm::FormBuilder.class_eval do
   prepend ActiveEnum::FormHelpers::SimpleForm::BuilderExtension
 
-  map_type :enum, :to => ActiveEnum::FormHelpers::SimpleForm::EnumInput
+  map_type :enum, to: ActiveEnum::FormHelpers::SimpleForm::EnumInput
+  map_type :grouped_enum, to: ActiveEnum::FormHelpers::SimpleForm::GroupedEnumInput
+
   alias_method :collection_enum, :collection_select
 end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '1.0.0.rc2'
+  VERSION = '1.0.0.rc7'
 end

data/spec/active_enum/acts_as_enum_spec.rb

@@ -45,6 +45,12 @@ describe ActiveEnum::ActsAsEnum do
     end
   end
 
+  context '#values' do
+    it "should return array of arrays containing id and name column values" do
+      expect(Person.values).to eq([[1, 'Dave'], [2, 'John']])
+    end
+  end
+
   context '#to_select' do
     it "should return array for select helpers" do
       expect(Person.to_select).to eq([['Dave', 1], ['John', 2]])
@@ -60,4 +66,22 @@ describe ActiveEnum::ActsAsEnum do
       expect(Person.meta(1)).to eq(Person.find(1).attributes.except('id', 'first_name'))
     end
   end
+
+  context '#include?' do
+    it "should return true if value is integer and model has id" do
+      expect(Person.exists?(id: 1)).to eq(true)
+      expect(Person.include?(1)).to eq(true)
+    end
+
+    it "should return false if value is integer and model does not have id" do
+      expect(Person.exists?(id: 100)).to eq(false)
+      expect(Person.include?(100)).to eq(false)
+    end
+
+    it "should return super if value is a module" do
+      expect(Person.include?(ActiveRecord::Attributes)).to eq(true)
+
+      expect(Person.include?(Module.new)).to eq(false)
+    end
+  end
 end

data/spec/active_enum/base_spec.rb

@@ -24,9 +24,9 @@ describe ActiveEnum::Base do
     end
   end
 
-  describe ".all" do
+  describe ".values" do
     it 'should return an empty array when no values defined' do
-      expect(define_enum.all).to eq([])
+      expect(define_enum.values).to eq([])
     end
 
     it 'should return an array of arrays with all values defined as [id, name]' do
@@ -34,7 +34,7 @@ describe ActiveEnum::Base do
         value :name => 'Name 1'
         value :name => 'Name 2'
       end
-      expect(enum.all).to eq([[1,'Name 1'], [2, 'Name 2']])
+      expect(enum.values).to eq([[1,'Name 1'], [2, 'Name 2']])
     end
   end
 
@@ -43,28 +43,28 @@ describe ActiveEnum::Base do
       enum = define_enum do
         value :id => 1, :name => 'Name'
       end
-      expect(enum.all).to eq([[1,'Name']])
+      expect(enum.values).to eq([[1,'Name']])
     end
 
     it 'should allow me to define a value with a name only' do
       enum = define_enum do
         value :name => 'Name'
       end
-      expect(enum.all).to eq([[1,'Name']])
+      expect(enum.values).to eq([[1,'Name']])
     end
 
     it 'should allow me to define a value as hash with id as key and name as value' do
       enum = define_enum do
         value 1 => 'Name'
       end
-      expect(enum.all).to eq([[1,'Name']])
+      expect(enum.values).to eq([[1,'Name']])
     end
 
     it 'should allow to define meta data value with extra key value pairs' do
       enum = define_enum do
         value :id => 1, :name => 'Name', :description => 'extra'
       end
-      expect(enum.all).to eq([[1,'Name',{:description => 'extra'}]])
+      expect(enum.values).to eq([[1,'Name',{:description => 'extra'}]])
     end
 
     it 'should increment value ids when defined without ids' do
@@ -72,7 +72,7 @@ describe ActiveEnum::Base do
         value :name => 'Name 1'
         value :name => 'Name 2'
       end
-      expect(enum.all).to eq([[1,'Name 1'], [2, 'Name 2']])
+      expect(enum.values).to eq([[1,'Name 1'], [2, 'Name 2']])
     end
 
     it 'should raise error if the id is a duplicate' do
@@ -117,7 +117,7 @@ describe ActiveEnum::Base do
         value :id => 2, :name => 'Name 2'
         value :id => 1, :name => 'Name 1'
       end
-      expect(enum.all).to eq([[1,'Name 1'], [2, 'Name 2']])
+      expect(enum.values).to eq([[1,'Name 1'], [2, 'Name 2']])
     end
 
     it 'should return sorted values by id using order setting' do
@@ -126,7 +126,7 @@ describe ActiveEnum::Base do
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'
       end
-      expect(enum.all).to eq([[2, 'Name 2'], [1,'Name 1']])
+      expect(enum.values).to eq([[2, 'Name 2'], [1,'Name 1']])
     end
 
     it 'should return sorted values by id using order setting' do
@@ -136,7 +136,7 @@ describe ActiveEnum::Base do
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'
       end
-      expect(enum.all).to eq([[3,'Name 3'], [1,'Name 1'], [2, 'Name 2']])
+      expect(enum.values).to eq([[3,'Name 3'], [1,'Name 1'], [2, 'Name 2']])
     end
   end
 
@@ -248,6 +248,32 @@ describe ActiveEnum::Base do
     end
   end
 
+  describe ".to_grouped_select" do
+    it 'should return array for grouped select helpers grouped by meta key value' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1', :category => 'Foo'
+        value :id => 2, :name => 'Name 2', :category => 'Bar'
+      end
+
+      expect(enum.to_grouped_select(:category)).to eq([
+        [ 'Foo', [ ['Name 1',1] ] ],
+        [ 'Bar', [ ['Name 2',2] ] ]
+      ])
+    end
+
+    it 'should group any value missing the group_by key by nil' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1', :category => 'Foo'
+        value :id => 2, :name => 'Name 2'
+      end
+
+      expect(enum.to_grouped_select(:category)).to eq([
+        [ 'Foo', [ ['Name 1',1] ] ],
+        [ nil, [ ['Name 2',2] ] ]
+      ])
+    end
+  end
+
   def define_enum(&block)
     Class.new(ActiveEnum::Base, &block)
   end

data/spec/active_enum/extensions_spec.rb

@@ -176,6 +176,11 @@ describe ActiveEnum::Extensions do
         expect(person.sex?(:female)).to be_falsey
         expect(person.sex?(:Female)).to be_falsey
       end
+
+      it 'should return false if attribute is nil regardless of enum value' do
+        person.sex = nil
+        expect(person.sex?(:nonexistent)).to be_falsey
+      end
     end
 
     context "with value as enum name symbol" do

data/spec/active_enum/form_helpers/simple_form_spec.rb

@@ -13,6 +13,16 @@ describe ActiveEnum::FormHelpers::SimpleForm, :type => :helper do
         value :id => 1, :name => 'Male'
         value :id => 2, :name => 'Female'
       end
+
+      enumerate :employment_status do
+        value :id => 1, :name => 'Full-time', group: 'Waged'
+        value :id => 3, :name => 'Part-time', group: 'Waged'
+        value :id => 4, :name => 'Casual', group: 'Waged'
+        value :id => 5, :name => 'Student', group: 'Un-waged'
+        value :id => 6, :name => 'Retired', group: 'Un-waged'
+        value :id => 7, :name => 'Unemployed', group: 'Un-waged'
+        value :id => 8, :name => 'Carer', group: 'Un-waged'
+      end
     end
   end
 
@@ -34,6 +44,15 @@ describe ActiveEnum::FormHelpers::SimpleForm, :type => :helper do
     expect(output).to have_xpath('//option[@value=2]', :text => 'Female')
   end
 
+  it "should use explicit :grouped_enum input type" do
+    output = simple_form_for(Person.new, :url => people_path) do |f|
+      concat f.input(:employment_status, :as => :grouped_enum, :group_by => :group)
+    end
+    expect(output).to have_selector('select#person_employment_status')
+    expect(output).to have_xpath('//optgroup[@label="Waged"]/option[@value=1]', :text => 'Full-time')
+    expect(output).to have_xpath('//optgroup[@label="Un-waged"]/option[@value=8]', :text => 'Carer')
+  end
+
   it "should not use enum input type if :as option indicates other type" do
     output = simple_form_for(Person.new, :url => people_path) do |f|
       concat f.input(:sex, :as => :string)

data/spec/support/schema.rb

@@ -5,6 +5,7 @@ ActiveRecord::Schema.define(:version => 1) do
     t.integer  :sex
     t.integer  :attending
     t.integer  :staying
+    t.integer  :employment_status
   end
 
   create_table :sorted_people, :force => true do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc7
 platform: ruby
 authors:
 - Adam Meehan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,6 +39,10 @@ files:
 - README.rdoc
 - Rakefile
 - active_enum.gemspec
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_5_0.gemfile
+- gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.gemfile
 - init.rb
 - lib/active_enum.rb
 - lib/active_enum/acts_as_enum.rb
@@ -68,7 +72,7 @@ files:
 homepage: http://github.com/adzap/active_enum
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Define enum classes in Rails and use them to enumerate ActiveRecord attributes
 test_files: