stop_watch 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe8209e2f9d17a1974938192c6b9c61400bdbb9e
-  data.tar.gz: 7d307466c4f693ddf7d217144e4d16dc48b9b051
+  metadata.gz: 3cfb8e5e7d370de76e18ad38acc1aced7f5b0c51
+  data.tar.gz: 2dd5dcc730b28b2002f3701365be8db52ea5dcee
 SHA512:
-  metadata.gz: b694f4bd62fdfd806df99d8d22f28fda773ccebc1707f3e26a79cf7d6250a70bb718d5075e914a49ef17efcd1f9b953a0abd0bf17147b272b0626015a210e4ce
-  data.tar.gz: '087cbda6acb8c30acf94cc0fbbf450ae2ae9bb6a3e9f1c897604c8e979426f7688c8c567f06c56eb8e4234c610ce5cee3d2645236248d55ff2d0d3bbd3929156'
+  metadata.gz: e9a443ebab65bcf7ea72d811e508877931bca7750f7966a75a0486389b4e775d76625445bf89e631af57cec0e62cfe1951b1da1d0cd4a4e93c9a30dfb36df227
+  data.tar.gz: 34caf65887b7f4b4d646254d028c593b1070c45a5a1a3400689ecabdc5f74ed78eb19bc369d053ce6e2af0aafcc72dcb81c0bcd49d00beb5f2ab8bb187cc241f

data/.codeclimate.yml

@@ -9,6 +9,6 @@ engines:
     enabled: true
 ratings:
   paths:
-  - "**.rb"
+  - "lib/stop_watch.rb"
 exclude_paths:
 - test/

data/.travis.yml

@@ -8,7 +8,7 @@ env:
   - secure: qXpWydxv6DHMrvGL8WH4wNRY4MTY7KV/x308Y5dHkZCrI7k9UOccvznp69KT3Z+tzYEFDXfUix5wA6pgyVcvrsQyiLSjGcyzHhxJKs1gk0gcxAkmhwHmUP9aiXWUe/mzpj7Uoc2DHwpPTpK1wQ5kV6eV+jzQLuN3nhfNr2sL8b4=
 addons:
   code_climate:
-    repo_token: TODO! UPDATE_THIS!
+    repo_token: 1783800b27684868b9e75c23f8d98913b74d26c4b92d7efca86d3b09c5f85bc8
 script: bundle exec rake test
 after_success:
   - bundle exec codeclimate-test-reporter

data/README.md

@@ -1,15 +1,12 @@
 [![Gem Version](https://badge.fury.io/rb/stop_watch.svg)](http://badge.fury.io/rb/stop_watch)
 [![Code Climate](https://codeclimate.com/github/danielpclark/stop_watch/badges/gpa.svg)](https://codeclimate.com/github/danielpclark/stop_watch)
 [![Build Status](https://travis-ci.org/danielpclark/stop_watch.svg)](https://travis-ci.org/danielpclark/stop_watch)
-[![Test Coverage](https://codeclimate.com/github/danielpclark/stop_watch/badges/coverage.svg)](https://codeclimate.com/github/danielpclark/stop_watch)
 [![Inline docs](http://inch-ci.org/github/danielpclark/stop_watch.svg?branch=master)](http://inch-ci.org/github/danielpclark/stop_watch)
 [![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg)](https://saythanks.io/to/danielpclark)
 
 # StopWatch
 
-Quick and dirty copy and paste gem from language_cards source to have a stop watch timer available as a gem.
-
-Lots of TODOs for this gem, they're not even written yet ;-)
+A stop watch timer where you hit `mark` to start the timer and continue to hit `mark` to mark times.
 
 ## Installation
 
@@ -29,7 +26,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'stop_watch'
+
+watch = StopWatch::Timer.new
+
+watch.mark
+# => 2017-02-24 18:03:43 -0500
+
+watch.time?
+# => false
+
+watch.mark
+# => [44.973787791]
+
+watch.time?
+# => true
+
+watch.mark
+# => [44.973787791, 6.39862104]
+
+watch.mark
+# => [44.973787791, 6.39862104, 4.238468485]
+
+watch.h # human total time
+# => "00:00:55"
+
+watch.ha # human average
+# => "18.54 second average"
+
+watch.times
+# => [44.973787791, 6.39862104, 4.238468485]
+```
 
 ## Development
 

data/lib/stop_watch/version.rb

@@ -1,3 +1,3 @@
 module StopWatch
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/stop_watch.rb

@@ -1,48 +1,78 @@
 require "stop_watch/version"
 
+##
+# StopWatch
+#
+# Project namespace for StopWatch.
 module StopWatch
+  ##
+  # Timer
+  #
+  # Object that behaves as a stop watch timer.
   class Timer
     def initialize
       @stamps = []
       @mark = nil
     end
 
+    # Start & Mark time with this `mark` method.
+    #
+    # @return [Time, Array<Float>] First time returns Time start. From then on it returns `times` method result. @see #times
     def mark
       if @mark
-        @stamps << -(@mark - (@mark = Time.now))
+        times << -(@mark - (@mark = Time.now))
       else
         @mark = Time.now
       end
     end
 
+    # Boolean check for any times `mark`ed.  Must mark atleast twice for this to be true.
+    #
+    # @return [true,false]
     def time?
       !times.empty?
     end
 
+    # Human display of total time elapsed in hours, minutes, and seconds.
+    #
+    # @return [String] String of hh:mm:ss
     def h # human
       "%02d:%02d:%02d" % [total/3600%24, total/60%60, total%60]
     end
 
+    # Average of times.  If `time?` if false this will raise an error.
+    #
+    # @return [Float,Error]
     def average
       total.fdiv(times.size)
     end
 
-    def ha # human average
-
+    # Human representation of average seconds per `mark`.
+    #
+    # @return [String] String representation of average or empty for none.
+    def ha
       "%0.2f second average" % average
     rescue
       ""
-
     end
 
+    # A collection of times `mark`ed.  Each represented in Float of seconds since the last `mark`.
+    #
+    # @return [Array<Float>] Returns array of times marked.
     def times
       @stamps
     end
 
+    # Last time `mark`ed.
+    #
+    # @return [Float,nil] Returns the last time `mark`ed, or else `nil`.
     def last
       @stamps.last
     end
 
+    # Total time accumulated.
+    #
+    # @return [Integer,Float] Returns total time since start.
     def total
       @stamps.inject(0, :+)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stop_watch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel P. Clark
@@ -71,7 +71,6 @@ files:
 - bin/setup
 - lib/stop_watch.rb
 - lib/stop_watch/version.rb
-- lib/timer.rb
 - stop_watch.gemspec
 homepage: https://github.com/danielpclark/stop_watch
 licenses:

data/lib/timer.rb

@@ -1,49 +0,0 @@
-
-module LanguageCards
-  class Timer
-    def initialize
-      @stamps = []
-      @mark = nil
-    end
-
-    def mark
-      if @mark
-        @stamps << -(@mark - (@mark = Time.now))
-      else
-        @mark = Time.now
-      end
-    end
-
-    def time?
-      !times.empty?
-    end
-
-    def h # human
-      "%02d:%02d:%02d" % [total/3600%24, total/60%60, total%60]
-    end
-
-    def average
-      total.fdiv(times.size)
-    end
-
-    def ha # human average
-
-      "%0.2f #{I18n.t('Timer.AverageSeconds')}" % average
-    rescue
-      ""
-
-    end
-
-    def times
-      @stamps
-    end
-
-    def last
-      @stamps.last
-    end
-
-    def total
-      @stamps.inject(:+) || 0
-    end
-  end
-end