enumbler 0.6.7 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b325cf47a0a64b573f1347bffbbea7338cc57b7422dfdf3f0da39d412274d8cb
-  data.tar.gz: 10affa6956ef071ec34ad4195379d632b86945745e8d0eb7718fc8735427fe9e
+  metadata.gz: d88e3b0c2b84e7fc868c0c249f07024410c345c302fb73ce9d258b69c4521d9f
+  data.tar.gz: 88221bf5dd81bd739e76ee6fafc6d1c7ea88776d5fb2cf63951a685d5ab484fc
 SHA512:
-  metadata.gz: a38a602c49f7a0bf3f69781b4a54d555bc92a23bd61788a27bbf858d75aa554599638a77af3afd8d2088b8e94fcc69768c63d3e2268b7ea0384fc4f74a955dfa
-  data.tar.gz: 98fae8e4a32aa7207f55fe07128ca7e4730c50701cfac378756ff32c27e8b745ab471afb88401cf8096e75b42deffe7ec031d9d9e1d3d0ba97bdddc37774058c
+  metadata.gz: fbb8eda79025a550a86ec856eafacd22f120ac980730036e8127f813e915a9239ff6a3277f9f3cd50b60e8013714f162dfe91b455e72a80c15fb58fc7acda405
+  data.tar.gz: c2c4268c754c0fc957cbe3c6d669e82317c766500ef225c471ddd4e549ba4b6293ffd39ffad0ec42367e6959fd58ef3a3d7f15bf68747809fed9423cb92c5656

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.7)
+    enumbler (0.6.12)
       activerecord (>= 5.2.3, < 6.1)
       activesupport (>= 5.2.3, < 6.1)
 
@@ -20,6 +20,7 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
+    byebug (11.1.3)
     concurrent-ruby (1.1.6)
     database_cleaner (1.8.5)
     database_cleaner-active_record (1.8.0)
@@ -72,6 +73,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
   database_cleaner-active_record (~> 1.8.0)
   enumbler!
   fuubar (~> 2.5)

data/README.md

@@ -129,6 +129,18 @@ class Feeling < ApplicationRecord
 end
 ```
 
+## Core ext
+
+Adds case equality power to the `Symbol` class allowing you to use case methods directly against an enabled instance:
+
+```ruby
+case Color.black
+when :black
+  'not surprised'
+when :blue, :purple
+  'very surprised'
+end
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/enumbler.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord', ['>= 5.2.3', '< 6.1']
   spec.add_dependency 'activesupport', ['>= 5.2.3', '< 6.1']
 
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'database_cleaner-active_record', '~> 1.8.0'
   spec.add_development_dependency 'fuubar', '~> 2.5'
   spec.add_development_dependency 'rake', '~> 12.0'

data/lib/enumbler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'enumbler/core_ext/symbol/case_equality_operator'
+
 require 'enumbler/collection'
 require 'enumbler/enumble'
 require 'enumbler/enabler'
@@ -55,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)
@@ -66,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
@@ -78,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
@@ -92,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/core_ext/symbol/case_equality_operator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Use case equality operator with an enabled class.
+#
+#   case House.black
+#   when :black
+#     'this is true'
+#   when :blue, :purple
+#     'this is not'
+#   end
+class Symbol
+  def ===(other)
+    super ||
+      other.class.included_modules.include?(Enumbler::Enabler) &&
+        other.enumble.enum == self
+
+  # Calling #enumble on a new instance that has not been defined raises an
+  # error, so catching that edge case here
+  rescue Enumbler::Error
+    false
+  end
+end

data/lib/enumbler/enabler.rb

@@ -17,13 +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?
+      to_enumble_attribute(:label) || super
+    end
 
-      super
+    # The enumble symbol if it exists.
+    # @return [Symbol]
+    def to_sym
+      to_enumble_attribute(:enum) || super
+    end
+
+    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.7'
+  VERSION = '0.6.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.12
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,7 @@ files:
 - enumbler.gemspec
 - lib/enumbler.rb
 - lib/enumbler/collection.rb
+- lib/enumbler/core_ext/symbol/case_equality_operator.rb
 - lib/enumbler/enabler.rb
 - lib/enumbler/enumble.rb
 - lib/enumbler/version.rb