enumbler 0.6.11 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e4caeaa0c8dc41e011352ed5931651f3f74d203f54a2a747034c384d065aea
-  data.tar.gz: 6e772d0c3b1c8c1403298ac244a3aad601d8150497a2a76ca924f2bfecc4a661
+  metadata.gz: 012b0ded68a635ef8ac4cb765eec4a648f16a4365abaa1d6def1897d389bcba8
+  data.tar.gz: a74d123fa2635a2118e1300cbf75a56d3255756e9bf9384049bb27f74187eb7a
 SHA512:
-  metadata.gz: b2312aec90691d56a46e99a89706eca87f82a7b4fd4e9a319e30486daad09554a41d1d40b8daf855fb099d23a4e371a276b94b53d225d782bdd6b1a912845bff
-  data.tar.gz: 85508fb5286ab683ca10b9ffde36133d52780d5d66cbff40f59ce6b86ef191a7c63f18b6a398a8981f21614e77804c744af7e7efc7853437329d2759ed712011
+  metadata.gz: e623093fbb3dbc1645c9d3f713c32100fa561b8ade1a62c03d4da9ae7b6c6a964b45ddcacd4bc158f8c41cc8bdf1150a02c340ce84c9b6e94ec831f798a00a76
+  data.tar.gz: '09ef23ba8854c6ff1f01fbffd7e9227e183148acf6a03ce14bd02f0244d9c38f2ef2b9d1e7494320b5b6c8be08849689d1875eff1d68d81545e358299e8ebeb8'

data/.github/workflows/ruby.yml

@@ -3,6 +3,8 @@ name: CI Matrix Testing
 on:
   push:
     branches: [ master ]
+    tags:
+      - "*"
   pull_request:
     branches: [ master ]
 
@@ -51,6 +53,7 @@ jobs:
         ruby-version: 2.7.x
 
     - name: Publish to RubyGems
+      if: contains(github.ref, 'refs/tags/')
       run: |
         mkdir -p $HOME/.gem
         touch $HOME/.gem/credentials

data/.gitignore

@@ -9,5 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
 
 tags*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumbler (0.6.11)
+    enumbler (0.8.1)
       activerecord (>= 5.2.3, < 6.1)
       activesupport (>= 5.2.3, < 6.1)
 
@@ -19,7 +19,8 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
+    ast (2.4.1)
+    coderay (1.1.2)
     concurrent-ruby (1.1.6)
     database_cleaner (1.8.5)
     database_cleaner-active_record (1.8.0)
@@ -31,13 +32,17 @@ GEM
       ruby-progressbar (~> 1.4)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
+    method_source (1.0.0)
     minitest (5.14.1)
     parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -52,14 +57,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.91.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.4.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.4.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
@@ -75,9 +83,10 @@ DEPENDENCIES
   database_cleaner-active_record (~> 1.8.0)
   enumbler!
   fuubar (~> 2.5)
+  pry
   rake (~> 12.0)
   rspec (~> 3.9.0)
-  rubocop (~> 0.81.0)
+  rubocop (~> 0.91.0)
   sqlite3 (~> 1.4.0)
 
 BUNDLED WITH

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)
 
@@ -108,12 +119,14 @@ House.color(Color.black, :white) # => ActiveRecord::Relation<house, house2>
 
 ### Use a column other than `label`
 
-By default, the Enumbler expects a table in the database with a column `label`.  However, you can change this to another underlying column name.  Note that the enumbler still treats it as a `label` column; however it will be saved to the correct place in the database.
+By default, the Enumbler expects a table in the database with a column `label`.  However, you can change this to another underlying column name.  Note that the enumbler still treats it as a `label` column; however it will be saved to the correct place in the database. Your model now can have its own `label` separate from whatever attribute/column was
+specified for Enumbler usage.
 
 ```ruby
 ActiveRecord::Schema.define do
   create_table :feelings, force: true do |t|
     t.string :emotion, null: false, index: { unique: true }
+    t.string :label
   end
 end
 
@@ -125,8 +138,15 @@ class Feeling < ApplicationRecord
 
   enumble :sad, 1
   enumble :happy, 2
-  enumble :verklempt, 3, label: 'overcome with emotion'
+  enumble :verklempt, 3, label: "Verklempt!", emotion: 'overcome with emotion'
 end
+
+# Now the `Feeling` model can use `label` if it wants to
+# and not conflict with Enumbler usage (:emotion in this case)
+# .enumble.label & .emotion is used internally by Enumbler
+Feeling.verklempt.label           # => 'Verklempt!'
+Feeling.verklempt.enumble.label   # => 'overcome with emotion'
+Feeling.verklempt.emotion         # => 'overcome with emotion'
 ```
 
 ## Core ext
@@ -140,6 +160,7 @@ when :black
 when :blue, :purple
   'very surprised'
 end
+```
 
 ## Development
 
@@ -149,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/enumbler.gemspec

@@ -34,8 +34,9 @@ Gem::Specification.new do |spec|
 
   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.81.0'
+  spec.add_development_dependency 'rubocop', '~> 0.91.0'
   spec.add_development_dependency 'sqlite3', '~> 1.4.0'
 end

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
@@ -330,11 +375,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 +398,42 @@ module Enumbler
           raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
         end
 
-        define_singleton_method("any_#{enumble.enum}?") do
+        define_singleton_method(any_method_name) do
           where(id: enumble.id).exists?
         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)

data/lib/enumbler/enumble.rb

@@ -8,9 +8,10 @@ module Enumbler
     def initialize(enum, id, label: nil, label_column_name: :label, **attributes)
       @id = id
       @enum = enum
-      @label = label || enum.to_s.dasherize
       @label_column_name = label_column_name
+      @label = (label_col_specified? ? attributes[label_column_name] : label) || enum.to_s.dasherize
       @additional_attributes = attributes || {}
+      @additional_attributes.merge!({ label: label }) if label_col_specified?
     end
 
     def ==(other)
@@ -19,10 +20,9 @@ module Enumbler
     end
 
     def attributes
-      @additional_attributes.merge({
-        id: id,
-        label_column_name => label,
-      })
+      hash = { id: id, label_column_name => label }
+      hash.merge!({ label: @additional_attributes[:label] }) if label_col_specified?
+      @additional_attributes.merge(hash)
     end
 
     # Used to return itself from a class method.
@@ -50,5 +50,11 @@ module Enumbler
     def to_s
       enum
     end
+
+    private
+
+    def label_col_specified?
+      label_column_name != :label
+    end
   end
 end

data/lib/enumbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.8.1
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.91.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 0.91.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Enums are terrific, but lack integrity.  Let's add some!