require_prof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c49d5f40de6332ebf834df091f6de815a0492d2
+  data.tar.gz: 1a906e1493fd0938e367360968739a70a259f8c4
+SHA512:
+  metadata.gz: 75a4bc193b559d49bac6998dbc0866915985f40f519882bb286a16c55c05e1b1c17670d2189af2194566410252ed1550c42c0a5380f2976e19e408fc06693a6f
+  data.tar.gz: 213695ef0e1d775d41c96e24766964bd89df1731aa6f29178290ec4c548f8d77b3168b5887e196e5ad15c7c4a16b1f581ba46a341f042867b4a9c7744307b07e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in require_prof.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kirill Nikitin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# RequireProf
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'require_prof'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install require_prof
+
+## Usage
+
+RequireProf profile some require like
+
+```ruby
+result = RequireProf.profile do
+  require 'mime-types'
+end
+```
+
+or just using start/stop without block
+
+```ruby
+RequireProf.start
+require 'mime-types'
+result = RequireProf.stop
+```   
+    
+### Printers
+    
+```ruby
+printer = RequireProf::TreePrinter.new(result)
+printer.print
+# or with extra options
+printer.print(output: STDOUT, precision: 3)
+```
+    
+    
+```
+.
+└── mime-types (136.68 ms, 13172 kb)
+    └── mime/types (132.64 ms, 13172 kb)
+        ├── mime/type (9.84 ms, 408 kb)
+        │   ├── mime (0.4 ms, 0 kb)
+        │   └── json (6.12 ms, 408 kb)
+        │       ├── json/common (3.28 ms, 0 kb)
+        │       │   ├── json/version (0.23 ms, 0 kb)
+        │       │   └── json/generic_object (1.22 ms, 0 kb)
+        │       │       └── ostruct (0.78 ms, 0 kb)
+        │       ├── json/version (0.04 ms, 0 kb)
+        │       └── json/ext (2.09 ms, 408 kb)
+        │           ├── json/common (0.02 ms, 0 kb)
+        │           ├── json/ext/parser (0.92 ms, 112 kb)
+        │           └── json/ext/generator (0.41 ms, 32 kb)
+        ├── mime/types/cache (0.69 ms, 0 kb)
+        ├── mime/types/loader (1.31 ms, 0 kb)
+        │   └── mime/types/loader_path (0.2 ms, 0 kb)
+        └── json (0.02 ms, 0 kb)
+```
+    
+    
+```ruby
+printer = RequireProf::TablePrinter.new(result)
+printer.print 
+# or with extra options 
+printer.print(output: STDOUT, sort: :memory, precision: 1, threshold: 100)
+printer.print(output: STDOUT, sort: :time, precision: 3, threshold: 5)
+```
+    
+    
+```
++------------------------+-----------+-------------+
+|          name          | time (ms) | memory (kb) |
++------------------------+-----------+-------------+
+| mime/types             | 105.92    | 13304.0     |
+| mime-types             | 3.94      | 0.0         |
+| mime/type              | 3.02      | 260.0       |
+| json/common            | 1.8       | 0.0         |
+| mime/types/loader      | 1.02      | 0.0         |
+| json/ext               | 0.93      | 0.0         |
+| json/ext/parser        | 0.86      | 248.0       |
+| ostruct                | 0.85      | 0.0         |
+| json                   | 0.58      | 0.0         |
+| mime/types/cache       | 0.51      | 0.0         |
+| json/generic_object    | 0.46      | 0.0         |
+| json/ext/generator     | 0.37      | 32.0        |
+| mime                   | 0.32      | 0.0         |
+| json/version           | 0.21      | 0.0         |
+| mime/types/loader_path | 0.17      | 0.0         |
++------------------------+-----------+-------------+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/Locke23rus/require_prof/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "require_prof"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/require_prof.rb

@@ -0,0 +1,75 @@
+require 'require_prof/ext/kernel'
+require 'require_prof/profile'
+require 'require_prof/printers/tree_printer'
+require 'require_prof/printers/table_printer'
+require 'require_prof/version'
+
+module RequireProf
+
+  def self.start
+    ensure_not_running!
+    @profile = Profile.new
+    @profile.start
+  end
+
+  def self.pause
+    ensure_running!
+    @profile.pause
+  end
+
+  def self.running?
+    if defined?(@profile) and @profile
+      @profile.running?
+    else
+      false
+    end
+  end
+
+  def self.paused?
+    if defined?(@profile) and @profile
+      @profile.paused?
+    else
+      false
+    end
+  end
+
+  def self.resume
+    ensure_running!
+    @profile.resume
+  end
+
+  def self.stop
+    ensure_running!
+    result = @profile.stop
+    @profile = nil
+    result
+  end
+
+  def self.profile(&block)
+    unless block_given?
+      raise(ArgumentError, 'A block must be provided to the profile');
+    end
+
+    start
+    yield
+    stop
+  end
+
+  def self.require(name)
+    if running? && !paused?
+      @profile.require(name)
+    else
+      rp_original_require(name)
+    end
+  end
+
+  private
+
+  def self.ensure_running!
+    raise 'RequireProf.start was not yet called' unless running?
+  end
+
+  def self.ensure_not_running!
+    raise 'RequireProf.start was already called' if running?
+  end
+end

data/lib/require_prof/ext/kernel.rb

@@ -0,0 +1,3 @@
+module Kernel
+  alias_method :rp_original_require, :require
+end

data/lib/require_prof/memory_sampler.rb

@@ -0,0 +1,73 @@
+module RequireProf
+  class MemorySampler
+
+    def self.available?
+      return @available if defined?(@available)
+      @available = defined?(JRuby) || platform =~ /linux|darwin|freebsd|solaris/
+      unless @available
+        STDERR.puts "WARNING: Unsupported platform for getting memory '#{platform}'"
+      end
+      @available
+    end
+
+    def self.sampler
+      return @sampler if defined?(@sampler)
+
+      @sampler = if defined? JRuby
+                   JavaHeapSampler.new
+                 elsif platform =~ /linux/
+                   ProcStatus.new
+                   # ShellPS.new('ps -o rsz')
+                 elsif platform =~ /darwin9/ # 10.5
+                   ShellPS.new('ps -o rsz')
+                 elsif platform =~ /darwin1\d+/ # >= 10.6
+                   ShellPS.new('ps -o rss')
+                 elsif platform =~ /freebsd/
+                   ShellPS.new('ps -o rss')
+                 elsif platform =~ /solaris/
+                   ShellPS.new('/usr/bin/ps -o rss -p')
+                 end
+    end
+
+    def self.platform
+      if RUBY_PLATFORM =~ /java/
+        %x[uname -s].downcase
+      else
+        RUBY_PLATFORM.downcase
+      end
+    end
+
+    def self.memory_usage
+      sampler.memory_usage
+    end
+
+    class JavaHeapSampler
+      def memory_usage
+        raise "Can't sample Java heap unless running in JRuby" unless defined? JRuby
+        java.lang.Runtime.getRuntime.totalMemory / 1024.0 rescue 0.0
+      end
+    end
+
+    class ShellPS
+      def initialize(command)
+        @command = command
+      end
+
+      def memory_usage
+        process = $$
+        `#{@command} #{process}`.split("\n")[1].to_f rescue 0.0
+      end
+    end
+
+    class ProcStatus
+      def memory_usage
+        proc_status = File.open("/proc/#{$$}/status", 'r') { |f| f.read_nonblock(4096).strip }
+        if proc_status =~ /RSS:\s*(\d+) kB/i
+          $1.to_f
+        else
+          0.0
+        end
+      end
+    end
+  end
+end

data/lib/require_prof/printers/abstract_printer.rb

@@ -0,0 +1,21 @@
+module RequireProf
+  class AbstractPrinter
+
+    def initialize(result)
+      @result = result
+    end
+
+    def print(options = {})
+      @options = options
+      @output = options.fetch(:output, STDOUT)
+      print_result
+    end
+
+    private
+
+    def precision
+      @options[:precision] || 2
+    end
+
+  end
+end

data/lib/require_prof/printers/table_printer.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'set'
+require 'require_prof/printers/abstract_printer'
+require 'text-table'
+
+
+module RequireProf
+  class TablePrinter < AbstractPrinter
+    SORTABLE_COLUMNS = %w(time memory)
+
+    private
+
+    def print_result
+      process_result
+      print_table
+    end
+
+    def process_result
+      @processed_nodes = Set.new
+      @rows = []
+      process_nodes @result.children
+    end
+
+    def print_table
+      @output << Text::Table.new(head: ["name", "time (ms)", "memory (kb)"], rows: sorted_rows).to_s
+    end
+
+    def process_nodes(nodes)
+      nodes.each do |node|
+        unless @processed_nodes.include?(node.name)
+          @processed_nodes.add node.name
+          @rows << [node.name, node.time.round(precision), node.memory]
+          process_nodes node.children
+        end
+      end
+    end
+
+    def sorted_rows
+      column = SORTABLE_COLUMNS.index(sort) + 1
+      @rows.select { |i| i[column] > threshold}.sort_by { |i| i[column] }.reverse
+    end
+
+    def sort
+      column = @options[:sort].to_s
+      SORTABLE_COLUMNS.include?(column) ? column : 'time'
+    end
+
+    def threshold
+      @options[:threshold] || 0.0
+    end
+
+  end
+end

data/lib/require_prof/printers/tree_printer.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'require_prof/printers/abstract_printer'
+
+module RequireProf
+  class TreePrinter < AbstractPrinter
+
+    private
+
+    def print_result
+      @output << "#{@result.name}\n"
+      print_trees(@result.children)
+    end
+
+    def print_trees(nodes, prefix = '')
+      last = nodes.size - 1
+      nodes.each_with_index do |node, i|
+        info = "#{node.name} (#{node.total_time.round(precision)} ms, #{node.total_memory.round} kb)\n"
+        if i == last
+          @output << "#{prefix}└── #{info}"
+          print_trees(node.children, prefix + '    ')
+        else
+          @output << "#{prefix}├── #{info}"
+          print_trees(node.children, prefix + '│   ')
+        end
+      end
+    end
+
+  end
+end

data/lib/require_prof/profile.rb

@@ -0,0 +1,86 @@
+require 'require_prof/ext/kernel'
+require 'require_prof/memory_sampler'
+require 'require_prof/require_tree'
+
+module RequireProf
+  class Profile
+
+    def initialize
+      @running = false
+      @paused = false
+      @root = RequireTree.new('.')
+      @stack = [@root]
+    end
+
+    def running?
+      @running
+    end
+
+    def paused?
+      @paused
+    end
+
+    def start
+      install_hook
+      @running = true
+    end
+
+    def pause
+      @paused = true
+    end
+
+    def resume
+      @paused = false
+    end
+
+    def stop
+      remove_hook
+      @running = false
+      post_process
+      @root
+    end
+
+    def require(name)
+      node = RequireTree.new(name)
+      @stack.last << node
+      @stack << node
+      begin
+        time_before = Time.now.to_f
+        if MemorySampler.available?
+          memory_before = MemorySampler.memory_usage
+          overhead_time_before = Time.now.to_f - time_before
+        end
+        rp_original_require name
+      ensure
+        @stack.pop
+        if MemorySampler.available?
+          tmp_time = Time.now.to_f
+          memory_after = MemorySampler.memory_usage
+          overhead_time_after = Time.now.to_f - tmp_time
+        end
+        time_after = Time.now.to_f
+      end
+      node.total_time = (time_after - time_before) * 1000
+      if MemorySampler.available?
+        node.total_memory = memory_after - memory_before
+        node.overhead_time = (overhead_time_before + overhead_time_after) * 1000
+      end
+    end
+
+    private
+
+    def install_hook
+      ::Kernel.send(:define_method, :require) { |file| RequireProf.require file }
+    end
+
+    def remove_hook
+      ::Kernel.send :alias_method, :require, :rp_original_require
+    end
+
+    def post_process
+      @root.process_time
+      @root.process_memory
+    end
+
+  end
+end

data/lib/require_prof/require_tree.rb

@@ -0,0 +1,53 @@
+module RequireProf
+  class RequireTree
+
+    attr_reader :name
+    attr_accessor :time, :total_time, :memory, :total_memory, :overhead_time
+
+    def initialize(name)
+      @name = name
+      @children = {}
+      @time = 0.0
+      @total_time = 0.0
+      @overhead_time = 0.0
+      @memory = 0.0
+      @total_memory = 0.0
+    end
+
+    def <<(tree)
+      @children[tree.name] ||= tree
+    end
+
+    def [](name)
+      @children[name]
+    end
+
+    def children
+      @children.values
+    end
+
+    def process_time
+      children.map(&:process_time)
+      @overhead_time += children.map(&:overhead_time ).reduce(:+).to_f
+      @total_time -= overhead_time
+      @time = total_time - children.map(&:total_time).reduce(:+).to_f
+    end
+
+    def process_memory
+      children.map(&:process_memory)
+      @memory = total_memory - children.map(&:total_memory).reduce(:+).to_f
+    end
+
+    def to_h
+      {
+        name: name,
+        children: children.map(&:to_h),
+        time: time,
+        total_time: total_time,
+        memory: memory,
+        total_memory: total_memory
+      }
+    end
+
+  end
+end

data/lib/require_prof/version.rb

@@ -0,0 +1,3 @@
+module RequireProf
+  VERSION = "0.1.0"
+end

data/require_prof.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'require_prof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "require_prof"
+  spec.version       = RequireProf::VERSION
+  spec.authors       = ["Kirill Nikitin"]
+  spec.email         = ["locke23rus@gmail.com"]
+
+  spec.summary       = %q{Simple require profiler}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/Locke23rus/require_prof"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "text-table", "~> 1.2"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: require_prof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirill Nikitin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: ''
+email:
+- locke23rus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/require_prof.rb
+- lib/require_prof/ext/kernel.rb
+- lib/require_prof/memory_sampler.rb
+- lib/require_prof/printers/abstract_printer.rb
+- lib/require_prof/printers/table_printer.rb
+- lib/require_prof/printers/tree_printer.rb
+- lib/require_prof/profile.rb
+- lib/require_prof/require_tree.rb
+- lib/require_prof/version.rb
+- require_prof.gemspec
+homepage: https://github.com/Locke23rus/require_prof
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple require profiler
+test_files: []