clocker 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e356e7d0d50521af9d67ef4698607fa341f746c3
-  data.tar.gz: 48f595a7020894dc8f649a3085d098ed96be1475
+  metadata.gz: d1a6a6c26851388c2fb79d9791fde1235a7549f7
+  data.tar.gz: 5b3310c6c7ebeb323a9487da6e8a70dedaff9a2f
 SHA512:
-  metadata.gz: 2408d28b66ba3c6261f7ecdc7e4f900dc9457b153aad468282474a2ca230863f3987d5d4390aee3fec8f7a4473a6e28c7b4efd96ee83038b8b055245deee9080
-  data.tar.gz: af3169ae0ab1ff937dcac51d4f3468b413a269896b19b6cac2e1dcc829c7090e6fda147560ac6cbd668bd45b92532eee38a8eb29c9a80821dd6ed476e8bf206a
+  metadata.gz: 2659f02b0c59f2a5f83a63b48d17d67a312ebcda368d1dd50c0a5718d728eb7dc63994ff362902a960429e3cf95098ad2c77df3d2383cb16c5c127cdf16a77a2
+  data.tar.gz: e6e32f90fc1cadf19314cb3f6d909428d737852d52347e274e7ae383d3130f8075788163ff69d54b71a041ba2c7f28cd7b722415885a7f742489ed43b2c0a38c

data/README.md

@@ -1,9 +1,12 @@
 # Clocker
-Quick way to find out how long that command or block of code takes to run.
+
+[![Gem Version](https://badge.fury.io/rb/clocker.svg)](http://badge.fury.io/rb/clocker)
+
+A simple RubyGem that gauges how long that Ruby command or 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.
+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
 ```
@@ -31,7 +34,7 @@ ended: 2015-08-18 16:16:49 -0700
 Clocked at 0 mins, 2 secs, and 12 ms
 ```
 
-### As Gem Library
+### Gem Library
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -73,7 +76,7 @@ c1c1c1
 ```ruby
 >> c2 = Clocker.new(show_messages: true)
 >> duration = c2.clock do
->>  3.times { purint 'c2'; sleep(1) }
+>>  3.times { print 'c2'; sleep(1) }
 >> end
 >> puts duration
 
@@ -82,3 +85,11 @@ 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

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-
 require_relative '../lib/clocker'
 require_relative '../lib/clocker/version'
 
@@ -13,18 +12,19 @@ def parse_options
   }
 
   optparse = OptionParser.new do |opts|
-    opts.banner = "usage: #{BINARY_NAME} [command|block]"
+    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 "#{BINARY_NAME} #{Clocker::VERSION}"
+      puts "#{Clocker::VERSION}"
       exit
     end
 
-    opts.on('-h', '--help', 'Display this screen and exit') do
+    opts.on('-h', '-?', '--help', 'Display this screen and exit') do
       puts opts
       exit
     end
@@ -38,10 +38,9 @@ end
 def print_error(error)
   case error
   when OptionParser::InvalidOption
-    puts "#{BINARY_NAME}: illegal option #{error.args.join(' ')}"
+    puts "#{BINARY_NAME} ERROR: illegal option #{error.args.join(' ')}"
   else
-    puts "An unexpected error occurred while running #{BINARY_NAME}:"
-    puts "  #{error}\n"
+    puts "#{BINARY_NAME} ERROR: #{error}"
   end
 end
 
@@ -49,12 +48,13 @@ begin
   options = parse_options
 
   if (ARGV.count > 0)
+    command = ARGV.join(" ")
     c = Clocker.new(options)
-    t = c.clock { eval(ARGV[0]) }
+    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"
+    puts "#{BINARY_NAME} ERROR: missing command or block"
   end
 rescue => error
   print_error(error)

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")

data/lib/clocker.rb

@@ -1,9 +1,6 @@
+# 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
 
@@ -21,7 +18,7 @@ class Clocker
     begin
       block.call
     rescue StandardError => e
-      puts e.message
+      puts "ERROR: invalid command or block"
     end
 
     return stop

data/lib/clocker/version.rb

@@ -2,5 +2,5 @@
 # Version of Clocker
 
 class Clocker
-  VERSION = '0.1.6'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clocker
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
-summary: Calculate how long a block of code takes to run
+summary: Calculate how long a command or block of code takes to run
 test_files: []