enumbler 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2943ee8d89898bb8164e0eccc955f51de0c0ba3d95c814f0a928f967bc82486b
-  data.tar.gz: bda8b04d4dd0c9f17a9cd0f0f05e700b4fde8b24d6bad394ac8c5ab5662064da
+  metadata.gz: 3c4dbada62dea66bb3e424ee945eb02dd5b84c63d04381efeafdda8a4e7a976c
+  data.tar.gz: 9cebdafc82d22fc9d8da9cbeec18eb2a62f1169a30206868bde27cccf3003a8e
 SHA512:
-  metadata.gz: 5340c39fd43f724d13eb648349be08d2115d9fd0964adda1c39403fdb992620b5209e45435ccb222589f9891048630763ec340c1866141e204b633cc4e58da09
-  data.tar.gz: e2f243201a8621571bdf000d82ca3fa8a9c12070c9a8a11ae8ab1796f8742f75baee7aa4abcad102c3b35cd39473b806d8f9af0c94bd9657a30462ce11b0fcf3
+  metadata.gz: df90746c7c1145fcb67136ea92ca6f0047ba8b5903329d3adcce39c63f76de88847a6ed12065c5a1ca9e43f9ea8541533854e6608e82771cf230634df000fe77
+  data.tar.gz: 12cb3873ca0a196155e3a953bdcc797a1621b03baee4962149368a2eb8b5f9efb743d73c88322d3976a016d4253ce89bb5f17dac4a58aa7435ae55c6ee44ffa2

data/Gemfile.lock

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

data/README.md

@@ -26,6 +26,7 @@ Suppose you have a `House` and you want to add some `colors` to the house.  You
 ActiveRecord::Schema.define do
   create_table :colors|t|
     t.string :label, null: false, index: { unique: true }
+    t.string :hex, null: true
   end
 
   create_table :houses|t|
@@ -42,8 +43,8 @@ end
 class Color < ApplicationRecord
   include Enumbler::Enabler
 
-  enumble :black, 1
-  enumble :white, 2
+  enumble :black, 1, hex: '000000'
+  enumble :white, 2, hex: 'ffffff'
   enumble :dark_brown, 3
   enumble :infinity, 4, label: 'Infinity - and beyond!'
 end
@@ -85,10 +86,14 @@ Color.ids_from_enumbler!(:black, 'does-no-exist') # => raises Enumbler::Error
 Color.id_from_enumbler!(:does_not_exist) # => raises Enumbler::Error
 
 # Get enumble object by id
-
 house = House.create!(color: Color.black)
-house.black?
-house.not_black?
+
+# These are all db-free lookups
+house.color_label        # => 'black'
+house.color_enum         # => :black
+house.color_graphql_enum # => 'BLACK'
+house.black?             # => true
+house.not_black?         # => false
 
 house2 = House.create!(color: Color.white)
 House.color(:black, :white)      # => ActiveRecord::Relation<house, house2>

data/lib/enumbler.rb

@@ -65,6 +65,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)
     rescue NameError
       raise Error, "The model #{class_name} cannot be found.  Uninitialized constant."
@@ -97,5 +98,16 @@ module Enumbler
         define_method(not_method_name) { self[column_name] != enumble.id }
       end
     end
+
+    # Add the attirbutes:
+    #
+    #   house.color_label #=> 'black'
+    #   house.color_enum  #=> :black
+    #   house.color_graphql_enum #=> 'BLACK'
+    def define_helper_attributes(name)
+      %i[label enum graphql_enum].each do |sym|
+        define_method("#{name}_#{sym}") { send(name).enumble.send(sym) }
+      end
+    end
   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_!
     #
@@ -40,8 +49,8 @@ module Enumbler
       #   class Color < ApplicationRecord
       #     include Enumbler::Enabler
       #
-      #     enumble :black, 1
-      #     enumble :white, 2
+      #     enumble :black, 1, hex: '000000'
+      #     enumble :white, 2, hex: 'ffffff'
       #     enumble :dark_brown, 3, # label: 'dark-brown'
       #     enumble :black_hole, 3, label: 'Oh my! It is a black hole!'
       #   end
@@ -55,14 +64,18 @@ module Enumbler
       # @param enum [Symbol] the enum representation
       # @param id [Integer] the primary key value
       # @param label [String] optional: label for humans
-      # @param **options [Hash] optional: additional attributes and values that
+      # @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, **options)
+      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
 
-        enumble = Enumble.new(enum, id, label: label, label_column_name: @enumbler_label_column_name, **options)
+        enumble = Enumble.new(enum, id, label: label, label_column_name: @enumbler_label_column_name, **attributes)
 
         if @enumbles.include?(enumble)
           raise Error, "You cannot add the same Enumble twice! Attempted to add: #{enum}, #{id}."
@@ -310,6 +323,29 @@ module Enumbler
           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)
+        return if attributes.blank?
+
+        unsupported_attrs = attributes.reject { |key, _value| has_attribute?(key) }
+
+        return if unsupported_attrs.blank?
+
+        raise Enumbler::Error,
+          "The model #{self} does not support the attribute(s): #{unsupported_attrs.keys.map(&:to_s).to_sentence}"
+      rescue ActiveRecord::StatementInvalid
+        warn "[Enumbler Warning] => Unable to find a table for #{self}."\
+          'This is to be expected if there is a pending migration; however, if there is not then something is amiss.'
+      end
     end
   end
 end

data/lib/enumbler/enumble.rb

@@ -2,18 +2,15 @@
 
 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
+    attr_reader :id, :enum, :label, :label_column_name
 
-    def initialize(enum, id, label: nil, label_column_name: :label, **options)
+    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
-      @options = options
+      @additional_attributes = attributes || {}
     end
 
     def ==(other)
@@ -22,10 +19,10 @@ module Enumbler
     end
 
     def attributes
-      {
+      @additional_attributes.merge({
         id: id,
         label_column_name => label,
-      }
+      })
     end
 
     # Used to return itself from a class method.

data/lib/enumbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord