spicerack 0.13.5 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68360e5269fe5fba490fbf357d063bf7b8c314806420595aaabeedd415a37bb9
-  data.tar.gz: a1652d7650cde1e8b8f30208b89e70129e634b37718df0ce8292faa96b290af8
+  metadata.gz: a664105c1a345538f9e8c22264d854b877cd8b9353574694b9ad57edd558d1df
+  data.tar.gz: ef09c99c0590654caf6d9dbd6305b7815ba46722e96da7da2aa7cba069d70513
 SHA512:
-  metadata.gz: 60b8b2c89f197b8a369f82fa2eb21f6a769587f05cd44ba38cdcda9d0a7f3521739bab39e479f2412fd8a3416919c113a91d4b994e1236dab4af20eb2d3620c7
-  data.tar.gz: a1d50a8d024e1a5f23bd0b387114a135874ecce67d3c4cdb685cda2212f860be43b4538f3371c7f678ed33b6dac077e0ddb88184d7a99ff3b8f089efe00fbc1d
+  metadata.gz: 8e44013fced63365fdd9e477c1fc65499419c1f62a220fd9257e2eb801c6809a416add2a412676851c623c571010e573ba8bbc37fd36ef708c3bcaad8e64d73a
+  data.tar.gz: 32b262fd44dd16ed3d2f5e7c1c070d48845787343415ab835f2c4da0c187e99a9d0bad68afcd49fe77b946e796b958b85268420b48d609a7bd3ea5bd830b88d3

data/lib/spicerack.rb

@@ -21,5 +21,6 @@ require "spicerack/root_object"
 require "spicerack/attribute_object"
 require "spicerack/input_object"
 require "spicerack/input_model"
+require "spicerack/configurable"
 
 module Spicerack; end

data/lib/spicerack/configurable.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "configurable/config_builder"
+require_relative "configurable/reader"
+
+# NOTE: This is still a pre-release feature! Use at your own risk - it may change before being released.
+#
+# A utility for creating read-only gem configuration singletons.
+#
+# Usage:
+#   # In your gem:
+#   module SomeGem
+#     module Configuration
+#       extend Spicerack::Configurable
+#
+#       configuration_options do
+#         option :some_config_option
+#         option :some_option_with_a_default, default: "I probably know what's best"
+#       end
+#     end
+#   end
+#
+#   # Then, in the application using the gem:
+#   SomeGem::Configuration.configure do |config|
+#     config.some_config_option = 12345
+#     config.some_option_with_a_default = "Nope, you really don't"
+#   end
+#
+#   # Then, back in your gem code:
+#   puts Configuration.config.some_config_option
+#   => 12345
+module Spicerack
+  module Configurable
+    delegate :configure, to: :_config_builder
+
+    def config
+      _config_builder.reader
+    end
+
+    private
+
+    def configuration_options(&block)
+      _config_builder.instance_exec(&block)
+    end
+
+    def _config_builder
+      @_config_builder ||= ConfigBuilder.new
+    end
+  end
+end

data/lib/spicerack/configurable/config_builder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module Configurable
+    class ConfigBuilder
+      def reader
+        @reader ||= Reader.new(configuration)
+      end
+
+      def configure
+        yield configuration
+      end
+
+      # NOTE: options must be set up before {#configure} is called
+      def option(*args)
+        config_class.__send__(:option, *args)
+      end
+
+      private
+
+      def configuration
+        @configuration ||= config_class.new
+      end
+
+      def config_class
+        @config_class ||= Class.new(InputObject)
+      end
+    end
+  end
+end

data/lib/spicerack/configurable/reader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spicerack
+  module Configurable
+    class Reader
+      def initialize(config)
+        @config = config
+      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)
+
+        super
+      end
+
+      def respond_to_missing?(method_name, *)
+        config._options.map(&:to_sym).include?(method_name.to_sym) || super
+      end
+    end
+  end
+end

data/lib/spicerack/rspec/custom_matchers.rb

@@ -4,3 +4,4 @@ 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/rspec/custom_matchers/define_config_option.rb

@@ -0,0 +1,32 @@
+# 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

data/lib/spicerack/version.rb

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

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: spicerack
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.14.0
 platform: ruby
 authors:
 - Eric Garside
 - Allen Rettberg
+- Jordan Minneti
+- Aleksei Kharkov
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -17,70 +19,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: redis_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: technologic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: tablesalt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -199,33 +201,35 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.5
+        version: 0.14.0
 description: This collection of gems will spice up your rails and kick your rubies
   up a notch. Bam!
 email:
 - garside@gmail.com
 - allen.rettberg@freshly.com
+- jordan.minneti@freshly.com
+- aliaksei.kharkou@freshly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -235,6 +239,9 @@ files:
 - lib/spicerack.rb
 - lib/spicerack/array_index.rb
 - lib/spicerack/attribute_object.rb
+- lib/spicerack/configurable.rb
+- lib/spicerack/configurable/config_builder.rb
+- lib/spicerack/configurable/reader.rb
 - lib/spicerack/hash_model.rb
 - lib/spicerack/input_model.rb
 - lib/spicerack/input_object.rb
@@ -247,6 +254,7 @@ files:
 - 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