hop_timer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4beec7c726bc7c516cbf6f25978855f32399d7ba879c64d245b87f804694a49
+  data.tar.gz: b894a0d0620f99b73c78e3882f3b8313710bcab3f59dc76f08520beb704e6a0a
+SHA512:
+  metadata.gz: 680395a4a60eeea6f1d86a033c64c6b8b9ab4200efd1e17e159e8a755de08236b600a83828f0911464264ec144fab92fe6e60c56e498a3f078de099a0e34aae5
+  data.tar.gz: bd5fb0f816f495a6dfc1cdb81d49e493be2c94dbd3e770864b64f01623754f3b86495e985b34982441aa0491878fe6669bae4e5b0705ae543c5a1be78923bf07

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,41 @@
+inherit_from: .rubocop_todo.yml
+
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: true
+
+Style/MutableConstant:
+  Description: Freeze mutable constants.
+  Enabled: true
+
+Style/TrailingWhitespace:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Enabled: true
+  Max: 40
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 12
+
+Style/HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  Enabled: true
+  EnforcedStyle: ruby19_no_mixed_keys
+  UseHashRocketsWithSymbolValues: false
+  PreferHashRocketsForNonAlnumEndingSymbols: false
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 24 lines of code.'
+  Enabled: true
+  CountComments: false  # count full line comments?
+  Max: 24

data/.rubocop_todo.yml

@@ -0,0 +1,91 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-23 19:40:38 +0100 using RuboCop version 0.85.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'hop_timer.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'hop_timer.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'hop_timer.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingEmptyLines:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Exclude:
+    - 'test/hop_timer_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'hop_timer.gemspec'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'hop_timer.gemspec'
+    - 'lib/hop_timer.rb'
+    - 'lib/hop_timer/version.rb'
+    - 'test/hop_timer_test.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/hop_timer/version.rb'
+
+# Offense count: 57
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'hop_timer.gemspec'
+    - 'lib/hop_timer.rb'
+    - 'lib/hop_timer/version.rb'
+    - 'test/hop_timer_test.rb'
+    - 'test/test_helper.rb'

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      sunguralican@gmail.com
+    on_failure: change
+    on_success: never
+
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 asungur
+
+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,94 @@
+# HopTimer
+[![Build Status](https://travis-ci.com/asungur/hop_timer.svg?token=yG7xo2a5AcaKbqTNd23W&branch=master)](https://travis-ci.com/asungur/hop_timer)
+[![Gem Version](https://badge.fury.io/rb/hop_timer.svg)](https://badge.fury.io/rb/hop_timer)
+![HopTimer Demo](https://media.giphy.com/media/kG8P3arKGzpMphCfGC/source.gif)
+
+HopTimer is a user friendly benchmarking gem that works as a wrapper for Ruby's default benchmark utility. If you are frequently using benchmark and looking for a more intuitive solution or even planning to start benchmarking in general, HopTimer is for you.
+
+HopTimer uses **check points** and evaluates the runtime between two. As you develop your application define instances of check points and evaluate them whenever you want.
+
+## **Installation**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hop_timer'
+```
+
+And then execute:
+
+```ruby
+$ bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install hop_timer
+```
+
+## **Usage**
+
+Once **HopTimer** is installed on your machine, `require` the gem.
+
+```ruby
+require 'hop_timer'
+```
+
+`HopTimer.eval` calculates the runtime between the instances of `HopTimer::CheckPoint` . It logs a table to the console and provides the same values in a form of hash.
+
+```ruby
+flag1 = HopTimer::CheckPoint.new('flag1')
+
+sleep 1.2 # OPERATIONS THAT YOU WANT TO BENCHMARK HERE
+
+flag2 = HopTimer::CheckPoint.new('flag2')
+
+HopTimer.eval(flag1, flag2) 
+# RETURNS => 
+{"user"=>"0.000022",
+"system"=>"0.000045",
+"total"=>"0.000067",
+"real"=>"1.201469"}
+
+# LOGS TO THE CONSOLE =>
+=============Runtime between flag1 and flag2=============
+┌-------------┬-------------┬-------------┬-------------┐
+|    user     |   system    |    total    |    real     |
+├-------------┼-------------┼-------------┼-------------┤
+|  0.000022   |  0.000045   |  0.000067   | 1.201469(s) |
+└-------------┴-------------┴-------------┴-------------┘
+```
+
+The table breakdowns the runtime as [CPU time](https://en.wikipedia.org/wiki/CPU_time)(user time, system time) and [real time](https://ruby-doc.org/core-2.6.3/Time.html) in seconds. HopTimer uses [Process](https://ruby-doc.org/core-2.6.1/Process.html) and [Benchmark::Tms](https://ruby-doc.org/stdlib-2.4.0/libdoc/benchmark/rdoc/Benchmark/Tms.html) for the calculation.
+
+The values provided with the returned hash can be specified as floats or strings(default).
+
+```ruby
+HopTimer.eval(flag1, flag2, :string)
+{"user"=>"0.000022",
+"system"=>"0.000045",
+"total"=>"0.000067",
+"real"=>"1.201469"}
+
+HopTimer.eval(flag1, flag2, :float) # OR
+HopTimer.eval(flag1, flag2, :number)
+{"user"=>3.9e-11,
+"system"=>2.5e-11,
+"total"=>6.4e-11,
+"real"=>1.201488e-06}
+```
+
+## **Development**
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 [https://github.com/asungur/hop_timer](https://github.com/%5BUSERNAME%5D/hop_timer).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hop_timer"
+
+# 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/hop_timer.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hop_timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hop_timer"
+  spec.version       = HopTimer::VERSION
+  spec.authors       = ["Alican Sungur"]
+  spec.email         = ["sunguralican@gmail.com"]
+
+  spec.summary       = "A tool that measures runtime between checkpoints"
+  spec.description   = "A ruby gem that calculates runtime between user defined checkpoints."
+  spec.homepage      = "https://github.com/asungur/hop_timer"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency 'coveralls'
+end

data/lib/hop_timer.rb

@@ -0,0 +1,172 @@
+require "hop_timer/version"
+require 'benchmark'
+
+module HopTimer
+  TITLES = "user system total real".split(' ').freeze
+  TIME_VALUES = %i[string number float].freeze
+  TABLE_ELEMENTS = {
+    top_center: "┬",
+    top_right: "┐",
+    mid_center: "┼",
+    mid_right: "┤",
+    bot_center: "┴",
+    bot_right: "┘",
+
+    top_divider: '┌',
+    top_row: "|",
+    mid_divider: "├",
+    bot_row: "|",
+    bot_divider: "└"
+  }.freeze
+
+  class CheckPoint
+    attr_reader :name, :r_time, :u_time, :s_time, :cu_time, :cs_time
+
+    def initialize(name)
+      name_validation(name)
+
+      @name = name
+      p_times = Process.times
+      @r_time = Time.now
+      @u_time = p_times.utime
+      @s_time = p_times.stime
+      @cu_time = p_times.cutime
+      @cs_time = p_times.cstime
+    end
+
+    def -(other)
+      time_diff_set = {}
+
+      time_diff_set[:r_diff] = r_time - other.r_time
+      time_diff_set[:u_diff] = u_time - other.u_time
+      time_diff_set[:s_diff] = s_time - other.s_time
+      time_diff_set[:cu_diff] = cu_time - other.cu_time
+      time_diff_set[:cs_diff] = cs_time - other.cs_time
+
+      time_diff_set.each { |key, val| time_diff_set[key] = val.abs }
+    end
+
+    private
+
+    def name_validation(name)
+      error_message = "Use alphanumeric and underscore characters only"
+      invalid_name = ArgumentError.new(error_message)
+      raise invalid_name unless valid_name?(name)
+    end
+
+    def valid_name?(name)
+      name == name.gsub(/[^a-z0-9_]/, '')
+    end
+  end
+
+  def self.eval(check_point1, check_point2, time_value = :string)
+    time_value_validation(time_value)
+
+    time_diff = check_point1 - check_point2
+
+    udiff = time_diff[:u_diff]
+    sdiff = time_diff[:s_diff]
+    cudiff = time_diff[:cu_diff]
+    csdiff = time_diff[:cs_diff]
+    realdiff = time_diff[:r_diff]
+
+    report = Benchmark::Tms.new(udiff, sdiff, cudiff, csdiff, realdiff).to_s
+
+    values = report_to_values(report)
+
+    log_table(values, check_point1.name, check_point2.name)
+
+    times_to_hash(values, time_value)
+  end
+
+  def self.time_value_validation(value_type)
+    error_message = "time value can be :string or :float/:number"
+    new_error = ArgumentError.new(error_message)
+
+    raise new_error unless TIME_VALUES.include?(value_type)
+  end
+
+  def self.log_table(times, name1, name2)
+    max_width = (times.map(&:length).max + 2)
+    title = set_title(name1, name2, max_width)
+
+    top_divider = TABLE_ELEMENTS[:top_divider]
+    top_row = TABLE_ELEMENTS[:top_row]
+    mid_divider = TABLE_ELEMENTS[:mid_divider]
+    bot_row = TABLE_ELEMENTS[:bot_row]
+    bot_divider = TABLE_ELEMENTS[:bot_divider]
+
+    times.each_with_index do |val, i|
+      top_divider << ("-" * max_width)
+      mid_divider << ("-" * max_width)
+      bot_divider << ("-" * max_width)
+
+      if i == (times.length - 1)
+        top_divider << TABLE_ELEMENTS[:top_right]
+        mid_divider << TABLE_ELEMENTS[:mid_right]
+        bot_divider << TABLE_ELEMENTS[:bot_right]
+      else
+        top_divider << TABLE_ELEMENTS[:top_center]
+        mid_divider << TABLE_ELEMENTS[:mid_center]
+        bot_divider << TABLE_ELEMENTS[:bot_center]
+      end
+
+      top_row << TITLES[i].center(max_width) + "|"
+      bot_row << val.center(max_width) + "|"
+    end
+
+    log_and_enter(title, top_divider, top_row, mid_divider, bot_row, bot_divider)
+  end
+
+  def self.set_title(name1, name2, width)
+    message = "Runtime between #{name1} and #{name2}"
+    width = (width * 4) + 5
+
+    message.center(width, "=")
+  end
+
+  def self.log_and_enter(*lines)
+    lines.each { |line| puts line + "\n" }
+  end
+
+  def self.report_to_values(report)
+    values = report.to_s.gsub(/(\(|\))/, '').split(' ')
+
+    values[-1] = values[-1] + "(s)"
+
+    values
+  end
+
+  def self.times_to_hash(times, value_type)
+    times_hash = {}
+
+    TITLES.each_with_index do |title, i|
+      val = i == (TITLES.length - 1) ? times[i][0..-4] : times[i]
+
+      output_val = case value_type
+                   when :string
+                     val
+                   else
+                     str_to_float(val)
+                   end
+
+      times_hash[title] = output_val
+    end
+
+    times_hash
+  end
+
+  def self.str_to_float(str)
+    str.to_f / 1_000_000
+  end
+
+  private_constant :TITLES, :TIME_VALUES, :TABLE_ELEMENTS
+
+  private_class_method :time_value_validation,
+                       :log_table,
+                       :log_and_enter,
+                       :report_to_values,
+                       :times_to_hash,
+                       :str_to_float,
+                       :set_title
+end

data/lib/hop_timer/version.rb

@@ -0,0 +1,3 @@
+module HopTimer
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: hop_timer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alican Sungur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: coveralls
+  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: A ruby gem that calculates runtime between user defined checkpoints.
+email:
+- sunguralican@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hop_timer.gemspec
+- lib/hop_timer.rb
+- lib/hop_timer/version.rb
+homepage: https://github.com/asungur/hop_timer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/asungur/hop_timer
+  source_code_uri: https://github.com/asungur/hop_timer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A tool that measures runtime between checkpoints
+test_files: []