monotonik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc1fc625cd3b0f6876224b415d45adec4fbed8fa2732b19f54b38dd9928e56bc
+  data.tar.gz: 81aabdafb20d90144948e57ecdc3371eeb57011cac4ee980f25a8aefc4a924cb
+SHA512:
+  metadata.gz: aab9859dcfce8f099d78b4cc211e7adc5d6ab361a0206ec18970e7276817eebd5ea60743dec218da03624a241b979a0c0d9fd969c4546e39e5db0ac514fe64af
+  data.tar.gz: 5ac7470e77a8a4648fb56b7b12e0a09855134933d6540f473dfe59bcdc9475821115c907664de9661144feea4de17436b420911e4ce0e84ffa73cdb2ccd5dd4c

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+  - 2.5.7
+  - 2.6.0
+  - 2.6.5
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in monotonik.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    monotonik (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  monotonik!
+  rake (~> 13.0.0)
+  rspec (~> 3.9.0)
+  rubocop (~> 0.79.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Evgeny Garlukovich
+
+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,92 @@
+# Monotonik
+
+![Monotonik](https://raw.githubusercontent.com/evgenygarl/monotonik/master/logo.PNG)
+
+[![Gem Version](http://img.shields.io/gem/v/monotonik.svg)](https://rubygems.org/gems/monotonik) [![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/monotonik)](https://rubygems.org/gems/monotonik) [![Gem Total Downloads](http://ruby-gem-downloads-badge.herokuapp.com/monotonik?type=total)](https://rubygems.org/gems/monotonik)
+
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/evgenygarl/monotonik.svg?branch=master)](https://travis-ci.org/evgenygarl/monotonik)
+
+[Usually](https://github.com/search?utf8=%E2%9C%93&q=elapsed+time.now+language%3ARuby&type=Code), Ruby-developers measure elapsed time this way:
+
+```ruby
+t1 = Time.now
+# time consuming operation
+t2 = Time.now
+
+time_elapsed = t2 - t1
+```
+
+But this way of measuring has an important issue: `Time.now` doesn't move only forwards 🤷‍♂️ It can be changed manually by the system administrator. Or system time on your machine may be changed during syncing with [NTP](http://www.ntp.org/) server. You can read more about this issue [here](https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/).
+So, there is no guarantee that the new value returned by `Time.now` will be in the future, and the elapsed time calculated this way may be even a negative value 🤷‍♂️
+
+If you want to measure elapsed time the right way, you should use the *monotonic clock*. Each time you request the time of the monotonic clock, time since a specific event is returned: for example, on macOS, this event is the system boot. Ruby provides a method to receive the current value of system monotonic clocks:
+
+```ruby
+t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+# time consuming operation
+t2 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+time_elapsed = t2 - t1
+```
+
+In its turn, `monotonik` gem provides tiny wrappers over this functionality to avoid writing a lot of boilerplate code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monotonik'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install monotonik
+
+## Usage
+
+How to measure elapsed time using `monotonik`? Here is an example:
+
+```ruby
+start = Monotonik.clock_time
+# time consuming operation
+finish = Monotonik.clock_time
+
+elapsed = finish - start #=> 14.73181
+```
+
+In order to avoid writing such boilerplate code, you can use `Monotonik.measure` method:
+
+```ruby
+result = Monotonik.measure { factorial(100_000) } # time consuming operation
+
+result.value #=> very long number...
+result.time #=> => 6.43604
+```
+
+Both `Monotonik.clock_time` and `Monotonik.measure` methods receive type of the return clock time value as the only argument. It can be set to one of the following values:
+* `:float_second` - number of seconds as a float (by default)
+* `:float_millisecond` - number of milliseconds as a float
+* `:float_microsecond` - number of microseconds as a float
+* `:second` - number of seconds as an integer
+* `:millisecond` - number of milliseconds as an integer
+* `:microsecond` - number of microseconds as an integer
+* `:nanosecond` - number of nanoseconds as an integer
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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 `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/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/evgenygarl/monotonik.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'monotonik'
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/lib/monotonik.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Module to help measure elapsed time the right way.
+module Monotonik
+  autoload :ClockTime, 'monotonik/clock_time'
+  autoload :Measure,   'monotonik/measure'
+  autoload :TimeUnits, 'monotonik/clock_time'
+  autoload :VERSION,   'monotonik/version'
+
+  module_function
+
+  # @see Monotonik::ClockTime#now
+  def clock_time(unit = ClockTime::DEFAULT_TIME_UNIT)
+    ClockTime.now(unit)
+  end
+
+  # @see Monotonik::Measure#call
+  def measure(unit = ClockTime::DEFAULT_TIME_UNIT, &block)
+    Measure.call(unit, &block)
+  end
+end

data/lib/monotonik/clock_time.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module Monotonik
+  module TimeUnits
+    FLOAT_SECOND      = :float_second
+    FLOAT_MILLISECOND = :float_millisecond
+    FLOAT_MICROSECOND = :float_microsecond
+    SECOND            = :second
+    MILLISECOND       = :millisecond
+    MICROSECOND       = :microsecond
+    NANOSECOND        = :nanosecond
+
+    ALL = [FLOAT_SECOND, FLOAT_MILLISECOND, FLOAT_MICROSECOND, SECOND, MILLISECOND, MICROSECOND, NANOSECOND].freeze
+  end
+
+  # Class to get monotonic clock time.
+  class ClockTime
+    include Singleton
+
+    DEFAULT_TIME_UNIT = TimeUnits::FLOAT_SECOND
+
+    class << self
+      extend Forwardable
+
+      # @!method now(unit = DEFAULT_TIME_UNIT)
+      #   @see Monotonik::ClockTime#now
+      def_delegator :instance, :now
+    end
+
+    # Returns a monotonic clock time returned by POSIX ::clock_gettime() function.
+    #
+    # @param unit [Symbol] Specifies a type of the return value, can be any value from `Monotonik::TimeUnits::ALL`.
+    #
+    # @raise [ArgumentError] When unexpected 'unit' value is given.
+    #
+    # @return [Float|Integer] A monotonic clock time returned by POSIX ::clock_gettime() function.
+    def now(unit = DEFAULT_TIME_UNIT)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, unit)
+    end
+  end
+end

data/lib/monotonik/measure.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Monotonik
+  # Class to measure elapsed time.
+  class Measure
+    Result = Struct.new(:time, :value)
+
+    attr_reader :clock_time
+
+    class << self
+      extend Forwardable
+
+      # @return [Monotonik::Measure]
+      def instance
+        @instance ||= new
+      end
+
+      # @!method call(unit = Monotonik::TimeUnits::FLOAT_SECOND)
+      #   @see Monotonik::Measure#call
+      def_delegator :instance, :call
+    end
+
+    def initialize(clock_time: ClockTime)
+      @clock_time = clock_time
+    end
+
+    # Measure elapsed time while performing the given block.
+    #
+    # @param unit [Symbol] Specifies a type of the return elapsed time value, can be any value from
+    #   `Monotonik::TimeUnits::ALL`.
+    #
+    # @yield Block to measure elapsed time for.
+    #
+    # @return [Monotonik::Measure::Result] Elapsed time with result of the given block yield.
+    def call(unit = TimeUnits::FLOAT_SECOND)
+      raise ArgumentError, 'No block given.' unless block_given?
+
+      start = clock_time.now(unit)
+      result = yield
+      finish = clock_time.now(unit)
+
+      Result.new(finish - start, result)
+    end
+  end
+end

data/lib/monotonik/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Monotonik
+  VERSION = '0.1.0'
+end

data/monotonik.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/monotonik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'monotonik'
+  spec.version       = Monotonik::VERSION
+  spec.authors       = ['Evgeny Garlukovich']
+  spec.email         = ['me@evgenygarl.dev']
+
+  spec.summary       = '⏱ Measure elapsed time the right way.'
+  spec.description   = 'This gem helps you to measure elapsed time the right way - using monotonic clock.'
+  spec.homepage      = 'https://github.com/evgenygarl/elapsed'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  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.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 13.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: monotonik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgeny Garlukovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+description: This gem helps you to measure elapsed time the right way - using monotonic
+  clock.
+email:
+- me@evgenygarl.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- lib/monotonik.rb
+- lib/monotonik/clock_time.rb
+- lib/monotonik/measure.rb
+- lib/monotonik/version.rb
+- logo.PNG
+- monotonik.gemspec
+homepage: https://github.com/evgenygarl/elapsed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: "⏱ Measure elapsed time the right way."
+test_files: []