gem_footprint_analyzer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7545b14e023e211b25a3e178e81fea39d7875f5e3cc440e3e2c343fa3e601cd
-  data.tar.gz: a7c6721d973008c2c5496c93fbecb9584e040d7bc523be3bed704100dfe4eee2
+  metadata.gz: 69c4c34c88102817c70c7d4a69e1716152213337d19edcb9139437c8c4ce80f0
+  data.tar.gz: 98e61556aa5bf8fdc6c8498f2157e16abb8f45294ed0e5345958652604d0c7a8
 SHA512:
-  metadata.gz: b72e58bb39f7e9f9fb886c1e3639b6a38bc8332b4cb7a272a273f132d08d495eda783d858286451562840b7d27c795a352ff3d39e87a044313dc4fcb41787c35
-  data.tar.gz: 6d75e8a5a5c7502ebc1d19b02654a49376458feba7f1d6c2e07986234ffc614c7638d9a31844b32c0500dc769a20d0ec0c165a1c670ddc5d2fc94450dfc47110
+  metadata.gz: b582135703728eaaa2ca71217ed4ad796e7c4add2e78c503887017a9f0666dad5bf09022b6dbc83a63cab5d60102524220ffc7e9b14797cb715dec8e16c64e37
+  data.tar.gz: 3c0b25663dd56f72928c0b3e7319e0f2c8c9dffcbefd7d5e6dcac3fa64636b5e10eec91673853cc2e2d2f739cff31851f35d8cc5fe7b9bf6444db95141611e3e

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Include:
+    - 'lib/gem_footprint_analyzer/**/*.rb'
+    - 'exe/*'
+    - 'spec/**/*'
+  TargetRubyVersion: 2.2
+
+Metrics/LineLength:
+  Max: 100
+
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in gem_footprint_analyzer.gemspec
 gemspec

data/Gemfile.lock

@@ -6,7 +6,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -21,6 +28,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.30.0)
+      rubocop (>= 0.58.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -30,6 +49,8 @@ DEPENDENCIES
   gem_footprint_analyzer!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.60.0)
+  rubocop-rspec
 
 BUNDLED WITH
    1.16.4

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/exe/analyze_requires

@@ -1,52 +1,13 @@
-#!/usr/bin/env ruby
-require 'gem_footprint_analyzer'
-require 'optparse'
-
-options = {}
-options[:runs] = 10
-options[:debug] = false
-options[:formatter] = 'tree'
-
-opts_parser = OptionParser.new do |opts|
-  script_name = "bundle exec #{File.basename($0)}"
-  opts.banner = "GemFootprintAnalyzer (#{GemFootprintAnalyzer::VERSION})"
-  opts.banner += "\nUsage: #{script_name} library_to_analyze [require]"
-
-  opts.on('-f', '--formatter FORMATTER', %w[json text tree], 'Format output using selected formatter (json text tree)') do |formatter|
-    options[:formatter] = formatter
-  end
+#!/usr/bin/env ruby --disable=did_you_mean --disable=gem --disable=rubyopt
 
-  opts.on('-n', '--runs-num NUMBER', OptParse::DecimalInteger, 'Number of runs for avergae') do |runs|
-    if runs < 1
-      fail OptionParser::InvalidArgument, 'must be a number greater than 0'
-    end
-    options[:runs] = runs
-  end
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift('./lib') if Dir.exist?('lib')
 
-  opts.on('-d', '--debug', 'Show debug information') do |debug|
-    opts.banner += "\n(#{File.expand_path(File.join(File.dirname(__FILE__), '..'))})" if debug
-    options[:debug] = debug
-  end
-
-  opts.on_tail('-h', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-end
-opts_parser.parse!(ARGV)
-
-if ARGV.size < 1
-  puts opts_parser
-  exit 1
-end
-
-requires_list_average = GemFootprintAnalyzer::AverageRunner.new(options[:runs]) do
-  GemFootprintAnalyzer::Analyzer.new.test_library(*ARGV)
-end.run
+require 'gem_footprint_analyzer'
 
-require 'gem_footprint_analyzer/formatters/text'
-require 'gem_footprint_analyzer/formatters/tree'
-require 'gem_footprint_analyzer/formatters/json'
+cli = GemFootprintAnalyzer::CLI.new
 
-formatter = GemFootprintAnalyzer::Formatters.const_get(options[:formatter].capitalize)
-puts formatter.new(options).format(requires_list_average)
+t1 = Time.now.to_f
+cli.run(ARGV)
+t2 = Time.now.to_f
+puts format("\nTotal runtime %0.4fs", (t2 - t1))

data/gem_footprint_analyzer.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
+  spec.add_development_dependency "rubocop-rspec"
 end

data/lib/gem_footprint_analyzer.rb

@@ -1,8 +1,9 @@
 require 'gem_footprint_analyzer/version'
-require 'gem_footprint_analyzer/pipe_transport'
+require 'gem_footprint_analyzer/transport'
 require 'gem_footprint_analyzer/require_spy'
 require 'gem_footprint_analyzer/analyzer'
 require 'gem_footprint_analyzer/average_runner'
+require 'gem_footprint_analyzer/cli'
 
 module GemFootprintAnalyzer
 end

data/lib/gem_footprint_analyzer/analyzer.rb

@@ -1,12 +1,24 @@
 module GemFootprintAnalyzer
+  # A class that faciliates sampling of the original require and subsequent require calls from
+  # within the library.
+  # It forks the original process and runs the first require in that fork explicitly.
+  # Require calls are interwoven with RSS checks done from the parent process, require timing
+  # is gathered in the fork and passed along to the parent.
   class Analyzer
-
-    def test_library(library, require_string=nil)
+    # @param library [String] name of the library or parameter for the gem method
+    #   (ex. 'activerecord', 'activesupport')
+    # @param require_string [String|nil] optional require string, if it differs from the gem name
+    #   (ex. 'active_record', 'active_support/time')
+    # @return [Array<Hash>] list of require-data-hashes, first element contains base level RSS,
+    #   last element can be treated as a summary as effectively it consists of all the previous.
+    def test_library(library, require_string = nil)
       try_activate_gem(library)
 
       child_transport, parent_transport = init_transports
 
       process_id = fork_and_require(require_string || library, child_transport)
+      fail 'Unable to fork' unless process_id
+      detach_process(process_id)
       requires = collect_requires(parent_transport, process_id)
 
       parent_transport.ack
@@ -16,8 +28,7 @@ module GemFootprintAnalyzer
     private
 
     def fork_and_require(require_string, child_transport)
-      GC.start
-      process_id = fork do
+      fork do
         RequireSpy.spy_require(child_transport)
         begin
           require(require_string)
@@ -25,47 +36,66 @@ module GemFootprintAnalyzer
           child_transport.exit_with_error(e)
           exit
         end
-        child_transport.done
-        child_transport.wait_for_ack
+        child_transport.done_and_wait_for_ack
       end
-      Process.detach(process_id)
-      process_id
     end
 
-    def collect_requires(parent_transport, process_id)
-      base_rss = nil
-      requires = []
-      while (msg, payload = parent_transport.read_one_command)
-        if msg == :require
-          curr_rss = rss(process_id) - base_rss
-          name, parent_name, time = payload
-
-          requires << {name: name, parent_name: parent_name, time: Float(time) * 1000, rss: curr_rss}
-        elsif msg == :already_required
-        elsif msg == :ready
-          unless base_rss
-            base_rss = rss(process_id)
-            requires << {base: true, rss: base_rss}
-          end
-          parent_transport.start
-        elsif msg == :exit
-          puts "Exiting because of exception: #{payload}"
-          exit 1
-        elsif msg == :done
-          break
-        else
-          fail "Unknown message: #{msg} (#{payload.inspect})"
-        end
+    def detach_process(pid)
+      Process.detach(pid)
+    end
+
+    def collect_requires(transport, process_id)
+      requires_context = {base_rss: nil, requires: [], process_id: process_id, transport: transport}
+
+      while (cmd = transport.read_one_command)
+        msg, payload = cmd
+
+        break unless handle_command(msg, payload, requires_context)
       end
-      requires
+
+      requires_context[:requires]
+    end
+
+    def handle_command(msg, payload, context)
+      case msg
+      when :require
+        context[:requires] << handle_require(context[:process_id], context[:base_rss], payload)
+      when :ready
+        handle_ready(context)
+        context[:transport].start
+      when :done then return false
+      when :exit then handle_exit(payload)
+      end
+      true
+    end
+
+    def handle_require(process_id, base_rss, payload)
+      cur_rss = rss(process_id) -  base_rss
+      name, parent_name, time = payload
+
+      {name: name, parent_name: parent_name, time: Float(time) * 1000, rss: cur_rss}
+    end
+
+    def handle_exit(payload)
+      puts "Exiting because of exception: #{payload}"
+      exit 1
+    end
+
+    def handle_ready(context)
+      return if context[:base_rss]
+
+      context[:base_rss] = rss(context[:process_id])
+      context[:requires] << {base: true, rss: context[:base_rss]}
     end
 
     def try_activate_gem(library)
+      return unless Kernel.respond_to?(:gem)
+
       gem(library)
     rescue Gem::LoadError
+      nil
     end
 
-
     def pkill(process_id)
       Process.kill('TERM', process_id)
     end
@@ -78,10 +108,10 @@ module GemFootprintAnalyzer
       child_reader, parent_writer = IO.pipe
       parent_reader, child_writer = IO.pipe
 
-      child_transport = GemFootprintAnalyzer::PipeTransport.new(child_reader, child_writer)
-      parent_transport = GemFootprintAnalyzer::PipeTransport.new(parent_reader, parent_writer)
+      child_transport = GemFootprintAnalyzer::Transport.new(child_reader, child_writer)
+      parent_transport = GemFootprintAnalyzer::Transport.new(parent_reader, parent_writer)
 
       [child_transport, parent_transport]
     end
   end
-end
+end

data/lib/gem_footprint_analyzer/average_runner.rb

@@ -1,15 +1,20 @@
 module GemFootprintAnalyzer
+  # A class handling sampling and calculating basic statistical values from the set of runs.
   class AverageRunner
     RUNS = 10
-    AVERAGED_FIELDS = %i[rss time]
+    AVERAGED_FIELDS = %i[rss time].freeze
 
-    def initialize(runs=RUNS, &run_block)
-      fail ArgumentError, 'runs must be > 0' if runs < 1
+    # @param runs [Integer] optional number of runs to perform
+    # @param run_block [proc] actual unit of work to be done runs times
+    def initialize(runs = RUNS, &run_block)
+      raise ArgumentError, 'runs must be > 0' unless runs > 0
 
       @run_block = run_block
       @runs = runs
     end
 
+    # @return [Array<Hash>] Array of hashes that now include average metrics in place of fields
+    #   present in {AVERAGED_FIELDS}. The rest of the columns is copied from the first sample.
     def run
       results = []
       @runs.times do
@@ -26,10 +31,7 @@ module GemFootprintAnalyzer
 
     # Take corresponding results array values and compare them
     def calculate_averages(results)
-      average_results = []
-      first_run = results[0]
-
-      first_run.size.times do |require_number|
+      Array.new(results.first.size) do |require_number|
         samples = results.map { |r| r[require_number] }
         first_sample = samples.first
 
@@ -39,9 +41,8 @@ module GemFootprintAnalyzer
 
           average[field] = calculate_average(samples.map { |s| s[field] })
         end
-        average_results << average
+        average
       end
-      average_results
     end
 
     def calculate_average(values)
@@ -49,7 +50,7 @@ module GemFootprintAnalyzer
       sum = values.sum.to_f
       mean = sum / num
 
-      stddev = Math.sqrt(values.sum { |v| (v - mean) ** 2 } / num)
+      stddev = Math.sqrt(values.sum { |v| (v - mean)**2 } / num)
       {mean: mean, sttdev: stddev}
     end
 

data/lib/gem_footprint_analyzer/cli.rb

@@ -0,0 +1,106 @@
+require 'optparse'
+
+module GemFootprintAnalyzer
+  # A command line interface class for the gem.
+  # Provides options parsing and help messages for the user.
+  class CLI
+    def initialize
+      @options = {}
+      @options[:runs] = 10
+      @options[:debug] = false
+      @options[:formatter] = 'tree'
+      @options[:skip_rubygems] = false
+    end
+
+    # @param args [Array<String>] runs the analyzer with parsed args taken as options
+    # @return [void]
+    def run(args = ARGV)
+      opts_parser.parse!(args)
+
+      if args.empty?
+        puts opts_parser
+        exit 1
+      end
+      require 'rubygems' unless options[:skip_rubygems]
+
+      print_requires(options, args)
+    end
+
+    private
+
+    def print_requires(options, args)
+      requires_list_average = capture_requires(options, args)
+      at_exit { clean_up }
+      formatter = formatter_instance(options)
+      puts formatter.new(options).format_list(requires_list_average)
+    end
+
+    attr_reader :options
+
+    def capture_requires(options, args)
+      GemFootprintAnalyzer::AverageRunner.new(options[:runs]) do
+        GemFootprintAnalyzer::Analyzer.new.test_library(*args)
+      end.run
+    end
+
+    def formatter_instance(options)
+      require 'gem_footprint_analyzer/formatters/text_base'
+      require 'gem_footprint_analyzer/formatters/tree'
+      require 'gem_footprint_analyzer/formatters/json'
+
+      GemFootprintAnalyzer::Formatters.const_get(options[:formatter].capitalize)
+    end
+
+    def opts_parser # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      @opts_parser ||= OptionParser.new do |opts|
+        opts.banner = banner
+        opts.on('-f', '--formatter FORMATTER', %w[json tree],
+                'Format output using selected formatter (json tree)') do |formatter|
+
+          options[:formatter] = formatter
+        end
+
+        opts.on('-n', '--runs-num NUMBER', OptParse::DecimalInteger, 'Number of runs') do |runs|
+          raise OptionParser::InvalidArgument, 'must be a number greater than 0' if runs < 1
+
+          options[:runs] = runs
+        end
+
+        opts.on('-d', '--debug', 'Show debug information') do |debug|
+          opts.banner += debug_banner if debug
+
+          options[:debug] = debug
+        end
+
+        opts.on(
+          '-g', '--disable-gems',
+          'Don\'t require rubygems (recommended for standard library analyses)'
+        ) do |skip_rubygems|
+
+          options[:skip_rubygems] = skip_rubygems
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def banner
+      script_name = "bundle exec #{File.basename($PROGRAM_NAME)}"
+
+      "GemFootprintAnalyzer (#{GemFootprintAnalyzer::VERSION})\n" \
+        "Usage: #{script_name} library_to_analyze [require]"
+    end
+
+    def debug_banner
+      "\n(#{File.expand_path(File.join(File.dirname(__FILE__), '..'))})"
+    end
+
+    def clean_up
+      fork_waiters = Thread.list.select { |th| th.is_a?(Process::Waiter) }
+      fork_waiters.each { |waiter| Process.kill('TERM', waiter.pid) }
+    end
+  end
+end

data/lib/gem_footprint_analyzer/formatters/json.rb

@@ -1,12 +1,14 @@
 module GemFootprintAnalyzer
   module Formatters
+    # A formatter class outputting bare JSON.
+    # Useful for integrating with other tools.
     class Json
       require 'json'
 
-      def initialize(*)
-      end
+      def initialize(*); end
 
-      def format(requires_list)
+      # @return [String] A JSON form of the requires_list array, last entry is the cumulated result.
+      def format_list(requires_list)
         JSON.dump(requires_list)
       end
     end

data/lib/gem_footprint_analyzer/formatters/text_base.rb

@@ -1,10 +1,14 @@
 module GemFootprintAnalyzer
   module Formatters
+    # Base class for all text formatters.
+    # Houses boilerplate and disclaimer text methods.
     class TextBase
-      def initialize(options={})
+      # @param options [Hash<Symbol>] A hash of CLI options, to be used in disclaimer text
+      def initialize(options = {})
         @options = options
       end
 
+      # Displays explanatory words for text formatter results
       def info
         lines = []
         lines << "GemFootprintAnalyzer (#{GemFootprintAnalyzer::VERSION})\n"
@@ -15,9 +19,10 @@ module GemFootprintAnalyzer
         lines.join("\n")
       end
 
+      # @return [String] Awesome text separator
       def dash(length)
         '-' * length
       end
     end
   end
-end
+end

data/lib/gem_footprint_analyzer/formatters/tree.rb

@@ -1,10 +1,13 @@
 module GemFootprintAnalyzer
+  # Tree type formatter for results.
   module Formatters
+    # Prints results with the cumulated entry first and details below, indented to give
+    # information about the calling order of subsequent requires.
     class Tree < TextBase
       INDENT = '  '.freeze
-
+      # Formatter helper class representing a single results require entry.
       class Entry
-        def initialize(entry_hash, options={})
+        def initialize(entry_hash, _options = {})
           @entry_hash = entry_hash
           @options = {}
         end
@@ -18,11 +21,13 @@ module GemFootprintAnalyzer
         end
 
         def time
-          time = @entry_hash.dig(:time, :mean)&.round
+          time = @entry_hash.dig(:time, :mean)
+          time && time.round
         end
 
         def rss
-          @entry_hash.dig(:rss, :mean)&.round
+          rss = @entry_hash.dig(:rss, :mean)
+          rss && rss.round
         end
 
         def formatted_name
@@ -38,35 +43,58 @@ module GemFootprintAnalyzer
         end
       end
 
-      def format(requires_list)
+      def format_list(requires_list)
         return if requires_list.size == 1
 
-        entries = requires_list.last(requires_list.size - 1).map { |entry_hash| Entry.new(entry_hash, @options) }
+        entries = init_entries(requires_list)
+        info + formatted_entries(entries)
+      end
 
-        root = entries.last
-        indent_levels = {root.name => 0}
+      private
 
+      def formatted_entries(entries)
+        indent_levels, max_indent = count_indent_levels(entries)
+        max_name_length = entries.map { |e| e.name.length }.max
+        ljust_value = max_name_length + max_indent + 1
 
-        (entries - [root]).reverse.each do |entry|
-          indent_levels[entry.name] ||= indent_levels.fetch(entry.parent, 0) + 1
+        lines = entries.reverse.map do |entry|
+          format_entry(entry, indent_levels, ljust_value)
         end
 
-        max_name_length = entries.map { |e| e.formatted_name.length }.max
-        max_indent = indent_levels.values.max
+        (legend(ljust_value) + lines).join("\n")
+      end
 
-        ljust_value = max_name_length + (max_indent *  INDENT.size) + 1
+      def legend(ljust_value)
+        [
+          'name'.ljust(ljust_value + 2) + 'time' + '   RSS after',
+          dash(ljust_value + 16)
+        ]
+      end
 
+      def format_entry(entry, indent_levels, ljust_value)
+        indent = INDENT * indent_levels[entry.name]
+        time = format('%5dms', entry.time)
+        rss = format('%7dKB', entry.rss)
 
-        lines = entries.reverse.map do |entry|
-          indent = INDENT * indent_levels[entry.name]
-          time = "%5dms" % entry.time
-          rss = "%7dKB"  % entry.rss
+        "#{indent}#{entry.formatted_name}".ljust(ljust_value) + time + rss
+      end
+
+      def init_entries(requires_list)
+        requires_list.last(requires_list.size - 1).map do |entry_hash|
+          Entry.new(entry_hash, @options)
+        end
+      end
+
+      def count_indent_levels(entries)
+        root = entries.last
+        indent_levels = {root.name => 0}
 
-          "#{indent}#{entry.formatted_name}".ljust(ljust_value) + time + rss
+        (entries - [root]).reverse_each do |entry|
+          indent_levels[entry.name] ||= indent_levels.fetch(entry.parent, 0) + 1
         end
-        lines.unshift(dash(ljust_value + 16))
-        lines.unshift('name'.ljust(ljust_value + 2) + 'time' + '   RSS after')
-        info + lines.join("\n")
+        max_indent = indent_levels.values.max
+
+        [indent_levels, max_indent * INDENT.size]
       end
     end
   end

data/lib/gem_footprint_analyzer/require_spy.rb

@@ -1,55 +1,73 @@
 module GemFootprintAnalyzer
+  # A module keeping hacks required to hijack {Kernel.require} and {Kernel.require_relative}
+  # and plug in versions of them that communicate meta data to the {Analyzer}.
   module RequireSpy
-    def self.relative_path(caller_entry, require_name=nil)
-      caller_file = caller_entry.split(':')[0]
-      if require_name
-        caller_dir = File.dirname(caller_file)
-        full_path = File.join(caller_dir, require_name)
-      else
-        full_path = caller_file
+    class << self
+      def relative_path(caller_entry, require_name = nil)
+        caller_file = caller_entry.split(':')[0]
+        if require_name
+          caller_dir = File.dirname(caller_file)
+          full_path = File.join(caller_dir, require_name)
+        else
+          full_path = caller_file
+        end
+        load_path = $LOAD_PATH.find { |lp| full_path.start_with?(lp) }
+        full_path.sub(%r{\A#{load_path}/}, '')
       end
-      load_path = $LOAD_PATH.find { |lp| full_path.start_with?(lp) }
-      full_path.sub(/\A#{load_path}\//, '')
-    end
 
-    def self.first_foreign_caller(caller)
-      ffc = caller.find { |c| GemFootprintAnalyzer::RequireSpy.relative_path(c) !~ /gem_footprint_analyzer/ }
-      if ffc
-        GemFootprintAnalyzer::RequireSpy.relative_path(ffc).sub(/\.rb\z/, '')
+      def first_foreign_caller(caller)
+        ffc = caller.find do |c|
+          GemFootprintAnalyzer::RequireSpy.relative_path(c) !~ /gem_footprint_analyzer/
+        end
+        GemFootprintAnalyzer::RequireSpy.relative_path(ffc).sub(/\.rb\z/, '') if ffc
       end
-    end
 
-    def self.spy_require(interactor)
-      Kernel.send :alias_method, :regular_require, :require
-      Kernel.send :alias_method, :regular_require_relative, :require_relative
+      def spy_require(transport)
+        alias_require_methods
+        define_timed_exec
 
-      Kernel.send :define_method, :timed_exec do |&block|
-        start_time = Time.now.to_f
-        block.call
-        (Time.now.to_f - start_time).round(4)
+        define_require_relative
+        define_require(transport)
       end
 
-      Kernel.send :define_method, :require do |name|
-        result = nil
+      def alias_require_methods
+        Kernel.send :alias_method, :regular_require, :require
+        Kernel.send :alias_method, :regular_require_relative, :require_relative
+      end
 
-        interactor.ready
-        interactor.wait_for_start
+      def define_timed_exec
+        Kernel.send :define_method, :timed_exec do |&block|
+          start_time = Time.now.to_f
+          block.call
+          (Time.now.to_f - start_time).round(4)
+        end
+      end
+
+      def define_require(transport)
+        Kernel.send :define_method, :require do |name|
+          result = nil
+
+          transport.ready
+          transport.wait_for_start
 
-        t = timed_exec do
-          result = regular_require(name)
+          t = timed_exec { result = regular_require(name) }
+
+          first_foreign_caller = GemFootprintAnalyzer::RequireSpy.first_foreign_caller(caller)
+          transport.report_require(name, first_foreign_caller || '', t)
+          result
         end
-        first_foreign_caller = GemFootprintAnalyzer::RequireSpy.first_foreign_caller(caller)
-        interactor.report_require(name, first_foreign_caller || '', t)
-        result
       end
 
-      # As of Ruby 2.5.1, both :require and :require_relative use an unexposed
-      # native method rb_safe_require, however it's challenging to plug into it
-      # and using original :require_relative is not really possible (it does path calculation magic)
-      # so instead we're redirecting :require_relative to the regular :require
-      Kernel.send :define_method, :require_relative do |name|
-        relative_path = GemFootprintAnalyzer::RequireSpy.relative_path(caller[0], name)
-        return require(relative_path)
+      def define_require_relative
+        # As of Ruby 2.5.1, both :require and :require_relative use an unexposed native method
+        # rb_safe_require, however it's challenging to plug into it and using original
+        # :require_relative is not really possible (it does path calculation magic) so instead
+        # we're redirecting :require_relative to the regular :require
+        Kernel.send :define_method, :require_relative do |name|
+          last_caller = caller(1..1).first
+          relative_path = GemFootprintAnalyzer::RequireSpy.relative_path(last_caller, name)
+          return require(relative_path)
+        end
       end
     end
   end

data/lib/gem_footprint_analyzer/transport.rb

@@ -0,0 +1,81 @@
+module GemFootprintAnalyzer
+  # A basic transport class that provides a simple text interface and faciliates the
+  # transmission via 2 streams.
+  class Transport
+    # @param read_stream [IO] stream that will be used to read from by this {Transport} instance
+    # @param write_stream [IO] stream that will be used to write to by this {Transport} instance
+    def initialize(read_stream, write_stream)
+      @read_stream = read_stream
+      @write_stream = write_stream
+    end
+
+    # @return [Array] A tuple with command and *payload
+    def read_one_command
+      case read_raw_command
+      when /\A(done|ack|start|ready)\z/
+        [Regexp.last_match(1).to_sym, nil]
+      when /\Arq: "([^"]+)","([^"]*)",([^,]+)\z/
+        [:require, [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)]]
+      when /\Aarq: "([^"]+)"\z/
+        [:already_required, Regexp.last_match(1)]
+      when /\Aexit: "([^"]+)"\z/
+        [:exit, Regexp.last_match(1)]
+      end
+    end
+
+    # Blocks until a :start command is received from the read stream
+    def wait_for_start
+      while (cmd = read_one_command)
+        msg, = cmd
+        break if msg == :start
+      end
+    end
+
+    # Sends a done command and blocks until ack command is received
+    def done_and_wait_for_ack
+      @write_stream.puts 'done'
+      while (cmd = read_one_command)
+        msg, = cmd
+        break if msg == :ack
+      end
+    end
+
+    # Sends a ready command
+    def ready
+      @write_stream.puts 'ready'
+    end
+
+    # Sends a start command
+    def start
+      @write_stream.puts 'start'
+    end
+
+    # Sends an ack command
+    def ack
+      @write_stream.puts 'ack'
+    end
+
+    # @param library [String] Name of the library that was required
+    # @param source [String] Name of the source file that required the library
+    # @param duration [Float] Time which it took to complete the require
+    def report_require(library, source, duration)
+      @write_stream.puts "rq: #{library.inspect},#{source.inspect},#{duration.inspect}"
+    end
+
+    # @param library [String] Name of the library that was required, but was already required before
+    def report_already_required(library)
+      @write_stream.puts "arq: #{library.inspect}"
+    end
+
+    # @param error [Exception] Exception object that should halt the program
+    def exit_with_error(error)
+      @write_stream.puts "exit: #{error.to_s.inspect}"
+    end
+
+    private
+
+    def read_raw_command
+      @read_stream.gets.strip
+    end
+  end
+end

data/lib/gem_footprint_analyzer/version.rb

@@ -1,3 +1,3 @@
 module GemFootprintAnalyzer
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_footprint_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Maciek Dubiński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - maciek@dubinski.net
@@ -62,6 +90,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -74,12 +104,12 @@ files:
 - lib/gem_footprint_analyzer.rb
 - lib/gem_footprint_analyzer/analyzer.rb
 - lib/gem_footprint_analyzer/average_runner.rb
+- lib/gem_footprint_analyzer/cli.rb
 - lib/gem_footprint_analyzer/formatters/json.rb
-- lib/gem_footprint_analyzer/formatters/text.rb
 - lib/gem_footprint_analyzer/formatters/text_base.rb
 - lib/gem_footprint_analyzer/formatters/tree.rb
-- lib/gem_footprint_analyzer/pipe_transport.rb
 - lib/gem_footprint_analyzer/require_spy.rb
+- lib/gem_footprint_analyzer/transport.rb
 - lib/gem_footprint_analyzer/version.rb
 homepage: https://github.com/irvingwashington/gem_footprint_analyzer
 licenses:

data/lib/gem_footprint_analyzer/formatters/text.rb

@@ -1,50 +0,0 @@
-require_relative 'text_base'
-
-module GemFootprintAnalyzer
-  module Formatters
-    class Text < TextBase
-      TABULATION = '  '.freeze
-      NEWLINE = "\n".freeze
-
-      def format(requires_list)
-        return if requires_list.size == 1
-        entries_num = requires_list.size
-        lines = []
-        longest_name_length = requires_list.map { |el| el[:name]&.length }.compact.max
-
-        lines << [format_name('name', longest_name_length, false), '  time  ', 'RSS after'].join(' ')
-        lines << dash(longest_name_length + 22) if requires_list.size > 2
-
-        requires_list.each_with_index do |entry, i|
-          next if i.zero?
-
-          last_element = (i == entries_num - 1)
-
-          name, time, rss = entry.values_at(:name, :time, :rss)
-          lines << dash(longest_name_length + 22) if last_element
-          lines << [format_name(name, longest_name_length, last_element), format_time(time), format_rss(rss)].join(' ')
-        end
-        info + lines.join(NEWLINE)
-      end
-
-      private
-
-      def format_name(name, longest_name_length, last_element = false)
-        left_just_size = longest_name_length + 3
-        left_just_size += TABULATION.size if last_element
-        tabulation = last_element ? '' : TABULATION
-        tabulation + name.ljust(left_just_size)
-      end
-
-      def format_time(time)
-        value = time.is_a?(Hash) ? time[:mean] : time
-        "%4dms" % value.round
-      end
-
-      def format_rss(rss)
-        value = rss.is_a?(Hash) ? rss[:mean] : rss
-        "%6dKB" % value
-      end
-    end
-  end
-end

data/lib/gem_footprint_analyzer/pipe_transport.rb

@@ -1,70 +0,0 @@
-module GemFootprintAnalyzer
-  class PipeTransport
-    def initialize(read_stream, write_stream)
-      @read_stream = read_stream
-      @write_stream = write_stream
-    end
-
-    def read_one_command
-      str = @read_stream.gets.strip
-
-      case str
-      when /\Adone\z/
-        [:done, nil]
-      when /\Aack\z/
-        [:ack, nil]
-      when /\Arq: "([^"]+)","([^"]*)",(.+)\z/
-        [:require, [$1, $2, $3]]
-      when /\Aarq: "([^"]+)"\z/
-        [:already_required, $1]
-      when /\Astart\z/
-        [:start, nil]
-      when /\Aready\z/
-        [:ready, nil]
-      when /\Aexit: "([^"]+)"\z/
-        [:exit, $1]
-      end
-    end
-
-    def wait_for_start
-      while (msg, payload = read_one_command)
-        break if msg == :start
-      end
-    end
-
-    def wait_for_ack
-      while (msg, data = read_one_command)
-        break if msg == :ack
-      end
-    end
-
-    def ready
-      @write_stream.puts 'ready'
-    end
-
-    def start
-      @write_stream.puts 'start'
-    end
-
-    def ack
-      @write_stream.puts 'ack'
-    end
-
-    # Signalize finalization
-    def done
-      @write_stream.puts 'done'
-    end
-
-    def report_require(library, source, duration)
-      @write_stream.puts "rq: #{library.inspect},#{source.inspect},#{duration.inspect}"
-    end
-
-    def report_already_required(library)
-      @write_stream.puts "arq: #{library.inspect}"
-    end
-
-    def exit_with_error(e)
-      @write_stream.puts "exit: #{e.to_s.inspect}"
-    end
-  end
-end