monotonic_tick_count 0.2.0.rails.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8e5ad9be33e236d673cf046950b0552dc653e3fe01ac6b64db11e2bf374b5c8
+  data.tar.gz: 489038b62cb1c55e4677ba83bd55e1f035490e7510b18f0ca380b04887a071ed
+SHA512:
+  metadata.gz: 25def2306d8d0fe545f24299cdc058a878e579b72d2148d60e7c3f5fa0b79c2ba82671728d56bc88abefbf656e5bd36ce98a8983155cbb80d17bfaa70d1d0e0a
+  data.tar.gz: 965c2904c654dddbac57013fc2fc6c40e08ddfe4379c6bede0a1bb6979c16a6217dafffe33ba4a80d705756b2bc080fb62727bb99173cfd67940cf1fff66ceae

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rubocop-http*
+.idea

data/.jenkins/Jenkinsfile

@@ -0,0 +1,51 @@
+#!/usr/bin/groovy
+@Library('jenkins-pipeline@v0.4.5')
+import com.invoca.docker.*;
+pipeline {
+  agent {
+    kubernetes {
+      defaultContainer "ruby"
+      yamlFile ".jenkins/ruby_build_pod.yml"
+    }
+  }
+
+  environment {
+    GITHUB_TOKEN = credentials('github_token')
+    BUNDLE_GEM__FURY__IO = credentials('gemfury_deploy_token')
+  }
+
+  stages {
+    stage('Setup') {
+      steps {
+        updateGitHubStatus('clean-build', 'pending', 'Unit tests.')
+        script {
+          sh 'bundle install'
+        }
+      }
+    }
+    stage('Unit Test') {
+      steps {
+        script {
+          sh 'bundle exec rspec --format RspecJunitFormatter --out spec/reports/rspec.xml'
+        }
+      }
+      post {
+        always { junit '*/reports/*.xml' }
+        success { updateGitHubStatus('clean-build', 'success', 'Unit tests.') }
+        failure { updateGitHubStatus('clean-build', 'failure', 'Unit tests.') }
+      }
+    }
+  }
+}
+
+void updateGitHubStatus(String context, String status, String description) {
+  gitHubStatus([
+    repoSlug:    'Invoca/monotonic_tick_count',
+    sha:         env.GIT_COMMIT,
+    description: description,
+    context:     context,
+    targetURL:   env.BUILD_URL,
+    token:       env.GITHUB_TOKEN,
+    status:      status
+  ])
+}

data/.jenkins/ruby_build_pod.yml

@@ -0,0 +1,19 @@
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  labels:
+  jenkins/monotonic-tick_count: 'true'
+  namespace: jenkins
+  name: monotonic-tick_count
+spec:
+  containers:
+  - name: ruby
+    image: ruby:2.6.5
+    tty: true
+    resources:
+    requests:
+      memory: "100Mi"
+    command:
+      - cat
+

data/.rubocop.yml

@@ -0,0 +1,5 @@
+# This rubocop config file inherits from our centralized style-guide repository.
+# If you are looking to update the ruby style guide, be sure to both update the rubocop config
+# as well as the README.md
+# https://github.com/Invoca/style-guide/tree/master/ruby
+inherit_from: https://raw.githubusercontent.com/Invoca/style-guide/master/ruby/.rubocop.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in monotonic_tick_count.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.17'
+  gem 'pry'
+  gem 'rake'
+  gem 'rspec', '~> 3.7'
+  gem 'rspec_junit_formatter', '~> 0.4'
+  gem 'rspec-mocks'
+  gem 'rubocop', '0.54.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Colin Kelley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# MonotonicTickCount
+
+Implements a PORO that can be used for monotonic timestamping. It wraps a count of fractional seconds (or ticks) that can be initialized to the system monotonic clock via the `.now` method or to any float you supply. It implements the comparable interface and arithmetic operators for calculating offsets and differences.
+
+For an explanation as to why this is preferrable to using the wall clock for timing calculations, see [this blog post](https://www.softwariness.com/articles/monotonic-clocks-windows-and-posix/).
+
+## Usage
+Comparing two monotonic timestamps
+```
+tick_count_a = MonotonicTickCount.now
+tick_count_b = tick_count_a + 15.minutes
+tick_count_a < tick_count_b => true
+tick_count_b - tick_count_a => 900.0
+```
+
+Finding the elapsed seconds of a block
+```
+return_val, elapsed_seconds = MonotonicTickCount.timer do
+  sleep(10)
+  1
+end
+return_val      => 1
+elapsed_seconds => 10.0
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monotonic_tick_count'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install monotonic_tick_count
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/monotonic_tick_count.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "monotonic_tick_count"
+
+# 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/lib/monotonic_tick_count.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "monotonic_tick_count/version"
+require "active_support"
+require "active_support/core_ext"
+
+class MonotonicTickCount
+  include Comparable
+
+  # the tick count in seconds as floating point at nanosecond granularity
+  attr_reader :tick_count_f
+
+  # initialize from one of:
+  #   - another object of this type OR
+  #   - an equivalent object that responds to tick_count_f OR
+  #   - an explicit keyword value of tick_count_f: which is a floating point count of seconds with fractional second at nanosecond granularity
+  def initialize(other = nil, tick_count_f: nil)
+    @tick_count_f = if other
+                      other.respond_to?(:tick_count_f) or raise ArgumentError, "Must initialize from #{self.class} or equivalent"
+                      other.tick_count_f
+                    else
+                      tick_count_f or raise ArgumentError, "Must provide either other or tick_count_f:"
+                    end
+  end
+
+  def inspect
+    "monotonic tick count #{@tick_count_f}"
+  end
+
+  # When the RHS is a convertible to float, returns an offset to the current tick count
+  # When the RHS is a MonotonicTickCount,   returns the difference in float seconds
+  def -(other)
+    if other.respond_to?(:tick_count_f)
+      @tick_count_f - other.tick_count_f
+    elsif other.respond_to?(:to_f)
+      self + -other
+    else
+      raise ArgumentError, "Other operand must be another #{self.class} or respond to to_f"
+    end
+  end
+
+  def +(other)
+    other.respond_to?(:to_f) or raise ArgumentError, "Other operand must respond to to_f"
+    self.class.new(tick_count_f: @tick_count_f + other.to_f)
+  end
+
+  def <=>(other)
+    other.respond_to?(:tick_count_f) or raise ArgumentError, "Other operand must be a #{self.class} or equivalent"
+    @tick_count_f <=> other.tick_count_f
+  end
+
+  def hash
+    @tick_count_f.hash
+  end
+
+  alias eql? ==
+
+  class << self
+    def now
+      new(tick_count_f: Process.clock_gettime(Process::CLOCK_MONOTONIC))
+    end
+
+    # yields to the caller and returns a pair: [result from yield, float time in seconds of block run]
+    def timer
+      start = self.now
+      result = yield
+      [result, self.now - start]
+    end
+  end
+end

data/lib/monotonic_tick_count/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class MonotonicTickCount
+  VERSION = "0.2.0.rails.5"
+end

data/monotonic_tick_count.gemspec

@@ -0,0 +1,31 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "monotonic_tick_count/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "monotonic_tick_count"
+  spec.version       = MonotonicTickCount::VERSION
+  spec.authors       = ["Invoca Development"]
+  spec.email         = ["development@invoca.com"]
+
+  spec.summary       = "PORO to hold a monotonic tick count. Useful for measuring time differences."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/invoca/monotonic_tick_count"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+   "allowed_push_host" => "https://rubygems.org"
+  }
+
+  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.add_dependency "activesupport", ">= 4.2"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: monotonic_tick_count
+version: !ruby/object:Gem::Version
+  version: 0.2.0.rails.5
+platform: ruby
+authors:
+- Invoca Development
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: PORO to hold a monotonic tick count. Useful for measuring time differences.
+email:
+- development@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".jenkins/Jenkinsfile"
+- ".jenkins/ruby_build_pod.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/monotonic_tick_count.rb
+- lib/monotonic_tick_count/version.rb
+- monotonic_tick_count.gemspec
+homepage: https://github.com/invoca/monotonic_tick_count
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: PORO to hold a monotonic tick count. Useful for measuring time differences.
+test_files: []