spicerack 0.19.3 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9142bb3eca4c03601d2fc283f02c23360fb5b06b78ff286446b4fbbef4a7e61b
-  data.tar.gz: 14c32a2cf67cb600b08822d49133b2d1befdd6a5f8c24479552376a418b3af42
+  metadata.gz: 6f2b9e1c6a0d68af5bcb74f6a95ca12fe3392ab112d20bcc9f4a0f3fb046b9c4
+  data.tar.gz: 4da6e9aed7a4c9c364acf35e274dc5a1ca5236497e128e539814ae59e752b8e8
 SHA512:
-  metadata.gz: f64e4722da3a47dea513a213385bd912f84b017ffd5c0f25833d47ca131ff658992c82f076a0a88b534fe16114e17b70fa8b5e4d9c41496fc93c1a0fe4876908
-  data.tar.gz: 8eff694a206b30609cdf1a883240612456910122a23378d71ae0c32bd479d6b36d22da4419c5dda3f79dc91f5180836653ef3e20246af01f3b3613b411f7617a
+  metadata.gz: 9d46f73f3fbd5c748d9ccc55177c5b0f6d9003106fc6d046b0cdd1209b781dcd91a64b609fc862b1e4f80498011b91df55101b3cbc9f07b59417b979c3c3b479
+  data.tar.gz: 4d2632089b4d709214911527b4119428f98a0bf3d9ad45445b4ae664c6faa8930b8c1c76a3241b860285c11bd435ddf8f75cb5d0603772d8662ad9eacfa1d624

data/lib/spicerack/configurable.rb

@@ -54,10 +54,27 @@ module Spicerack
   module Configurable
     delegate :configure, :config_eval, to: :_config_builder
 
+    # @return [Spicerack::Configurable::ConfigReader] A read-only object containing configuration options set inside {#configure}
     def config
       _config_builder.reader
     end
 
+    # Run a callback before the configure block is evaluated.
+    #
+    # Note: if configure is called multiple times for your gem, this block will get run each time!
+    #
+    def before_configure(&block)
+      _config_builder_class.set_callback(:configure, :before, &block)
+    end
+
+    # Run a callback after the configure block is evaluated.
+    #
+    # Note: if configure is called multiple times for your gem, this block will get run each time!
+    #
+    def after_configure(&block)
+      _config_builder_class.set_callback(:configure, :after, &block)
+    end
+
     private
 
     def configuration_options(&block)
@@ -65,7 +82,13 @@ module Spicerack
     end
 
     def _config_builder
-      @_config_builder ||= ConfigBuilder.new
+      @_config_builder ||= _config_builder_class.new
+    end
+
+    def _config_builder_class
+      @_config_builder_class ||= Class.new(ConfigBuilder).tap do |klass|
+        const_set(:ConfigBuilder, klass)
+      end
     end
   end
 end

data/lib/spicerack/configurable/config_builder.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
+require "technologic"
+
+require_relative "config_builder/double_configure"
+
 module Spicerack
   module Configurable
     class ConfigBuilder
+      include ActiveSupport::Callbacks
+      define_callbacks :configure
+
+      # This concern uses the configure callback, so it needs to be included after the callback is defined
+      include DoubleConfigure
+
       delegate :config_eval, to: :reader
 
       def reader
@@ -10,8 +20,10 @@ module Spicerack
       end
 
       def configure
-        mutex.synchronize do
-          yield configuration
+        run_callbacks :configure do
+          mutex.synchronize do
+            yield configuration
+          end
         end
       end
 
@@ -26,6 +38,8 @@ module Spicerack
 
       private
 
+      attr_writer :configure_called
+
       def configuration
         config_class.instance
       end

data/lib/spicerack/configurable/config_builder/double_configure.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "technologic"
+
+module Spicerack
+  module Configurable
+    module DoubleConfigure
+      extend ActiveSupport::Concern
+
+      include Technologic
+
+      included do
+        set_callback :configure, :after, :warn_on_multiple_configure_calls
+      end
+
+      private
+
+      def configure_called?
+        @configure_called
+      end
+
+      def warn_on_multiple_configure_calls
+        unless configure_called?
+          @configure_called = true
+          return
+        end
+
+        puts <<~WARNING
+          #{self.class._configurable_module_name}.configure has been called more than once, which can lead to unexpected consequences.
+          For the most predictable behavior, configure should only be called once per library.
+        WARNING
+      end
+
+      module ClassMethods
+        def _configurable_module_name
+          name.gsub("::#{name.demodulize}", "")
+        end
+      end
+    end
+  end
+end

data/lib/spicerack/version.rb

@@ -2,5 +2,5 @@
 
 module Spicerack
   # This constant is managed by spicerack
-  VERSION = "0.19.3"
+  VERSION = "0.20.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spicerack
 version: !ruby/object:Gem::Version
-  version: 0.19.3
+  version: 0.20.0
 platform: ruby
 authors:
 - Eric Garside
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: around_the_world
@@ -19,82 +19,82 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: redis_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: technologic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: tablesalt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
@@ -207,28 +207,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -295,6 +295,7 @@ files:
 - lib/spicerack/attribute_object.rb
 - lib/spicerack/configurable.rb
 - lib/spicerack/configurable/config_builder.rb
+- lib/spicerack/configurable/config_builder/double_configure.rb
 - lib/spicerack/configurable/config_delegation.rb
 - lib/spicerack/configurable/config_object.rb
 - lib/spicerack/configurable/evaluator.rb
@@ -330,6 +331,7 @@ metadata:
   homepage_uri: https://github.com/Freshly/spicerack
   source_code_uri: https://github.com/Freshly/spicerack
   changelog_uri: https://github.com/Freshly/spicerack/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/spicerack
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -345,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A suite of utility gems for Ruby on Rails.