rshade 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf8737edb621544556bb58751c0513b17fe1d9f47a6d36fc77c57cac7cb00ef4
-  data.tar.gz: 13beabd1a6b22e62efc8c4bec6d0a7931ddd2960b8a4ec9cf0eeac6c0c2b8b95
+  metadata.gz: c22edeb524363703e1593cc552713c7e9cef6203ab2df81d1c52ce1d39b8e68f
+  data.tar.gz: ac8080bc18e8c4ef3ebe9274815c35cbbd201cc210791c914f366786648f07e7
 SHA512:
-  metadata.gz: d2e84b206dc81d4dad3af68cee691f22ec65749de2971ba5ec4c6001187333a17ea2e36c42cdb8341605cfbbbbc459add8355af29fc097e2108b96eb5c9e233c
-  data.tar.gz: cd41a6538fad5193dfcf4888da29ba1bfc0e216a5d2023e47291425546d8633660af24cffbd196960d6896e4b2b077ff549f4a57392164b8b625a54b90947f66
+  metadata.gz: e8803cd8aa9df51f749d3e68ec9a8bb86aad01d731ce69b69862f5d105fea6297c8933092b20a66a1f3a2fd62a762da11b765e4c944cd9ccd6e65a88a7483168
+  data.tar.gz: 637c5715a9404d2e491919f32658ac499027d39cf85c126a804f6b44f5a15aa0bc469483deae67f7516f3735bd873c450105baae34a3d042c6428ed815cfe9b6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rshade (0.1.2)
+    rshade (0.1.3)
       colorize
 
 GEM

data/README.md

@@ -1,10 +1,8 @@
 # RShade  
-  
  
 ![warcraft shade](https://github.com/gingray/rshade/raw/master/shade.jpg)
 
-Ruby Shade or RShade gem to help you to reveal which code are used in program execution.
-
+Ruby Shade or RShade gem to help you to reveal what lines of code are used in program execution.
   
 ```ruby
 trace = RShade::Trace.new  
@@ -18,6 +16,26 @@ trace.show
  end 
 
 ```
+## Example
+I've took example from https://github.com/spree/spree code base. Wrap code to take a look what code is in use when you save variant.
+On such huge codebase as spree it's helpful to know what callbacks are triggered and so on.
+```ruby
+  context '#cost_currency' do
+    context 'when cost currency is nil' do
+      before { variant.cost_currency = nil }
+
+      it 'populates cost currency with the default value on save', focus: true do
+        rshade_reveal do
+          variant.save!
+        end
+        expect(variant.cost_currency).to eql 'USD'
+      end
+    end
+  end
+```
+Below is example how output will look like.
+As you can see all code that have been in use is printed.
+[![asciicast](https://asciinema.org/a/MR5KL7TmHmYRUhwBUWQjBI373.svg)](https://asciinema.org/a/MR5KL7TmHmYRUhwBUWQjBI373)
 
 ## Installation  
   
@@ -27,23 +45,13 @@ Add this line to your application's Gemfile:
 gem 'rshade'  
 ```  
   
-And then execute:  
-  
- $ bundle  
-Or install it yourself as:  
-  
- $ gem install rshade  
-## Usage  
-  
-TODO: Write usage instructions here  
-  
 ## TODO  
 Use stack to keep connections between current method and caller  
 take a look on https://github.com/matugm/visual-call-graph  
   
 ## Contributing  
   
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rshade.  
+Bug reports and pull requests are welcome on GitHub at https://github.com/gingray/rshade.  
   
 ## License  
   

data/lib/rshade/source.rb

@@ -31,6 +31,10 @@ module RShade
       @hash[:method_name]
     end
 
+    def vars
+      @hash[:vars]
+    end
+
     def exclude_path
       @path_arr ||= begin
         [ENV['GEM_PATH'].split(':'), parse_ruby_version].flatten.compact
@@ -47,7 +51,7 @@ module RShade
     def pretty
       class_method = "#{klass}##{method_name}".colorize(:green)
       full_path = "#{path}:#{lineno}".colorize(:blue)
-      "#{class_method} -> #{full_path}"
+      "#{class_method}(#{vars.to_json}) -> #{full_path}"
     end
   end
 end

data/lib/rshade/trace.rb

@@ -50,14 +50,20 @@ module RShade
     def process_trace(tp)
       if tp.event == :call
         parent = @stack.last
-        hash = { level: @stack.size, path: tp.path, lineno: tp.lineno, klass: tp.defined_class, method_name: tp.method_id }
+        vars = {}
+        tp.binding.local_variables.each do |var|
+          vars[var] = tp.binding.local_variable_get var
+        end
+        hash = { level: @stack.size, path: tp.path, lineno: tp.lineno, klass: tp.defined_class, method_name: tp.method_id, vars: vars }
         node = SourceNode.new(Source.new(hash))
         node.parent = parent
         parent << node
         @stack.push node
       end
 
-      @stack.pop if tp.event == :return && @stack.size > 1
+      if tp.event == :return && @stack.size > 1
+        @stack.pop
+      end
     end
   end
 end

data/lib/rshade/version.rb

@@ -1,3 +1,3 @@
 module RShade
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rshade
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ivan Lopatin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize