multi_measure 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85c1f833335aceab867050b604697ddddc6ea51553b008c93c204a17edb8d5a5
+  data.tar.gz: dcd90263d5a7c4893b3f22f708dad1c03e249d7a93e129bf7c2cc050dcf17df8
+SHA512:
+  metadata.gz: 7b92a03ac6a094c2136aa61e4c63ce6e9f2572f24c5a1880e2e0f037521cd0fd7533c017ed366d94602d2785816b1778d35535993959c3f0a2d495553d0c4d3b
+  data.tar.gz: 1f195cab27258836d41bd379126b706269aa01f39cbf2580443deb20c35efd11a255fce5a7c2a711939fa96dce45d71733a234854a16bcfe9bff6feba60f7d31

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

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 multi_measure.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    multi_measure (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    takes_macro (1.0.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4.0.0)
+  bundler (~> 2.1.0)
+  minitest (~> 5.0)
+  multi_measure!
+  rake (~> 10.0)
+  takes_macro (~> 1.0)
+
+BUNDLED WITH
+   2.1.0

data/README.md

@@ -0,0 +1,3 @@
+# MultiMeasure
+
+![ci badge](https://github.com/tonsser/multi_measure/workflows/Ruby/badge.svg "ci badge")

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 "multi_measure"
+
+# 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/lib/multi_measure.rb

@@ -0,0 +1,147 @@
+require "multi_measure/version"
+require "multi_measure/thread_safe_hash"
+require "multi_measure/math_helpers"
+require "multi_measure/null_measurer"
+require "multi_measure/middleware"
+require "multi_measure/macros"
+require "multi_measure/measurement_state"
+require "benchmark"
+require "multi_measure/config"
+
+class MultiMeasure
+  class << self
+    def configure
+      yield config
+      @config = config
+    end
+
+    def default_config
+      MultiMeasure::Config.build_from(
+        output_prefix: "MULTI_MEASURE_TOTAL",
+        write_to: STDOUT,
+        middleware: {
+          env_var: "MULTI_MEASURE_ENABLED"
+        }
+      )
+    end
+
+    def set_default_config
+      @config = default_config
+    end
+
+    def config
+      @config ||= default_config
+    end
+
+    def start
+      Thread.current[STORE_KEY] = new
+    end
+
+    def reset
+      Thread.current[STORE_KEY] = nil
+    end
+
+    def done
+      instance.print_all_measurements
+      reset
+    end
+
+    def track_measurements
+      start
+      yield.tap { done }
+    end
+
+    def current_measurements
+      instance.current_measurements
+    end
+
+    def measure(*names, &block)
+      instance.measure(*names, &block)
+    end
+
+    private
+
+    STORE_KEY = :multi_measure_thread
+
+    def instance
+      Thread.current.fetch(STORE_KEY) { NullMeasurer.new }
+    end
+  end
+
+  def initialize
+    @measurements = ThreadSafeHash.new
+  end
+
+  def measure(*names)
+    return_value = nil
+
+    state = MeasurementState.new
+
+    time = Benchmark.realtime do
+      return_value = yield state
+    end
+
+    if state.track_measurement?
+      names.each do |name|
+        measurements[name] ||= []
+        measurements[name] << time
+      end
+    end
+
+    return_value
+  end
+
+  def current_measurements
+    measurements.to_normal_hash
+  end
+
+  def print_all_measurements
+    longest_key_length = 0
+    measurements.each do |key, _value|
+      if key.length > longest_key_length
+        longest_key_length = key.length
+      end
+    end
+
+    longest_time_length = 0
+    measurements.each do |_key, times|
+      length = to_ms(times.sum).to_s.length
+      if length > longest_time_length
+        longest_time_length = length
+      end
+    end
+
+    sorted_measurements = measurements.sort_by { |_key, times| times.sum }
+    sorted_measurements.each do |key, times|
+      key = key.rjust(longest_key_length)
+      time = to_ms(times.sum).to_s.rjust(longest_time_length)
+
+      std = MathHelpers.standard_deviation(times.map { |t| to_ms(t) }).round(2)
+      extra_info = "(+/- #{std}ms, #{times.size} calls)"
+
+      write_to_io "#{key} #{time}ms #{extra_info}"
+    end
+  end
+
+  private
+
+  attr_reader :measurements
+
+  def write_to_io(message)
+    message = "#{config.output_prefix} #{message}"
+
+    if config.write_to.respond_to?(:debug)
+      config.write_to.debug(message)
+    else
+      config.write_to.puts(message)
+    end
+  end
+
+  def config
+    self.class.config
+  end
+
+  def to_ms(seconds)
+    (seconds * 1_000).round(1)
+  end
+end

data/lib/multi_measure/config.rb

@@ -0,0 +1,22 @@
+require "active_support/ordered_options"
+
+class MultiMeasure
+  module Config
+    class << self
+      def build_from(hash)
+        config = ActiveSupport::OrderedOptions.new
+
+        hash.each do |key, value|
+          case value
+          when Hash
+            config[key] = build_from(value)
+          else
+            config[key] = value
+          end
+        end
+
+        config
+      end
+    end
+  end
+end

data/lib/multi_measure/macros.rb

@@ -0,0 +1,26 @@
+require "active_support/concern"
+
+class MultiMeasure
+  module Macros
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def multi_measure(*methods)
+        methods.each do |method|
+          method = method.to_s
+
+          aliased_name = "__multi_measure_original_#{method}__"
+          alias_method aliased_name, method
+
+          measure_key = "#{self.name}##{method}"
+
+          define_method(method) do |*args|
+            MultiMeasure.measure(measure_key) do
+              send(aliased_name, *args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/multi_measure/math_helpers.rb

@@ -0,0 +1,23 @@
+class MultiMeasure
+  # Copied from https://stackoverflow.com/questions/7749568/how-can-i-do-standard-deviation-in-ruby
+  module MathHelpers
+    def self.sum(a)
+      a.inject(0){ |accum, i| accum + i }
+    end
+
+    def self.mean(a)
+      sum(a) / a.length.to_f
+    end
+
+    def self.sample_variance(a)
+      m = mean(a)
+      sum = a.inject(0){ |accum, i| accum + (i - m) ** 2 }
+      sum / (a.length - 1).to_f
+    end
+
+    def self.standard_deviation(a)
+      return 0.0 if a.length < 2
+      Math.sqrt(sample_variance(a))
+    end
+  end
+end

data/lib/multi_measure/measurement_state.rb

@@ -0,0 +1,15 @@
+class MultiMeasure
+  class MeasurementState
+    def initialize
+      @track_measurement = true
+    end
+
+    def ignore_measurement
+      @track_measurement = false
+    end
+
+    def track_measurement?
+      @track_measurement
+    end
+  end
+end

data/lib/multi_measure/middleware.rb

@@ -0,0 +1,21 @@
+class MultiMeasure
+  class Middleware
+    def self.enabled?
+      ENV[MultiMeasure.config.middleware.env_var] != "false"
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if self.class.enabled?
+        MultiMeasure.track_measurements do
+          MultiMeasure.measure("request") { @app.call(env) }
+        end
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/multi_measure/null_measurer.rb

@@ -0,0 +1,13 @@
+class MultiMeasure
+  class NullMeasurer
+    def measure(*)
+      yield
+    end
+
+    def current_measurements(*)
+      {}
+    end
+
+    def print_all_measurements(*); end
+  end
+end

data/lib/multi_measure/thread_safe_hash.rb

@@ -0,0 +1,26 @@
+class MultiMeasure
+  class ThreadSafeHash
+    def initialize
+      @mutex = Mutex.new
+      @hash = {}
+    end
+
+    def [](key)
+      @mutex.synchronize { @hash[key] }
+    end
+
+    def []=(key, value)
+      @mutex.synchronize { @hash[key] = value }
+    end
+
+    include Enumerable
+
+    def each(&block)
+      @mutex.synchronize { @hash.each(&block) }
+    end
+
+    def to_normal_hash
+      @mutex.synchronize { @hash.dup }
+    end
+  end
+end

data/lib/multi_measure/version.rb

@@ -0,0 +1,3 @@
+class MultiMeasure
+  VERSION = "0.1.1"
+end

data/multi_measure.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "multi_measure/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_measure"
+  spec.version       = MultiMeasure::VERSION
+  spec.authors       = ["David Pedersen"]
+  spec.email         = ["david.pdrsn@gmail.com"]
+  spec.licenses      = ['Nonstandard']
+
+  spec.summary       = %q{Useful for measuring blocks of code execution time.}
+  spec.description   = %q{Useful for measuring blocks of code execution time.}
+  spec.homepage      = "http://github.com/tonsser/multi_measure"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.1.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "takes_macro", "~> 1.0"
+  spec.add_development_dependency 'activesupport', '~> 4.0', '>= 4.0.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: multi_measure
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Pedersen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.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: 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: takes_macro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Useful for measuring blocks of code execution time.
+email:
+- david.pdrsn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multi_measure.rb
+- lib/multi_measure/config.rb
+- lib/multi_measure/macros.rb
+- lib/multi_measure/math_helpers.rb
+- lib/multi_measure/measurement_state.rb
+- lib/multi_measure/middleware.rb
+- lib/multi_measure/null_measurer.rb
+- lib/multi_measure/thread_safe_hash.rb
+- lib/multi_measure/version.rb
+- multi_measure.gemspec
+homepage: http://github.com/tonsser/multi_measure
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Useful for measuring blocks of code execution time.
+test_files: []