blinkbox-common_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzdmOWVmNTZhNWM2ZTkzNzEyZGY5YTUxOTY2MjUwN2Q3NmQwM2JjZQ==
+  data.tar.gz: !binary |-
+    MTkzYTEwNjJmYWVlMDRhYzZjZDI2YWMzYThiMDYwZTQ5MDk2NmZiOQ==
+SHA512:
+  metadata.gz: !binary |-
+    OGU1ZWNkNTFjY2JiNGZkZGUwN2RmODFhODIxYTc3ZTkxMzVlZDU0NmUxOGIy
+    YjJlOTUwNTQ5MTBmZTNkMjNiYjY1Y2Q3NGM2YTU3ZTI5YmY3MGIwOWM0OTcz
+    ZTI3YmUwYWZiZDRiMWU5ODg3MDA2YjJkMGQwYmUxMjc0NTMyZTM=
+  data.tar.gz: !binary |-
+    Y2U1ZjM1YjkyNmQwYzY1NmJmOTY4MjA0MzFmOTQ5NGIxNGZjMTlmMzhjZTNl
+    NWU0YmI3YzNkMmU1MmI2OTlmOTAzODA3NDVlNTM0ZGUxZjY1ZWFmNjNjMWM3
+    OWIwMDU2Mjk5OTljMTc3ODcyMzExODZjMzY2MTc2Njg1OGVlZjU=

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change log
+
+## Open Source release (2015-01-28 14:11:21)
+
+Today we have decided to publish parts of our codebase on Github under the [MIT licence](LICENCE). The licence is very permissive, but we will always appreciate hearing if and where our work is used!
+
+## 0.1.0 ([#1](https://git.mobcastdev.com/Platform/common_helpers.rb/pull/1) 2014-10-07 07:55:34)
+
+Tictoc
+
+### New Feature
+
+- Added `tic`, `toc` and `reset_tictoc` in the `Blinkbox::CommonHelpers::TicToc` library for counting timespans.
+

data/README.md

@@ -0,0 +1,31 @@
+# Blinkbox::CommonHelpers
+
+A bunch of helpful snippets of Ruby.
+
+## TicToc
+
+Track how long things took in your app:
+
+```ruby
+include Blinkbox::CommonHelpers::TicToc
+tic
+sleep 9
+p toc
+# => 9001
+# (It is over 9000 because time is an illusion, lunchtime doubly so)
+```
+
+You can also track timespans in parallel:
+
+```ruby
+include Blinkbox::CommonHelpers::TicToc
+tic :a
+sleep 1
+tic :b
+sleep 1
+p toc :b
+# => 1000
+sleep 1
+p toc :a
+# => 3000
+```

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/blinkbox/tictoc.rb

@@ -0,0 +1,60 @@
+module Blinkbox
+  module CommonHelpers
+    # Gives you two methods, `tic` and `toc`. Without arguments `toc` will give you the number of milliseconds
+    # since you last called `tic`. Takes one argument, which can be used to have two timers running independently:
+    #
+    # @example: Basic use
+    #   include Blinkbox::CommonHelpers::TicToc
+    #   tic
+    #   sleep 9
+    #   p toc
+    #   # => 9001
+    #   # (It is over 9000 because time is an illusion, lunchtime doubly so)
+    #
+    # @example: Parallel use
+    #   include Blinkbox::CommonHelpers::TicToc
+    #   tic :a
+    #   sleep 1
+    #   tic :b
+    #   sleep 1
+    #   p toc :b
+    #   # => 1000
+    #   sleep 1
+    #   p toc :a
+    #   # => 3000
+    module TicToc
+      # Starts a timer with the given label. Will return the last value of the timer
+      # if #tic had been called before.
+      #
+      # @param [Symbol] label The label to use.
+      # @return [Time, nil] The Time #tic was called with this label previously
+      def tic(label = :default)
+        last_value = (@@timers ||= {})[label]
+        @@timers[label] = Time.now.utc
+        last_value
+      end
+
+      # Returns the number of milliseconds since tic (for the same label) was called.
+      # Will return nil if tic has never been called.
+      #
+      # @param [Symbol] label The label to use.
+      # @return [Float, nil] The number of milliseconds since the equivalent #tic was last called.
+      def toc(label = :default)
+        return nil if @@timers[label].nil?
+        ((Time.now.utc - @@timers[label]) * 1000).to_f
+      end
+
+      # Resets the timer for a specific label, or all labels (if none are specified)
+      #
+      # @param [Array<Symbol>] labels The labels to reset
+      # @return [nil]
+      def tictoc_reset(labels = [])
+        @@timers = {} if labels.empty?
+        labels.each do |label|
+          @@timers[label] = nil
+        end
+        nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: blinkbox-common_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extensions to ruby useful for blinkbox Books
+email:
+- jphastings@blinkbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- README.md
+- VERSION
+- lib/blinkbox/tictoc.rb
+homepage: ''
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Extensions to ruby useful for blinkbox Books
+test_files: []