trace_graph 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd780ac25e119f53019469ce53d16566fb3acbe251ca04eec7f275b5170bcdae
-  data.tar.gz: d0055ce4f5bf0c69d384b40b4fb72b88584de876bc830084c3b527fc290a3e88
+  metadata.gz: 5e2e5ebf7e939d4bf028dad7f11ff1afe26ee16f69925b007413a5f81f63ae76
+  data.tar.gz: 863b4f213222ee2fdf1c22c3d2dd504e9e5a169adadfbf99ad44265b5c7d4a87
 SHA512:
-  metadata.gz: 45e82dac33a5477f396d3f4bff13f4eef95bc4ad6435f63a16d94a9268ae08e83009a4e2420e2e7a67b15b8db2c68f27bd141ee6aaed94d35d48085ce562da52
-  data.tar.gz: 8b4066d99e34ea38b1e1cb4957a6a732b795fa001b1912337f8da12d2926c5351eb495c2df3c630c806fe6be80b2eaca70c2366e7fecb9192e143304b9701fc7
+  metadata.gz: 724f8e037289823034a7ff94e8fa49b6839a43d22e29d5bab8b32def090ea4fc98b855502c057c8ee206610b6f1699c906fd999e2265f3a58fadbd7ea8d8ff97
+  data.tar.gz: 6c38689b930461cb9ab57c1b86522a73c65fd0a75ee7ec25c3ef1154fadf5f7a6fbaaa36d707bc74aeb6d88df2a5dfdfc95c6a138467a17a8837df656b519fc7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trace_graph (0.1.0)
+    trace_graph (0.1.1)
       ruby-graphviz
       tree_graph
 

data/README.md

@@ -5,12 +5,55 @@ trying to form a mental picture of it, let TraceGraph draw you a picture like th
 
 ![Document Worker Trace](docs/images/document_worker_trace.png)
 
+Or it can generate a text based graph, like this:
+
+```
+trace
+└─DocumentGenerationWorker#perform
+  └─DocumentGenerator#generate_and_store_documents
+    └─OutputGenerationWorker#perform
+      └─OutputGenerator#generate_and_store_output
+        ├─OutputOwnerUtils#current_output
+        │ └─OutputOwnerUtils#current_outputs
+        ├─OutputGenerator#find_creator
+        ├─OutputUtils#local_path
+        │ └─Output#local_file_prefix
+        ├─Output#s3_path
+        │ └─OutputUtils#s3_filename
+        └─OutputGenerator#generate_and_store_output_implementation
+          ├─OutputUtils#markdown_path
+          │ └─Output#local_file_prefix (#2)
+          ├─OutputGenerator#generate_output
+          │ ├─Style#template_variable_hash
+          │ │ ├─Style#template_variables
+          │ │ └─Style#template
+          │ ├─Document#importurlsupported
+          │ ├─Account#current_subscription
+          │ │ └─Account#active_subscriptions
+          │ ├─Account#current_subscription (#2)
+          │ │ └─Account#active_subscriptions (#2)
+          │ ├─OutputUtils#markdown_path (#2)
+          │ │ └─Output#local_file_prefix (#3)
+          │ └─PdfCreator#create_pdf
+          │   ├─PdfCreator#localize_images
+          │   │ └─PdfCreator#find_image_tags_and_urls
+          │   ├─PdfCreator#process_liquid
+          │   ├─LatexHelper#make_dollars_safe
+          │   └─PdfCreator#build_pandoc_string
+          │     ├─PdfCreator#merged_variable_options
+          │     ├─PdfCreator#class_options
+          │     └─PdfCreator#add_pandoc_options
+          └─OutputGenerator#notify_output
+            └─PusherOutputNotifier#notify_output
+              └─Account#pusher_channel
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'trace_graph'
+gem 'trace_graph', group: [:development, :test]
 ```
 
 And then execute:
@@ -76,7 +119,8 @@ in the graph.
 * `excluded_paths` - A list of paths to exclude. Maybe `["my_app/some_utility_helper"]`. Default
   value is `nil`.
 
-* `png` - A string path where to write a png graph.
+* `png` - A string path where to write a png graph. If no value is passed a png will not be generated
+  and only a text representation will be written to standar out.
 
 * `mark_duplicate_calls` - Either `true` or `false`. Default value is `false`. When `true` any
   repeat calls to a method will be marked with a count, and will be colored red on the png.
@@ -92,8 +136,8 @@ A robust tracer might look like this:
 
 ```ruby
 tracer = TraceGraph::Tracer.new({
-  included_paths: ["my_app/app"],         # See everything local to a rails app
-  excluded_paths: ["my_app/app/helpers"], # Except the helpers
+  included_paths: ["my_app/app", "my_app/lib"], # See everything local to a rails app
+  excluded_paths: ["my_app/app/helpers"],       # Except the helpers
   mark_duplicate_calls: true,
   show_arguments: true,
   show_return_values: true,

data/lib/trace_graph/trace_node.rb

@@ -6,14 +6,16 @@ module TraceGraph
     attr_accessor :label
     attr_accessor :sub_nodes
     attr_accessor :is_duplicate
+    attr_accessor :class_name
 
     alias_method :label_for_tree_graph, :label
     alias_method :children_for_tree_graph, :sub_nodes
 
-    def initialize(label, is_duplicate: false)
+    def initialize(label, is_duplicate: false, class_name: nil)
       self.label = label
       self.is_duplicate = is_duplicate
       self.sub_nodes = []
+      self.class_name = class_name
     end
 
     def << child_node

data/lib/trace_graph/tracer.rb

@@ -11,6 +11,7 @@ module TraceGraph
       @mark_duplicate_calls = options.key?(:mark_duplicate_calls) ? options[:mark_duplicate_calls] : true
       @show_arguments = options[:show_arguments] || false
       @show_return_values = options[:show_return_values] || false
+      @only_class_transitions = options[:only_class_transitions] || false
 
       @trace_point = build_trace_point
       @top_node = TraceGraph::TraceNode.new("trace")
@@ -90,6 +91,10 @@ module TraceGraph
 
     def build_node_label(tp, for_call: true)
       label = "#{tp.defined_class}##{tp.method_id}"
+      if tp.defined_class.name != tp.self.class.name
+        label = "#{tp.self.class.name} -> #{label}"
+      end
+
       args = extract_arguments(tp)
       if @show_arguments && args.any?
         label = "#{label} →(#{args})"
@@ -112,9 +117,15 @@ module TraceGraph
     end
 
     def handle_call(tp)
+      if @only_class_transitions
+        last_node = @stack.last
+        if last_node && last_node.class_name == tp.self.class.name
+          return
+        end
+      end
       parent = @stack.last
       label, is_duplicate = build_node_label(tp)
-      new_node = TraceGraph::TraceNode.new(label, is_duplicate: is_duplicate)
+      new_node = TraceGraph::TraceNode.new(label, is_duplicate: is_duplicate, class_name: tp.self.class.name)
       @stack << new_node
       @all_nodes << new_node
       if parent
@@ -160,6 +171,7 @@ module TraceGraph
       unless public_methods.include?(method) || @include_protected
         should_include = false
       end
+      
       return should_include
     end
   end

data/lib/trace_graph/version.rb

@@ -1,3 +1,3 @@
 module TraceGraph
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trace_graph
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Green
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tree_graph