enumbler 0.7.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd8d1d86b3abe14b9454f4b36519d41c7d21e6544c749e5db19215d790a4b3dc
-  data.tar.gz: 44a694212c3feaa9aad8ea5dacd0ca370105e8dc69fe6196b67b158fd0f4ba63
+  metadata.gz: ab789606b3b4b29bf976ec57a54ca62c838209f286b440f32946f494c331b92e
+  data.tar.gz: 9bae37ac280295c70380949c7222e643a240f6c8aec3897c76ec4609349cdfa1
 SHA512:
-  metadata.gz: 374e370ed1e6ff6575b0d494d57f20b95ebf25116382dbabe723a4450a06e4bf53a1ae688576e632fbbaabd97c4d5aa35f8a048fc71d76caf7d739a2a7d5676a
-  data.tar.gz: 51772747de3d1e9e3ac2012c1a91223c68470f7caa96127807b30c398870965e781fa813f297fc2a28fa8dfe25bc8a4174836ab8035ce2bcb6eae4e7d41ddf9a
+  metadata.gz: 06d0fa3bfbac702c77a2968e90a53b86a3912c3fa8f18bab1619d3d6c008e5e3c8daeab3f0e0edf5005f83ca02f06d17e58125728b22c26a3e4a3a97c929c793
+  data.tar.gz: 3cad767146fc58f6a103480ab57b749ff5522e80e3a397a71f374423c6a64104cd54f81b9e2107fb66f196dd5b3d445bcbf7204a05aa196a7a5b00c0b06d1746

data/.rubocop.yml

@@ -1,7 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.6
-  Exclude:
-    - 'bin/pre_commit_rubocop.rb'
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 Layout/ArgumentAlignment:
   Enabled: true
@@ -11,16 +10,36 @@ Layout/FirstHashElementIndentation:
   Enabled: true
   EnforcedStyle: consistent
 
+Layout/HashAlignment:
+  Enabled: true
+  # This allows "implicit" hash arguments (without curly braces) to be aligned
+  # differently.
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
 Layout/LineLength:
   AllowURI: true
   Max: 119
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
 Lint/RaiseException:
   Enabled: true
 
 Lint/StructNewOverride:
   Enabled: true
 
+Metrics:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames: [at, by, db, id, in, ip, of, on, to, tz]
+
+Naming/PredicateName:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 
@@ -33,6 +52,9 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
 Style/TrailingCommaInHashLiteral:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma
@@ -41,5 +63,5 @@ Style/TrailingCommaInArrayLiteral:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma
 
-Metrics:
-  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in enumbler.gemspec
 gemspec

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    enumbler (0.7.0)
-      activerecord (>= 5.2.3, < 6.1)
-      activesupport (>= 5.2.3, < 6.1)
+    enumbler (0.9.1)
+      activerecord (>= 5.2.3, < 7)
+      activesupport (>= 5.2.3, < 7)
 
 GEM
   remote: https://rubygems.org/

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)
 
@@ -159,14 +170,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Roadmap
 
-* We need to add in support for additional attributes/columns in the enumbled table.  For example, following the `Color` concept, we may want to have a column which is `hex` and stores the colors `hex` value (e.g., `FFFFFF`).  This should be supported.
-* Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.where_color(:blue)`.  But right now am in a rush and not sure how to go about doing that properly.
+* Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.color(:blue)`.  But right now am in a rush and not sure how to go about doing that properly.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/linguabee/enumbler.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'enumbler'
+require "bundler/setup"
+require "enumbler"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'enumbler'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/pre_commit_rubocop.rb

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # Put this file into your path and use `<file> install` to add a new hook
 # or use it as a binary to check changed files
 
-require 'shellwords'
+require "shellwords"
 
 if ARGV == ["install"]
   exec "ln", "-sf", File.expand_path(File.basename(__FILE__), __dir__), ".git/hooks/pre-commit"
@@ -10,15 +12,23 @@ else
   raise unless ARGV == []
 end
 
-changed = `git status --porcelain`.
-  split("\n").
-  map { |l| l.split(" ", 2) }.
-  select { |status, _| ["A", "AM", "M"].include?(status) }.
-  map { |_, file| file.delete('"') }
+changed = `git status --porcelain`
+  .split("\n")
+  .map { |l| l.split(" ", 2) }
+  .select { |status, _| %w[A AM M].include?(status) }
+  .map { |_, file| file.delete('"') }
 
 exit if changed.empty?
 
-parallel = ((File.read(".rubocop.yml").include?("UseCache: false") rescue false) ? "" : " --parallel")
+parallel = (if begin
+  File.read(".rubocop.yml").include?("UseCache: false")
+rescue StandardError
+  false
+end
+              ""
+            else
+              " --parallel"
+            end)
 result = `bundle exec rubocop #{parallel} --color --force-exclusion #{changed.shelljoin}`
-puts result unless $?.success?
-exit $?.exitstatus
+puts result unless $CHILD_STATUS.success?
+exit $CHILD_STATUS.exitstatus

data/enumbler.gemspec

@@ -1,42 +1,42 @@
 # frozen_string_literal: true
 
-require_relative 'lib/enumbler/version'
+require_relative "lib/enumbler/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'enumbler'
+  spec.name          = "enumbler"
   spec.version       = Enumbler::VERSION
-  spec.authors       = ['Damon Timm']
-  spec.email         = ['damon@linguabee.com']
+  spec.authors       = ["Damon Timm"]
+  spec.email         = ["damon@linguabee.com"]
 
   spec.summary       = "Enums are terrific, but lack integrity.  Let's add some!"
-  spec.description   = 'A more complete description is forthcoming.'
-  spec.homepage      = 'https://github.com/linguabee/enumbler'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.description   = "A more complete description is forthcoming."
+  spec.homepage      = "https://github.com/linguabee/enumbler"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = spec.homepage
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activerecord', ['>= 5.2.3', '< 6.1']
-  spec.add_dependency 'activesupport', ['>= 5.2.3', '< 6.1']
-
-  spec.add_development_dependency 'database_cleaner-active_record', '~> 1.8.0'
-  spec.add_development_dependency 'fuubar', '~> 2.5'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.9.0'
-  spec.add_development_dependency 'rubocop', '~> 0.91.0'
-  spec.add_development_dependency 'sqlite3', '~> 1.4.0'
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", [">= 5.2.3", "< 7"]
+  spec.add_dependency "activesupport", [">= 5.2.3", "< 7"]
+
+  spec.add_development_dependency "database_cleaner-active_record", "~> 1.8.0"
+  spec.add_development_dependency "fuubar", "~> 2.5"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "rubocop", "~> 0.91.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4.0"
 end

data/lefthook.yml

@@ -0,0 +1,12 @@
+# EXAMPLE USAGE
+# Refer for explanation to following link:
+# https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
+
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      tags: backend style
+      glob: "*.rb"
+      exclude: "application.rb|routes.rb"
+      run: bundle exec rubocop --force-exclusion {all_files}

data/lib/enumbler.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'enumbler/core_ext/symbol/case_equality_operator'
+require "enumbler/core_ext/symbol/case_equality_operator"
 
-require 'enumbler/collection'
-require 'enumbler/enumble'
-require 'enumbler/enabler'
-require 'enumbler/version'
+require "enumbler/collection"
+require "enumbler/enumble"
+require "enumbler/enabler"
+require "enumbler/version"
 
-require 'active_support/concern'
-require 'active_support/inflector'
+require "active_support/concern"
+require "active_support/inflector"
 
 # The Enumbler add integrity to our enum implementation!
 module Enumbler

data/lib/enumbler/collection.rb

@@ -16,7 +16,7 @@ module Enumbler
       super
     end
 
-    def respond_to_missing?(method_name, include_private = false)
+    def respond_to_missing?(method_name, *args, &block)
       enumble = find { |e| e.enum == method_name }
       enumble.present? || super
     end

data/lib/enumbler/enabler.rb

@@ -12,7 +12,7 @@ module Enumbler
     def enumble
       @enumble = self.class.find_enumble(id)
 
-      raise Error, 'An enumble is not defined for this record!' if @enumble.nil?
+      raise Error, "An enumble is not defined for this record!" if @enumble.nil?
 
       @enumble
     end
@@ -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
@@ -182,6 +227,8 @@ module Enumbler
             enumble =
               if arg.is_a?(Symbol)
                 @enumbled_model.enumbles.find { |e| e.enum == arg }
+              elsif arg.is_a?(Enumbler::Enumble)
+                @enumbled_model.enumbles.find { |e| e.enum == arg.enum }
               elsif arg.is_a?(String)
                 @enumbled_model.enumbles.find do |e|
                   if case_sensitive
@@ -285,7 +332,7 @@ module Enumbler
       #   longer defined (default: false)
       # @param validate [Boolean] validate on save?
       def seed_the_enumbler(delete_missing_records: false, validate: true)
-        max_database_id = all.order('id desc').take&.id || 0
+        max_database_id = all.order("id desc").take&.id || 0
         max_enumble_id = @enumbles.map(&:id).max
 
         # If we are not deleting records, we just need to update each listed
@@ -330,11 +377,21 @@ module Enumbler
         method_name = "#{enumble.enum}?"
         not_method_name = "not_#{enumble.enum}?"
         alias_method_name = "is_#{enumble.enum}"
+        any_method_name = "any_#{enumble.enum}?"
+
+        [method_name, not_method_name, alias_method_name].each do |mname|
+          detect_enumbler_conflict(enumble.enum, mname)
+        end
+
+        [enumble.enum, any_method_name].each do |mname|
+          detect_enumbler_conflict(enumble.enum, mname, klass_method: true)
+        end
 
         const_set(enumble.enum.to_s.upcase, enumble.id)
         define_method(method_name) { id == enumble.id }
         define_method(not_method_name) { id != enumble.id }
         alias_method alias_method_name, method_name
+
         define_singleton_method(enumble.enum) do |attr = nil|
           return find(enumble.id) if attr.nil?
 
@@ -343,13 +400,42 @@ module Enumbler
           raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
         end
 
-        define_singleton_method("any_#{enumble.enum}?") do
-          where(id: enumble.id).exists?
+        define_singleton_method(any_method_name) do
+          exists?(id: enumble.id)
         rescue NoMethodError
           raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
         end
       end
 
+      # This idea sourced lovingly from ActiveRecord::Enum
+      ENUMBLER_CONFLICT_MESSAGE = <<~TEXT.squish
+        You tried to define the enumble :%<enum>s on the model %<klass>s, but
+        this will generate a %<type>s method `%<method>s`, which is already defined
+        by %<source>s.
+      TEXT
+
+      def detect_enumbler_conflict(enumble_name, method_name, klass_method: false)
+        if klass_method && dangerous_class_method?(method_name)
+          raise_conflict_error(enumble_name, method_name, type: "class")
+        elsif klass_method && method_defined_within?(method_name, ActiveRecord::Relation)
+          raise_conflict_error(enumble_name, method_name, type: "class", source: ActiveRecord::Relation.name)
+        elsif !klass_method && dangerous_attribute_method?(method_name)
+          raise_conflict_error(enumble_name, method_name)
+        end
+      end
+
+      def raise_conflict_error(enumble_name, method_name, type: "instance", source: "ActiveRecord")
+        raise Error,
+          format(
+            ENUMBLER_CONFLICT_MESSAGE,
+            enum: enumble_name,
+            klass: name,
+            type: type,
+            method: method_name,
+            source: source,
+          )
+      end
+
       # I accidentally forgot to provide an id one time and it was confusing as
       # the last argument became the hash of options.  This should help.
       def validate_id_is_numeric(enum, id)
@@ -366,11 +452,17 @@ module Enumbler
 
         return if unsupported_attrs.blank?
 
+        ActiveRecord::Migration.check_pending!
+
         raise Enumbler::Error,
           "The model #{self} does not support the attribute(s): #{unsupported_attrs.keys.map(&:to_s).to_sentence}"
+      rescue ActiveRecord::PendingMigrationError
+        warn "[Enumbler Warning] => The model #{self} does not currently support the attribute(s): #{unsupported_attrs.keys.map(&:to_s).to_sentence}." \
+          " You have a pending migration which hopefully would remedy this!  If not, you need to add a migration for this attibrute or" \
+          " remove it from the Enumbler."
       rescue ActiveRecord::StatementInvalid
         warn "[Enumbler Warning] => Unable to find a table for #{self}."\
-          'This is to be expected if there is a pending migration; however, if there is not then something is amiss.'
+          "This is to be expected if there is a pending migration; however, if there is not then something is amiss."
       end
     end
   end

data/lib/enumbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 5.2.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.2.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 5.2.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 5.2.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +169,7 @@ files:
 - bin/pre_commit_rubocop.rb
 - bin/setup
 - enumbler.gemspec
+- lefthook.yml
 - lib/enumbler.rb
 - lib/enumbler/collection.rb
 - lib/enumbler/core_ext/symbol/case_equality_operator.rb
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Enums are terrific, but lack integrity.  Let's add some!