tick_tock 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78fb0e8694ff38d1b76653ed5d713cd0334368f265e041cb43f4895979effb19
+  data.tar.gz: 6e2de7ccb4128857a521773c9ddf3ea1b67acaacc753be369414a08c7a9d750b
+SHA512:
+  metadata.gz: 87a256c0e37232f5aa37e2605aeca0fc1bd8b62c3aa67a24f42235fb11ac30618cb253991bf5896507554bf70fdd805ee50c10400b3215babe70b79964974317
+  data.tar.gz: b15e21a6b9222f418ef40df680b57dfb176e7e59b349faf609216ba1d68ea3d817fba004dacd0f05e94b191090967c3bf9e5789fbb0c6346646dcf534fb48720

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# RVM local config
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+
+language: ruby
+
+rvm:
+  - 2.4
+  - 2.3
+
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tick_tock.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# TickTock
+
+[![Build Status](https://img.shields.io/travis/ms-ati/tick_tock/master.svg)](https://travis-ci.org/ms-ati/tick_tock)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tick_tock`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tick_tock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tick_tock
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tick_tock.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tick_tock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/lazy_example.rb

@@ -0,0 +1,21 @@
+require "pp"
+require "tick_tock"
+
+lazy_enum = [1, 2, 3].lazy
+
+slow_proc = ->(n) { sleep(1); n * 2 }
+
+# See how these can be defined elsewhere, but end up logging hierarchically
+wrapped_slow_proc =
+  TickTock.tick_tock_proc(slow_proc, subject: ->(n) { "Num #{n}" })
+
+wrapped_lazy_enum =
+  TickTock.tick_tock_lazy(lazy_enum, subject: "Lazy Enum")
+
+# Here we both log the block and also hierarchically log what happens inside it:
+result =
+  TickTock.tick_tock(subject: "Top Level") do
+    wrapped_lazy_enum.map(&wrapped_slow_proc).to_a
+  end
+
+pp result

data/examples/threaded_example.rb

@@ -0,0 +1,27 @@
+require "pp"
+require "tick_tock"
+
+inputs = [1, 2, 3]
+
+slow_proc = ->(n) { sleep(1); n * Thread.current.name.to_i }
+
+wrapped_slow_proc = TickTock.tick_tock_proc(
+  slow_proc,
+  subject: ->(n) { "Thr #{Thread.current.name}, Num #{n}" }
+)
+
+result =
+  TickTock.tick_tock(subject: "Top Level") do
+    thread_proc = TickTock.tick_tock_proc(
+      subject: ->(n) { "Thr #{n}" },
+      save_context: true
+    ) do |n|
+      Thread.current.name = n.to_s
+      inputs.map(&wrapped_slow_proc)
+    end
+
+    # In each thread, we pick up logging within the saved context
+    Array.new(3) { |n| Thread.new(n + 1, &thread_proc) }.map(&:value)
+  end
+
+pp result

data/lib/tick_tock.rb

@@ -0,0 +1,174 @@
+require "tick_tock/clock"
+require "tick_tock/version"
+
+# {TickTock} makes it easy to wrap your Ruby code to measure nested timings and
+# to log them -- even when the code is asynchronous or lazy, so straight-forward
+# blocks do not work.
+#
+# The TickTock module uses Ruby's
+# {http://ruby-doc.org/core-2.3.4/Module.html#method-i-module_function
+# module_function} directive to enable two different usage patterns:
+# 1. Calling methods directly on the module
+# 2. Including the module into classes as a mix-in
+#
+# == Configuration
+#
+# When calling methods directly on the module, the instance of {TickTock::Clock}
+# configured via {TickTock.clock=} will be used for all calls.
+#
+# On the other hand, when including the TickTock module into a class, the class
+# may choose to override {#clock} to return a specific instance.
+#
+# @example 1. Calling TickTock methods directly on the module
+#   TickTock.tick_tock(subject: "a block") do
+#     times_2 = ->(n) { n * 2 }
+#     [1, 2].map(&TickTock.tick_tock_proc(times_2, subject: :to_s.to_proc))
+#   end
+#   # => [2, 4]
+#
+#   # Logs the following
+#   # I, [2018-02-04T14:22:01.1261 #26]  INFO -- : > Started a block
+#   # I, [2018-02-04T14:22:01.1264 #26]  INFO -- : >> Started 1
+#   # I, [2018-02-04T14:22:01.1265 #26]  INFO -- : << Completed 1 [0.000s]
+#   # I, [2018-02-04T14:22:01.1267 #26]  INFO -- : >> Started 2
+#   # I, [2018-02-04T14:22:01.1267 #26]  INFO -- : << Completed 2 [0.000s]
+#   # I, [2018-02-04T14:22:01.1268 #26]  INFO -- : < Completed a block [0.001s]
+#
+# @example 2. Including the module into classes as a mix-in
+#   class Times2
+#     include TickTock
+#
+#     def call
+#       tick_tock(subject: "a block") do
+#         [1, 2].map(&tick_tock_proc(method(:times_2), subject: :to_s.to_proc))
+#       end
+#     end
+#
+#     def times_2(n)
+#       n * 2
+#     end
+#   end
+#
+#   Times2.new.call
+#   # => [2, 4]
+#
+#   # Logs the same as above
+#
+module TickTock
+  class << self
+    # @return [Clock]
+    #   the configured global instance of Clock, assigned by calling {.clock=}.
+    attr_accessor :clock
+  end
+
+  # @return [Clock]
+  #   when the TickTock module is included in a class, by default returns the
+  #   configured global instance of Clock. Override {#clock} in classes to
+  #   return a class-specific instance instead.
+  def clock
+    self.class.clock
+  end
+
+  module_function
+
+  # @!group Basics: Start and stop a timing context
+
+  # Starts a new timing context, returns a "card" representing it.
+  #
+  # @param subject [Object]  Description of the subject we are timing
+  # @return        [Object]  A new card representing the new timing context
+  def tick(subject: nil)
+    clock.tick(subject: subject)
+  end
+
+  # Completes a timing context represented by the given "card".
+  #
+  # @param card [Object]  A card representing the timing context to complete
+  # @return     [Object]  The card after being marked completed
+  def tock(card:)
+    clock.tock(card: card)
+  end
+
+  # @!endgroup
+
+  # @!group Helpers: Wrap an asynchronous construct in a timing context
+
+  # Executes the given block in a timing context using {.tick} and {.tock}.
+  #
+  # @param subject [Object]  Description of the subject we are timing
+  # @return        [Object]  Return value of the given block
+  def tick_tock(subject: nil)
+    card = tick(subject: subject)
+    yield
+  ensure
+    tock(card: card) unless card.nil?
+  end
+
+  # Wraps a
+  # {http://ruby-doc.org/core-2.3.4/Enumerator/Lazy.html lazy enumerator} with
+  # a timing context using *lazy* calls to {.tick} and {.tock}, which will be
+  # called when the enumerator starts and completes enumeration respectively.
+  #
+  # @param lazy_enum_to_wrap [Enumerator::Lazy]  Lazy enumerator to wrap
+  # @param subject           [Object]            Description of the subject
+  # @return                  [Enumerator::Lazy]  Wrapped lazy enumerator
+  def tick_tock_lazy(lazy_enum_to_wrap, subject: nil)
+    shared_state = [nil]
+
+    lazy_tick = proc { shared_state[0] = tick(subject: subject); [] }
+    lazy_tock = proc { shared_state[0] = tock(card: shared_state[0]); [] }
+
+    arr_with_callbacks = [
+      [:dummy].lazy.flat_map(&lazy_tick),
+      lazy_enum_to_wrap.lazy,
+      [:dummy].lazy.flat_map(&lazy_tock)
+    ]
+
+    arr_with_callbacks.lazy.flat_map(&:itself)
+  end
+
+  # Wraps a Proc with a timing context using a call to {.tick_tock}. Can
+  # optionally wrap the current nested timing contexts into the Proc, so that
+  # when executed asynchronously it will retain the same context.
+  #
+  # @param callable_to_wrap [Proc, #call]
+  #   Callable to wrap, given as a normal parameter.
+  #
+  # @param subject [Object, Proc, #call]
+  #   Description of the subject, or optionally a function which, when called on
+  #   the args that are actually eventually passed to the final proc, will
+  #   generate the actual subject.
+  #
+  # @param save_context [Boolean]
+  #   Optionally wrap the currently active timing contexts into the Proc, so
+  #   that when executed asynchronously it will retain the same context.
+  #
+  # @param proc_to_wrap [Proc]
+  #   Alternatively you can pass the callable as a "block" parameter -- only
+  #   used if callable_to_wrap is nil.
+  #
+  # @return [Proc]
+  #   A Proc wrapping the given callable in a timing context.
+  def tick_tock_proc(
+    callable_to_wrap = nil,
+    subject: nil,
+    save_context: false,
+    &proc_to_wrap
+  )
+    tt_proc = proc do |*proc_args|
+      # if original subject was a Proc, apply it to args to create the subject
+      subject = subject&.respond_to?(:call) ? subject.call(*proc_args) : subject
+
+      tick_tock(subject: subject) do
+        (callable_to_wrap || proc_to_wrap).call(*proc_args)
+      end
+    end
+
+    save_context ? Locals.wrap_proc(&tt_proc) : tt_proc
+  end
+
+  # @!endgroup
+end
+
+# Assigns a global default clock instance
+TickTock.clock = TickTock::Clock.default

data/lib/tick_tock/card.rb

@@ -0,0 +1,43 @@
+require "values"
+
+module TickTock
+  # @api private
+  #
+  # The representation of a "punch card" used by the default {Punch}
+  # implementation
+  #
+  # @!parse
+  #   class Card
+  #     # Constructor accepting keyword args.
+  #     #
+  #     # @param subject     [Object]     Description of subject of this card
+  #     # @param parent_card [Card, nil]
+  #     # @param time_in     [Time, nil]
+  #     # @param time_out    [Time, nil]
+  #     # @return [Card]
+  #     def self.with(subject:, parent_card:, time_in:, time_out:); end
+  #
+  #     # @param subject     [Object]     Description of subject of this card
+  #     # @param parent_card [Card, nil]
+  #     # @param time_in     [Time, nil]
+  #     # @param time_out    [Time, nil]
+  #     def initialize(subject, parent_card, time_in, time_out); end
+  #
+  #     # @return [Card]
+  #     #   a copy of this instance with any given values replaced.
+  #     #
+  #     # @param subject     [Object]     Description of subject of this card
+  #     # @param parent_card [Card, nil]
+  #     # @param time_in     [Time, nil]
+  #     # @param time_out    [Time, nil]
+  #     def with(subject: nil, parent_card: nil, time_in: nil, time_out: nil)
+  #     end
+  #   end
+  #
+  # @attr_reader subject     [Object]     Description of subject of this card
+  # @attr_reader parent_card [Card, nil]
+  # @attr_reader time_in     [Time, nil]
+  # @attr_reader time_out    [Time, nil]
+  class Card < Value.new(:subject, :parent_card, :time_in, :time_out)
+  end
+end

data/lib/tick_tock/card_logger.rb

@@ -0,0 +1,58 @@
+require "logger"
+require "values"
+
+module TickTock
+  CardLogger = Value.new(
+    :logger,
+    :severity,
+    :secs_decimals,
+    :show_zero_mins,
+    :show_zero_hrs
+  )
+
+  class CardLogger
+    def self.default
+      with(
+        logger:         Logger.new($stdout),
+        severity:       Logger::INFO,
+        secs_decimals:  3,
+        show_zero_mins: false,
+        show_zero_hrs:  false
+      )
+    end
+
+    def call(card)
+      logger.add(severity, nil, nil) { format(card) }
+    end
+
+    private
+
+    def format(card)
+      prefix, verb = card.time_out.nil? ? [">", "Started"] : ["<", "Completed"]
+      suffix = card.time_out && "[#{elapsed(card.time_out - card.time_in)}]"
+      [prefix * depth(card), verb, card.subject, suffix].compact.join(" ")
+    end
+
+    def depth(card, count = 1)
+      card.parent_card.nil? ? count : depth(card.parent_card, count + 1)
+    end
+
+    def elapsed(secs)
+      if secs < 60 && !show_zero_hrs && !show_zero_mins
+        "%.#{secs_decimals}fs" % secs
+      else
+        secs_width = 3 + secs_decimals # because 3 is 2 digits plus a "."
+
+        str = "%02dh:%02dm:%0#{secs_width}.#{secs_decimals}fs" % [
+          secs / 3600,    # hours
+          secs / 60 % 60, # minutes
+          secs % 60       # seconds
+        ]
+
+        str.sub!("00h:", "") unless show_zero_hrs
+        str.sub!("00m:", "") unless show_zero_hrs || show_zero_mins
+        str
+      end
+    end
+  end
+end

data/lib/tick_tock/clock.rb

@@ -0,0 +1,107 @@
+require "tick_tock/card"
+require "tick_tock/card_logger"
+require "tick_tock/locals"
+require "tick_tock/punch"
+
+module TickTock
+  # A {TickTock::Clock} can {#tick} and then {#tock}. Inspired by the
+  # {https://en.wikipedia.org/wiki/Time_clock "punch-card" or "bundy" clock}
+  # (where workers carry their own cards to punch in and out): the instances of
+  # Clock are immutable, and the states of timing contexts are kept on "cards".
+  #
+  # == Punch cards
+  #
+  # This class delegates to a {TickTock::Punch} implementation (via {#punch}) in
+  # order to obtain cards, to punch them in, and to punch them out. It does not
+  # depend on any details of those classes. It is therefore possible to replace
+  # the implementation of {Punch} - for example, to provide an alternate time
+  # source, or to use a memory-optimized representation of the punch cards.
+  #
+  # == Hierarchical state
+  #
+  # To represent the hierarchy of currently active punch cards, we use {Locals},
+  # which allows us to get and set state in a manner analogous to thread-local
+  # variables, but which can be captured and accessed across asynchronous
+  # contexts.
+  #
+  # == Logging and any other side-effects
+  #
+  # Callbacks {#on_tick} and {#on_tock} define logging (and any other
+  # {https://en.wikipedia.org/wiki/Side_effect_(computer_science) side-effects})
+  # which should take place on *ticks* and *tocks*.
+  #
+  # @!parse
+  #   class Clock
+  #     # Constructor accepting keyword args.
+  #     #
+  #     # @param punch   [Punch]      Implementation of {Punch} to use
+  #     # @param on_tick [Proc, nil]  Callback on {#tick}
+  #     # @param on_tock [Proc, nil]  Callback on {#tock}
+  #     # @return [Clock]
+  #     def self.with(punch:, on_tick:, on_tock:); end
+  #
+  #     # @param punch   [Punch]      Implementation of {Punch} to use
+  #     # @param on_tick [Proc, nil]  Callback on {#tick}
+  #     # @param on_tock [Proc, nil]  Callback on {#tock}
+  #     def initialize(punch, on_tick, on_tock); end
+  #
+  #     # @return [Clock]
+  #     #   a copy of this instance with any given values replaced.
+  #     #
+  #     # @param punch   [Punch]      Implementation of {Punch} to use
+  #     # @param on_tick [Proc, nil]  Callback on {#tick}
+  #     # @param on_tock [Proc, nil]  Callback on {#tock}
+  #     def with(punch: nil, on_tick: nil, on_tock: nil); end
+  #   end
+  #
+  # @attr_reader punch   [Punch]      Implementation of {Punch} to use
+  # @attr_reader on_tick [Proc, nil]  Callback on {#tick}
+  # @attr_reader on_tock [Proc, nil]  Callback on {#tock}
+  class Clock < Value.new(:punch, :on_tick, :on_tock)
+    # @return [Clock]  an instance with the default configuration
+    def self.default
+      log_card = CardLogger.default.method(:call)
+      with(punch: Punch.default, on_tick: log_card, on_tock: log_card)
+    end
+
+    # Starts timing a new card, calls any given {#on_tick}, and returns it.
+    #
+    # @param subject [Object]  Description of the subject we are timing
+    # @return        [Object]  A new card representing the new timing context
+    def tick(subject: nil)
+      card = punch.card(subject: subject, parent_card: self.class.current_card)
+      card_in = punch.in(card)
+      self.class.current_card = card_in
+      on_tick&.call(card_in)
+      card_in
+    end
+
+    # Completes timing the given card, calls any given {#on_tock}, and returns
+    # it.
+    #
+    # @param card [Object]  A card representing the timing context to complete
+    # @return     [Object]  The card after being marked completed
+    def tock(card:)
+      card_out = punch.out(card)
+      self.class.current_card = punch.parent_card_of(card_out)
+      on_tock&.call(card_out)
+      card_out
+    end
+
+    private
+
+    # @return [Symbol]  Key to store and retrieve current punch card in {Locals}
+    CURRENT_CARD = :"__tick_tock/current_card__"
+    private_constant :CURRENT_CARD
+
+    # @return [Punch::Card]  The currently active punch card
+    def self.current_card
+      Locals.key?(CURRENT_CARD) ? TickTock::Locals[CURRENT_CARD] : nil
+    end
+
+    # Sets the currently active punch card
+    def self.current_card=(card)
+      Locals[CURRENT_CARD] = card
+    end
+  end
+end

data/lib/tick_tock/locals.rb

@@ -0,0 +1,115 @@
+module TickTock
+  # {Locals} provides the convenience of Thread-local (or Fiber-local) variables
+  # to asynchronous code. By "asynchronous", we simply mean that a given Proc
+  # may end up executing on a different Thread or Fiber from the one in which
+  # it was created -- or equally -- on the same thread, but at a later time!
+  #
+  # See {.wrap_proc} for an example of how this can be used to capture local
+  # state and wrap it with a Proc for later use, independent of how that state
+  # may change during the intervening period.
+  #
+  # {https://github.com/monix/monix/blob/v3.0.0-M3/monix-execution/shared/src/main/scala/monix/execution/misc/Local.scala
+  # Here's how similar concepts are implemented} in the Monix library in Scala.
+  #
+  module Locals
+    module_function
+
+    # @return [Hash] Default context is an empty hash
+    DEFAULT_CONTEXT = {}.freeze
+    private_constant :DEFAULT_CONTEXT
+
+    # @return [Symbol] Key under which context is stored as a fiber-local var
+    FIBER_LOCAL_KEY = :"__tick_tock/local_context__"
+    private_constant :FIBER_LOCAL_KEY
+
+    # Wraps the current local context into the given proc, so that when it is
+    # run it has access to the same local context as when it was wrapped, even
+    # if it is run in a different Thread, Fiber, or simply at a later time after
+    # the local context was changed.
+    #
+    # @example Wrap current local context into a Proc object
+    #   # proc which depends on some local variable
+    #   a_proc = proc { "proc sees: " + TickTock::Locals[:foo].to_s }
+    #
+    #   # wraps the current state of the locals into the proc
+    #   TickTock::Locals[:foo] = :bar
+    #   wrapped_proc = TickTock::Locals.wrap_proc(&a_proc)
+    #
+    #   # later, the state of the locals change, but the wrapped state does not
+    #   TickTock::Locals[:foo] = 42
+    #   wrapped_proc.call
+    #   #=> "proc sees: bar"
+    #
+    #   TickTock::Locals[:foo]
+    #   #=> 42
+    #
+    # @param proc_to_wrap [Proc]  A proc to wrap with the current local context
+    # @return [Proc]              Wrapped version of the given `proc_to_wrap`
+    def wrap_proc(&proc_to_wrap)
+      wrapped_context = context
+
+      proc do |*args|
+        begin
+          saved_context = context
+          self.context = wrapped_context
+          proc_to_wrap.call(*args)
+        ensure
+          self.context = saved_context
+        end
+      end
+    end
+
+    # Fetches current value of given `key` in the local context.
+    #
+    # @param key [String, Symbol]  Key to fetch
+    # @return [Object]             Current value of `key` in local context
+    # @raise [KeyError]            Raise if key not found
+    def [](key)
+      context.fetch(key)
+    end
+
+    # Updates the current local context to map *key* to *value*. Works in a
+    # non-mutative way, so that any other references to the old context will be
+    # left unchanged.
+    #
+    # @param key [String, Symbol]  Key to set a value for
+    # @param value [Object]        Value to set for `key` in local context
+    # @return [Object]             The value that was set
+    def []=(key, value)
+      self.context = context.merge(key => value).freeze
+    end
+
+    # Check if the given key is currently set in the local context.
+    #
+    # @param key [String, Symbol]  Key to check for
+    # @return [Boolean]            Is the key currently set?
+    def key?(key)
+      context.key?(key)
+    end
+
+    # Clears the current local context
+    def clear!
+      self.context = DEFAULT_CONTEXT
+    end
+
+    # @return [Hash{String, Symbol => Object}]
+    #   The current local context represented as a frozen hash.
+    def context
+      if Thread.current.key?(FIBER_LOCAL_KEY)
+        Thread.current[FIBER_LOCAL_KEY]
+      else
+        DEFAULT_CONTEXT
+      end
+    end
+
+    # @api private
+    #
+    # Sets the local context to the given frozen hash.
+    #
+    # @param hsh [Hash]  Frozen hash to set as current local context
+    def context=(hsh)
+      Thread.current[FIBER_LOCAL_KEY] = hsh
+    end
+    private_class_method :context=
+  end
+end

data/lib/tick_tock/punch.rb

@@ -0,0 +1,30 @@
+require "tick_tock/card"
+
+module TickTock
+  class Punch < Value.new(:time_now)
+    def self.default
+      with(time_now: Time.method(:now))
+    end
+
+    def card(subject: nil, parent_card: nil)
+      Card.with(
+        subject: subject,
+        parent_card: parent_card,
+        time_in: nil,
+        time_out: nil
+      )
+    end
+
+    def in(card)
+      card.with(time_in: time_now.call)
+    end
+
+    def out(card)
+      card.with(time_out: time_now.call)
+    end
+
+    def parent_card_of(card)
+      card.parent_card
+    end
+  end
+end

data/lib/tick_tock/version.rb

@@ -0,0 +1,3 @@
+module TickTock
+  VERSION = "0.2.0"
+end

data/tick_tock.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tick_tock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tick_tock"
+  spec.version       = TickTock::VERSION
+  spec.authors       = ["Marc Siegel"]
+  spec.email         = ["marc@usainnov.com"]
+
+  spec.summary       = "TickTock wraps Ruby code in timing and logging easily!"
+  spec.description   = "TickTock makes it easy to wrap your Ruby code to "\
+                       "measure nested timings and to log them -- even when "\
+                       "the code is asynchronous or lazy, so straight-forward "\
+                       "blocks do not work. Versions follow SemVer."
+  spec.homepage      = "https://github.com/ms-ati/tick_tock"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_runtime_dependency "values", ">= 1.8.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "byebug"
+
+  spec.add_development_dependency "benchmark-ips"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: tick_tock
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Marc Siegel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: byebug
+  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: benchmark-ips
+  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: TickTock makes it easy to wrap your Ruby code to measure nested timings
+  and to log them -- even when the code is asynchronous or lazy, so straight-forward
+  blocks do not work. Versions follow SemVer.
+email:
+- marc@usainnov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/lazy_example.rb
+- examples/threaded_example.rb
+- lib/tick_tock.rb
+- lib/tick_tock/card.rb
+- lib/tick_tock/card_logger.rb
+- lib/tick_tock/clock.rb
+- lib/tick_tock/locals.rb
+- lib/tick_tock/punch.rb
+- lib/tick_tock/version.rb
+- tick_tock.gemspec
+homepage: https://github.com/ms-ati/tick_tock
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: TickTock wraps Ruby code in timing and logging easily!
+test_files: []