tablesalt 0.23.2 → 0.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32be8f4aba8c2345d143f8e7ec32497c38fdb93283d001dcff734ed3a24e2280
-  data.tar.gz: c289b11fdf258b1e8515d2eab9872809302749339b44322080a3af8b07974bee
+  metadata.gz: 32b2974935a587bd2189cf801e9525259500458aa4ca280a072146d9135ac16a
+  data.tar.gz: 16f152b1f455fa7ea0f98f1e132f5becba475b45884c683780e05660106ce36c
 SHA512:
-  metadata.gz: bd04098eb17d5bc9bbc2ab6b679c38c8b06eee2c0dc66634b3b15e126191c6dc39f2c463dae4720191055d647515a0d3bc79411567d028ab5ad136ae09d1396e
-  data.tar.gz: 3a72138c4968b8b777d873c5b1ebf9b591e34b8285aa8c3efc63880a144fcfcdcab2b094610c366013c6656676adbd507b30b2f69e30a573967e1066e8769397
+  metadata.gz: 51d8b5e463199792b30de3c8c8aaea89a0588e838fb6c1b28d444dfae9e0d91df34be6266958bb4be63c40c60a29f571c6c59c76122577697a7e31bfa99a877b
+  data.tar.gz: d5ca1fa8ca4ad95a5df47b03fa31dc93cbfc9dc6ce2790d1c4aad97b4089afe0ddd6d3f924305062617fd5dffd20d800a9a29b3c9d3916008c035fd28fe1c1ab

data/lib/tablesalt/rspec/custom_matchers/define_thread_reader.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/keys"
+
+# RSpec matcher to assert the definition of a thread accessor
+#
+#     class MyClass
+#       include Tablesalt::ConfigDelegation
+#
+#       thread_reader :a_thread_key
+#     end
+#
+#     RSpec.describe MyClass do
+#       subject { described_class }
+#
+#       it { is_expected.to define_thread_reader :a_thread_key, private: false }
+#     end
+RSpec::Matchers.define :define_thread_reader do |method_name, thread_key, **options|
+  attr_reader :subject, :method_name, :thread_key, :private_opt
+
+  description { "defines#{a_private} thread reader #{method_name.inspect} with thread key #{thread_key.inspect}" }
+
+  failure_message { "expected #{subject_module} to define#{a_private} thread reader #{method_name.inspect} with thread key #{thread_key.inspect}" }
+  failure_message_when_negated { "expected #{subject_module} not to define#{a_private} thread reader #{method_name.inspect} with thread key #{thread_key.inspect}" }
+
+  match_unless_raises do |subject|
+    options.assert_valid_keys(:private)
+
+    @subject = subject
+    @method_name = method_name
+    @thread_key = thread_key.to_sym
+    @private_opt = options.fetch(:private, true)
+
+    with_value_on_thread do
+      expect(instance).to be_respond_to(method_name, true)
+      expect(klass).to be_respond_to(method_name, true)
+
+      expect(instance.__send__(method_name)).to eq stubbed_value
+      expect(klass.__send__(method_name)).to eq stubbed_value
+
+      if private_opt
+        expect { instance.public_send(method_name) }.to raise_error NoMethodError
+        expect { klass.public_send(method_name) }.to raise_error NoMethodError
+      end
+    end
+
+    true
+  end
+
+  private
+
+  def with_value_on_thread
+    Thread.current[thread_key] = stubbed_value
+
+    yield
+
+    Thread.current[thread_key] = nil
+  end
+
+  def subject_module
+    subject.is_a?(Module) ? subject : subject.class
+  end
+
+  def klass
+    @klass ||=
+      case subject
+      when Class
+        subject
+      when Module
+        Class.new(subject)
+      else
+        subject.class
+      end
+  end
+
+  def instance
+    return subject unless subject.is_a?(Module)
+
+    @instance ||= begin
+      allow(klass).to receive(:initialize).with(any_args)
+      subject.new
+    end
+  end
+
+  def stubbed_value
+    @stubbed_value ||= double("Thread value")
+  end
+
+  def a_private
+    return unless private_opt
+
+    " a private"
+  end
+end

data/lib/tablesalt/rspec/custom_matchers.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative "custom_matchers/define_thread_reader"
 require_relative "custom_matchers/isolate"

data/lib/tablesalt/thread_accessor.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Tablesalt
+  module ThreadAccessor
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      private
+
+      # Defines an instance method and a singleton method to read from a given key in Thread.current
+      #
+      # @example
+      #   class SomeClass
+      #     include Tablesalt::ThreadAccessor
+      #
+      #     thread_reader :current_foo, :foo, private: false
+      #   end
+      #
+      #   Thread.current[:foo] = "bar"
+      #   SomeClass.current_foo
+      #   => "bar"
+      #
+      #   SomeClass.new.current_foo
+      #   => "bar"
+      #
+      # @param method [String, Symbol] The name of the reader method
+      # @param thread_key [String, Symbol] The key to read from Thread.current
+      # @option :private [Boolean] If true, both defined methods will be private. Default: true
+      def thread_reader(method, thread_key, **options)
+        define_method(method) { Thread.current[thread_key] }
+        define_singleton_method(method) { Thread.current[thread_key] }
+
+        return unless options.fetch(:private, true)
+
+        private method
+        private_class_method method
+      end
+
+      # Defines an instance method and a singleton method to write to a given key in Thread.current
+      #
+      # @example
+      #   class SomeClass
+      #     include Tablesalt::ThreadAccessor
+      #
+      #     thread_writer :current_foo, :foo, private: false
+      #   end
+      #
+      #   SomeClass.current_foo = "bar"
+      #
+      #   Thread.current[:foo]
+      #   => "bar"
+      #
+      # @param method [String, Symbol] The name of the writer method
+      # @param thread_key [String, Symbol] The key to write to on Thread.current
+      # @option :private [Boolean] If true, both defined methods will be private. Default: true
+      def thread_writer(method, thread_key, **options)
+        method_name = "#{method}="
+
+        define_method(method_name) { |value| Thread.current[thread_key] = value }
+        define_singleton_method(method_name) { |value| Thread.current[thread_key] = value }
+
+        return unless options.fetch(:private, true)
+
+        private method_name
+        private_class_method method_name
+      end
+
+      # Defines instance methods and singleton methods to read/write a given key in Thread.current
+      #
+      # @example
+      #   class SomeClass
+      #     include Tablesalt::ThreadAccessor
+      #
+      #     thread_accessor :current_foo, :foo, private: false
+      #   end
+      #
+      #   SomeClass.current_foo = "bar"
+      #   SomeClass.current_foo
+      #   => "bar"
+      #
+      #   SomeClass.new.current_foo = "baz"
+      #   SomeClass.new.current_foo
+      #   => "baz"
+      #
+      #   Thread.current[:foo]
+      #   => "baz"
+      #
+      # @param method [String, Symbol] The name of the writer method
+      # @param thread_key [String, Symbol] The key to write to on Thread.current
+      # @option :private [Boolean] If true, all defined methods will be private. Default: true
+      def thread_accessor(method, thread_key, **options)
+        thread_reader(method, thread_key, **options)
+        thread_writer(method, thread_key, **options)
+      end
+    end
+  end
+end

data/lib/tablesalt/version.rb

@@ -2,5 +2,5 @@
 
 module Tablesalt
   # This constant is managed by spicerack
-  VERSION = "0.23.2"
+  VERSION = "0.23.3"
 end

data/lib/tablesalt.rb

@@ -8,6 +8,7 @@ require "tablesalt/version"
 require "tablesalt/dsl_accessor"
 require "tablesalt/isolation"
 require "tablesalt/stringable_object"
+require "tablesalt/thread_accessor"
 require "tablesalt/uses_hash_for_equality"
 
 module Tablesalt; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tablesalt
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.23.3
 platform: ruby
 authors:
 - Jordan Minneti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,9 +53,11 @@ files:
 - lib/tablesalt/dsl_accessor.rb
 - lib/tablesalt/isolation.rb
 - lib/tablesalt/rspec/custom_matchers.rb
+- lib/tablesalt/rspec/custom_matchers/define_thread_reader.rb
 - lib/tablesalt/rspec/custom_matchers/isolate.rb
 - lib/tablesalt/spec_helper.rb
 - lib/tablesalt/stringable_object.rb
+- lib/tablesalt/thread_accessor.rb
 - lib/tablesalt/uses_hash_for_equality.rb
 - lib/tablesalt/version.rb
 homepage: https://github.com/Freshly/spicerack/tree/master/tablesalt
@@ -65,7 +67,7 @@ metadata:
   homepage_uri: https://github.com/Freshly/spicerack/tree/master/tablesalt
   source_code_uri: https://github.com/Freshly/spicerack/tree/master/tablesalt
   changelog_uri: https://github.com/Freshly/spicerack/blob/master/tablesalt/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/tablesalt/0.23.2
+  documentation_uri: https://www.rubydoc.info/gems/tablesalt/0.23.3
 post_install_message: 
 rdoc_options: []
 require_paths: