enumbler 0.6.3 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29989e16025afc87b0db8fd70347b21978c683ab44c6ffa2d1f44a22c20fb166
-  data.tar.gz: 807a16dd6e6ff6e8c95b3f5337acf2f1ea456d07378dc702b8f2672c0b862276
+  metadata.gz: 4ddaace87d45b05778db532d5d0d4d4b28a475a02ec7079f1dff8820edc05d24
+  data.tar.gz: b24dd09f614e8e32bed14b17bd9a36a8db1907dd4cb6e7614f73897394de3ef6
 SHA512:
-  metadata.gz: 2c8dbf495025d467ee30172289097169d84d23776320a1624d5e3920f2f66e738f606a15e61e2bbce696051c6d87ec99c811c45b3d9cdcb631f7e3bd1b961409
-  data.tar.gz: 3a6d12fe63ff37e1274b5ec3ec31023aa08f520f455b44695746a5555a20bc063283fbd6afaf2f9831d740588bcf090426647f052c1bc87e98d829a071a9fc7d
+  metadata.gz: 98349a3658d0cef8674e4a63a577a4b9e71279a4051d292f9b817fd5d8e1a2c0c837fdbb3b3cc01cac6de6219558a567eaafc9b0567d35e09bfe7b5d1689ce2c
+  data.tar.gz: 2a52456e1524c22fd224e18421fea42bff5f45fd35f016dddce701df59c7ae5edb3738555faa26ce2fee4afaae7d94043997a6e25d15414cba5bd7872f97a237

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumbler (0.6.3)
+    enumbler (0.6.8)
       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'

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

@@ -10,13 +10,22 @@ module Enumbler
     # The Enumble definition that this record defined.
     # @return [Enumbler::Enumble]
     def enumble
-      @enumble = self.class.enumbles.find { |enumble| enumble.id == id }
+      @enumble = self.class.find_enumble(id)
 
       raise Error, 'An enumble is not defined for this record!' if @enumble.nil?
 
       @enumble
     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
+    end
+
     # These ClassMethods can be included in any model that you wish to
     # _Enumble_!
     #
@@ -58,12 +67,14 @@ module Enumbler
       # @param **attributes [Hash] optional: additional attributes and values that
       #   will be saved to the database for this enumble record
       def enumble(enum, id, label: nil, **attributes)
+        raise_error_if_model_does_not_support_attributes(attributes)
+
+        id = validate_id_is_numeric(enum, id)
+
         @enumbles ||= Enumbler::Collection.new
         @enumbled_model = self
         @enumbler_label_column_name ||= :label
 
-        raise_error_if_model_does_not_support_attributes(attributes)
-
         enumble = Enumble.new(enum, id, label: label, label_column_name: @enumbler_label_column_name, **attributes)
 
         if @enumbles.include?(enumble)
@@ -157,7 +168,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
@@ -311,6 +326,21 @@ 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
+      # the last argument became the hash of options.  This should help.
+      def validate_id_is_numeric(enum, id)
+        Integer(id)
+      rescue ArgumentError, TypeError
+        raise Enumbler::Error,
+          "You must provide a numeric primary key, like: `enumble :#{enum}, 1 `"
       end
 
       def raise_error_if_model_does_not_support_attributes(attributes)

data/lib/enumbler/version.rb

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

metadata

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