yuslow 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd953740e32fb7b75846380345a9574985088e04515198336ded5a33fe3953a
-  data.tar.gz: 5c611848b2a5be441b54063854cf65e127bf323266f3e7f48ba44f1fc5a2d837
+  metadata.gz: 5246c2535d0277df7d0117c0abdb1a9ce9eeb49c434d0df1db0bfa85f71fbdd5
+  data.tar.gz: e2408ca24e820cd5d91cfa10b441bbbf8246e7476f7aab48f657bc6cd82fe1b8
 SHA512:
-  metadata.gz: bad736143507ff82c224514901d4f375aeed60d5666772817cf8d764f45cec5f42d6a8d85231de60f29b7e3ce46bed39fdc5ed7860874f5dc4e2c80a65f6355f
-  data.tar.gz: ed0bba601e95633f94e97ae6b17db4f9d93e0249dfbee20258cb1629e4d1ddc8f534cc435fac00dd624a6bdc7628deeb64214ed6f2b4972135c896e8c5b42696
+  metadata.gz: a89ddd6dd6063d40a3614904226728771d15f746a29d326e2b01cc96b2f6895f01e0366c375b6dccb6862a1492cebb94386e4e0a176bf88266d8f61c0c26b482
+  data.tar.gz: 9c0c568bcd841ac8b0e78927b00fa7cc73d1bdf4cb0bc2a6e140679de948d5e853210798137158c6403583f1fa07d6cf7a1a1172418284dbbc108e4126538ec9

data/README.md

@@ -0,0 +1,44 @@
+# Yuslow
+Yuslow `[waɪ ju sləʊ]` is a lightweight profiler for Ruby designed to debug slow parts of your system.
+
+## Install
+
+```
+gem install yuslow
+```
+
+## Usage
+Require the gem in the file which you would like to investigate.
+
+```ruby
+require 'yuslow'
+```
+
+then add
+
+```ruby
+Yuslow.run do
+  a_very_slow_method
+end
+```
+
+or
+
+```ruby
+investigation = Yuslow.investigation
+
+investigation.start
+a_very_slow_method
+investigation.finish
+```
+
+to your code. Execute the code and you will see output in $stdout with the following tree structure. It will help you understand which branch and method of your code has poor performance.
+
+```
+Thread[1]:
+  Object#very_slow elapsed 1000 ms
+    Object#not_my_fault elapsed 1000 ms
+      Object#not_me elapsed 0 ms
+      Object#root_cause elapsed 1000 ms
+        Kernel#sleep elapsed 1000 ms
+```

data/lib/yuslow/investigation.rb

@@ -0,0 +1,72 @@
+module Yuslow
+  class Investigation
+    def initialize(debug: false, printer: nil)
+      @printer = printer
+      @debug = debug
+      @tracing = false
+      @trace = nil
+      @indent = 0
+      @execution = {}
+    end
+
+    def start
+      @trace = TracePoint.new(:call, :return, :c_call, :c_return) do |trace_point|
+        thread_id = Thread.current.object_id
+        @execution[thread_id] ||= {root: nil, current: nil}
+
+        if trace_point.defined_class == self.class && trace_point.callee_id == :start
+          @tracing = true
+        elsif trace_point.defined_class == self.class && trace_point.callee_id == :finish
+          @tracing = false
+        elsif @tracing
+          if %i(call c_call).include? trace_point.event
+            if @execution[thread_id][:current]
+              @execution[thread_id][:current] =
+                @execution[thread_id][:current].fork object: trace_point.defined_class,
+                                                     method: trace_point.callee_id
+            else
+              operation = Operation.new object: trace_point.defined_class, method: trace_point.callee_id
+              @execution[thread_id][:root]    = operation
+              @execution[thread_id][:current] = operation
+            end
+
+            debug trace_point, @indent
+            @indent += 1
+
+          elsif %i(return c_return).include? trace_point.event
+            @indent -= 1
+            debug trace_point, @indent
+
+            @execution[thread_id][:current]&.complete
+            @execution[thread_id][:current] = @execution[thread_id][:current]&.parent
+          end
+        end
+      end
+
+      @trace.enable
+    end
+
+    def finish
+      @trace.disable
+
+      print_result @printer if @printer
+    end
+
+    def debug(trace_point, indent)
+      return unless @debug
+
+      puts (' ' * indent) + "#{trace_point.event} #{trace_point.defined_class}##{trace_point.callee_id}"
+    end
+
+    def print_result(printer)
+      return unless printer
+
+      operations =
+        @execution.keys.map do |thread_id|
+          @execution[thread_id][:root]
+        end
+
+      printer.execute operations
+    end
+  end
+end

data/lib/yuslow/operation.rb

@@ -0,0 +1,39 @@
+class Operation
+  attr_reader :parent, :children
+
+  class << self
+    def start(object, method)
+      new(object, method)
+    end
+  end
+
+  def initialize(object:, method:, parent: nil, started_at: Time.now, completed_at: nil, children: [])
+    @object = object
+    @method = method
+    @started_at = started_at
+    @completed_at = completed_at
+    @parent = parent
+    @children = children
+  end
+
+  def fork(object:, method:)
+    operation = self.class.new object: object, method: method, parent: self
+    @children << operation
+
+    operation
+  end
+
+  def identifier
+    "#{@object}##{@method}"
+  end
+
+  def complete
+    raise 'This operation is already completed' if @completed_at
+
+    @completed_at = Time.now
+  end
+
+  def elapsed
+    ((@completed_at - @started_at) * 1000).round if @completed_at
+  end
+end

data/lib/yuslow/stdout_printer.rb

@@ -0,0 +1,60 @@
+module Yuslow
+  module StdoutPrinter
+    extend self
+
+    def execute(operations, colorize = true)
+      output = []
+
+      operations.each_with_index.map do |operation, index|
+        output << "Thread[#{index + 1}]:"
+        output << stringify_operation(operation, 1, colorize)
+        output << nil
+      end
+
+      print output.join "\n"
+    end
+
+    def stringify_operation(operation, indent, colorize)
+      output = []
+      indentation = '  ' * indent
+
+      if operation.elapsed
+        identifier = operation.identifier
+        identifier = colorize(identifier, :green) if colorize
+
+        elapsed = operation.elapsed
+        elapsed = colorize(elapsed, :white) if colorize
+
+        output << "#{indentation}#{identifier} elapsed #{elapsed} ms"
+      else
+        text = "#{operation.identifier} did not finish"
+        colorize(text, :red) if colorize
+
+        output << "#{indentation}#{text}"
+      end
+
+      operation.children.each do |child_operation|
+        output << stringify_operation(child_operation, indent + 1, colorize)
+      end
+
+      output.join "\n"
+    end
+
+    def colorize(text, color)
+      code =
+        case color
+        when :black    then '30'
+        when :red      then '31'
+        when :green    then '32'
+        when :white    then '1;37'
+        when :bg_black then '40'
+        when :bg_red   then '41'
+        when :bg_green then '42'
+        else
+          0
+        end
+
+      "\e[#{code}m#{text}\e[0m"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yuslow
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Deyan Dobrinov
@@ -31,7 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/yuslow.rb
+- lib/yuslow/investigation.rb
+- lib/yuslow/operation.rb
+- lib/yuslow/stdout_printer.rb
 homepage: https://github.com/dobrinov/yuslow
 licenses:
 - MIT