checkpoint_timer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b615af706b07ceea74ed16a31e06df876b167ae
+  data.tar.gz: ce05ecfa1d191cb318186eb66dd8bcf1f3ab495a
+SHA512:
+  metadata.gz: aa56970ceb1256260b1cb26f71c70465d8316b2f050d4a4f0877afcbc76719b5e72aa4a0bc93eb28323cc76b0a74eed4915bec776c48c99fc6234dc7b7637309
+  data.tar.gz: 92edd020440e05039b9dac40b263e597b983fcdce89e0f4c1f41be38cc43a8ee9ed228f005cfef19e60e8853e08b4ffcca337eb9286633110e2209b66174b0c3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at cdavidson@workwithopal.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkpoint_timer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Casey Davidson
+
+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,60 @@
+# CheckpointTimer
+
+Checkpoint Timer is a gem to provide a very lightweight Ruby stopwatch timer.
+
+The impetus for this was some performance diagnostic work that I was doing. I wanted to see how long different method calls were taking, but wanted something more lightweight than Ruby's Benchmark library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkpoint_timer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkpoint_timer
+
+## Usage
+
+To use the timer, create an instance of the timer class.
+```Ruby
+timer = CheckpointTimer::Timer.new
+timer.start
+# ... execute code here
+timer.checkpoint(logging: true, message: 'First checkpoint')
+# ... execute some more code
+timer.checkpoint(logging: true, message: 'Second checkpoint')
+```
+
+The timer can also be used without logging, if you wish to use the data differently
+```ruby
+timer = CheckpointTimer::Timer.new
+timer.start
+# ... execute code here
+elapsed_time = timer.checkpoint
+```
+The `CheckpointTimer::Timer#checkpoint` method returns the elapsed time in seconds since the previous checkpoint.
+
+Logging can also be enabled at the instance level.
+```ruby
+timer = CheckpointTimer::Timer.new(log_all: true)
+timer.start
+# ... execute code here
+elapsed_time = timer.checkpoint(message: 'Global logging is enabled')
+```
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/checkpoint_timer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,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 "checkpoint_timer"
+
+# 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

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/checkpoint_timer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkpoint_timer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "checkpoint_timer"
+  spec.version       = CheckpointTimer::VERSION
+  spec.authors       = ["Casey Davidson"]
+  spec.email         = ["cdavidson@workwithopal.com"]
+
+  spec.summary       = "A handy timer to benchmark Ruby code"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/checkpoint_timer.rb

@@ -0,0 +1,5 @@
+require 'checkpoint_timer/version'
+require 'checkpoint_timer/timer'
+
+module CheckpointTimer
+end

data/lib/checkpoint_timer/timer.rb

@@ -0,0 +1,68 @@
+require 'pry'
+
+module CheckpointTimer
+  class TimerNotStartedError < StandardError
+  end
+
+  class Timer
+    attr_reader :current_time,
+                :previous_time,
+                :start_time,
+                :checkpoint_counter,
+                :log_all
+
+    def initialize(log_all: false)
+      @log_all = log_all
+    end
+
+    def start
+      @checkpoint_counter = 0
+      @start_time = Time.now
+      @current_time = start_time
+    end
+
+    # @param message [String]
+    # @return [Fixnum]
+    def checkpoint(logging: false, message: nil)
+      raise TimerNotStartedError unless start_time
+      @previous_time = current_time
+      set_current_time
+      iterate_counter
+
+      log_checkpoint(message) if logging || log_all?
+      elapsed_time
+    end
+
+    # @return [Fixnum]
+    def total_checkpoint_time
+      current_time - start_time
+    end
+
+    private
+
+    # @param message [String]
+    def log_checkpoint(message)
+      puts "Checkpoint: #{checkpoint_counter}"
+      puts message if message
+      puts "Elapsed time since last checkpoint: #{format('%.3f', elapsed_time)}"
+    end
+
+    def iterate_counter
+      @checkpoint_counter += 1
+    end
+
+    def set_current_time
+      @current_time = Time.now
+    end
+
+    # @return [Fixnum]
+    def elapsed_time
+      current_time - previous_time
+    end
+
+    # @return [Boolean]
+    def log_all?
+      !!log_all
+    end
+  end
+end

data/lib/checkpoint_timer/version.rb

@@ -0,0 +1,3 @@
+module CheckpointTimer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: checkpoint_timer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Casey Davidson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: pry
+  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: 
+email:
+- cdavidson@workwithopal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- checkpoint_timer.gemspec
+- lib/checkpoint_timer.rb
+- lib/checkpoint_timer/timer.rb
+- lib/checkpoint_timer/version.rb
+homepage: 
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A handy timer to benchmark Ruby code
+test_files: []