trace_spy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3831d476b8d255dbec62c68b430fbd5733a8ff9a517c16d61a5be2ccac842a59
-  data.tar.gz: 4247e3304fd6cb2ef1e81187e1a29e8457ca4225c6414d5a171aed34775739ca
+  metadata.gz: f438d726a80168f12bdf852bc190fb9c30dde90a12b3cb9fd63b9a650a209acc
+  data.tar.gz: a2096afab270481c50c3d0ba58bdbbe8b372bb2ebcb31e9d55c1fc352bd631a4
 SHA512:
-  metadata.gz: 69c58ab72a6908eee036ecebbae4ee3b1337ef6d8baa921d2d885bc017781a86fa5ea09a4892b6a575b9d82e4190c8785c43b8af9825543e71c2c5c0208b4b9a
-  data.tar.gz: 3226f8d53fd8cceb8403bfda5f90a5cfa3938d77c71bfbdcb5f131098e55fee9642492bd60028fb78d42cceb78423abbc5aedfa368328ea36957b020c953764c
+  metadata.gz: 3a8fa257ab7856e95835a6761772e78e09ee2df6f1dd080ea973216036d17c8a5480d9a9bbc587182c7ef2ad16b14e4d7b88b8659613d60d8bf09ef3ecb823ac
+  data.tar.gz: 1ab33f532bc2baaf669e943ebbf70a42c211a0a77ffcbc31b6bb9e37fa0ce2048f70edd1467bbb45dd28df06124536e32aa01d57ab3716869ccc0ea7f6b6ecb6

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    trace_spy (0.0.2)
+      qo (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    any (0.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    qo (0.5.0)
+      any (= 0.1.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  guard-rspec (~> 4.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  trace_spy!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -63,26 +63,37 @@ testing_spy = TraceSpy::Method.new(:testing) do |spy|
   end
 end
 
-testing_spy.enable
-# => false
+# If you want to manually enable/disable the trace, use:
+#
+#   testing_spy.enable
+#   testing_spy.disable
+#
+# Otherwise, use:
+
+# Outside of this block, the trace is inactive:
+testing_spy.with_tracing do
+  p testing(1, 2, 3)
+  # My args were 1, 2, 3: {:a=>1, :b=>2, :c=>3}
+  # I got an even return: 6
+  # => 6
+
+  p testing(21, 2, 3) rescue 'nope'
+  # I encountered an error: heck
+  # => 'nope'
+
+  p testing(*%w(foo bar baz))
+  # Oh hey! You called me with strings: {:a=>"foo", :b=>"bar", :c=>"baz"}
+  # Strings in, Strings out no?: foobarbaz
+  # => 'foobarbaz'
+
+  p testing(1, 2, 4)
+  # I saw d was a local in here!: {:a=>1, :b=>2, :c=>4, :d=>5}
+  # => 7
+end
 
-p testing(1, 2, 3)
-# My args were 1, 2, 3: {:a=>1, :b=>2, :c=>3}
-# I got an even return: 6
+# Back to normal
+testing(1, 2, 3)
 # => 6
-
-p testing(21, 2, 3) rescue 'nope'
-# I encountered an error: heck
-# => 'nope'
-
-p testing(*%w(foo bar baz))
-# Oh hey! You called me with strings: {:a=>"foo", :b=>"bar", :c=>"baz"}
-# Strings in, Strings out no?: foobarbaz
-# => 'foobarbaz'
-
-p testing(1, 2, 4)
-# I saw d was a local in here!: {:a=>1, :b=>2, :c=>4, :d=>5}
-# => 7
 ```
 
 ## Installation

data/lib/trace_spy/method.rb

@@ -65,6 +65,37 @@ module TraceSpy
       yield(self) if block_given?
     end
 
+    # Allows to run a block of code in the context of a tracer with the
+    # convenient side-effect of not having to remember to turn it off
+    # afterwards.
+    #
+    # Tracer will only be active within the block, and will be disabled
+    # afterwards
+    #
+    # @since 0.0.3
+    #
+    # @example
+    #   The tracer will only be active within the block:
+    #
+    #   ```ruby
+    #   tracer.with_tracing do
+    #     # tasks
+    #   end
+    #   ```
+    #
+    # @param &traced_function [Proc]
+    #   Function to execute with tracing enabled
+    #
+    # @return [TrueClass]
+    #   Result of disabling the tracer
+    def with_tracing(&traced_function)
+      self.enable
+
+      yield
+
+      self.disable
+    end
+
     # Creates a Spy on function arguments
     #
     # @since 0.0.1

data/lib/trace_spy/version.rb

@@ -1,3 +1,3 @@
 module TraceSpy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/trace_spy.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trace_spy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Weaver
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: 
 email:
 - keystonelemur@gmail.com
@@ -78,6 +92,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile