spicerack 0.16.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab658b1a460b32983639d4d8e3e39f293e285ddb90f48806388f100b1908f5b9
-  data.tar.gz: 0df60d065dde766fe6bb21f8b33adec402d293a77ffa20572a6c8a0fe38d9880
+  metadata.gz: c92116412b94f90920f84dd05d8419d0bc7a4c2ffa3b33482ee6b53e32ad2032
+  data.tar.gz: 432943870f985ad4301e95b7f40bf936696c73d3f7d60eefaea27f85fb20bbe6
 SHA512:
-  metadata.gz: 1feee1e4d22e6e90a393d8d0736edda1a6e472a1dbab79d7296f068f6ea6e4ae3c735dd2b9095460017e6cdf725f166239c5fa9d7005f92c3d9de1383443eae4
-  data.tar.gz: 87efaba97f8eb03e43126f669ab739daf7a553fff86aa47aba4910d587bd3d8c8cb0bf804c13552002365d33c495a2361bf0c750714389ab89e829cd12cc4c53
+  metadata.gz: 3cccd7de009826d22e34d5de0534ac5d7543e7873db5e72e6c2951814b56089d4dc30ec47076fc91bc40b6329c0c99d97a6f061426dbb6b031c6e80ec3ae3093
+  data.tar.gz: bad53b799446ca49f068ca3931be811d225b1681d3b141de3bbd21dd314c49ffc61d4f5d1ef48c7ac6e36a7394abd2c475958db8033bd06bdacadaaa885b81c5

data/lib/spicerack/configurable.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "configurable/config_builder"
+require_relative "configurable/config_delegation"
+require_relative "configurable/config_object"
+require_relative "configurable/evaluator"
 require_relative "configurable/reader"
 
 # NOTE: This is still a pre-release feature! Use at your own risk - it may change before being released.
@@ -16,6 +19,12 @@ require_relative "configurable/reader"
 #       configuration_options do
 #         option :some_config_option
 #         option :some_option_with_a_default, default: "I probably know what's best"
+#
+#         nested :whats_behind do
+#           option :door_one, default: "It's a goat"
+#           option :door_two, default: "Another goat"
+#           option :door_three, default: "It's a car!"
+#         end
 #       end
 #     end
 #   end
@@ -24,14 +33,27 @@ require_relative "configurable/reader"
 #   SomeGem::Configuration.configure do |config|
 #     config.some_config_option = 12345
 #     config.some_option_with_a_default = "Nope, you really don't"
+#
+#     config.whats_behind do |nested|
+#       nested.door_one = "It's a boat!"
+#       nested.door_three = "The teletubbies on repeat 😱"
+#     end
 #   end
 #
 #   # Then, back in your gem code:
 #   puts Configuration.config.some_config_option
 #   => 12345
+#   puts Configuration.config.whats_behind.door_one
+#   => "It's a boat!"
+#
+#   # Or, if you want to select dynamically:
+#   doors = %i[door_one door_two door_three]
+#   Configuration.config.config_eval(whats_behind, doors.sample).read
+#   => "The teletubbies on repeat 😱"
+#
 module Spicerack
   module Configurable
-    delegate :configure, to: :_config_builder
+    delegate :configure, :config_eval, to: :_config_builder
 
     def config
       _config_builder.reader

data/lib/spicerack/configurable/config_builder.rb

@@ -3,27 +3,39 @@
 module Spicerack
   module Configurable
     class ConfigBuilder
+      delegate :config_eval, to: :reader
+
       def reader
         @reader ||= Reader.new(configuration)
       end
 
       def configure
-        yield configuration
+        mutex.synchronize do
+          yield configuration
+        end
       end
 
       # NOTE: options must be set up before {#configure} is called
-      def option(*args)
-        config_class.__send__(:option, *args)
+      def option(*args, &block)
+        config_class.__send__(:option, *args, &block)
+      end
+
+      def nested(*args, &block)
+        config_class.__send__(:nested, *args, &block)
       end
 
       private
 
       def configuration
-        @configuration ||= config_class.new
+        config_class.instance
       end
 
       def config_class
-        @config_class ||= Class.new(InputObject)
+        @config_class ||= Class.new(ConfigObject)
+      end
+
+      def mutex
+        @mutex = Mutex.new
       end
     end
   end

data/lib/spicerack/configurable/config_delegation.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Spicerack
+  module Configurable
+    module ConfigDelegation
+      extend ActiveSupport::Concern
+
+      DEFAULT_CONFIGURATION_MODULE_NAME = "Configuration"
+
+      module ClassMethods
+        delegate :config, :configure, to: :_configuration_module
+
+        private
+
+        # Sets up delegation from a top-level class to a nested Configuration module.
+        #
+        # @example
+        #   class SomeClass
+        #     include Spicerack::Configurable::ConfigDelegation
+        #
+        #     delegates_to_configuration
+        #   end
+        #
+        #   module SomeClass::Configuration
+        #     include Spicerack::Configurable
+        #   end
+        #
+        #   SomeClass.config
+        #   => returns SomeClass::Configuration.config
+        #   SomeClass.configure do { |config| # config is the yielded config object from SomeClass::Configuration.configure }
+        #
+        # @param config_class [Spicerack::Configurable] A module that extends Spicerack::Configurable. Defaults to the module +YourGem::Configuration+
+        def delegates_to_configuration(config_class = nil)
+          @_configuration_module = config_class || "#{self}::#{DEFAULT_CONFIGURATION_MODULE_NAME}".constantize
+        end
+
+        def _configuration_module
+          raise NoMethodError, "Configuration not set up for #{self}. Did you forget to call delegates_to_configuration?" if @_configuration_module.nil?
+
+          @_configuration_module
+        end
+      end
+    end
+  end
+end

data/lib/spicerack/configurable/config_object.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module Configurable
+    class ConfigObject < InputObject
+      include Singleton
+      include ActiveModel::AttributeAssignment
+
+      alias_method :assign, :assign_attributes
+
+      RESERVED_WORDS = %i[config_eval].freeze
+
+      class_attribute :_nested_options, instance_writer: false, default: []
+      class_attribute :_nested_builders, instance_writer: false, default: {}
+
+      class << self
+        def name
+          super.presence || "#{superclass}:0x#{object_id.to_s(16)}"
+        end
+
+        def inspect
+          "#<#{name}>"
+        end
+
+        private
+
+        def option(name, *)
+          _ensure_safe_option_name(name)
+
+          super
+        end
+
+        def nested(namespace, &block)
+          _ensure_safe_option_name(namespace)
+
+          nested_config_builder_for(namespace).tap do |builder|
+            builder.instance_exec(&block)
+
+            _nested_options << namespace.to_sym
+            define_method(namespace) { builder.__send__ :configuration }
+          end
+        end
+
+        def nested_config_builder_for(namespace)
+          _nested_builders[namespace.to_sym] ||= ConfigBuilder.new
+        end
+
+        def _ensure_safe_option_name(name)
+          raise ArgumentError, "#{name.inspect} is reserved and cannot be used at a config option" if name.to_sym.in? RESERVED_WORDS
+          raise ArgumentError, "#{name.inspect} is already in use" if _nested_options.include?(name.to_sym)
+
+          puts "Warning: the config option #{name} is already defined" if _options.include?(name.to_sym) # rubocop:disable Rails/Output
+        end
+
+        def inherited(base)
+          base._nested_options = _nested_options.dup
+          base._nested_builders = _nested_builders.dup
+          super
+        end
+      end
+    end
+  end
+end

data/lib/spicerack/configurable/evaluator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module Configurable
+    class Evaluator
+      # @param path [Array<Symbol, String>] A message path for the desired config
+      # @param configuration [Spicerack::Configurable::Reader]
+      def initialize(path, configuration)
+        @path = path
+        @configuration = configuration
+      end
+
+      def read
+        path.inject(configuration, &:public_send)
+      end
+
+      private
+
+      attr_reader :path, :configuration
+    end
+  end
+end

data/lib/spicerack/configurable/reader.rb

@@ -7,18 +7,31 @@ module Spicerack
         @config = config
       end
 
+      def config_eval(*path)
+        Evaluator.new(path, self)
+      end
+
       private
 
       attr_reader :config
 
       def method_missing(method_name, *)
-        return config.public_send(method_name) if config._options.map(&:to_sym).include?(method_name.to_sym)
+        name = method_name.to_sym
+
+        return mutex.synchronize { config.public_send(name) } if config._options.map(&:to_sym).include?(name)
+        return config._nested_builders[name].reader if config._nested_builders.key?(name)
 
         super
       end
 
       def respond_to_missing?(method_name, *)
-        config._options.map(&:to_sym).include?(method_name.to_sym) || super
+        config._options.map(&:to_sym).include?(method_name.to_sym) ||
+          config._nested_builders.key?(name) ||
+          super
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
       end
     end
   end

data/lib/spicerack/objects/defaults.rb

@@ -25,12 +25,14 @@ module Spicerack
       end
 
       class Value
+        include Tablesalt::Isolation
+
         def initialize(static: nil, &block)
           @value = (static.nil? && block_given?) ? block : static
         end
 
         def value
-          (@value.respond_to?(:call) ? instance_eval(&@value) : @value).dup
+          isolate(@value.respond_to?(:call) ? instance_eval(&@value) : @value)
         end
       end
     end

data/lib/spicerack/rspec/configurable/dsl.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "matchers"
+
+module Spicerack
+  module RSpec
+    module Configurable
+      module DSL
+        def nested_config_option(config_name, &block)
+          in_nested_config_stack(config_name) do |nested_stack|
+            describe(config_name.to_s, caller: caller) do
+              subject { nested_config }
+
+              let(:parent_config) { parent_config_for_nested(nested_stack) }
+              let(:nested_config) { parent_config.public_send(nested_stack.last) }
+
+              it "defines nested config object #{config_name}" do
+                expect(parent_config).to respond_to config_name
+                expect(parent_config._nested_options).to include config_name.to_sym
+                expect(parent_config.public_send(config_name)).to be_a Spicerack::Configurable::ConfigObject
+              end
+
+              instance_eval(&block)
+            end
+          end
+        end
+
+        def self.included(base)
+          base.extend DSL
+          super
+        end
+
+        private
+
+        def parent_config_for_nested(nested_stack)
+          @parent_config ||= {}
+
+          @parent_config[nested_stack] ||= described_class.
+            __send__(:_config_builder).
+            __send__(:configuration).
+            yield_self do |config|
+              nested_stack[0..-2].inject(config) do |conf, nested_name|
+                conf.public_send(nested_name)
+              end
+            end
+        end
+
+        def in_nested_config_stack(name)
+          _nested_config_stack << name.to_sym
+
+          yield _nested_config_stack.dup
+
+          _nested_config_stack.pop
+        end
+
+        def _nested_config_stack
+          Thread.current[:nested_config_stack] ||= []
+        end
+      end
+    end
+  end
+end

data/lib/spicerack/rspec/configurable/matchers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module RSpec
+    module Configurable
+      module Matchers
+        extend ::RSpec::Matchers::DSL
+      end
+    end
+  end
+end
+
+require_relative "matchers/define_config_option"

data/lib/spicerack/rspec/configurable/matchers/define_config_option.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module RSpec
+    module Configurable
+      module Matchers
+        # RSpec matcher to test options of a Configurable class
+        #
+        #     class ExampleConfiguration
+        #       include Spicerack::Configurable
+        #
+        #       option :foo
+        #       option :bar, default: :baz
+        #     end
+        #
+        #     RSpec.describe ExampleConfiguration, type: :configuration do
+        #       subject { described_class.new }
+        #
+        #       it { is_expected.to define_config_option :foo }
+        #       it { is_expected.to define_config_option :bar, default: :baz }
+        #     end
+        define :define_config_option do |option, default: nil|
+          description { "define config option #{option}" }
+          failure_message { "expected #{subject} to define config option #{option} #{with_default(default)}".strip }
+
+          match do |obj|
+            if obj.is_a? Spicerack::Configurable::ConfigObject
+              expect(obj).to define_option option, default: default
+            else
+              expect(obj).to respond_to :config
+              expect(obj.config.instance_variable_get(:@config)).to be_present
+              expect(obj.config.instance_variable_get(:@config)).to define_option option, default: default
+            end
+          end
+
+          def with_default(default)
+            "with default #{default}" unless default.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spicerack/rspec/configurable/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "matchers"
+require_relative "dsl"
+
+RSpec.configure do |config|
+  config.include(Spicerack::RSpec::Configurable::Matchers, type: :configuration)
+  config.include(Spicerack::RSpec::Configurable::DSL, type: :configuration)
+end

data/lib/spicerack/rspec/custom_matchers.rb

@@ -4,4 +4,3 @@ require_relative "custom_matchers/define_argument"
 require_relative "custom_matchers/define_attribute"
 require_relative "custom_matchers/define_field"
 require_relative "custom_matchers/define_option"
-require_relative "custom_matchers/define_config_option"

data/lib/spicerack/spec_helper.rb

@@ -3,7 +3,9 @@
 require "rspice"
 require "redis_hash/spec_helper"
 require "technologic/spec_helper"
+require "tablesalt/spec_helper"
 
 require_relative "rspec/custom_matchers"
 require_relative "rspec/shared_examples"
 require_relative "rspec/shoulda_matcher_helper"
+require_relative "rspec/configurable/spec_helper"

data/lib/spicerack/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spicerack
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.17.0
 platform: ruby
 authors:
 - Eric Garside
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: around_the_world
@@ -19,98 +19,98 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: collectible
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: facet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: redis_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: technologic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: tablesalt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -235,28 +235,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
@@ -323,6 +323,9 @@ files:
 - lib/spicerack/attribute_object.rb
 - lib/spicerack/configurable.rb
 - lib/spicerack/configurable/config_builder.rb
+- lib/spicerack/configurable/config_delegation.rb
+- lib/spicerack/configurable/config_object.rb
+- lib/spicerack/configurable/evaluator.rb
 - lib/spicerack/configurable/reader.rb
 - lib/spicerack/hash_model.rb
 - lib/spicerack/input_model.rb
@@ -333,10 +336,13 @@ files:
 - lib/spicerack/objects/options.rb
 - lib/spicerack/redis_model.rb
 - lib/spicerack/root_object.rb
+- lib/spicerack/rspec/configurable/dsl.rb
+- lib/spicerack/rspec/configurable/matchers.rb
+- lib/spicerack/rspec/configurable/matchers/define_config_option.rb
+- lib/spicerack/rspec/configurable/spec_helper.rb
 - lib/spicerack/rspec/custom_matchers.rb
 - lib/spicerack/rspec/custom_matchers/define_argument.rb
 - lib/spicerack/rspec/custom_matchers/define_attribute.rb
-- lib/spicerack/rspec/custom_matchers/define_config_option.rb
 - lib/spicerack/rspec/custom_matchers/define_field.rb
 - lib/spicerack/rspec/custom_matchers/define_option.rb
 - lib/spicerack/rspec/shared_examples.rb

data/lib/spicerack/rspec/custom_matchers/define_config_option.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-# RSpec matcher to test options of a Configurable class
-#
-#     class ExampleConfiguration
-#       include Spicerack::Configurable
-#
-#       option :foo
-#       option :bar, default: :baz
-#     end
-#
-#     RSpec.describe ExampleConfiguration, type: :configuration do
-#       subject { described_class.new }
-#
-#       it { is_expected.to define_config_option :foo }
-#       it { is_expected.to define_config_option :bar, default: :baz }
-#     end
-
-RSpec::Matchers.define :define_config_option do |option, default: nil|
-  description { "define config option #{option}" }
-  failure_message { "expected #{subject} to define config option #{option} #{with_default(default)}".strip }
-
-  match do |obj|
-    expect(obj).to respond_to :config
-    expect(obj.config.instance_variable_get(:@config)).to be_present
-    expect(obj.config.instance_variable_get(:@config)).to define_option option, default: default
-  end
-
-  def with_default(default)
-    "with default #{default}" unless default.nil?
-  end
-end