clocker 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 241d80d7ab828ad458f5e1f76b583c787c3c392361ecb419d7e1218d08e58816
+  data.tar.gz: dce67fae4400fc505d7f8e3716fcc3e66af171e1962b18e6fcac59e498b87317
+SHA512:
+  metadata.gz: cf9d4a93c56a0c68556dd7a8f628a1bd5452f2c0ca8b31fc20a5961aa58e64eeda35393fcf3a7c8699280fda684809eef334a8d7759a9eb486e6445ffc3efd39
+  data.tar.gz: 48484f36c1e403cf479f5dd429703172ac5ab44c9bd33fd46d91d13ddb7ee3783566cbf55227046309dc64c3f880d6aa6f91e7a0187a39ddb0014ea03bf2ed9f

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Chadwick
+
+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,95 @@
+# Clocker
+
+[![Gem Version](https://badge.fury.io/rb/clocker.svg)](http://badge.fury.io/rb/clocker)
+
+A simple RubyGem that reports how long a specific Ruby command or block of code takes to run.
+
+## Usage
+### Command Line
+Simply run `clocker` followed by a command or block of code. Add an `-m` before the command or block to print out start and end times.
+
+Ex. 1
+```
+$ clocker "puts 'hi'"
+hi
+Clocked at 0 mins, 0 secs, 0 ms
+```
+
+Ex. 2
+```
+$ clocker "2.times { puts 'hello world'; sleep(0.6) }"
+hello world
+hello world
+
+Clocked at 0 mins, 1 secs, and 210 ms
+```
+
+Ex. 3
+```
+$ clocker -m "1.upto(5) { |i| print i+1; sleep(0.4) }"
+start: 2015-08-18 16:16:47 -0700
+23456
+ended: 2015-08-18 16:16:49 -0700
+
+Clocked at 0 mins, 2 secs, and 12 ms
+```
+
+### Gem Library
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clocker'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install clocker
+```
+
+Sample code block:
+```ruby
+>> clocker = Clocker.new
+>> clocker.clock do
+>>  # code here
+>> end
+```
+
+By default, clocker will not print out the start time before the command|block, or the end time after the command|block, unless you pass the instance `show_messages: true`.
+
+```ruby
+>> c1 = Clocker.new
+>> duration = c1.clock do
+>>  3.times { print 'c1'; sleep(1) }
+>> end
+>> puts
+>> puts duration
+
+c1c1c1
+{:mins=>0, :secs=>3, :ms=>13}
+```
+
+```ruby
+>> c2 = Clocker.new(show_messages: true)
+>> duration = c2.clock do
+>>  3.times { print 'c2'; sleep(1) }
+>> end
+>> puts duration
+
+start: 2015-08-18 16:07:17 -0700
+c2c2c2
+ended: 2015-08-18 16:07:20 -0700
+{:mins=>0, :secs=>3, :ms=>14}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/michaelchadwick/clocker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/clocker

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/clocker'
+require_relative '../lib/clocker/version'
+
+BINARY_NAME = $PROGRAM_NAME.split('/').last
+
+def parse_options
+  options = {
+    show_messages: false
+  }
+
+  optparse = OptionParser.new do |opts|
+    opts.banner = "Calculate how long a command or block of code takes to run\n"
+    opts.banner += "usage: #{BINARY_NAME} COMMAND|BLOCK\n"
+
+    opts.on('-m', '--message', 'Show start and ended messages') do |m|
+      options[:show_messages] = m
+    end
+
+    opts.on('-v', '--version', 'Display version number and exit') do
+      puts "#{Clocker::VERSION}"
+      exit
+    end
+
+    opts.on('-h', '-?', '--help', 'Display this screen and exit') do
+      puts opts
+      exit
+    end
+  end
+
+  optparse.parse!()
+
+  return options
+end
+
+def print_error(error)
+  case error
+  when OptionParser::InvalidOption
+    puts "#{BINARY_NAME} ERROR: illegal option #{error.args.join(' ')}"
+  else
+    puts "#{BINARY_NAME} ERROR: #{error}"
+  end
+end
+
+begin
+  options = parse_options
+
+  if (ARGV.count > 0)
+    command = ARGV.join(" ")
+    c = Clocker.new(options)
+    t = c.clock { eval(command) }
+    puts
+    puts "Clocked at #{t[:mins]} mins, #{t[:secs]} secs, and #{t[:ms]} ms"
+  else
+    puts "#{BINARY_NAME} ERROR: missing command or block"
+  end
+rescue => error
+  print_error(error)
+  exit(false)
+end

data/clocker.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clocker/version'
+
+Gem::Specification.new do |spec|
+  spec.name            = 'clocker'
+  spec.version         = Clocker::VERSION
+  spec.platform        = Gem::Platform::RUBY
+  spec.authors         = ['Michael Chadwick']
+  spec.email           = ['mike@codana.me']
+  spec.homepage        = 'http://rubygems.org/gems/clocker'
+  spec.summary         = 'Calculate how long a command or block of code takes to run'
+  spec.description     = 'Give Clocker some code to process, and it will run it and display how long it took to finish.'
+
+  spec.files           = `git ls-files`.split("\n")
+  spec.test_files      = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables     = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths   = ['lib']
+  spec.license         = 'MIT'
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+end

data/lib/clocker.rb

@@ -0,0 +1,54 @@
+# lib/clocker.rb
+# Clocker
+
+class Clocker
+  attr_accessor :options
+
+  def initialize(options = {})
+    self.options = options
+  end
+
+  def clock(&block)
+    @start = Time.now
+
+    if options[:show_messages]
+      puts "\nstart: #{@start}"
+    end
+
+    begin
+      block.call
+    rescue
+      puts "ERROR: invalid command or block"
+    end
+
+    return stop
+  end
+
+  def stop
+    @stop = Time.now
+
+    if options[:show_messages]
+      puts "\nended: #{@stop}"
+    end
+
+    ms = ((@stop - @start) * 1000).to_i
+
+    if ms > 60000
+      mins = ms / 60000
+      ms = ms - (60000 * mins)
+      if ms > 1000
+        secs = ms / 1000
+        ms = ms % 1000
+      end
+
+      return { mins: mins, secs: secs, ms: ms }
+    elsif ms > 1000
+      secs = ms / 1000
+      ms = ms % 1000
+
+      return { mins: 0, secs: secs, ms: ms }
+    else
+      return { mins: 0, secs: 0, ms: ms }
+    end
+  end
+end

data/lib/clocker/version.rb

@@ -0,0 +1,6 @@
+# lib/clocker/version.rb
+# Version of Clocker
+
+class Clocker
+  VERSION = '1.0.2'
+end

data/spec/clocker_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Clocker do
+  it 'has a version number' do
+    expect(Clocker::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'clocker'

data/tests/test-clocker.rb

@@ -0,0 +1,18 @@
+require 'clocker'
+
+c1 = Clocker.new
+
+duration1 = c1.clock do
+  3.times { print 'c1'; sleep(1) }
+end
+
+puts
+puts duration1
+
+c2 = Clocker.new(show_messages: true)
+
+duration2 = c2.clock do
+  3.times { print 'c2'; sleep(1) }
+end
+
+puts duration2

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: clocker
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Michael Chadwick
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-21 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: Give Clocker some code to process, and it will run it and display how
+  long it took to finish.
+email:
+- mike@codana.me
+executables:
+- clocker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/clocker
+- clocker.gemspec
+- lib/clocker.rb
+- lib/clocker/version.rb
+- spec/clocker_spec.rb
+- spec/spec_helper.rb
+- tests/test-clocker.rb
+homepage: http://rubygems.org/gems/clocker
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Calculate how long a command or block of code takes to run
+test_files:
+- spec/clocker_spec.rb
+- spec/spec_helper.rb