benchin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56b56dc6c976815e1fdc736932b8918879c30b8eb925eb7f6834998a802aa0b0
+  data.tar.gz: c54eb4f9d6a5f3eae5287242acc36931eeeea68b7e2005fee42c874a3c13fef2
+SHA512:
+  metadata.gz: 4aaace72b22276acb2afa8981f0256785afc558a9edaced10a1e6e1f99f72b8b844c5b231a95d8b0f610cd8e272377f8e6bc51972cd7d6c678de192da433098c
+  data.tar.gz: 5ca4be7447beea555217ad15916c8791cf6d69b71f7bfa91603dbad50a456c6aece5fbc6e441dc5c678e916cfd4151e5930c0426e7dfef2b9d8a59971c02dae9

data/.github/workflows/build.yml

@@ -0,0 +1,47 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: 0 2 * * 1-5
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.5.x
+          - 2.6.x
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install Bundler
+        run: gem install bundler
+      - name: Install Hunspell
+        run: sudo apt-get install hunspell
+      - name: Install Deps
+        run: bundle install --jobs 4 --retry 3
+      - name: Rubocop
+        run: bundle exec rake rubocop
+      - name: Reek
+        run: bundle exec rake reek
+      - name: RSpec
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: bundle exec rake spec
+      - name: Markdown Linter (docs)
+        run: bundle exec rake mdl
+      - name: Spelling Check (docs & code)
+        run: bundle exec rake spellcheck
+      - name: Documentation Check
+        run: bundle exec rake inch

data/.gitignore

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

data/.mdlrc

@@ -0,0 +1 @@
+rules "~MD013", "~MD033"

data/.reek.yml

@@ -0,0 +1,11 @@
+---
+detectors:
+  TooManyInstanceVariables:
+    exclude:
+      - 'Benchin::Wrap::Report::Node'
+  TooManyStatements:
+    exclude:
+      - 'Benchin::Wrap#call'
+  DuplicateMethodCall:
+    allow_calls:
+      - 'Process.clock_gettime'

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,40 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-md
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - '**/*.md'
+
+Style/MixinUsage:
+  Exclude:
+    - '**/*.md'
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - '**/*.md'
+
+Lint/UnusedBlockArgument:
+  Exclude:
+    - '**/*.md'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at roman.kolesnev@vineti.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,166 @@
+PATH
+  remote: .
+  specs:
+    benchin (0.1.0)
+      rainbow (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    backports (3.15.0)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    codecov (0.1.15)
+      json
+      simplecov
+      url
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    crass (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    equatable (0.6.1)
+    ffi (1.11.1)
+    ffi-hunspell (0.5.0)
+      ffi (~> 1.0)
+    forspell (0.0.8)
+      backports (~> 3.0)
+      ffi-hunspell
+      highline
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      parser
+      pastel
+      ruby-progressbar
+      sanitize (~> 5.0)
+      slop (~> 4.6)
+      yard
+    highline (2.0.3)
+    ice_nine (0.11.2)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    jaro_winkler (1.5.4)
+    json (2.2.0)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    kwalify (0.7.2)
+    mdl (0.7.0)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    mixlib-cli (2.1.1)
+    mixlib-config (3.0.1)
+      tomlrb
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    nokogumbo (2.0.1)
+      nokogiri (~> 1.8, >= 1.8.4)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reek (5.4.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-md (0.3.0)
+      rubocop (~> 0.60)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    sanitize (5.1.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.8.0)
+      nokogumbo (~> 2.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (4.7.0)
+    sparkr (0.4.1)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thread_safe (0.3.6)
+    tins (1.22.0)
+    tomlrb (1.2.8)
+    tty-color (0.5.0)
+    unicode-display_width (1.6.0)
+    url (0.3.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchin!
+  bundler (~> 2.0)
+  codecov
+  forspell (~> 0.0.8)
+  inch
+  mdl
+  rake (~> 10.0)
+  reek
+  rspec (~> 3.0)
+  rubocop
+  rubocop-md
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  yard
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Roman Kolesnev
+
+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,51 @@
+# Benchin
+
+[![Build Status](https://github.com/ffloyd/benchin/workflows/Build/badge.svg)](https://github.com/ffloyd/benchin/actions)
+[![codecov](https://codecov.io/gh/ffloyd/benchin/branch/master/graph/badge.svg)](https://codecov.io/gh/ffloyd/benchin)
+[![Gem Version](https://badge.fury.io/rb/benchin.svg)](https://badge.fury.io/rb/benchin)
+
+Toolset for performance investigations in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchin'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+bundle
+
+Or install it yourself as:
+
+```sh
+gem install benchin
+```
+
+## Usage
+
+Check out [documentation](https://rubydoc.info/github/ffloyd/benchin/master) for usage examples.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [ffloyd/benchin](https://github.com/ffloyd/benchin). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Benchin project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ffloyd/benchin/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'forspell/cli'
+require 'mdl'
+require 'inch/rake'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+Reek::Rake::Task.new
+Inch::Rake::Suggest.new
+
+PATHS_TO_SPELLCHECK = ['.'].freeze
+PATHS_FOR_MDL = ['README.md'].freeze
+
+desc 'Run self spellchecking'
+task :spellcheck do |_task|
+  Forspell::CLI.new(PATHS_TO_SPELLCHECK).call
+end
+
+desc 'Run markdown linter'
+task :mdl do |_task|
+  MarkdownLint.run(PATHS_FOR_MDL)
+end
+
+# TODO: spellcheck and mdl tasks stop execution even with successful result
+# should be fixed someday
+task default: %i[rubocop reek inch spec spellcheck mdl]

data/benchin.gemspec

@@ -0,0 +1,55 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'benchin'
+  spec.version       = Benchin::VERSION
+  spec.authors       = ['Roman Kolesnev']
+  spec.email         = ['rvkolesnev@gmail.com']
+
+  spec.summary       = 'Benchmarking toolset for performance investigations.'
+  spec.homepage      = 'https://github.com/ffloyd/benchin'
+  spec.license       = 'MIT'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ffloyd/benchin'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rainbow', '~> 3.0'
+
+  # Essential dev deps
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # Test Coverage
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'simplecov'
+
+  # Documentation
+  spec.add_development_dependency 'yard'
+
+  # Code & Documentation Quality
+  spec.add_development_dependency 'forspell', '~> 0.0.8'
+  spec.add_development_dependency 'inch'
+  spec.add_development_dependency 'mdl'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'benchin'
+
+# 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(__FILE__)

data/bin/setup

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

data/forspell.dict

@@ -0,0 +1,6 @@
+# Format: one word per line. Empty lines and #-comments are supported too.
+# If you want to add word with its forms, you can write 'word: example' (without quotes) on the line,
+# where 'example' is existing word with the same possible forms (endings) as your word.
+# Example: deduplicate: duplicate
+Benchin
+toolset

data/lefthook.yml

@@ -0,0 +1,18 @@
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      glob: "{*.rb,*.md,*.gemspec,Gemfile,Rakefile}"
+      run: bundle exec rubocop {staged_files}
+    reek:
+      glob: "*.rb"
+      run: bundle exec reek {staged_files}
+    markdownlinter:
+      glob: "*.md"
+      run: bundle exec mdl {staged_files}
+    forspell:
+      glob: "{*.md,*.rb}"
+      run: bundle exec forspell {staged_files}
+    inch:
+      glob: "{*.md,*.rb}"
+      run: bundle exec rake inch

data/lib/benchin.rb

@@ -0,0 +1,34 @@
+require 'benchin/version'
+require 'benchin/wrap'
+
+# Benchmarking toolset.
+#
+# @example Using {Wrap} global instance
+#   Benchin.wrap.reset
+#   Benchin.wrap.call('Expesive Code') do
+#     expesive_logic
+#     10.times do
+#       Benchin.wrap.call('Nested Hot Operation') { do_something }
+#     end
+#   end
+#
+#   puts Benchin.wrap
+#
+# @see Wrap
+module Benchin
+  # Base error class
+  class Error < StandardError; end
+
+  class << self
+    # Returns global instance of {Wrap}.
+    #
+    # It can be used to simplify usage when you have
+    # to wrap code in many different places in your project.
+    #
+    # @see Wrap
+    # @return [Wrap]
+    def wrap
+      @wrap ||= Wrap.new('GLOBAL')
+    end
+  end
+end

data/lib/benchin/version.rb

@@ -0,0 +1,3 @@
+module Benchin
+  VERSION = '0.1.0'.freeze
+end

data/lib/benchin/wrap.rb

@@ -0,0 +1,148 @@
+require_relative './wrap/report'
+
+module Benchin
+  # Benchmark tool for high-level nested measurement. Check out {Report#to_h} for an example of
+  # the report structure.
+  #
+  # It's designed to use when:
+  #
+  # - you have some slow code (even one execution takes significant time)
+  # - you know which blocks of code you have to measure
+  # - you have to measure:
+  #   - total time spend in each block
+  #   - time spend in blocks executed inside a concrete block (child time)
+  #   - time spend in a concrete block minus child block's time (self time)
+  #
+  # By using this information you can discover which block of slow code is the slowest one.
+  #
+  # Measurement uses WALL time.
+  #
+  # One of the most common possible examples of usage is to investigate slow requests in legacy and
+  # big codebases. In this case more classic instruments like stack profiling can be too
+  # focused on particular methods instead of logic chunks in your code.
+  #
+  # It can be inconvenient to 'drill' {Wrap} instance to all the places where we have to wrap some code.
+  # To address this issue we have helper {Benchin.wrap} which uses global {Wrap} instance.
+  #
+  # @example Measure request timings in controller
+  #   class SomeDirtyController < SomeWebFramework::Controller
+  #     def create(params)
+  #       @bench = Benchin::Wrap.new('CREATE REQUEST')
+  #
+  #       data = @bench.call('Create Operation') do
+  #         do_create(params)
+  #       end
+  #
+  #       @bench.call('Rendering') do
+  #         render data
+  #       end
+  #
+  #       File.write('report.txt', @bench.to_s)
+  #     end
+  #
+  #     private
+  #
+  #     def do_create(params)
+  #       do_something(params)
+  #       @bench.call('Event Logging') do
+  #         log_events
+  #       end
+  #     end
+  #   end
+  #   # Report saved to a file will look like:
+  #   #
+  #   # CREATE REQUEST ->
+  #   # |   time(all):       22.0
+  #   # |   Create Operation ->
+  #   # |   |   calls:              1
+  #   # |   |   time(all):       15.0
+  #   # |   |   time(self):       5.0
+  #   # |   |   time(childs):    10.0
+  #   # |   |   Event Logging ->
+  #   # |   |   |   calls:              1
+  #   # |   |   |   time(all):       10.0
+  #   # |   |   |   time(self):      10.0
+  #   # |   |   |   time(childs):     0.0
+  #   # |   Rendering ->
+  #   # |   |   calls:              1
+  #   # |   |   time(all):        7.0
+  #   # |   |   time(self):       7.0
+  #   # |   |   time(childs):     0.0
+  class Wrap
+    # @return [Report] collected measurement data.
+    attr_reader :report
+
+    # @param name [String] report name
+    def initialize(name)
+      @name = name
+
+      @report = Report.new(@name)
+      @current_path = []
+    end
+
+    # Resets the {#report} to an empty state.
+    #
+    # @return [Wrap] self
+    def reset
+      @report = Report.new(@name)
+      @current_path = []
+
+      self
+    end
+
+    # Wraps code block with WALL time measurement and returns the block result.
+    #
+    # Can be used in a nested way.
+    #
+    # @example Simple measurement
+    #   wrap = Benchin::Wrap.new
+    #   wrap.call('Sum of strings') do
+    #     ['aa', 'bb', 'cc'].sum
+    #   end
+    #   #=> 'aabbcc'
+    #
+    # @example Nested measurement
+    #   wrap = Benchin::Wrap.new
+    #   wrap.call('Big calcultation') do
+    #     array = some_expensive_code
+    #     processed = array.map do |data|
+    #       wrap.call('Nested calcultation') do
+    #         some_tranformation(data)
+    #       end
+    #     end
+    #     send_somewhere(processed)
+    #   end
+    #
+    # @param name [String] name for code block in reporting.
+    # @yield code block to execute.
+    # @return result of provided block execution.
+    def call(name)
+      @current_path.push name
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      result = yield
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elapsed = ending - starting
+
+      report.add_time(@current_path, elapsed)
+      @current_path.pop
+
+      result
+    end
+
+    # Shortcut for `report.to_s`.
+    #
+    # @see {Report.to_s}
+    # @return [String]
+    def to_s
+      report.to_s
+    end
+
+    # Shortcut for `report.to_h`.
+    #
+    # @see {Report.to_s}
+    # @return [Hash]
+    def to_h
+      report.to_s
+    end
+  end
+end

data/lib/benchin/wrap/report.rb

@@ -0,0 +1,87 @@
+require_relative './report/node'
+require_relative './report/node_printer'
+
+module Benchin
+  class Wrap
+    # Represents tree-like time measurement data produced by {Wrap}.
+    #
+    # See {#to_h} method for more concrete example.
+    class Report
+      # @param name [String] report name
+      def initialize(name)
+        @root = Node::Virtual.new(name)
+      end
+
+      # Adds seconds to a {path} in a tree and increases calls count by 1.
+      #
+      # @param path [Array<String>] path in a report tree.
+      # @param seconds [Float] amount of total seconds spent in this call (including child calls).
+      #
+      # @return [Report] self
+      def add_time(path, seconds)
+        target_node = path.reduce(@root) do |node, name|
+          node.nested[name] ||= Node.new(name)
+        end
+
+        target_node.add_call(seconds)
+
+        self
+      end
+
+      # Transforms report to a basic ruby types: arrays and hashes.
+      #
+      # @example
+      #   report = Report.new('Report name')
+      #   report
+      #     .add_time(%w[TOP NESTED], 10.0)
+      #     .add_time(%w[TOP], 10.0)
+      #     .add_time(%w[TOP], 5.0)
+      #     .add_time(%w[NESTED], 7.0)
+      #     .to_h
+      #   # will produce following structure
+      #   {
+      #     name: 'Report name',
+      #     total_seconds: 22.0,
+      #     nested: [
+      #       {
+      #         name: 'TOP',
+      #         total_seconds: 15.0,
+      #         self_seconds: 5.0,
+      #         child_seconds: 10.0,
+      #         calls: 2,
+      #         nested: [
+      #           {
+      #             name: 'NESTED',
+      #             total_seconds: 10.0,
+      #             self_seconds: 10.0,
+      #             child_seconds: 0.0,
+      #             calls: 1,
+      #             nested: []
+      #           }
+      #         ]
+      #       },
+      #       {
+      #         name: 'NESTED',
+      #         total_seconds: 7.0,
+      #         self_seconds: 7.0,
+      #         child_seconds: 0.0,
+      #         calls: 1,
+      #         nested: []
+      #       }
+      #     ]
+      #   }
+      #
+      # @return [Hash] report represented using {Array}s and {Hash}es. It's safe to modify it.
+      def to_h
+        @root.to_h
+      end
+
+      # Renders human readable report.
+      #
+      # @return [String] human readable report with TTY colors
+      def to_s
+        NodePrinter.new(@root).to_s
+      end
+    end
+  end
+end

data/lib/benchin/wrap/report/node.rb

@@ -0,0 +1,75 @@
+module Benchin
+  class Wrap
+    class Report
+      # @api private
+      class Node
+        attr_reader :name
+        attr_reader :calls
+        attr_reader :total_seconds
+        attr_reader :nested
+
+        def initialize(name)
+          @name = name
+
+          @calls = 0
+          @total_seconds = 0.0
+          @nested = {}
+        end
+
+        def add_call(seconds)
+          @child_seconds = nil
+          @calls += 1
+          @total_seconds += seconds
+        end
+
+        def to_h
+          {
+            name: name,
+            calls: calls,
+            total_seconds: total_seconds,
+            self_seconds: self_seconds,
+            child_seconds: child_seconds,
+            nested: nested.values.map(&:to_h)
+          }
+        end
+
+        def self_seconds
+          total_seconds - child_seconds
+        end
+
+        def child_seconds
+          child_nodes = nested.values
+
+          @child_seconds ||= child_nodes.map(&:total_seconds).sum.to_f
+        end
+
+        # Virtual Node is a node without ability to track time in.
+        #
+        # It is designed to be used as container for nested nodes.
+        #
+        # @api private
+        class Virtual < Node
+          def total_seconds
+            child_seconds
+          end
+
+          def self_seconds
+            0.0
+          end
+
+          def add_time
+            raise 'Cannot add time to a virtual node'
+          end
+
+          def to_h
+            {
+              name: name,
+              total_seconds: total_seconds,
+              nested: nested.values.map(&:to_h)
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/benchin/wrap/report/node_printer.rb

@@ -0,0 +1,103 @@
+require 'rainbow'
+
+module Benchin
+  class Wrap
+    class Report
+      # Human readable {Node} printing.
+      #
+      # With TTY colors.
+      #
+      # @api private
+      class NodePrinter
+        FIELD_SPACE = 14
+        VALUE_SPACE = 7
+        PRECISION = 3
+
+        # @param node [Node] node to print
+        # @param level [Integer] defines current level of nesting
+        def initialize(node, level: 0)
+          @node = node
+          @level = level
+        end
+
+        # @return [String] rendered report
+        def to_s
+          [
+            (@node.is_a?(Node::Virtual) ? virtual_body : body),
+            @node.nested.values.map do |child_node|
+              self.class.new(child_node, level: @level + 1).to_s
+            end
+          ].flatten.join("\n")
+        end
+
+        private
+
+        def virtual_body
+          nav = '|   '
+          prefix = nav * @level
+
+          [
+            title,
+            nav + time_all
+          ].map { |line| prefix + line }.join("\n")
+        end
+
+        def body
+          nav = '|   '
+          prefix = nav * @level
+
+          [
+            title,
+            nav + calls,
+            nav + time_all,
+            nav + time_self,
+            nav + time_childs
+          ].map { |line| prefix + line }.join("\n")
+        end
+
+        def title
+          "#{Rainbow(@node.name).bright} ->"
+        end
+
+        def calls
+          'calls:'.ljust(FIELD_SPACE) +
+            Rainbow(
+              @node.calls
+                .to_s
+                .rjust(VALUE_SPACE)
+            ).blue
+        end
+
+        def time_all
+          'time(all):'.ljust(FIELD_SPACE) +
+            Rainbow(
+              @node.total_seconds
+                .truncate(PRECISION)
+                .to_s
+                .rjust(VALUE_SPACE)
+            ).green
+        end
+
+        def time_self
+          'time(self):'.ljust(FIELD_SPACE) +
+            Rainbow(
+              @node.self_seconds
+                .truncate(PRECISION)
+                .to_s
+                .rjust(VALUE_SPACE)
+            ).green.bright
+        end
+
+        def time_childs
+          'time(childs):'.ljust(FIELD_SPACE) +
+            Rainbow(
+              @node.child_seconds
+                .truncate(PRECISION)
+                .to_s
+                .rjust(VALUE_SPACE)
+            ).green
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,279 @@
+--- !ruby/object:Gem::Specification
+name: benchin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Kolesnev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: forspell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: inch
+  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'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  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'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
+- !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:
+- rvkolesnev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".mdlrc"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchin.gemspec
+- bin/console
+- bin/setup
+- forspell.dict
+- lefthook.yml
+- lib/benchin.rb
+- lib/benchin/version.rb
+- lib/benchin/wrap.rb
+- lib/benchin/wrap/report.rb
+- lib/benchin/wrap/report/node.rb
+- lib/benchin/wrap/report/node_printer.rb
+homepage: https://github.com/ffloyd/benchin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ffloyd/benchin
+  source_code_uri: https://github.com/ffloyd/benchin
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Benchmarking toolset for performance investigations.
+test_files: []