clocked 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5cb23d9c15274667a7f193c1bf40454089018397a870322c073b55211643861
+  data.tar.gz: 0374d830df84452815f119d95bdc949edc83631e29f967c33f783ebb4aaaca95
+SHA512:
+  metadata.gz: 7f81b075382e421cce2f128ccf057872ba19a8d5282b84409119594a0054461eeb41919adaf95f1fe69295e254e2548c71d505e0105fdb36ea7fe1998523acdd
+  data.tar.gz: aa6119ba79f49279d376b65877d1c56aa8d5d1f5d9222ee6ab2b0775c05def388c6f542f047461186bc39eb9ecd4409bcd0ef1ec228d6fbef91bdf1c204a4e1d

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,7 @@
+**.DS_Store
+*.gem
+Gemfile.lock
+.bundle
+.yardoc
+doc
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--protected lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevinstuffandthings@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Kevin McDonald
+
+MIT License
+
+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,51 @@
+# Clocked ![Build Status](https://github.com/kevinstuffandthings/clocked/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/clocked.svg)](https://badge.fury.io/rb/clocked)
+
+A simple code timer. One of many. But simple.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+# update with the version of your choice
+gem 'clocked'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install clocked
+```
+
+## Usage
+```ruby
+require "clocked"
+
+sw = Clocked::Stopwatch.new("My expensive routine")
+
+sleep 3.2
+sw.mark_lap
+
+sleep 1.4
+sw.mark_lap("next one")
+
+sleep 0.5
+sleep 0.8
+sw.mark_lap
+
+puts sw
+```
+
+Output:
+```
+My expensive routine: 5.912148s (Lap 1: 3.201557s, next one: 1.404762s, Lap 3: 1.305776s)
+```
+
+# Problems?
+Please submit an [issue](https://github.com/kevinstuffandthings/clocked/issues).
+We'll figure out how to get you up and running with Clocked as smoothly as possible.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "standard/rake"
+
+Dir.glob("lib/tasks/*.rake").each { |r| load r }

data/clocked.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clocked/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "clocked"
+  spec.version = Clocked::VERSION
+  spec.authors = ["Kevin McDonald"]
+  spec.email = ["kevinstuffandthings@gmail.com"]
+  spec.summary = "A simple code timer"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/kevinstuffandthings/clocked"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "yard"
+end

data/lib/clocked/stopwatch.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Clocked
+  class Stopwatch
+    Lap = Struct.new(:name, :start_time, :end_time) do
+      def elapsed
+        end_time - start_time
+      end
+
+      def to_s
+        "#{name}: #{elapsed}s"
+      end
+    end
+
+    attr_reader :name, :laps, :start_time
+
+    # Create a new stopwatch.
+    # @param name [String] an optional name for this stopwatch
+    # @return [Stopwatch]
+    def initialize(name = nil)
+      @name = name
+      @start_time = now
+      @laps = []
+    end
+
+    # Determine how much time has elapsed since the creation of this stopwatch.
+    # @return [Float]
+    def elapsed
+      now - start_time
+    end
+
+    # Mark the completion of a lap.
+    # @param name [String] an optional name for the newly marked lap
+    def mark_lap(name = nil)
+      laps << Lap.new(
+        name || "Lap #{laps.count + 1}",
+        laps.last&.end_time || start_time,
+        now
+      )
+    end
+
+    # Generate a string-representation of the stopwatch and any laps.
+    # @return [String]
+    def to_s
+      text = [name, "#{elapsed}s"].compact.join(": ")
+      text += " (#{laps.map(&:to_s).join(", ")})" unless laps.empty?
+      text
+    end
+
+    private
+
+    def now
+      Time.now
+    end
+  end
+end

data/lib/clocked/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clocked
+  VERSION = "0.0.1"
+end

data/lib/clocked.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "clocked/version"
+require "clocked/stopwatch"
+
+# Clocked
+module Clocked
+end

data/spec/lib/clocked/stopwatch_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Clocked
+  describe Stopwatch do
+    describe "#elapsed" do
+      let(:duration) { 1.2 }
+
+      it "can provide a simple summary of what it timed" do
+        sw = described_class.new
+        sleep duration
+        expect(sw.elapsed).to be_within(0.05).of(duration)
+      end
+
+      it "builds based on #now" do
+        expect(Time).to receive(:now).and_return(18, 47, 96, 98)
+        expect(subject.elapsed).to eq(47 - 18)
+        expect(subject.elapsed).to eq(96 - 18)
+        expect(subject.to_s).to eq "80s"
+      end
+    end
+
+    describe "#mark_lap" do
+      subject { described_class.new("My routine") }
+      before(:each) { allow(Time).to receive(:now).and_return(12, 19, 35, 52, 83, 85) }
+
+      it "can mark a variety of laps, with and without names" do
+        subject.mark_lap
+        subject.mark_lap("thing")
+        subject.mark_lap("stuff")
+        subject.mark_lap
+
+        expect(subject.laps.count).to eq 4
+        subject.laps.each { |l| expect(l).to be_a described_class::Lap }
+
+        expect(subject.to_s).to eq "My routine: 73s (Lap 1: 7s, thing: 16s, stuff: 17s, Lap 4: 31s)"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+require "clocked"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: clocked
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin McDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: pry-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: 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: '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'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: yard
+  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: A simple code timer
+email:
+- kevinstuffandthings@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clocked.gemspec
+- lib/clocked.rb
+- lib/clocked/stopwatch.rb
+- lib/clocked/version.rb
+- spec/lib/clocked/stopwatch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kevinstuffandthings/clocked
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A simple code timer
+test_files:
+- spec/lib/clocked/stopwatch_spec.rb
+- spec/spec_helper.rb