clocker 0.1.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 313d465450aad6b302c19b427cd85f1558e842e6
-  data.tar.gz: 8f5ec6a2e5f7eb59e1bd02827316b1535f0a2489
+SHA256:
+  metadata.gz: 241d80d7ab828ad458f5e1f76b583c787c3c392361ecb419d7e1218d08e58816
+  data.tar.gz: dce67fae4400fc505d7f8e3716fcc3e66af171e1962b18e6fcac59e498b87317
 SHA512:
-  metadata.gz: c3bc670dada1807546c51c61627eae28b3ad2766c3e78783bfeee3bc8518fb5ba97d0e16cb4f45d9ffe341998867005513111147202eb619f950244ac071b9a8
-  data.tar.gz: 1ffc33bf6fccfc9b228046b5afc10fc8667408445c865bf0e118efc4b8a435e6f6ab0cae3d2eae5e0b90d80de143e21a4e467cebe4740185aac1661d20bdfdb1
+  metadata.gz: cf9d4a93c56a0c68556dd7a8f628a1bd5452f2c0ca8b31fc20a5961aa58e64eeda35393fcf3a7c8699280fda684809eef334a8d7759a9eb486e6445ffc3efd39
+  data.tar.gz: 48484f36c1e403cf479f5dd429703172ac5ab44c9bd33fd46d91d13ddb7ee3783566cbf55227046309dc64c3f880d6aa6f91e7a0187a39ddb0014ea03bf2ed9f

data/.gitignore

@@ -27,9 +27,9 @@ build/
 
 # 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
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/README.md

@@ -1,9 +1,40 @@
 # Clocker
 
-Find out how long that block of code takes to run.
+[![Gem Version](https://badge.fury.io/rb/clocker.svg)](http://badge.fury.io/rb/clocker)
 
-## Installation
+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
@@ -11,18 +42,54 @@ gem 'clocker'
 ```
 
 And then execute:
-
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
+```
+$ gem install clocker
+```
+
+Sample code block:
+```ruby
+>> clocker = Clocker.new
+>> clocker.clock do
+>>  # code here
+>> end
+```
 
-    $ gem install clocker
+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`.
 
-## Usage
+```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}
 ```
-clocker = Clocker.new
-clocker.clock do
-  # code here
-end
-```
+
+```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/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

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors         = ['Michael Chadwick']
   spec.email           = ['mike@codana.me']
   spec.homepage        = 'http://rubygems.org/gems/clocker'
-  spec.summary         = 'Calculate how long a block of code takes to run'
+  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")
@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths   = ['lib']
   spec.license         = 'MIT'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
 end

data/lib/clocker.rb

@@ -1,35 +1,38 @@
+# lib/clocker.rb
 # Clocker
 
-# Allows you to run a process for a time and get stats on how long it took
-# If you give it ms bounds on init, it will just run a timer for a random 
-# time between the two params
-
 class Clocker
+  attr_accessor :options
+
   def initialize(options = {})
     self.options = options
   end
 
-  def clock
+  def clock(&block)
     @start = Time.now
-    unless options[:show_messages].nil?
-      puts "start: #{@start}"
+
+    if options[:show_messages]
+      puts "\nstart: #{@start}"
     end
-  
+
     begin
-      yield
-    rescue StandardError => e
-      puts e.message
+      block.call
+    rescue
+      puts "ERROR: invalid command or block"
     end
-    stop
+
+    return stop
   end
-  
+
   def stop
     @stop = Time.now
-    unless options[:show_messages].nil?
-      puts "ended: #{@stop}"
+
+    if options[:show_messages]
+      puts "\nended: #{@stop}"
     end
+
     ms = ((@stop - @start) * 1000).to_i
-    
+
     if ms > 60000
       mins = ms / 60000
       ms = ms - (60000 * mins)
@@ -37,15 +40,15 @@ class Clocker
         secs = ms / 1000
         ms = ms % 1000
       end
-      
-      { mins: mins, secs: secs, ms: ms }
+
+      return { mins: mins, secs: secs, ms: ms }
     elsif ms > 1000
       secs = ms / 1000
       ms = ms % 1000
-      
-      { mins: 0, secs: secs, ms: ms }
+
+      return { mins: 0, secs: secs, ms: ms }
     else
-      { mins: 0, secs: 0, ms: ms }
+      return { mins: 0, secs: 0, ms: ms }
     end
   end
 end

data/lib/clocker/version.rb

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

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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clocker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.2
 platform: ruby
 authors:
 - Michael Chadwick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,35 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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:
-- console
-- setup
+- clocker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -52,22 +51,21 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,9 +80,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Calculate how long a block of code takes to run
-test_files: []
+summary: Calculate how long a command or block of code takes to run
+test_files:
+- spec/clocker_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,21 +0,0 @@
-PATH
-  remote: .
-  specs:
-    clocker (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    rake (10.4.2)
-
-PLATFORMS
-  ruby
-  x64-mingw32
-
-DEPENDENCIES
-  bundler (~> 1.9)
-  clocker!
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.10.5

data/bin/console

@@ -1 +0,0 @@
-#!/usr/bin/env ruby

data/bin/setup

@@ -1 +0,0 @@
-#!/usr/bin/env ruby