interjectable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe0594cf0a21a6f303ae028952f2922aa4ccc389
-  data.tar.gz: 19c22afac4eb1264b760d94f3a24b774b2b9ab0c
+  metadata.gz: bf87a04b27e693b7dec66842c4c51ea738a7942e
+  data.tar.gz: 6c8fdb8852fa3fc8dea1bb3f17ae47dbab4d29b5
 SHA512:
-  metadata.gz: 5c433d1585325e8ddd5e40af9cd0b9bc4166eeeccb863b370dbef3da32cba6f604108fbbd6112673324f205034d2e11391c304b0fc9626fe3f926bdd6b949693
-  data.tar.gz: 611df0ea5914b1d94781024d828a2ae5f76b9c27f2127164e6448449028ca78fcbb701ab984acb89f3c52907ecf7473a62547e7223fca351618d96a5f51f2ace
+  metadata.gz: cbe3d00e061ff7b5a39ba5f49564ee58f7cd07b69b9f927b4f2bf766d7cef3656ea452ef5305bbb2c75c4f0280fb1785c190bd2836d8547098af91d378b454ad
+  data.tar.gz: 980a68ad0da41b00ad1d0663f049137d9984bcc0be716dd592bd985247396ef8f6fd0657d802fe683415785643433c7fe7993a805cac93fec08844a07ef9ac7b

data/CHANGES.md

@@ -1,5 +1,11 @@
 # Change Log
 
+# v1.1.0
+
+- Add another RSpec helper `test_inject` to avoid needing a local variable for
+  the setter block to reference. Again, see the [README.md](README.md) for
+  usage.
+
 # v1.0.0
 
 - Calling `#inject` or `#inject_static` multiple times is now an error. Use

data/README.md

@@ -79,12 +79,12 @@ require "interjectable/rspec"
 describe A do
   describe "#read" do
     before do
-      instance_double(B, parse: "result").tap do |fake_b|
-        a.test_inject(:b) { fake_b }
-      end
-      instance_double(C, boom: "goat").tap do |fake_c|
-        a.test_inject(:c) { fake_c }
-      end
+      # You can use the block form of #test_inject to inject a fake object that references methods on a.
+      a.test_inject(:b) { FakeB.new(foo) }
+
+      # You can use the test_inject RSpec helper if you just want to inject an object that doesn't
+      # need to reference anything on a.
+      test_inject(described_class, :c, instance_double(C, boom: "goat"))
     end
 
     it "parses from its b, and foos from its c" do
@@ -93,6 +93,9 @@ describe A do
     end
   end
 
+  # Both Interjectable.test_inject and the RSpec test_inject helper will setup
+  # RSpec after hooks to cleanup any test_inject-ed dependencies after the
+  # context they are defined in.
   it "doesn't pollute other tests" do
     expect(subject.read).to eq(B.new.parse)
     expect(subject.foo).to eq(C.new.boom)

data/lib/interjectable/rspec.rb

@@ -2,15 +2,17 @@
 
 module Interjectable
   module ClassMethods
+    BLANK = Object.new
+
     class SuperclassInjectStatic < Struct.new(:klass, :dependency)
-      def override(setter)
+      def override(value, &setter)
         cvar = "@@#{dependency}"
         klass.remove_class_variable(cvar) if klass.class_variable_defined?(cvar)
         klass.define_singleton_method(dependency) do
           if class_variable_defined?(cvar)
             class_variable_get(cvar)
           else
-            class_variable_set(cvar, instance_eval(&setter))
+            class_variable_set(cvar, value != ::Interjectable::ClassMethods::BLANK ? value : instance_eval(&setter))
           end
         end
       end
@@ -36,13 +38,13 @@ module Interjectable
     end
 
     class SuperclassInject < Struct.new(:klass, :dependency)
-      def override(setter)
+      def override(value, &setter)
         ivar = "@#{dependency}"
         klass.define_method(dependency) do
           if instance_variable_defined?(ivar)
             instance_variable_get(ivar)
           else
-            instance_variable_set(ivar, instance_eval(&setter))
+            instance_variable_set(ivar, value != ::Interjectable::ClassMethods::BLANK ? value : instance_eval(&setter))
           end
         end
       end
@@ -72,31 +74,36 @@ module Interjectable
       end
       rspec_example_group = setter.binding.receiver.class
 
+      ClassMethods.test_inject(rspec_example_group, self, dependency, BLANK, &setter)
+    end
+
+    def self.test_inject(rspec_example_group, target, dependency, value, &setter)
+      unless value || setter
+        raise ArgumentError, "missing value or setter for #{target}'s #{dependency.inspect}"
+      end
+
       unless rspec_example_group < RSpec::Core::ExampleGroup
         raise "#test_inject can only be called from an RSpec ExampleGroup (e.g.: it, before, after)"
       end
 
-      injector = if singleton_methods(false).include?(dependency) # inject_static(dependency) on this class
-        InjectStatic.new(self, dependency)
-      elsif singleton_methods.include?(dependency) # inject_static(dependency) on a superclass of this class
-        SuperclassInjectStatic.new(self, dependency)
-      elsif instance_methods(false).include?(dependency) # inject(dependency) on this class
-        Inject.new(self, dependency)
-      elsif instance_methods.include?(dependency) # inject(dependency) on a superclass of this class
-        SuperclassInject.new(self, dependency)
+      injector = if target.singleton_methods(false).include?(dependency) # inject_static(dependency) on this class
+        InjectStatic.new(target, dependency)
+      elsif target.singleton_methods.include?(dependency) # inject_static(dependency) on a superclass of this class
+        SuperclassInjectStatic.new(target, dependency)
+      elsif target.instance_methods(false).include?(dependency) # inject(dependency) on this class
+        Inject.new(target, dependency)
+      elsif target.instance_methods.include?(dependency) # inject(dependency) on a superclass of this class
+        SuperclassInject.new(target, dependency)
       else
         raise ArgumentError, "tried to override a non-existent dependency: #{dependency.inspect}"
       end
 
-      injector.override(setter)
 
-      scope = rspec_example_group.currently_executing_a_context_hook? ? :context : :each
+      injector.override(value, &setter)
 
-      key = [self, dependency, scope]
-      # if dependency == :dependency && scope == :each
-      #   puts "override: #{key.inspect} #{rspec_example_group}"
-      # end
+      scope = rspec_example_group.currently_executing_a_context_hook? ? :context : :each
 
+      key = [target, dependency, scope]
       # If we already have a restore after(:each) hook for this class +
       # dependency + scope, don't add another. To check if we already have an
       # after(:each) hook, we look at all previous after(:each) hooks we've
@@ -107,21 +114,29 @@ module Interjectable
       # for the same #test_inject call since those before hooks only run once,
       # and therefore only setup a single after hook.
       return if scope == :each && RESTORE_HOOKS[key].any? { |group| rspec_example_group <= group }
-      # if dependency == :dependency && scope == :each
-      #   puts "adding new after=#{key.inspect} hooks=#{RESTORE_HOOKS[key]} group=#{rspec_example_group}"
-      # end
       RESTORE_HOOKS[key] << rspec_example_group
 
-      # if dependency == :dependency && scope == :each
-      #   puts RESTORE_HOOKS.select { |(_, d, s)| d == :dependency && s == :each }
-      # end
-
       rspec_example_group.after(scope) do
-        # if dependency == :dependency && scope == :each
-        #   puts "restore:  #{key.inspect} #{rspec_example_group}"
-        # end
         injector.restore
       end
     end
   end
+
+  module RSpecHelper
+    def test_inject(target, dependency, value)
+      unless value
+        raise ArgumentError, "missing value for #{dependency.inspect}, correct usage: test_inject(my_thing, #{dependency.inspect}, FakeDependency.new)"
+      end
+
+      ClassMethods.test_inject(self.class, target, dependency, value)
+    end
+  end
+end
+
+if defined?(RSpec)
+  RSpec.configure do |c|
+    c.include(Interjectable::RSpecHelper)
+  end
+else
+  raise "RSpec helper was required but RSpec has not beed defined"
 end

data/lib/interjectable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Interjectable
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/interjectable/rspec_spec.rb

@@ -50,7 +50,7 @@ describe "RSpec test helper #test_inject" do
     end
 
     before do
-      Klass.test_inject(:dependency) { :another_unused_dependency }
+      test_inject(Klass, :dependency, :another_unused_dependency)
       Klass.test_inject(:dependency) { foo }
       Klass.test_inject(:static_dependency) { :overriden_static_dependency }
     end
@@ -75,7 +75,7 @@ describe "RSpec test helper #test_inject" do
     context "override dependency" do
       before(:all) do
         Klass.test_inject(:dependency) { :yet_another_unused_dependency }
-        Klass.test_inject(:static_dependency) { :unused_static_dependency }
+        test_inject(Klass, :static_dependency, :unused_static_dependency)
       end
 
       before do
@@ -143,7 +143,8 @@ describe "RSpec test helper #test_inject" do
   context "isoloated context: subclass before :all" do
     before(:all) do
       SubKlass.test_inject(:static_dependency) { :bar }
-      SubKlass.test_inject(:static_dependency) { :baz }
+      SubKlass.test_inject(:static_dependency) { :zoo }
+      test_inject(SubKlass, :static_dependency, :baz)
     end
 
     it "sets the static_dependency" do
@@ -152,7 +153,7 @@ describe "RSpec test helper #test_inject" do
 
     context "subcontext" do
       before(:all) do
-        SubKlass.test_inject(:static_dependency) { :goat }
+        test_inject(SubKlass, :static_dependency, :goat)
       end
 
       it "sets the static_dependency" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interjectable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Zach Margolis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies: []
 description: A simple dependency injection library for unit testing
 email: