enumbler 0.6.5 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c4dbada62dea66bb3e424ee945eb02dd5b84c63d04381efeafdda8a4e7a976c
-  data.tar.gz: 9cebdafc82d22fc9d8da9cbeec18eb2a62f1169a30206868bde27cccf3003a8e
+  metadata.gz: 3f5c38e7d7fa5b50711b36695b14990509fcee834dfbf91025bf9c23b68f0164
+  data.tar.gz: 2a03beaa5e2a8ae713af29b9a39358122b586cfa9b7fa75583e15655806aeb80
 SHA512:
-  metadata.gz: df90746c7c1145fcb67136ea92ca6f0047ba8b5903329d3adcce39c63f76de88847a6ed12065c5a1ca9e43f9ea8541533854e6608e82771cf230634df000fe77
-  data.tar.gz: 12cb3873ca0a196155e3a953bdcc797a1621b03baee4962149368a2eb8b5f9efb743d73c88322d3976a016d4253ce89bb5f17dac4a58aa7435ae55c6ee44ffa2
+  metadata.gz: 428b407fdec8f44eec45e14503acbdfa98356a6b8b4d4b08ece07a355b4e6ae2de147c3807e0f3d7aeccb3fd2c81681f718bd8ada45e7d4c57103b7e53a1c30b
+  data.tar.gz: 2a3d3b91abe35d68dfb97b76bbddec356debe6f02ba9687f89c3b6f6c34d5f217365a61f846df5cafaa6630d045e9517d5d47b2e288d865475f4df010abe170b

data/Gemfile.lock

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

data/README.md

@@ -61,6 +61,9 @@ Color.black.black?         # => true
 Color.black.is_black       # => true
 Color.white.not_black?     # => true
 
+Color.all.any_black?                         # => true
+Color.where.not(id: Color::BLACK).any_black? # => false
+
 # Get attributes without hitting the database
 Color.black(:id)           # => 1
 Color.black(:enum)         # => :black
@@ -73,6 +76,9 @@ Color.find_enumbles(:black, 'does-not-exist') # => [Enumbler::Enumble<:black>, n
 
 Color.find_enumble(:black) # => Enumbler::Enumble<:black>
 
+# Is pretty flexible with findidng things from strings
+Color.find_enumble('Dark_Brown') # => Enumbler::Enumble<:dark-brown>
+
 # raises errors if none found
 Color.find_enumbles!!(:black, 'does-no-exist') # => raises Enumbler::Error
 Color.find_enumble!(:does_not_exist) # => raises Enumbler::Error
@@ -123,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/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

@@ -26,6 +26,15 @@ module Enumbler
       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?
+
+      super
+    end
+
     # These ClassMethods can be included in any model that you wish to
     # _Enumble_!
     #
@@ -168,7 +177,11 @@ module Enumbler
                 @enumbled_model.enumbles.find { |e| e.enum == arg }
               elsif arg.is_a?(String)
                 @enumbled_model.enumbles.find do |e|
-                  case_sensitive ? e.label == arg : arg.casecmp?(e.label)
+                  if case_sensitive
+                    [e.label, e.enum.to_s].include?(arg)
+                  else
+                    arg.casecmp?(e.label) || arg.casecmp?(e.enum.to_s)
+                  end
                 end
               elsif arg.instance_of?(@enumbled_model)
                 arg.enumble
@@ -322,6 +335,12 @@ module Enumbler
         rescue NoMethodError
           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?
+        rescue NoMethodError
+          raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
+        end
       end
 
       # I accidentally forgot to provide an id one time and it was confusing as

data/lib/enumbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.10
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,6 +157,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