enumbler 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cb3204d93f558b4286bd533ca6ac0cd4e70170f3678d28848777526e44732d
-  data.tar.gz: e21fbf9da2af04a6133df3559307892f259324fbad8fe0077facbf4024b63185
+  metadata.gz: 2eb7435b5b57b7fa3b04f7201bc41b3caaea6f148af6998fbdad02bdd44794bd
+  data.tar.gz: cf198237307efcbc457e55c3b046e612ba44a9fef52b86bb47f02a0989350df0
 SHA512:
-  metadata.gz: e6dcafa85a85b9e304810e8554b81435c0414ed984bde78063e8aeceb397d3bfcb77534d4da2f04153dccd99cc7f2403e61156722f9743fe485fc242d8e26ba6
-  data.tar.gz: 07fc687fa545b3bf402622d57fd3f0c95d961dede6b6358131cf39524c7fcd7ed6036a24baade2448f01599ecde2e91354ed43803e7657d40b1d0b9dbded6265
+  metadata.gz: e39538cefdfe366d8c944732796c0354c49f7fbc9930d7f3a4fb7912b6088188a1b1dbbd9f9395a4ea67f2c857a1ea7490f3631285daec68c388c19779b95602
+  data.tar.gz: f490870fc3d1bfe7f7a10bad501619668929f351f2882455e5e7da0581511957bd95fa08c77c09715e4b54f659212f742736256e9bca4706e906d1e0b3629551

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    enumbler (0.4.2)
+    enumbler (0.5.0)
       activerecord (~> 6.0.2)
       activesupport (~> 6.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
     concurrent-ruby (1.1.6)
-    database_cleaner (1.8.4)
+    database_cleaner (1.8.5)
     database_cleaner-active_record (1.8.0)
       activerecord
       database_cleaner (~> 1.8.0)
@@ -32,9 +32,9 @@ GEM
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    minitest (5.14.0)
+    minitest (5.14.1)
     parallel (1.19.1)
-    parser (2.7.1.0)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (12.3.3)
@@ -43,15 +43,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     rubocop (0.81.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/README.md

@@ -54,17 +54,23 @@ class House < ApplicationRecord
 end
 
 # This gives you some power:
-Color::BLACK           # => 1
-Color.black            # => equivalent to Color.find(1)
-Color.black.black?     # => true
-Color.black.is_black   # => true
-Color.white.not_black? # => true
+Color::BLACK               # => 1
+Color.black                # => equivalent to Color.find(1)
+Color.black.black?         # => true
+Color.black.is_black       # => true
+Color.white.not_black?     # => true
+
+Color.black(:id)           # => 1
+Color.black(:enum)         # => :black
+Color.black(:label)        # => 'black'
+Color.black(:graphql_enum) # => 'BLACK'
 
 house = House.create!(color: Color.black)
 house.black?
 house.not_black?
 
-House.color(:black) # => [house]
+house2 = House.create!(color: Color.white)
+House.color(:black, :white) # => [house, house2]
 ```
 
 ### Use a column other than `label`
@@ -98,7 +104,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Roadmap
 
-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.
+* 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.
 
 ## Contributing
 

data/lib/enumbler.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'enumbler/collection'
 require 'enumbler/enumble'
 require 'enumbler/enabler'
 require 'enumbler/version'

data/lib/enumbler/collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Enumbler
+  # Not sure if this will be needed but was leaning toward a custom wrapper for
+  # our array holding the `enumbles` for our model.  As it is, allows you to
+  # query them based on the enum:
+  #
+  # ```
+  # Color.enumbles.black # => [Enumbler::Enumble]
+  # ```
+  class Collection < Array
+    def method_missing(method_name, *args, &block)
+      enumble = find { |e| e.enum == method_name }
+      return enumble if enumble.present?
+
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      enumble = find { |e| e.enum == method_name }
+      enumble.present? || super
+    end
+  end
+end

data/lib/enumbler/enabler.rb

@@ -58,7 +58,7 @@ module Enumbler
       # @param **options [Hash] optional: additional attributes and values that
       #   will be saved to the database for this enumble record
       def enumble(enum, id, label: nil, **options)
-        @enumbles ||= []
+        @enumbles ||= Enumbler::Collection.new
         @enumbled_model = self
         @enumbler_label_column_name ||= :label
 
@@ -68,7 +68,7 @@ module Enumbler
           raise Error, "You cannot add the same Enumble twice! Attempted to add: #{enum}, #{id}."
         end
 
-        define_dynamic_methods_and_constants_for_enumbled_model(enum, id)
+        define_dynamic_methods_and_constants_for_enumbled_model(enumble)
 
         @enumbles << enumble
       end
@@ -190,16 +190,22 @@ module Enumbler
 
       private
 
-      def define_dynamic_methods_and_constants_for_enumbled_model(enum, id)
-        method_name = "#{enum}?"
-        not_method_name = "not_#{enum}?"
-        alias_method_name = "is_#{enum}"
+      def define_dynamic_methods_and_constants_for_enumbled_model(enumble)
+        method_name = "#{enumble.enum}?"
+        not_method_name = "not_#{enumble.enum}?"
+        alias_method_name = "is_#{enumble.enum}"
 
-        const_set(enum.to_s.upcase, id)
-        define_method(method_name) { self.id == id }
-        define_method(not_method_name) { self.id != id }
+        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(enum) { find(id) }
+        define_singleton_method(enumble.enum) do |attr = nil|
+          return find(enumble.id) if attr.nil?
+
+          enumble.send(attr)
+        rescue NoMethodError
+          raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
+        end
       end
     end
   end

data/lib/enumbler/enumble.rb

@@ -2,6 +2,9 @@
 
 module Enumbler
   # Class that holds each row of Enumble data.
+  #
+  # @todo We need to support additional options/attributes beyond the id/label
+  #   pairs.  Is on the backburner for a moment.
   class Enumble
     attr_reader :id, :enum, :label, :label_column_name, :options
 
@@ -29,5 +32,16 @@ module Enumbler
       other.class == self.class &&
         (other.id == id || other.enum == enum || other.label == label)
     end
+
+    # Standardizing the enum for a GraphQL schema with an uppercase string
+    # value.
+    # @return [String]
+    def graphql_enum
+      enum.to_s.upcase
+    end
+
+    def to_s
+      enum
+    end
   end
 end

data/lib/enumbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,7 @@ files:
 - bin/setup
 - enumbler.gemspec
 - lib/enumbler.rb
+- lib/enumbler/collection.rb
 - lib/enumbler/enabler.rb
 - lib/enumbler/enumble.rb
 - lib/enumbler/version.rb