active_enum 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e647ed19a3af115aa962e61aaecb6b254d51064a60c86a14a4735b32d264d5
-  data.tar.gz: c4d6f20b518d1b8171780048624f36f657f276cd996b78f6fec7ef4d99f7dcdc
+  metadata.gz: 66c4c41a89eb9ab6b433bd74195b5da31f5e6f77ffd2bf6e4d71152f6f37ff43
+  data.tar.gz: 78f1bfd4039e743136f0258c84a042f13397f89629fd7fb324e501db15068b3d
 SHA512:
-  metadata.gz: af70d47df41c0ad90a99ca11691609e8812034acbaac5b389ec07542c0e8eed326657351de923eeeb60e9a15a60adadb726186f114a511952e17afd71bc0433b
-  data.tar.gz: 76d5265b1205a28435c857a2b108bfb4f36d1cfd2bd3bf1dbe5a99594e0b10b9828f2a7a7bdfb1d4d2e834372fc122912e01939ca22fedd60500692cffc2c929
+  metadata.gz: cb0f30bd0ea8655166dc74c44f7e8748d49c131676fb5ebea4e5529d2c2117a305f806601a770fc659bef3254a9f9b324e0eac89f94738dd2221c4a80def2707
+  data.tar.gz: 91ed0d9875049d3453ea00e745f4e594c0fb7e7c36cb018d2e170da24e4b4a00007e856d2146d0fa07840d81941a34a830832817269e2f69ca55753ce72b1778

data/lib/active_enum/acts_as_enum.rb

@@ -6,7 +6,7 @@ module ActiveEnum
       def acts_as_enum(options={})
         extend ClassMethods
         class_attribute :active_enum_options
-        self.active_enum_options = options.reverse_merge(:name_column => 'name')
+        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]}")) }
@@ -33,14 +33,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,12 +58,12 @@ 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)

data/lib/active_enum/base.rb

@@ -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/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 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']])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_enum
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Adam Meehan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport