active_enum 1.0.0.rc7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c79754f5d68c12d7955e1a77e870612ffb1fdb62cc65681e50efc137da125ba
-  data.tar.gz: e0604ad18f10935d8111491b18481e3b273b7d6d064c0284c41c02836cadff3c
+  metadata.gz: 8e3ba1613a53b9f8ba7fcf13ff5b109f8c5e6ed02916fda74124dc9fdbac5055
+  data.tar.gz: 1da9d43ebd9a40564e7e7c46624d85f15216fe9906cf1ac85272cdc6454f1218
 SHA512:
-  metadata.gz: '07383e22c02937744c155c72e0c35333c03169f7f3807dfd54765f490a225035ecd24017664fe7b1274c134422e164b12d4fc1a18f57b227f649b93bb166c3b2'
-  data.tar.gz: 8bd02a86d9a478ec1bf1cbdf76f28fa6d673b00c61f2edddf6a9c3d90782a33986087ff8a3cf789ab439ab58b60227f3f7c36c4ab5ab097ee6b6430bff119119
+  metadata.gz: d88b6864c8b46a21f02823989e90156f7a3aa631d45f5cebee5dd9aa448b6f5370a1614263fe144b8b497bbdae667a692421fb6583496fd04ed8fa75622b9a85
+  data.tar.gz: '09e15b242df5668932babded2d1a675831071474656b8368ddd6456638be509169fafb7136700d6a168fce4e690a6b9b12d730f665f98ce34af3bf9fa02aa934'

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.rc4'
+  gem 'active_enum', '~> 1.0.0'
 
 Then generate the config initializer file
 

data/lib/active_enum/base.rb

@@ -4,6 +4,7 @@ module ActiveEnum
   class NotFound < StandardError; end
 
   class Base
+    DEFAULT_GROUPED_SELECT_TRANSFORM = proc { |group| group&.html_safe }
 
     class << self
       attr_accessor :store
@@ -60,12 +61,25 @@ module ActiveEnum
       end
 
       # Return enum values in a nested array suitable to pass to a Rails form grouped select helper.
-      def to_grouped_select(group_by)
+      def to_grouped_select(group_by, group_transform: DEFAULT_GROUPED_SELECT_TRANSFORM)
         store.values.group_by { |(_id, _name, meta)| (meta || {})[group_by] }.map { |group, collection|
-          [ group, collection.map { |(id, name, _meta)| [ name.html_safe, id ] } ]
+          [ group_transform.call(group), collection.map { |(id, name, _meta)| [ name.html_safe, id ] } ]
         }
       end
 
+      # Return a simple hash of key value pairs id => name for each value
+      def to_h
+        store.values.inject({}) { |hash, row|
+          hash.merge(row[0] => row[1])
+        }
+      end
+
+      # Return count of values defined
+      def length
+        store.values.length
+      end
+      alias_method :size, :length
+
       # Access id or name value. Pass an id number to retrieve the name or
       # a symbol or string to retrieve the matching id.
       def get(index)
@@ -76,7 +90,7 @@ module ActiveEnum
       alias_method :[], :get
 
       def include?(value)
-        !get(value).nil?
+        !get_value(value, false).nil?
       end
 
       # Access any meta data defined for a given id or name. Returns a hash.
@@ -88,22 +102,22 @@ module ActiveEnum
       private
 
       # Access value row array for a given id or name value.
-      def get_value(index)
+      def get_value(index, raise_on_not_found = ActiveEnum.raise_on_not_found)
         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 || (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
-          name = hash.delete(:name)
-          meta = hash
+          id   = hash.fetch(:id) { next_id }
+          name = hash.fetch(:name).freeze
+          meta = hash.except(:id, :name).freeze
           return id, name, (meta.empty? ? nil : meta)
         elsif hash.keys.first.is_a?(Integer)
-          return *Array(hash).first
+          return *Array(hash).first.tap { |arr| arr[1].freeze }
         else
           raise ActiveEnum::InvalidValue, "The value supplied, #{hash}, is not a valid format."
         end

data/lib/active_enum/extensions.rb

@@ -92,9 +92,9 @@ module ActiveEnum
             when :id
               value if enum[value]
             when :name
-              enum[value]
+              enum[value].dup
             when Symbol
-              (enum.meta(value) || {})[arg]
+              (enum.meta(value) || {})[arg].try(:dup)
             end
           end
         DEF

data/lib/active_enum/version.rb

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

data/spec/active_enum/base_spec.rb

@@ -272,6 +272,51 @@ describe ActiveEnum::Base do
         [ nil, [ ['Name 2',2] ] ]
       ])
     end
+
+    it 'shoud transform group name with custom group transform proc' 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, group_transform: proc { |group| group.to_s.upcase })).to eq([
+        [ 'FOO', [ ['Name 1',1] ] ],
+        [ '', [ ['Name 2',2] ] ]
+      ])
+    end
+  end
+
+  describe ".to_h" do
+    it 'should return hash of ids as keys and names as values' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      expect(enum.to_h).to eq({ 1 => 'Name 1', 2 => 'Name 2' })
+    end
+  end
+
+  describe ".length" do
+    it 'should return number of values defined' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      expect(enum.length).to eq 2
+    end
+
+    it 'should return 0 when no values defined' do
+      enum = define_enum {}
+      expect(enum.length).to eq 0
+    end
+
+    it 'should be aliased as size' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      expect(enum.size).to eq enum.length
+    end
   end
 
   def define_enum(&block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Meehan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,11 +83,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Define enum classes in Rails and use them to enumerate ActiveRecord attributes