gem_footprint_analyzer 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e977cf9fc36c1045294e18296c00c63ab7b7e1ccf482691cb85a231a4e18273
-  data.tar.gz: d917cd40bb4ca7d2f608928337a880a04ef7bdb71a352fccb7279e46ca40d42b
+  metadata.gz: 4ea3f3ac4a4cdc86a560ae500fdbdc59423afe2d28ac9f16f5fdc7efe5d433fc
+  data.tar.gz: 5baf82c20f15679d84b56f86e303e81325aadbc4577fdcc6bc36a388d0b92baa
 SHA512:
-  metadata.gz: c6c448e829e042a6620f774102cb04a80eca75fd9bc4c3b1593ffcd6b4947088493d51e789f90a298176c3f7c849c924f40f923cd5c923e18aa70b2a7e977fac
-  data.tar.gz: f16657789a803c5ee278e6af25e5b8505d2c97ebae833ee2b3f5fb13a69febe5b94509459cd6452e6e4cf6192c98ec743c672c20228db80fa5c61cd8d5b7e0b9
+  metadata.gz: 54b934c3cb13d9b564f52abc70adc1286c5842acb2e0c25d178131d6d1e653732f9a1d49df807004fc434089e97f119fbf32ddee75af29e488e1df415b58bbfe
+  data.tar.gz: 50bb084a66ae63808ee91acde1c257cda615cb28cb2ea2ee71463306e7d8ca2b59a3fcf1e4d09d2fe3ebef8e1c6fb12e4440b4a5c3f523a6108b03bf4d44fbdc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gem_footprint_analyzer (0.1.5)
+    gem_footprint_analyzer (0.1.6)
 
 GEM
   remote: https://rubygems.org/
@@ -10,7 +10,7 @@ GEM
     diff-lcs (1.3)
     jaro_winkler (1.5.1)
     parallel (1.12.1)
-    parser (2.5.1.2)
+    parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     rainbow (3.0.0)
@@ -36,8 +36,8 @@ GEM
       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)
+    rubocop-rspec (1.30.1)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
     unicode-display_width (1.4.0)
 
@@ -50,7 +50,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.60.0)
-  rubocop-rspec
+  rubocop-rspec (~> 1.30)
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -10,7 +10,7 @@ Requires Ruby >= 2.2.0, works on Linux and MacOS.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'gem_footprint_analyzer'
+gem 'gem_footprint_analyzer', require: false
 ```
 
 And then execute:

data/exe/analyze_requires

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby --disable=did_you_mean --disable=gem --disable=rubyopt
+#!/usr/bin/env ruby --disable=gem --disable=rubyopt
 
 $LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
 $LOAD_PATH.unshift('./lib') if Dir.exist?('lib')
@@ -7,7 +7,7 @@ require 'gem_footprint_analyzer'
 
 cli = GemFootprintAnalyzer::CLI.new
 
-t1 = Time.now.to_f
+t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 cli.run(ARGV)
-t2 = Time.now.to_f
+t2 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 STDERR.puts(format("\nTotal runtime %0.4fs", (t2 - t1)))

data/gem_footprint_analyzer.gemspec

@@ -12,11 +12,12 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A simple tool to analyze footprint of Ruby requires.}
   spec.homepage      = "https://github.com/irvingwashington/gem_footprint_analyzer"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.2.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec/|\.)}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -26,5 +27,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.30"
 end

data/lib/gem_footprint_analyzer/analyzer.rb

@@ -5,16 +5,17 @@ module GemFootprintAnalyzer
   # Require calls are interwoven with RSS checks done from the parent process, require timing
   # is gathered in the child process and passed along to the parent.
   class Analyzer
+    # @param fifos [Hash<Symbol>] Hash containing filenames of :child and :parent FIFO files
+    def initialize(fifos)
+      @fifos = fifos
+    end
+
     # @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 initialize(fifos)
-      @fifos = fifos
-    end
-
     def test_library(library, require_string = nil)
       child = ChildProcess.new(library, require_string, fifos)
       child.start_child

data/lib/gem_footprint_analyzer/average_runner.rb

@@ -16,10 +16,7 @@ module GemFootprintAnalyzer
     # @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
-        results << run_once
-      end
+      results = Array.new(@runs) { run_once }
       calculate_averages(results)
     end
 
@@ -50,8 +47,8 @@ module GemFootprintAnalyzer
       sum = values.sum.to_f
       mean = sum / num
 
-      stddev = Math.sqrt(values.sum { |v| (v - mean)**2 } / num)
-      {mean: mean, sttdev: stddev}
+      stddev = Math.sqrt(values.sum { |v| (v - mean)**2 } / num).round(4)
+      {mean: mean, stddev: stddev}
     end
 
     def initialize_average_with_copied_fields(sample)

data/lib/gem_footprint_analyzer/child_context.rb

@@ -20,7 +20,9 @@ module GemFootprintAnalyzer
       begin
         require(require_string)
       rescue LoadError => e
+        warn_about_load_error(e)
         transport.exit_with_error(e)
+        exit 1
       end
       transport.done_and_wait_for_ack
     end
@@ -52,6 +54,16 @@ module GemFootprintAnalyzer
       STDOUT.puts(message)
       STDOUT.flush
     end
+
+    def warn_about_load_error(error)
+      possible_gem = error.message.split.last
+      STDERR.puts "Cannot load '#{possible_gem}', this might be an issue with implicit require in" \
+        " the '#{require_string}'"
+      STDERR.puts "If '#{possible_gem}' is a gem, you can try adding it to the Gemfile explicitly" \
+        ", running `bundle install` and trying again\n\n"
+      STDERR.puts error.backtrace
+      STDERR.flush
+    end
   end
 end
 

data/lib/gem_footprint_analyzer/child_process.rb

@@ -4,6 +4,7 @@ require 'rbconfig'
 module GemFootprintAnalyzer
   # A class for starting the child process that does actual requires.
   class ChildProcess
+    LEGACY_RUBY_CMD = [RbConfig.ruby, '--disable=gem'].freeze
     RUBY_CMD = [RbConfig.ruby, '--disable=did_you_mean', '--disable=gem'].freeze
 
     def initialize(library, require_string, fifos)
@@ -15,11 +16,11 @@ module GemFootprintAnalyzer
 
     def start_child
       @child_thread ||= Thread.new do # rubocop:disable Naming/MemoizedInstanceVariableName
-        Open3.popen3(child_env_vars, *RUBY_CMD, context_file) do |_, stdout, stderr|
+        Open3.popen3(child_env_vars, *ruby_command, context_file) do |_, stdout, stderr|
           @pid = stdout.gets.strip.to_i
 
           while (line = stderr.gets)
-            puts "!! #{line.strip}"
+            print "!! #{line}"
           end
         end
       end
@@ -29,7 +30,6 @@ module GemFootprintAnalyzer
       return unless child_thread
 
       sleep 0.01 while @pid.nil?
-
       @pid
     end
 
@@ -37,6 +37,14 @@ module GemFootprintAnalyzer
 
     attr_reader :require_string, :child_thread, :fifos
 
+    def ruby_command
+      if RbConfig::CONFIG['MAJOR'].to_i >= 2 && RbConfig::CONFIG['MINOR'].to_i >= 3
+        RUBY_CMD
+      else
+        LEGACY_RUBY_CMD
+      end
+    end
+
     def child_env_vars
       {
         'require_string' => require_string,

data/lib/gem_footprint_analyzer/core_ext/file.rb

@@ -3,7 +3,7 @@ module GemFootprintAnalyzer
     # Provides File#mkfifo, missing in Ruby 2.2.0
     module File
       def mkfifo(name)
-        system("mkfifo #{name}")
+        system("mkfifo #{name}") || fail('Failed to make FIFO special file')
       end
     end
   end

data/lib/gem_footprint_analyzer/formatters/text_base.rb

@@ -11,7 +11,8 @@ module GemFootprintAnalyzer
       # Displays explanatory words for text formatter results
       def info
         lines = []
-        lines << "GemFootprintAnalyzer (#{GemFootprintAnalyzer::VERSION})\n"
+        lines << "GemFootprintAnalyzer (#{GemFootprintAnalyzer::VERSION})"
+        lines << (debug? ? "(#{File.expand_path(File.join(File.dirname(__FILE__), '..'))})\n" : '')
         lines << "Analyze results (average measured from #{@options[:runs]} run(s))"
         lines << 'time is the amount of time given require has taken to complete'
         lines << 'RSS is total memory increase up to the point after the require'
@@ -23,6 +24,12 @@ module GemFootprintAnalyzer
       def dash(length)
         '-' * length
       end
+
+      private
+
+      def debug?
+        @options[:debug]
+      end
     end
   end
 end

data/lib/gem_footprint_analyzer/formatters/tree.rb

@@ -7,9 +7,9 @@ module GemFootprintAnalyzer
       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 = {}
+          @options = options
         end
 
         def name
@@ -39,7 +39,7 @@ module GemFootprintAnalyzer
         def debug_parent
           return unless @options[:debug]
 
-          "(#{parent})"
+          " (#{parent})"
         end
       end
 
@@ -53,12 +53,13 @@ module GemFootprintAnalyzer
       private
 
       def formatted_entries(entries)
-        indent_levels, max_indent = count_indent_levels(entries)
-        max_name_length = entries.map { |e| e.name.length }.max
+        max_indent = max_indent(entries)
+        max_name_length = entries.map { |e| e.formatted_name.length }.max
         ljust_value = max_name_length + max_indent + 1
 
         lines = entries.reverse.map do |entry|
-          format_entry(entry, indent_levels, ljust_value)
+          indent_level = count_indent_level(entry)
+          format_entry(entry, indent_level, ljust_value)
         end
 
         (legend(ljust_value) + lines).join("\n")
@@ -71,8 +72,8 @@ module GemFootprintAnalyzer
         ]
       end
 
-      def format_entry(entry, indent_levels, ljust_value)
-        indent = INDENT * indent_levels[entry.name]
+      def format_entry(entry, indent_level, ljust_value)
+        indent = INDENT * indent_level
         time = format('%5dms', entry.time)
         rss = format('%7dKB', entry.rss)
 
@@ -85,6 +86,22 @@ module GemFootprintAnalyzer
         end
       end
 
+      def max_indent(entries)
+        entries.reverse_each { |entry| count_indent_level(entry) }
+        max_indent_level = @indent_levels.map(&:values).flatten.max
+        @indent_levels = []
+        max_indent_level * INDENT.size
+      end
+
+      def count_indent_level(entry)
+        @indent_levels ||= []
+        parent_hash = @indent_levels.find { |elem| elem.key?(entry.parent) }
+        parent_level = parent_hash ? parent_hash.values.first : -1
+        indent_level = parent_level + 1
+        @indent_levels.unshift(entry.name => indent_level)
+        indent_level
+      end
+
       def count_indent_levels(entries)
         root = entries.last
         indent_levels = {root.name => 0}

data/lib/gem_footprint_analyzer/require_spy.rb

@@ -15,11 +15,15 @@ module GemFootprintAnalyzer
         full_path.sub(%r{\A#{load_path}/}, '')
       end
 
-      def first_foreign_caller(caller)
-        ffc = caller.find do |c|
-          GemFootprintAnalyzer::RequireSpy.relative_path(c) !~ /gem_footprint_analyzer/
+      def without_extension(name)
+        name.sub(/\.rb\z/, '')
+      end
+
+      def first_foreign_caller(caller_list)
+        ffc = caller_list.find do |c|
+          relative_path(c) !~ /gem_footprint_analyzer/
         end
-        GemFootprintAnalyzer::RequireSpy.relative_path(ffc).sub(/\.rb\z/, '') if ffc
+        without_extension(relative_path(ffc)) if ffc
       end
 
       def spy_require(transport)
@@ -37,9 +41,9 @@ module GemFootprintAnalyzer
 
       def define_timed_exec
         Kernel.send :define_method, :timed_exec do |&block|
-          start_time = Time.now.to_f
+          start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
           block.call
-          (Time.now.to_f - start_time).round(4)
+          (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time).round(4)
         end
       end
 
@@ -53,7 +57,8 @@ module GemFootprintAnalyzer
           t = timed_exec { result = regular_require(name) }
 
           first_foreign_caller = GemFootprintAnalyzer::RequireSpy.first_foreign_caller(caller)
-          transport.report_require(name, first_foreign_caller || '', t)
+          bare_name = GemFootprintAnalyzer::RequireSpy.without_extension(name)
+          transport.report_require(bare_name, first_foreign_caller || '', t)
           result
         end
       end

data/lib/gem_footprint_analyzer/transport.rb

@@ -9,7 +9,7 @@ module GemFootprintAnalyzer
       @write_stream = write_stream
     end
 
-    # @return [Array] A tuple with command and *payload
+    # @return [Array|nil] A tuple with command and *payload or nil when command not recognized
     def read_one_command
       case read_raw_command
       when /\A(done|ack|start|ready)\z/

data/lib/gem_footprint_analyzer/version.rb

@@ -1,3 +1,3 @@
 module GemFootprintAnalyzer
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_footprint_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Maciek Dubiński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-03 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
 description: 
 email:
 - maciek@dubinski.net
@@ -88,11 +88,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop"
-- ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -128,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,22 +0,0 @@
-require: rubocop-rspec
-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
-
-Style/SignalException:
-  EnforcedStyle: semantic
-
-RSpec/NestedGroups:
-  Max: 5

data/.travis.yml

@@ -1,14 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-  - 2.2
-before_install:
-  - gem install bundler -v 1.17.1
-script:
-  - bundle exec rubocop
-  - bundle exec rspec
-  - bundle exec analyze_requires -d rubocop
-  - bundle exec analyze_requires net/http