enumbler 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd8d1d86b3abe14b9454f4b36519d41c7d21e6544c749e5db19215d790a4b3dc
-  data.tar.gz: 44a694212c3feaa9aad8ea5dacd0ca370105e8dc69fe6196b67b158fd0f4ba63
+  metadata.gz: a3b8d2a2e38789cb62f2be5c895aa0fb2776b26b8efbbfe3386e88feaf041393
+  data.tar.gz: d981a2476760ab1d0afb09bd2eb790c125cf54ba54cad3493a5865f52163648b
 SHA512:
-  metadata.gz: 374e370ed1e6ff6575b0d494d57f20b95ebf25116382dbabe723a4450a06e4bf53a1ae688576e632fbbaabd97c4d5aa35f8a048fc71d76caf7d739a2a7d5676a
-  data.tar.gz: 51772747de3d1e9e3ac2012c1a91223c68470f7caa96127807b30c398870965e781fa813f297fc2a28fa8dfe25bc8a4174836ab8035ce2bcb6eae4e7d41ddf9a
+  metadata.gz: 65c1b774b7fd7fe86e3038c5bfea649608708e57ef626529c933e82e31249a43716b50e54d2a822640d11d6b98321832f032dfedf2efce9a750aebc1e25fd26c
+  data.tar.gz: c223ff2703dd5693ee9925dd4ffc025c890138962001acca6619f8c1d30b7e6056a5275fa84f5c159f163c052b8fbc546c1f9132917b93a96956c6aba9d1e72e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumbler (0.7.0)
+    enumbler (0.8.0)
       activerecord (>= 5.2.3, < 6.1)
       activesupport (>= 5.2.3, < 6.1)
 

data/README.md

@@ -91,6 +91,17 @@ Color.ids_from_enumbler(:black, 'does-no-exist') # => [1, nil]
 Color.ids_from_enumbler!(:black, 'does-no-exist') # => raises Enumbler::Error
 Color.id_from_enumbler!(:does_not_exist) # => raises Enumbler::Error
 
+# Get a model instance (like `.find_by` in Rails)
+Color.find_by_enumble(1)
+Color.find_by_enumble(:black)
+Color.find_by_enumble("black")
+Color.find_by_enumble("BLACK")
+Color.find_by_enumble(Color.black) # => self
+Color.find_by_enumble("whoops")    # => nil
+
+# Raise ActiveRecord::RecordNotFound error with bang
+Color.find_by_enumble!("whoops")    # => nil
+
 # Get enumble object by id
 house = House.create!(color: Color.black)
 

data/lib/enumbler/enabler.rb

@@ -126,6 +126,51 @@ module Enumbler
         @enumbler_label_column_name = label_column_name
       end
 
+      # Like `ActiveRecord#find_by`, will try and return an instance of this
+      # model that matches any of our enumble attributes (instance, id, string,
+      # or symbol).
+      #
+      #   Color.find_by_enumble(1)
+      #   Color.find_by_enumble(:black)
+      #   Color.find_by_enumble("black")
+      #   Color.find_by_enumble("BLACK")
+      #   Color.find_by_enumble(Color.black) # => self
+      #   Color.find_by_enumble("whoops")    # => nil
+      #
+      # @param arg [Class, String, Integer, Symbol] search argument
+      # @param case_sensitive [Boolean] string search to be case sensitive (default: false)
+      # @param raise_error [Boolean] whether to raise RecordNotFound error (default: false)
+      # @return [self]
+      def find_by_enumble(arg, case_sensitive: false, raise_error: false)
+        return arg if arg.instance_of?(@enumbled_model)
+
+        id = id_from_enumbler(arg, case_sensitive: case_sensitive, raise_error: raise_error)
+
+        find_by = raise_error ? :find_by! : :find_by
+        @enumbled_model.public_send(find_by, id: id)
+      rescue Enumbler::Error
+        raise ActiveRecord::RecordNotFound.new("Couldn't find #{@enumbled_model}", @enumbled_model)
+      end
+
+      # Like `ActiveRecord#find`, will try and return an instance of this model
+      # that matches any of our enumble attributes (instance, id, string, or
+      # symbol) raises a `RecordNotFound` error if none found.
+      #
+      #   Color.find_by_enumble!(1)
+      #   Color.find_by_enumble!(:black)
+      #   Color.find_by_enumble!("black")
+      #   Color.find_by_enumble!("BLACK")
+      #   Color.find_by_enumble!(Color.black) # => returns self
+      #   Color.find_by_enumble!("whoops")    # => raise ActiveRecord::RecordNotFound
+      #
+      # @param arg [Class, String, Integer, Symbol] search argument
+      # @param case_sensitive [Boolean] string search to be case sensitive (default: false)
+      # @param raise_error [Boolean] whether to raise RecordNotFound error (default: false)
+      # @return [self]
+      def find_by_enumble!(arg, case_sensitive: false)
+        find_by_enumble(arg, case_sensitive: case_sensitive, raise_error: true)
+      end
+
       # See {.find_enumbles}.  Simply returns the first object.  Use when you
       # want one argument to be found and not returned in an array.
       # @raise [Error] when there is no [Enumbler::Enumble] to be found and

data/lib/enumbler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enumbler
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord