enumbler 0.6.9 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8023f1c813e4ecfd32ca382d1fb6ea0fe4d195d046a232fc3650d185c17e1fc4
-  data.tar.gz: 14b35d77a8491b27a2d93059851a8ce01e7e9852c04e5ee22460f6637b3d43e0
+  metadata.gz: bd8d1d86b3abe14b9454f4b36519d41c7d21e6544c749e5db19215d790a4b3dc
+  data.tar.gz: 44a694212c3feaa9aad8ea5dacd0ca370105e8dc69fe6196b67b158fd0f4ba63
 SHA512:
-  metadata.gz: fd0044a895d518a5c3615bd3bb021b58262c7c376074bcfa409ad6bf3c78bea42a7afebdeec16f38a27bcc0a62e0b51107c89caec0de45f0c26e874c411b3123
-  data.tar.gz: 193c7a98d2c496ce9339f4ff1c6b5bd27b6a3b2a2f9ee7a2182ed61832ee243895c02b0bdd0e0c31d207d4b1f6f0a91601e5f0c9c1c85f5358020aba08d40860
+  metadata.gz: 374e370ed1e6ff6575b0d494d57f20b95ebf25116382dbabe723a4450a06e4bf53a1ae688576e632fbbaabd97c4d5aa35f8a048fc71d76caf7d739a2a7d5676a
+  data.tar.gz: 51772747de3d1e9e3ac2012c1a91223c68470f7caa96127807b30c398870965e781fa813f297fc2a28fa8dfe25bc8a4174836ab8035ce2bcb6eae4e7d41ddf9a

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.9)
+    enumbler (0.7.0)
       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

@@ -108,12 +108,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 +127,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 +149,7 @@ when :black
 when :blue, :purple
   'very surprised'
 end
+```
 
 ## Development
 

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.rb

@@ -57,7 +57,7 @@ module Enumbler
     #   example: `where_by` will make it `House.where_by_color(:black)`
     # @param **options [Hash] additional options passed to `belongs_to`
     def enumbled_to(name, scope = nil, prefix: false, scope_prefix: nil, **options)
-      class_name = name.to_s.classify
+      class_name = options.fetch(:class_name, name.to_s.classify)
       enumbled_model = class_name.constantize
 
       unless enumbled_model.respond_to?(:enumbles)
@@ -68,7 +68,7 @@ module Enumbler
       belongs_to(name, scope, **options)
 
       define_helper_attributes(name)
-      define_dynamic_methods_for_enumbled_to_models(enumbled_model, prefix: prefix, scope_prefix: scope_prefix)
+      define_dynamic_methods_for_enumbled_to_models(name, enumbled_model, prefix: prefix, scope_prefix: scope_prefix)
     rescue NameError
       raise Error, "The model #{class_name} cannot be found.  Uninitialized constant."
     end
@@ -80,11 +80,10 @@ module Enumbler
     # @todo - we should check for naming conflicts!
     #     dangerous_attribute_method?(method_name)
     #     method_defined_within?(method_name, self, Module)
-    def define_dynamic_methods_for_enumbled_to_models(enumbled_model, prefix: false, scope_prefix: nil)
-      model_name = enumbled_model.to_s.underscore
-      column_name = "#{model_name}_id"
+    def define_dynamic_methods_for_enumbled_to_models(name, enumbled_model, prefix: false, scope_prefix: nil)
+      column_name = "#{name}_id"
 
-      cmethod = scope_prefix.blank? ? model_name : "#{scope_prefix}_#{model_name}"
+      cmethod = scope_prefix.blank? ? name : "#{scope_prefix}_#{name}"
       define_singleton_method(cmethod) do |*args|
         where(column_name => enumbled_model.ids_from_enumbler(args))
       end
@@ -94,8 +93,8 @@ module Enumbler
       end
 
       enumbled_model.enumbles.each do |enumble|
-        method_name = prefix ? "#{model_name}_#{enumble.enum}?" : "#{enumble.enum}?"
-        not_method_name = prefix ? "#{model_name}_not_#{enumble.enum}?" : "not_#{enumble.enum}?"
+        method_name = prefix ? "#{name}_#{enumble.enum}?" : "#{enumble.enum}?"
+        not_method_name = prefix ? "#{name}_not_#{enumble.enum}?" : "not_#{enumble.enum}?"
         define_method(method_name) { self[column_name] == enumble.id }
         define_method(not_method_name) { self[column_name] != enumble.id }
       end

data/lib/enumbler/enabler.rb

@@ -17,22 +17,29 @@ module Enumbler
       @enumble
     end
 
+    # The enumble graphql_enum if it exists.
+    # @return [Symbol]
+    def to_graphql_enum
+      to_enumble_attribute(:graphql_enum) || super
+    end
+
     # The enumble label if it exists.
     # @return [String]
     def to_s
-      enumble = self.class.find_enumble(id)
-      return enumble.label if enumble.present?
-
-      super
+      to_enumble_attribute(:label) || super
     end
 
     # The enumble symbol if it exists.
     # @return [Symbol]
     def to_sym
-      enumble = self.class.find_enumble(id)
-      return enumble.enum if enumble.present?
+      to_enumble_attribute(:enum) || super
+    end
 
-      super
+    private
+
+    def to_enumble_attribute(attribute)
+      enumble = self.class.find_enumble(id)
+      return enumble.send(attribute) if enumble.present?
     end
 
     # These ClassMethods can be included in any model that you wish to

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.9'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.7.0
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2020-10-01 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