enumbler 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5b55b5cdb2b6514f035a98bdc6e5959066b4ea10dbfaae62001d1c33b04e30
-  data.tar.gz: 807311615dc77faa62757ef3272ebb0b557962e7780af4151b841bc62db1158b
+  metadata.gz: 2eb7435b5b57b7fa3b04f7201bc41b3caaea6f148af6998fbdad02bdd44794bd
+  data.tar.gz: cf198237307efcbc457e55c3b046e612ba44a9fef52b86bb47f02a0989350df0
 SHA512:
-  metadata.gz: 5a037f268d76bd8017788831aa300201571c6cf1246572599ae7972235f13df2b4984a9c8d4df007a7f546be34fcb645db955256a5f2255f792a560413e93f58
-  data.tar.gz: c39c25eea9bff43c6e75df877ce33e8b33e616e1ec0ff01f10d361c3187c7b2711e4f85e81cdf06bfc38712ced4f6c0a2cd2c5047c688742ce3d5f42eac632b6
+  metadata.gz: e39538cefdfe366d8c944732796c0354c49f7fbc9930d7f3a4fb7912b6088188a1b1dbbd9f9395a4ea67f2c857a1ea7490f3631285daec68c388c19779b95602
+  data.tar.gz: f490870fc3d1bfe7f7a10bad501619668929f351f2882455e5e7da0581511957bd95fa08c77c09715e4b54f659212f742736256e9bca4706e906d1e0b3629551

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    enumbler (0.3.0)
-      activerecord (>= 6.0)
-      activesupport (>= 6.0)
+    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

@@ -2,15 +2,30 @@
 
 `Enums` are terrific, but they lack integrity.  Enumbler! The _enum enabler_!  The goal is to allow one to maintain a true foreign_key database driven relationship that also behaves a little bit like an `enum`.  Best of both worlds?  We hope so.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumbler'
+```
+
+And then execute:
 
-## Example
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install enumbler
+
+## Usage
 
 Suppose you have a `House` and you want to add some `colors` to the house.  You are tempted to use an `enum` but the `Enumbler` is calling!
 
 ```ruby
 ActiveRecord::Schema.define do
   create_table :colors|t|
-    t.string :label, null: false
+    t.string :label, null: false, index: { unique: true }
   end
 
   create_table :houses|t|
@@ -39,38 +54,47 @@ 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]
 ```
 
-## Installation
+### Use a column other than `label`
 
-Add this line to your application's Gemfile:
+By default, the Enumbler expects a table in the database with a column `label`.  However, you can change this to another underlying column name.  Note that the enumbler still treats it as a `label` column; however it will be saved to the correct place in the database.
 
 ```ruby
-gem 'enumbler'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+ActiveRecord::Schema.define do
+  create_table :feelings, force: true do |t|
+    t.string :emotion, null: false, index: { unique: true }
+  end
+end
 
-    $ gem install enumbler
+class Feeling < ApplicationRecord
+  # @!parse extend Enumbler::Enabler::ClassMethods
+  include Enumbler::Enabler
 
-## Usage
+  enumbler_label_column_name :emotion
 
-TODO: Write usage instructions here
+  enumble :sad, 1
+  enumble :happy, 2
+  enumble :verklempt, 3, label: 'overcome with emotion'
+end
+```
 
 ## Development
 
@@ -80,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/enumbler.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 6.0'
-  spec.add_dependency 'activesupport', '>= 6.0'
+  spec.add_dependency 'activerecord', '~> 6.0.2'
+  spec.add_dependency 'activesupport', '~> 6.0.2'
 
   spec.add_development_dependency 'database_cleaner-active_record', '~> 1.8.0'
   spec.add_development_dependency 'fuubar', '~> 2.5'

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

@@ -34,7 +34,7 @@ module Enumbler
       #
       #   # in your migration
       #   create_table :colors, force: true do |t|
-      #     t.string :label, null: false
+      #     t.string :label, null: false, index: { unique: true }
       #   end
       #
       #   class Color < ApplicationRecord
@@ -58,23 +58,63 @@ 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
 
-        enumble = Enumble.new(enum, id, label: label, **options)
+        enumble = Enumble.new(enum, id, label: label, label_column_name: @enumbler_label_column_name, **options)
 
         if @enumbles.include?(enumble)
           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
 
-      # Return the record id(s) based on different argument types.  Can accept an
-      # Integer, a Symbol, or an instance of Enumbled model.  This lookup is a
-      # databse-free lookup.
+      # By default, the Enumbler is expecting a table with an underlying column
+      # named `label` that represents the enum in the database.  You can change
+      # this by calling `enumber_label_column_name` before you `enumble`!
+      #
+      #   ActiveRecord::Schema.define do
+      #     create_table :feelings, force: true do |t|
+      #       t.string :emotion, null: false, index: { unique: true }
+      #     end
+      #   end
+      #
+      #   class Feeling < ApplicationRecord
+      #     # @!parse extend Enumbler::Enabler::ClassMethods
+      #     include Enumbler::Enabler
+      #
+      #     enumbler_label_column_name :emotion
+      #
+      #     enumble :sad, 1
+      #     enumble :happy, 2
+      #     enumble :verklempt, 3, label: 'overcome with emotion'
+      #   end
+      def enumbler_label_column_name(label_column_name)
+        @enumbler_label_column_name = label_column_name
+      end
+
+      # Return the record id for a given argument.  Can accept an Integer, a
+      # Symbol, or an instance of Enumbled model.  This lookup is a database-free
+      # lookup.
+      #
+      #   Color.id_from_enumbler(1) # => 1
+      #   Color.id_from_enumbler(:black) # => 1
+      #   Color.id_from_enumbler(Color.black) # => 1
+      #
+      # @raise [Error] when there is no enumble to be found
+      # @param arg [Integer, Symbol, Class]
+      # @return [Integer]
+      def id_from_enumbler(arg)
+        ids_from_enumbler(arg).first
+      end
+
+      # Return the record id(s) based on different argument types.  Can accept
+      # an Integer, a Symbol, or an instance of Enumbled model.  This lookup is
+      # a database-free lookup.
       #
       #   Color.ids_from_enumbler(1, 2) # => [1, 2]
       #   Color.ids_from_enumbler(:black, :white) # => [1, 2]
@@ -104,18 +144,28 @@ module Enumbler
         end
       end
 
-      # Seeds the database with the Enumble data.
+      # Seeds the database with the Enumbler data.
       # @param delete_missing_records [Boolean] remove any records that are no
       #   longer defined (default: false)
-      def seed_the_enumbler(delete_missing_records: false)
+      # @param validate [Boolean] validate on save?
+      def seed_the_enumbler(delete_missing_records: false, validate: true)
         max_database_id = all.order('id desc').take&.id || 0
         max_enumble_id = enumbles.map(&:id).max
 
-        max_id = max_enumble_id > max_database_id ? max_enumble_id : max_database_id
+        # If we are not deleting records, we just need to update each listed
+        # enumble and skip anything else in the database.  If we are deleting
+        # records, we need to know the max database id.
+        iterator = if !delete_missing_records
+                     @enumbles.map(&:id)
+                   elsif max_enumble_id > max_database_id
+                     (1..max_enumble_id)
+                   else
+                     (1..max_database_id)
+                   end
 
         discarded_ids = []
 
-        (1..max_id).each do |id|
+        iterator.each do |id|
           enumble = @enumbles.find { |e| e.id == id }
 
           if enumble.nil?
@@ -125,7 +175,7 @@ module Enumbler
 
           record = find_or_initialize_by(id: id)
           record.attributes = enumble.attributes
-          record.save!
+          record.save!(validate: validate)
         end
 
         where(id: discarded_ids).delete_all if delete_missing_records
@@ -133,22 +183,29 @@ module Enumbler
 
       # Seeds the database with the Enumble data, removing any records that are no
       # longer defined.
-      def seed_the_enumbler!
-        seed_the_enumbler(delete_missing_records: true)
+      # @param validate [Boolean] validate on save?
+      def seed_the_enumbler!(validate: true)
+        seed_the_enumbler(delete_missing_records: true, validate: validate)
       end
 
       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,13 +2,17 @@
 
 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, :options
+    attr_reader :id, :enum, :label, :label_column_name, :options
 
-    def initialize(enum, id, label: nil, **options)
+    def initialize(enum, id, label: nil, label_column_name: :label, **options)
       @id = id
       @enum = enum
       @label = label || enum.to_s.dasherize
+      @label_column_name = label_column_name
       @options = options
     end
 
@@ -20,7 +24,7 @@ module Enumbler
     def attributes
       {
         id: id,
-        label: label,
+        label_column_name => label,
       }
     end
 
@@ -28,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.3.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: enumbler
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Damon Timm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -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