active_enum 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e647ed19a3af115aa962e61aaecb6b254d51064a60c86a14a4735b32d264d5
-  data.tar.gz: c4d6f20b518d1b8171780048624f36f657f276cd996b78f6fec7ef4d99f7dcdc
+  metadata.gz: cef2baaca824d0aabf253fc18b8316ee90c0cb55f4ab9c1d64d636ad32da8fdd
+  data.tar.gz: a5e4fbed89a43e84520cf82561b92be85ef4165a444c3f4406f5f234f06fc336
 SHA512:
-  metadata.gz: af70d47df41c0ad90a99ca11691609e8812034acbaac5b389ec07542c0e8eed326657351de923eeeb60e9a15a60adadb726186f114a511952e17afd71bc0433b
-  data.tar.gz: 76d5265b1205a28435c857a2b108bfb4f36d1cfd2bd3bf1dbe5a99594e0b10b9828f2a7a7bdfb1d4d2e834372fc122912e01939ca22fedd60500692cffc2c929
+  metadata.gz: 65517f34358ae160cadfe3ef4154bc9e4af1354dbe3b0f1d214322f53fbc11e4b53a63f77cb11bf1c7f418448bd9dce168bc4fb004b68b636764b6adf4ce691b
+  data.tar.gz: 6324aa433ff7737a0d1a2092d7d288bbd64a17ddbdeb3f9a646de24230e2eb869f2d38a6b86aa1bc5f5f32a4a01b4a8cbba72a5033a5e36d7d67a2b28789e6e6

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "rails_7_0" do
+  gem "rails", "~> 7.0.0"
+  gem 'sqlite3', '~> 1.7.0'
+end
+
+appraise "rails_7_1" do
+  gem "rails", "~> 7.1.0"
+  gem 'sqlite3', '~> 2.6.0'
+end
+
+appraise "rails_7_2" do
+  gem "rails", "~> 7.2.0"
+  gem 'sqlite3', '~> 2.6.0'
+end
+
+appraise "rails_8_0" do
+  gem "rails", "~> 8.0.0"
+  gem 'sqlite3', '~> 2.6.0'
+end

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 6.1.0"
+gem "sqlite3", "~> 1.4.0"
+gem "combustion"
+gem "rake"
+gem "simple_form", "~> 5.0.0"
+gem "debug"
+gem "rspec", "~> 3.4"
+gem "rspec-rails", "~> 6.0"
+gem "capybara"
+
+gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7.0"
+gem "combustion"
+gem "rake"
+gem "simple_form", "~> 5.0.0"
+gem "debug"
+gem "rspec", "~> 3.4"
+gem "rspec-rails", "~> 6.0"
+gem "capybara"
+
+gemspec path: "../"

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 2.6.0"
+gem "combustion"
+gem "rake"
+gem "simple_form", "~> 5.0.0"
+gem "debug"
+gem "rspec", "~> 3.4"
+gem "rspec-rails", "~> 6.0"
+gem "capybara"
+
+gemspec path: "../"

data/gemfiles/rails_7_2.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 7.2.0"
+gem "sqlite3", "~> 2.6.0"
+gem "combustion"
+gem "rake"
+gem "simple_form", "~> 5.0.0"
+gem "debug"
+gem "rspec", "~> 3.4"
+gem "rspec-rails", "~> 6.0"
+gem "capybara"
+
+gemspec path: "../"

data/gemfiles/rails_8_0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 8.0.0"
+gem "sqlite3", "~> 2.6.0"
+gem "combustion"
+gem "rake"
+gem "simple_form", "~> 5.0.0"
+gem "debug"
+gem "rspec", "~> 3.4"
+gem "rspec-rails", "~> 6.0"
+gem "capybara"
+
+gemspec path: "../"

data/lib/active_enum/acts_as_enum.rb

@@ -6,15 +6,17 @@ module ActiveEnum
       def acts_as_enum(options={})
         extend ClassMethods
         class_attribute :active_enum_options
-        self.active_enum_options = options.reverse_merge(:name_column => 'name')
-        scope :enum_values, proc { select(Arel.sql("#{primary_key}, #{active_enum_options[:name_column]}")).
-                                   where(active_enum_options[:conditions]).
-                                   order(Arel.sql("#{primary_key} #{active_enum_options[:order]}")) }
+        self.active_enum_options = options.reverse_merge(name_column: 'name')
       end
 
     end
 
     module ClassMethods
+      def enum_values
+        select(Arel.sql("#{primary_key}, #{active_enum_options[:name_column]}"))
+          .where(active_enum_options[:conditions])
+          .order(Arel.sql("#{primary_key} #{active_enum_options[:order]}"))
+      end
 
       def values
         enum_values.map { |v| [ v.id, v.send(active_enum_options[:name_column]) ] }
@@ -33,14 +35,19 @@ module ActiveEnum
       end
 
       def [](index)
-        row = get_value(index)
+        get(index)
+      end
+
+      def get(index, raise_on_not_found: ActiveEnum.raise_on_not_found)
+        row = get_value(index, raise_on_not_found)
         return if row.nil?
         index.is_a?(Integer) ? row.send(active_enum_options[:name_column]) : row.id
       end
 
       # Access any meta data defined for a given id or name. Returns a hash.
-      def meta(index)
+      def meta(index, raise_on_not_found: ActiveEnum.raise_on_not_found)
         row = lookup_relation(index).unscope(:select).first
+        raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") if raise_on_not_found
         row&.attributes.except(primary_key.to_s, active_enum_options[:name_column].to_s)
       end
 
@@ -53,17 +60,17 @@ module ActiveEnum
 
       private
 
-      def get_value(index)
+      def get_value(index, raise_on_not_found = ActiveEnum.raise_on_not_found)
         lookup_relation(index).first || begin
-          raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") if ActiveEnum.raise_on_not_found
+          raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") if 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))
+          enum_values.where("lower(#{active_enum_options[:name_column]}) = lower(:name)", name: index.to_s)
         end
       end
     end

data/lib/active_enum/base.rb

@@ -5,7 +5,7 @@ module ActiveEnum
 
   class Base
     class << self
-      attr_accessor :store
+      attr_reader :store
 
       def inherited(subclass)
         ActiveEnum.enum_classes << subclass
@@ -26,6 +26,8 @@ module ActiveEnum
       # Allowed values are :asc, :desc or :natural
       #
       def order(order)
+        raise "Invalid order '#{order}' in #{self}" unless order.in?([:asc, :desc, :as_defined, :natural])
+
         if order == :as_defined
           ActiveSupport::Deprecation.warn("You are using the order :as_defined which has been deprecated. Use :natural.")
           order = :natural
@@ -87,9 +89,7 @@ module ActiveEnum
       end
 
       def [](index)
-        row = get_value(index)
-        return if row.nil?
-        index.is_a?(Integer) ? row[1] : row[0]
+        get(index)
       end
 
       def include?(value)

data/lib/active_enum/extensions.rb

@@ -43,7 +43,7 @@ module ActiveEnum
 
             define_active_enum_methods_for_attribute(attribute, options) unless options[:skip_accessors]
           rescue NameError => e
-            raise e unless e.message =~ /uninitialized constant/
+            raise e unless e.message.match?(/uninitialized constant/)
             raise ActiveEnum::EnumNotFound, "Enum class could not be found for attribute '#{attribute}' in class #{self}. Specify the enum class using the :with option."
           end
         end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/active_enum/acts_as_enum_spec.rb

@@ -31,20 +31,43 @@ describe ActiveEnum::ActsAsEnum do
   end
 
   context "#[]" do
-    it "should return name column value when passing id to [] method" do
+    it "should return name column value when passed id" do
       expect(Person[1]).to eq('Dave')
     end
 
-    it "should return id column value when passing string name to [] method" do
+    it "should return id column value when passed string name" 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
+    it "should return id column value when passed symbol name" do
       expect(Person[:dave]).to eq(1)
     end
   end
 
+  context '#get' do
+    it "should return name column value when passed id" do
+      expect(Person.get(1)).to eq('Dave')
+    end
+
+    it "should return id column value when passed string name" do
+      expect(Person.get('Dave')).to eq(1)
+      expect(Person.get('dave')).to eq(1)
+    end
+
+    it "should return id column value when passed symbol name" do
+      expect(Person.get(:dave)).to eq(1)
+    end
+
+    it "should not raise for missing id when raise_on_not_found is false" do
+      expect { Person.get(0, raise_on_not_found: false) }.to_not raise_error
+    end
+
+    it "should raise for missing id when raise_on_not_found is true" do
+      expect { Person.get(0, raise_on_not_found: true) }.to raise_error(ActiveEnum::NotFound)
+    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']])

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 ENV["RAILS_ENV"] ||= 'test'
-require 'spec_helper'
 
+require 'logger'
 require 'rails'
 require 'active_record'
 require 'action_controller/railtie'
@@ -9,21 +9,16 @@ require 'action_mailer'
 
 require 'active_enum'
 require 'active_enum/acts_as_enum'
-require 'securerandom'
-require 'byebug'
 
-module ActiveEnum 
+module ActiveEnum
   class Application < Rails::Application
     config.generators do |g|
       g.orm             :active_record
       g.test_framework  :rspec, :fixture => false
     end
     config.active_support.deprecation = :notify
-    config.eager_load = false if Rails.version >= "4.0"
-    config.secret_key_base = SecureRandom.hex(10) if Rails.version >= "4.0"
   end
 end
-ActiveEnum::Application.initialize!
 
 I18n.enforce_available_locales = false
 I18n.available_locales = ['en', 'ja']

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_enum
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Meehan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -29,20 +28,22 @@ email: adam.meehan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
 - CHANGELOG
 - MIT-LICENSE
+- README.rdoc
 files:
 - ".travis.yml"
+- Appraisals
 - CHANGELOG
 - MIT-LICENSE
 - 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
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_8_0.gemfile
 - init.rb
 - lib/active_enum.rb
 - lib/active_enum/acts_as_enum.rb
@@ -72,7 +73,6 @@ files:
 homepage: http://github.com/adzap/active_enum
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Define enum classes in Rails and use them to enumerate ActiveRecord attributes
 test_files:

data/gemfiles/rails_4_2.gemfile

@@ -1,16 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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

@@ -1,16 +0,0 @@
-# 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: "../"