gem_footprint_analyzer 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ad6f4a90d9f22d88152496807371138eecc8456b195ecf63597771c3e5f43d
-  data.tar.gz: 6f78c45ebac12fb4602c61d3ff59b71b9c8dc0dff0fb88a7344ce56506e0c4f1
+  metadata.gz: 222e0c4ea30e4a328897f79bb5c1bbd137b8fd5f063bbf9fe74bc697fbebbe76
+  data.tar.gz: d65e4e2b96459f029579244653a87761f137f21f43a6bdb56b456b2f2946923d
 SHA512:
-  metadata.gz: 5aa544dacfe1ac6d74622d07ed884e92ddeb40203f460701a2afe05f691bd0df2d495bac22efb3dba8b32d0b678e925ede6d00fbfaf66fe1fcef472c541f83b0
-  data.tar.gz: 52ee797d7c5a24d16effc451eb9d64b5bfd577601767e2efd974d9b7fe013cddceca41d9d89aaffcefb7931f8ac75920869a63fb53e89696dc97b4d169e64459
+  metadata.gz: d18b017d780781fb892285df686cafd654d852f5ddb8b82b42ff221cc7ffb0651ae9b2d2e3ac1f4a22712e6d3b1296512fa2fcb5bb2f9532fdda8a0bf1da8349
+  data.tar.gz: 9eaad5508e6687e037d1ed49aa2e26ab81cc5e42b38804907b91a2661fecfc98f3554e9d7feb0e5341ff9c244a39eceb3348d9ee9418a73139a02c751f2a5340

data/Gemfile

@@ -5,3 +5,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in gem_footprint_analyzer.gemspec
 gemspec
 
+group :development do
+  gem 'rubocop', github: 'rubocop-hq/rubocop', branch: 'master'
+end
+

data/Gemfile.lock

@@ -1,7 +1,21 @@
+GIT
+  remote: https://github.com/rubocop-hq/rubocop
+  revision: aa2c86fd45463acd2818650898771bd9bed8731b
+  branch: master
+  specs:
+    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)
+
 PATH
   remote: .
   specs:
-    gem_footprint_analyzer (0.1.7)
+    gem_footprint_analyzer (0.1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -28,14 +42,6 @@ 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.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
@@ -49,7 +55,7 @@ DEPENDENCIES
   gem_footprint_analyzer!
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0.60.0)
+  rubocop!
   rubocop-rspec (~> 1.30)
 
 BUNDLED WITH

data/gem_footprint_analyzer.gemspec

@@ -26,6 +26,5 @@ 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", "~> 1.30"
 end

data/lib/gem_footprint_analyzer/child_context.rb

@@ -9,6 +9,8 @@ module GemFootprintAnalyzer
     PARENT_FIFO = '/tmp/parent'.freeze
     CHILD_FIFO = '/tmp/child'.freeze
 
+    # Prints the process pid, so it can be grabbed by the supervisor process, inits tranport fifos
+    # and requires requested libraries.
     def initialize
       output Process.pid
       init_transport

data/lib/gem_footprint_analyzer/child_process.rb

@@ -7,6 +7,7 @@ module GemFootprintAnalyzer
     LEGACY_RUBY_CMD = [RbConfig.ruby, '--disable=gem'].freeze
     RUBY_CMD = [RbConfig.ruby, '--disable=did_you_mean', '--disable=gem'].freeze
 
+    # Sets necessary ivars
     def initialize(library, require_string, fifos, options = {})
       @library = library
       @require_string = require_string || library
@@ -15,6 +16,8 @@ module GemFootprintAnalyzer
       @options = options
     end
 
+    # Starts a child process in a child-watching-thread
+    # Reads it's PID from the new process' STDOUT and sets it as an instance variable
     def start_child
       @child_thread ||= Thread.new do # rubocop:disable Naming/MemoizedInstanceVariableName
         Open3.popen3(child_env_vars, *ruby_command, context_file) do |_, stdout, stderr|
@@ -27,6 +30,8 @@ module GemFootprintAnalyzer
       end
     end
 
+    # Blocking method
+    # @return [Integer|nil] Process id or nil, if the child-watching-thread is not started
     def pid
       return unless child_thread
 

data/lib/gem_footprint_analyzer/cli.rb

@@ -4,6 +4,7 @@ module GemFootprintAnalyzer
   # A command line interface class for the gem.
   # Provides options parsing and help messages for the user.
   class CLI
+    # Sets default options, to be overwritten by option parser down the road
     def initialize
       @options = {}
       @options[:runs] = 10

data/lib/gem_footprint_analyzer/cli/opts.rb

@@ -57,6 +57,8 @@ module GemFootprintAnalyzer
 
       attr_reader :options
 
+      private
+
       def banner
         script_name = "bundle exec #{File.basename($PROGRAM_NAME)}"
 

data/lib/gem_footprint_analyzer/cli/utils.rb

@@ -2,6 +2,9 @@ module GemFootprintAnalyzer
   class CLI
     # A module containing helper methods for CLI
     module Utils
+      # Outputs strings to STDOUT, in case it's no longer possible (ex. when piped to head),
+      # it exits the process.
+      # @param output [String] message to be outputted to STDOUT
       def self.safe_puts(output)
         output ||= "\n"
 

data/lib/gem_footprint_analyzer/core_ext/array.rb

@@ -2,6 +2,7 @@ module GemFootprintAnalyzer
   module CoreExt
     # Provides Array#sum, missing in Ruby 2.2.0
     module Array
+      # Sums over the array
       def sum(init = 0, &block)
         if block
           reduce(init) { |acc, el| acc + yield(el) }

data/lib/gem_footprint_analyzer/core_ext/file.rb

@@ -2,6 +2,7 @@ module GemFootprintAnalyzer
   module CoreExt
     # Provides File#mkfifo, missing in Ruby 2.2.0
     module File
+      # @param name [String] Name of the fifo file to be created
       def mkfifo(name)
         system("mkfifo #{name}") || fail('Failed to make FIFO special file')
       end

data/lib/gem_footprint_analyzer/core_ext/hash.rb

@@ -2,6 +2,7 @@ module GemFootprintAnalyzer
   module CoreExt
     # Provides Hash#dig, missing in Ruby 2.2.0
     module Hash
+      # @param keys [Array<Symbol|String>] list of keys to dig from the hash
       def dig(*keys)
         value = self
         keys.each do |key|

data/lib/gem_footprint_analyzer/formatters/json.rb

@@ -3,6 +3,7 @@ module GemFootprintAnalyzer
     # A formatter class outputting bare JSON.
     # Useful for integrating with other tools.
     class Json
+      # Initializer conforms to formatters interface
       def initialize(*); end
 
       # @return [String] A JSON form of the requires_list array, last entry is the cumulated result.

data/lib/gem_footprint_analyzer/formatters/tree.rb

@@ -9,33 +9,41 @@ module GemFootprintAnalyzer
       class Entry
         BUNDLER_RUNTIME = 'bundler/runtime'.freeze
 
+        # @param entry_hash [Hash<Symbol>] Hash with a single require analysis
+        # @param options [Hash<Symbol>]
         def initialize(entry_hash, options = {})
           @entry_hash = entry_hash
           @options = options
         end
 
+        # @return [String] Require name
         def name
           @entry_hash[:name]
         end
 
+        # @return [String] Formatted parent require name
         def parent
           @entry_hash[:parent_name]
         end
 
+        # @return [Integer] Formatted time value
         def time
           time = @entry_hash.dig(:time, :mean)
           time && time.round
         end
 
+        # @return [Integer] Formatted RSS value
         def rss
           rss = @entry_hash.dig(:rss, :mean)
           rss && rss.round
         end
 
+        # @return [String] Formatted require name
         def formatted_name
           "#{name}#{debug_parent}"
         end
 
+        # @return [Bool] Is the entry a Gem or original require to be analyzed
         def top_level?
           parent.nil? || parent == BUNDLER_RUNTIME
         end

data/lib/gem_footprint_analyzer/require_spy.rb

@@ -7,6 +7,9 @@ module GemFootprintAnalyzer
       %r{active_support/dependencies\.rb.+(`require'|`load_dependency'|`block in require')\z}.freeze
 
     class << self
+      # @param caller_entry [String] A single stack frame
+      # @param require_name [String|nil] An optional require name to calculate full_path from
+      # @return [String] path relative to the gem lib directory
       def relative_path(caller_entry, require_name = nil)
         caller_file = caller_entry.split(':')[0]
         if require_name
@@ -19,14 +22,19 @@ module GemFootprintAnalyzer
         full_path.sub(%r{\A#{load_path}/}, '')
       end
 
+      # @return [Array<String>] All configured load paths in the full directory form
       def load_paths
         @load_paths ||= $LOAD_PATH.map { |path| File.expand_path(path) }
       end
 
+      # @param name [String] require name
+      # @return [String] name with the .rb extension truncated
       def without_extension(name)
         name.sub(/\.rb\z/, '')
       end
 
+      # @param [Array<String>] List of caller stack frames
+      # @return [String|nil] First caller entry that doesn't originate from this gem
       def first_foreign_caller(caller_list)
         ffc = caller_list.find do |c|
           c !~ ACTIVESUPPORT_REQUIRE_DEPENDENCY &&
@@ -35,6 +43,7 @@ module GemFootprintAnalyzer
         without_extension(relative_path(ffc)) if ffc
       end
 
+      # Installs require spying on all relevant methods
       def spy_require(transport)
         alias_require_methods
 
@@ -42,6 +51,7 @@ module GemFootprintAnalyzer
         define_requires(transport)
       end
 
+      # @return [Array] Tuple with method call duration and return value
       def timed_exec
         start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         result = yield
@@ -49,6 +59,7 @@ module GemFootprintAnalyzer
         [duration, result]
       end
 
+      # Aliases original methods, so they are accessible from methods that shadow them
       def alias_require_methods
         kernels.each do |k|
           k.send :alias_method, :regular_require, :require
@@ -56,14 +67,19 @@ module GemFootprintAnalyzer
         end
       end
 
+      # @return [Array<Class>] CLasses that have require* methods that we'll spy on
       def kernels
         @kernels ||= [(class << ::Kernel; self; end), Kernel]
       end
 
+      # @param transport [Transport] Instance of transport to be used by the require proxy method
       def define_requires(transport)
         kernels.each { |k| define_require(k, transport) }
       end
 
+      # @param klass [Class] Target class to have the spying require defined
+      # @param transport [Transport] Instance of transport to be used by the require proxy method
+      # Replaces require methods with proxied versions
       def define_require(klass, transport)
         klass.send :define_method, :require do |name|
           transport.ready_and_wait_for_start
@@ -78,6 +94,7 @@ module GemFootprintAnalyzer
         end
       end
 
+      # Replaces require_relative methods with proxied versions
       def define_require_relatives
         # 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
@@ -85,9 +102,10 @@ module GemFootprintAnalyzer
         # we're redirecting :require_relative to the regular :require
         kernels.each do |k|
           k.send :define_method, :require_relative do |name|
+            return require(name) if name.start_with?('/')
+
             last_caller = caller(1..1).first
             relative_path = GemFootprintAnalyzer::RequireSpy.relative_path(last_caller, name)
-
             require(relative_path)
           end
         end

data/lib/gem_footprint_analyzer/version.rb

@@ -1,3 +1,3 @@
 module GemFootprintAnalyzer
-  VERSION = '0.1.7'.freeze
+  VERSION = '0.1.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_footprint_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Maciek Dubiński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ 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