etalon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fb791760ce141b660f228dde7b375ab1cc8da1517bfb73037a5f62fa131f688
+  data.tar.gz: 38d7da2d8215dc9e4dc4588247295a953c3130729a621e537b6dc607617a40f0
+SHA512:
+  metadata.gz: e46a28737336f6c99d0e97c218a2c66913b9cee61e34fccaed6d531dcd6bd8ba1ca5141a567a189ae4637203705ac0091aebfb3fe31c1e89d67469dae0f0f64a
+  data.tar.gz: 55270db263194c75f3afcb0bb4ea7ab1e3fdedb67197a72234e80f7f401b53026496602468a075d303b7510c9b5cab37098cde48c0629f47d6b562c323b09bf1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+*.gem
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.standard.yml

@@ -0,0 +1,6 @@
+ignore:
+  - '**/*.rb':
+    - Layout/SpaceInsideHashLiteralBraces
+    - Layout/SpaceInsideArrayLiteralBrackets
+    - Layout/SpaceAroundOperators
+    - Standard/SemanticBlocks

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.6.1
+- 2.5.3
+- 2.4.2
+- 2.3.8
+- 2.2.10
+- jruby
+- truffleruby

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 0.1.0 - October 31, 2018
+### Added
+- `Etalon.time` method which accepts a string title as its first argument
+and a block argument which will store calls matching the same title and
+compare their minimum, maximum, and average execution time but also the
+standard deviation from that average, the 5 slowest timings, and the
+iteration count.
+- `Etalon.print_timings` method which returns a Hash of the above metrics
+for all blocks of instrumented code and logs one line per unique `Etalon.time`
+title in either the `Rails.logger` or a `Syslog::Logger` instance.
+- `Etalon.active?` to check whether Etalon is... activated. Meaning whether it
+is recording metrics or simply yielding to the block of code supplied to
+`Etalon.time` without doing anything.
+- `Etalon.activate` to make the `ETALON_ACTIVE` environment variable truthy,
+which will cause `Etalon.active?` to return `true`.
+- `Etalon.deactivate` to make the `ETALON_ACTIVE` environment variable falsey,
+which will cause `Etalon.active?` to return `false`.
+
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.1.0...HEAD

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+After checking out the repo, run `bin/setup` to install dependencies.
+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).

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in etalon.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    etalon (0.1.0)
+      activesupport (> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    standard (0.0.26)
+      rubocop (>= 0.63)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  etalon!
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  standard (~> 0.0)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Olivier Lacan
+
+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,79 @@
+# Etalon [![Build Status][ci-badge]][ci-url]
+
+A simple tool to instrument Ruby code and output basic metrics to a
+logger or store them in a hash.
+
+From the French noun `étalon` meaning:
+> standard: something used as a measure for comparative evaluations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'etalon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install etalon
+
+In that last case, you'll need to manually `require "etalon"`.
+
+## Usage
+
+Assuming the following instrumented code:
+
+```ruby
+  class Cooking
+    def self.potato
+      Etalon.time("Making taters") do
+        peel_potato
+        cook_potato
+      end
+    end
+  end
+```
+
+You can do the following:
+
+```
+$ irb
+require "cooking"
+=> true
+
+Etalon.activate
+=> true
+
+Etalon.print_timings
+=> {:making_taters=>["count: 1", "min: 0", "max: 400", "mean: 400.0", "deviation: 0.0", "top 5: [400]"]}
+```
+
+If `Rails.logger` is available, Etalon will also output the following with
+a call to `Rails.logger.debug` in the relevant log file:
+
+```
+Making Taters - count: 1 | min: 0 | max: 400 | mean: 400.0 | deviation: ±0.0% | top 5: [400]
+```
+
+If `Rails.logger` isn't available, Etalon attempts to require
+[`syslog/logger`][syslog-logger] from the Ruby standard library as a fallback
+logging mechanism.
+
+[syslog-logger]: https://www.rubydoc.info/stdlib/syslog/2.3.1/Syslog/Logger
+
+## Contributing
+
+[Bug reports][bugs] and [pull requests][pulls] are welcome.
+
+See [contribution guidelines][contributions].
+
+[bugs]: https://github.com/olivierlacan/etalon/issues
+[pulls]: https://github.com/olivierlacan/etalon/pulls
+[contributions]: https://github.com/olivierlacan/etalon/blob/master/CONTRIBUTING.md
+[ci-badge]: https://travis-ci.org/olivierlacan/etalon.svg?branch=master
+[ci-url]: https://travis-ci.org/olivierlacan/etalon

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

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

@@ -0,0 +1,43 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "etalon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "etalon"
+  spec.version       = Etalon::VERSION
+  spec.licenses      = ["MIT"]
+  spec.authors       = ["Olivier Lacan"]
+  spec.email         = ["hi@olivierlacan.com"]
+
+  spec.summary       = "A very simple tool to instrument Ruby code"
+  spec.description   = '
+    A very simple tool to instrument Ruby code and output basic metrics to a
+    logger or store them in a hash.
+  '.split.join(" ")
+  spec.homepage = "https://github.com/olivierlacan/etalon"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  end
+
+  # 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.metadata["yard.run"] = "yri"
+
+  spec.add_dependency "activesupport", "> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "standard", "~> 0.0"
+end

data/lib/etalon.rb

@@ -0,0 +1,167 @@
+require "etalon/version"
+require "active_support/inflector"
+
+# Etalon is a simple tool to instrument Ruby code and output basic
+# metrics to a logger or store them in a hash.
+module Etalon
+  class << self
+    #
+    # @return [Boolean] whether Etalon is active and recording metrics.
+    def active?
+      # rubocop:disable Style/DoubleNegation
+      !!ENV["ETALON_ACTIVE"]
+      # rubocop:enable Style/DoubleNegation
+    end
+
+    # Runs timing metrics on the supplied block of code and stores those metrics
+    # for later logging or analysis using the supplied @identifier.
+    #
+    #
+    # @param identifier [String] A unique identifier used to store calls to
+    #  the supplied block and report them later.
+    # @return the supplied block's return value
+    def time(identifier)
+      if active?
+        unless block_given?
+          raise "Please supply a block of code for Etalon to instrument"
+        end
+
+        start = Time.now
+
+        return_value = yield
+
+        duration = elapsed(start)
+
+        key = key_from(identifier: identifier)
+        store = instrument_store_for(key: key)
+
+        store[:count] += 1
+        store[:min] = duration if duration < store[:min]
+        store[:max] = duration if duration > store[:max]
+        store[:all] << duration
+
+        return_value
+      else
+        yield
+      end
+    end
+
+    #
+    # Uses either Rails.logger or a Syslog::Logger instance to print out
+    # iteration count, minimum, maximum, average and standard deviation
+    # timings for each individual call instrumented by #time.
+    #
+    # @return [Hash] all stored metrics indexed by identifier
+    def print_timings
+      if active?
+        instrument_store.each_with_object({}) do |(key, metrics), memo|
+          count, min, max, all = metrics.values_at(:count, :min, :max, :all)
+          top = all.sort.reverse.take(5)
+          mean = mean(all).floor(2)
+          deviation = standard_deviation(all).floor(2)
+
+          title = key.to_s.titleize
+
+          output = [
+            "count: #{count}",
+            "min: #{min}",
+            "max: #{max}",
+            "mean: #{mean}",
+            "deviation: ±#{deviation}%",
+            "top 5: #{top}",
+          ]
+
+          logger.debug("#{title} - #{output.join(" | ")}")
+
+          memo[key] = output
+        end
+      end
+    end
+
+    #
+    # Resets Etalon's internal storage to remove all stored timings.
+    #
+    # @return [type] [description]
+    def reset_timings
+      @instrument_store = nil
+    end
+
+    #
+    # Activates Etalon.
+    #
+    # @return [Boolean] Etalon's current activation status
+    def activate
+      !!ENV["ETALON_ACTIVE"] = "true"
+    end
+
+    #
+    # Deactivates Etalon.
+    #
+    # @return [Boolean] Etalon's current activation status
+    def deactivate
+      !!ENV["ETALON_ACTIVE"] = nil
+    end
+
+    private
+
+    def instrument_store
+      @instrument_store ||= {}
+    end
+
+    def instrument_store_for(key:)
+      instrument_store[key] ||= {
+        count: 0,
+        min: Float::INFINITY,
+        max: 0,
+        all: [],
+      }
+    end
+
+    def key_from(identifier:)
+      parameterize(identifier, separator: "_").to_sym
+    end
+
+    def elapsed(start)
+      ((Time.now - start) * 1000).floor
+    end
+
+    def mean(samples)
+      (samples.sum / samples.length.to_f)
+    end
+
+    def square(number)
+      number ** 2
+    end
+
+    def variance(samples)
+      return 0 if samples.length < 2
+
+      sum = samples.inject(0) do |store, value|
+        store + square(value - mean(samples))
+      end
+
+      sum.fdiv((samples.length - 1).to_f)
+    end
+
+    def standard_deviation(samples)
+      return 0 if samples.length < 2
+
+      Math.sqrt(variance(samples))
+    end
+
+    def logger
+      @logger ||= begin
+        if defined?(Rails.logger)
+          Rails.logger
+        else
+          require("syslog/logger")
+          Syslog::Logger.new
+        end
+      end
+    end
+
+    def parameterize(*args)
+      ActiveSupport::Inflector.parameterize(*args)
+    end
+  end
+end

data/lib/etalon/version.rb

@@ -0,0 +1,3 @@
+module Etalon
+  VERSION = "0.1.0" #:no-doc
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: etalon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Olivier Lacan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: A very simple tool to instrument Ruby code and output basic metrics to
+  a logger or store them in a hash.
+email:
+- hi@olivierlacan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- etalon.gemspec
+- lib/etalon.rb
+- lib/etalon/version.rb
+homepage: https://github.com/olivierlacan/etalon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/olivierlacan/etalon
+  source_code_uri: https://github.com/olivierlacan/etalon
+  changelog_uri: https://github.com/olivierlacan/etalon/blob/master/CHANGELOG.md
+  yard.run: yri
+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.2
+signing_key: 
+specification_version: 4
+summary: A very simple tool to instrument Ruby code
+test_files: []