clocker 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: debd54564a6bbb21e26970160a5cbe8683328e8b
-  data.tar.gz: 77a4c22b06f10e8469bc0654c8f0613312159734
+  metadata.gz: e356e7d0d50521af9d67ef4698607fa341f746c3
+  data.tar.gz: 48f595a7020894dc8f649a3085d098ed96be1475
 SHA512:
-  metadata.gz: 1e4b7a7f2d11f3aa403a731dc25f50a396667a565e6dc581208ca72b5872ae94f95eeefb951a49db59f1bd35ce5f78390e66cbd86251da0378a3357a9401c8b8
-  data.tar.gz: fd3284a01a511e99c3ba9d0e8209bc668b49380d6c1bc96831841deda1db8026e13f9f3b4bed889cf9281e59aa3eedcf303dbebb9ab8909c567a4e45f7389735
+  metadata.gz: 2408d28b66ba3c6261f7ecdc7e4f900dc9457b153aad468282474a2ca230863f3987d5d4390aee3fec8f7a4473a6e28c7b4efd96ee83038b8b055245deee9080
+  data.tar.gz: af3169ae0ab1ff937dcac51d4f3468b413a269896b19b6cac2e1dcc829c7090e6fda147560ac6cbd668bd45b92532eee38a8eb29c9a80821dd6ed476e8bf206a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clocker (0.1.0)
+    clocker (0.1.6)
 
 GEM
   remote: https://rubygems.org/
@@ -18,4 +18,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/README.md

@@ -1,9 +1,37 @@
 # Clocker
+Quick way to find out how long that command or block of code takes to run.
 
-Find out how long that block of code takes to run.
+## Usage
+### Command Line
+Simply run `clocker` followed by a command or block in double quotes. 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
+```
 
-## Installation
+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
+```
+
+### As Gem Library
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -11,18 +39,46 @@ gem 'clocker'
 ```
 
 And then execute:
-
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
+```
+$ gem install clocker
+```
 
-    $ gem install clocker
+Sample code block:
+```ruby
+>> clocker = Clocker.new
+>> clocker.clock do
+>>  # code here
+>> end
+```
 
-## Usage
+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 { purint '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}
 ```
-clocker = Clocker.new
-clocker.clock do
-  # code here
-end
-```

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 = "usage: #{BINARY_NAME} [command|block]"
+
+    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 "#{BINARY_NAME} #{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}: illegal option #{error.args.join(' ')}"
+  else
+    puts "An unexpected error occurred while running #{BINARY_NAME}:"
+    puts "  #{error}\n"
+  end
+end
+
+begin
+  options = parse_options
+
+  if (ARGV.count > 0)
+    c = Clocker.new(options)
+    t = c.clock { eval(ARGV[0]) }
+    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/lib/clocker.rb

@@ -11,27 +11,31 @@ class Clocker
     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
+      block.call
     rescue StandardError => e
       puts e.message
     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)
@@ -39,15 +43,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.5'
+# lib/clocker/version.rb
+# Version of Clocker
+
+class Clocker
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clocker
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Michael Chadwick
@@ -42,7 +42,8 @@ description: Give Clocker some code to process, and it will run it and display h
   long it took to finish.
 email:
 - mike@codana.me
-executables: []
+executables:
+- clocker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -54,6 +55,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/clocker
 - clocker.gemspec
 - lib/clocker.rb
 - lib/clocker/version.rb