active_enum 1.0.0.rc1 → 1.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: abc265242b6f277fd73cd50f675eb3e966407cda
-  data.tar.gz: 5b4c18dd92b26c6282afa3ba13e131d9ac916bd0
+SHA256:
+  metadata.gz: a6fb4a88a4e4c0b8894a94b35dee75c23f9ddbdba0db2c5078dd51049cbeb82a
+  data.tar.gz: 53e5d91603101b6c0e6590ceb58f6c214cbd221be7da6e4780825b51e71b640f
 SHA512:
-  metadata.gz: c0a0d1e62906848e9a031e6bb8cd27071a3fa4b2b6919d4311eb7fbae2fcfb1676f9a6d292d94d462a167d2b084cccc795e37d58d65c0af25f6db5a9bf1f08f8
-  data.tar.gz: 5c9cb81a882a6ddaf6c2e3c6d864598e85d544e91f835ea711b9881a2c710b1b20b5812987481dc50975ee13ff60814cda8967fc36058f67dfed5a873b45947e
+  metadata.gz: b208b4ad29373d4f604673eef17315d5ede6265384d0cb3cadda81b674953fa35d09ac8149a2831a257d2f4e05e9931b02c01767aece9b2a7e45e4152f09e462
+  data.tar.gz: 8ef7bde84f962ac14307dccfee60849d022699c2841fabd7fe33cb5b4c284cafcff938e91497a6f44f02df27fc0cd0d7bbf707162b16663df30ad61d63688f08

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,47 +7,65 @@ 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 }
+        enum_values.map { |v| v.id }
       end
 
       def names
-        enum_values.map {|v| v.send(active_enum_options[:name_column]) }
+        enum_values.map { |v| v.send(active_enum_options[:name_column]) }
       end
 
       def to_select
-        enum_values.map {|v| [v.send(active_enum_options[:name_column]), v.id] }
+        enum_values.map { |v| [v.send(active_enum_options[:name_column]), v.id] }
       end
 
       def [](index)
-        if index.is_a?(Integer)
-          v = lookup_by_id(index)
-          v.send(active_enum_options[:name_column]) unless v.blank?
-        else
-          v = lookup_by_name(index)
-          v.id unless v.blank?
-        end
+        row = get_value(index)
+        return if row.nil?
+        index.is_a?(Integer) ? row.send(active_enum_options[:name_column]) : row.id
       end
 
-      private
-
-      def lookup_by_id(index)
-        enum_values.find_by_id(index)
+      # Access any meta data defined for a given id or name. Returns a hash.
+      def meta(index)
+        row = lookup_relation(index).unscope(:select).first
+        row&.attributes.except(primary_key.to_s, active_enum_options[:name_column].to_s)
       end
 
-      def lookup_by_name(index)
-        enum_values.where("#{active_enum_options[:name_column]} like lower(?)", index.to_s).first
+      # Enables use as a delimiter in inclusion validation
+      def include?(value)
+        return super if value.is_a?(Module)
+
+        !self[value].nil?
       end
 
+      private
+
+      def get_value(index)
+        lookup_relation(index).first || begin
+          raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") if ActiveEnum.raise_on_not_found
+        end
+      end
+      
+      def lookup_relation(index)
+        if index.is_a?(Integer)
+          enum_values.where(id: index)
+        else
+          enum_values.where("lower(#{active_enum_options[:name_column]}) = lower(?)", Arel.sql(index.to_s))
+        end
+      end
     end
 
   end

data/lib/active_enum/base.rb

@@ -20,7 +20,7 @@ module ActiveEnum
       #   value 1 => 'Foo'
       #
       def value(enum_value)
-        store.set *id_and_name_and_meta(enum_value)
+        store.set(*id_and_name_and_meta(enum_value))
       end
 
       # Specify order enum values are returned. 
@@ -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)
@@ -44,17 +46,24 @@ module ActiveEnum
 
       # Array of all enum id values
       def ids
-        store.values.map {|v| v[0] }
+        store.values.map { |v| v[0] }
       end
 
       # Array of all enum name values
       def names
-        store.values.map {|v| v[1] }
+        store.values.map { |v| v[1] }
       end
 
       # 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
@@ -66,15 +75,6 @@ module ActiveEnum
       end
       alias_method :[], :get
 
-      # Access value row array for a given id or name value.
-      def get_value(index)
-        if index.is_a?(Integer)
-          store.get_by_id(index)
-        else
-          store.get_by_name(index)
-        end || (ActiveEnum.raise_on_not_found ? raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") : nil)
-      end
-
       def include?(value)
         !get(value).nil?
       end
@@ -87,6 +87,15 @@ module ActiveEnum
 
       private
 
+      # Access value row array for a given id or name value.
+      def get_value(index)
+        if index.is_a?(Integer)
+          store.get_by_id(index)
+        else
+          store.get_by_name(index)
+        end || (ActiveEnum.raise_on_not_found ? raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") : nil)
+      end
+
       def id_and_name_and_meta(hash)
         if hash.has_key?(:name)
           id   = hash.delete(:id) || next_id

data/lib/active_enum/extensions.rb

@@ -64,7 +64,7 @@ module ActiveEnum
         enum_class_name = "#{name}::#{attribute.to_s.camelize}"
         eval("class #{enum_class_name} < ActiveEnum::Base; end")
         enum = enum_class_name.constantize
-        enum.class_eval &block
+        enum.class_eval(&block)
         enum
       end
 
@@ -112,7 +112,7 @@ module ActiveEnum
             if arg.is_a?(Symbol)
               super self.class.active_enum_for(:#{attribute})[arg]
             else
-              super arg
+              super
             end
           end
         DEF

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/storage/i18n_store.rb

@@ -14,7 +14,7 @@ module ActiveEnum
       end
 
       def values
-        _values.map { |(id, name)| get_by_id(id) }
+        _values.map { |(id, _)| get_by_id(id) }
       end
 
       def i18n_scope

data/lib/active_enum/storage/memory_store.rb

@@ -4,7 +4,7 @@ module ActiveEnum
 
       def set(id, name, meta=nil)
         check_duplicate id, name
-        _values << [id, name.to_s, meta].compact
+        _values << [ id, name.to_s, meta ].compact
         sort!
       end
 

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc6'
 end

data/spec/active_enum/acts_as_enum_spec.rb

@@ -30,24 +30,58 @@ describe ActiveEnum::ActsAsEnum do
     expect(TestPerson.extended_modules).to include(ActiveEnum::ActsAsEnum::ClassMethods)
   end
 
-  it "should return name column value when passing id to [] method" do
-    expect(Person[1]).to eq('Dave')
+  context "#[]" do
+    it "should return name column value when passing id to [] method" do
+      expect(Person[1]).to eq('Dave')
+    end
+
+    it "should return id column value when passing string name to [] method" do
+      expect(Person['Dave']).to eq(1)
+      expect(Person['dave']).to eq(1)
+    end
+
+    it "should return id column value when passing symbol name to [] method" do
+      expect(Person[:dave]).to eq(1)
+    end
   end
 
-  it "should return id column value when passing string name to [] method" do
-    expect(Person['Dave']).to eq(1)
-    expect(Person['dave']).to eq(1)
+  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
 
-  it "should return id column value when passing symbol name to [] method" do
-    expect(Person[:dave]).to eq(1)
+  context '#to_select' do
+    it "should return array for select helpers" do
+      expect(Person.to_select).to eq([['Dave', 1], ['John', 2]])
+    end
+
+    it "should return sorted array from order value for select helpers when an order is specified" do
+      expect(SortedPerson.to_select).to eq([['John', 2], ['Dave', 1]])
+    end
   end
 
-  it "should return array for select helpers from to_select" do
-    expect(Person.to_select).to eq([['Dave', 1], ['John', 2]])
+  context '#meta' do
+    it "should return record attributes hash without id and name columns" do
+      expect(Person.meta(1)).to eq(Person.find(1).attributes.except('id', 'first_name'))
+    end
   end
 
-  it "should return sorted array from order value for select helpers from to_select when an order is specified" do
-    expect(SortedPerson.to_select).to eq([['John', 2], ['Dave', 1]])
+  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/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.rc1
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - Adam Meehan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2020-07-01 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.5.1
-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: