timmy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 378e5c010407e6580faf572a2978188f53ec39f0
+  data.tar.gz: 8c3dd12f56e273ee41a833245624921798ef8c0d
+SHA512:
+  metadata.gz: b2b47383177bbc8504e59536032cd2403dcf4c4677612017c9adecdb014d7bd9142e86bcd02e13cc308cac5356f9587301a9b0d5a426d44f59e8484991d6998a
+  data.tar.gz: 1fcdaff54247ee41a9fff01f76e27ec77f8fe7b34dd87a1b04204d316632bd0fa08fcfdfc0aca05656effc127b94fe79db47837dd491952e41f289997dad016a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.5

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Karol Słuszniak
+
+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,38 @@
+# Timmy
+
+**Time execution of command and its stages marked by console output.**
+
+This tool allows to measure how much an arbitrary command line tool spends on each stage of its execution as long as it prints lines to standard output to indicate when these stages start and end.
+
+## Installation
+
+Install the gem globally:
+
+    gem install timmy
+
+## Usage
+
+Pipe the output from any command to it, e.g. from `docker build`:
+
+    docker build . | timmy
+
+As the most basic means for timing, each line of command output will be prefixed by total time elapsed since `timmy` has started.
+
+In addition, `timmy` is capable of capturing and timing specific stages of command execution by matching the output against its meter definitions. For example, there's a built-in support provided for `docker build` which means that:
+
+- meter is started every time Docker outputs something like `Step 16/22 : RUN bundle`
+- meter is stopped when Docker outputs something like ` ---> 8912f93fa8a5` and `timmy` prints the duration of a Docker build step that has just finished
+
+In the end, `timmy` will also write the entire output to a log file in `/tmp` in order to make it easier to run a series of benchmarks and refer back to their results.
+
+## Configuration
+
+You can add your own meters by creating `~/.timmy.rb` like below:
+
+```ruby
+Timmy::Meters.add(:docker_build_step,
+  start_regex: /Step \d+\/\d+ : (?<title>.*)$/,
+  end_regex: / ---> [0-9a-f]{12}$/)
+```
+
+Note that `end_regex` is optional - if absent, previous meter instance will be stopped every time a new is started.

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 "timmy"
+
+# 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/exe/timmy

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'timmy'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: [COMMAND] | timmy"
+end.parse!
+
+Timmy::ConfigLoader.load()
+Timmy::Timer.new().consume_stdin()

data/lib/timmy/config_loader.rb

@@ -0,0 +1,14 @@
+module Timmy
+  class ConfigLoader
+    class << self
+      def load
+        home = Dir.home()
+        config = File.join(home, ".timmy.rb")
+
+        if File.exists?(config)
+          eval(File.read(config))
+        end
+      end
+    end
+  end
+end

data/lib/timmy/meters.rb

@@ -0,0 +1,24 @@
+module Timmy
+  class Meters
+    BUILTIN = {
+      docker_build_step: {
+        begin_regex: /Step \d+\/\d+ : (?<title>.*)$/,
+        end_regex: / ---> [0-9a-f]{12}$/
+      }
+    }
+
+    class << self
+      def add(key, begin_regex:, end_regex: nil)
+        meters[key] = { begin_regex: begin_regex, end_regex: end_regex }
+      end
+
+      def clone_all
+        Marshal.load(Marshal.dump(meters))
+      end
+
+      def meters
+        @meters ||= BUILTIN
+      end
+    end
+  end
+end

data/lib/timmy/timer.rb

@@ -0,0 +1,115 @@
+module Timmy
+  class Timer
+    def initialize
+      @start_time = current_time()
+      @output = ""
+      @meters = Meters.clone_all
+    end
+
+    def consume_stdin
+      STDIN.each_line do |line|
+        line.rstrip!
+
+        try_start_meters(line)
+        put_line(line)
+        try_end_meters(line)
+      end
+
+      end_all_meters()
+      finalize()
+    end
+
+    private
+
+    def try_start_meters(line)
+      @meters.each do |key, meter|
+        begin_regex = meter.fetch(:begin_regex)
+
+        if meter_start = line.match(begin_regex)
+          end_meter(key) if meter.has_key?(:start_time)
+
+          title = begin
+            meter_start[:title]
+          rescue IndexError
+            nil
+          end
+
+          meter.merge!({
+            start_time: current_time(),
+            title: title
+          })
+        end
+      end
+    end
+
+    def try_end_meters(line)
+      started_meters.each do |key, meter|
+        if (end_regex = meter[:end_regex]) && line.match?(end_regex)
+          end_meter(key)
+        end
+      end
+    end
+
+    def end_all_meters
+      started_meters.each do |key, _|
+        end_meter(key)
+      end
+    end
+
+    def end_meter(key)
+      meter = @meters.fetch(key)
+
+      start_time = meter.fetch(:start_time)
+      title = meter.fetch(:title)
+
+      log_line = key.to_s.upcase
+      log_line += " #{title}" if title
+
+      put_line(log_line, since: start_time, internal: true)
+
+      meter.delete(:start_time)
+      meter.delete(:title)
+    end
+
+    def put_line(line, since: @start_time, internal: false)
+      current_time_cached = current_time()
+
+      if internal
+        @output += "#{format_duration(current_time_cached - since)} #{line}\n"
+        puts "#{bold(format_duration(current_time_cached - since))} #{bold(line)}"
+      else
+        @output += "#{format_duration(current_time_cached - since)} | #{line}\n"
+        puts "#{feint(format_duration(current_time_cached - since))} #{line}"
+      end
+    end
+
+    def finalize
+      total_duration = current_time() - @start_time
+      suffix = "#{@start_time}+#{total_duration.round}"
+      log_filename = "/tmp/timmy-#{suffix}.log"
+
+      put_line("EOF > #{log_filename}", internal: true)
+      File.write(log_filename, @output)
+    end
+
+    def format_duration(duration)
+      sprintf("%d:%02d", duration / 60, duration % 60)
+    end
+
+    def bold(string)
+      "\e[0m\e[1m#{string}\e[0m"
+    end
+
+    def feint(string)
+      "\e[0m\e[2m#{string}\e[0m"
+    end
+
+    def current_time
+      Time.now().to_i()
+    end
+
+    def started_meters
+      @meters.select { |_, meter| meter.has_key?(:start_time) }
+    end
+  end
+end

data/lib/timmy/version.rb

@@ -0,0 +1,3 @@
+module Timmy
+  VERSION = "0.1.0"
+end

data/lib/timmy.rb

@@ -0,0 +1,4 @@
+require "timmy/config_loader"
+require "timmy/meters"
+require "timmy/timer"
+require "timmy/version"

data/timmy.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "timmy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "timmy"
+  spec.version       = Timmy::VERSION
+  spec.authors       = ["Karol Słuszniak"]
+  spec.email         = ["ksluszniak@gmail.com"]
+
+  spec.summary       = "Time execution of command and its stages marked by console output"
+  spec.homepage      = "https://github.com/karolsluszniak/timmy"
+  spec.license       = "MIT"
+
+  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", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: timmy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Słuszniak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-28 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+description: 
+email:
+- ksluszniak@gmail.com
+executables:
+- timmy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/timmy
+- lib/timmy.rb
+- lib/timmy/config_loader.rb
+- lib/timmy/meters.rb
+- lib/timmy/timer.rb
+- lib/timmy/version.rb
+- timmy.gemspec
+homepage: https://github.com/karolsluszniak/timmy
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Time execution of command and its stages marked by console output
+test_files: []