pretty_stopwatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba3811db87aefda87dc46290686c31917665972a1f14d80739015d4fe288ddf1
+  data.tar.gz: 23b860704b818babfb475e803211fe1055065ac1ecfd29aa6a2711a99f88796c
+SHA512:
+  metadata.gz: 4b5d2a2482c85fa0098d03b213583645e21de723152750704b38b164d73a7888b1fee5316767df34449bec2b40d10bbe35cb2051ad17e38dc271bed39062964f
+  data.tar.gz: e0f4a8cb22040e7a42037fbf33620060b00b2dec59c03fd46557614930c7881c8fdff5be8084b21b639c70bdaf370a762eb8698be936589317fb02201a6ca97d

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ben Mcfadyen
+
+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,35 @@
+# PrettyStopwatch
+
+TODO: Delete this and the text below, and describe your gem
+
+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/pretty_stopwatch`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## 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 the created tag, 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]/pretty_stopwatch.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/pretty_stopwatch/version.rb

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

data/lib/pretty_stopwatch.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative "pretty_stopwatch/version"
+
+#
+# Based on the Guava Stopwatch com.google.common.base.Stopwatch
+# Credit: The Guava Authors
+#
+# = Basic Example:
+#   stopwatch = Stopwatch::create_started
+#   sleep(0.1)
+#   stopwatch.stop # optional
+#   puts "slept for #{stopwatch}" # to_s optional
+#   Output: "slept for 0.1014ms"
+#
+# = Named Example:
+#   stopwatch = Stopwatch::create_started(:foo)
+#   sleep(0.1)
+#   puts "slept for #{stopwatch.get(:foo)}"
+#   Output: "slept for 0.1014ms"
+#
+# = Block Example:
+#   stopwatch = Stopwatch::time{sleep 0.1}
+#
+# = Lambda Example:
+#   lambda = -> {sleep 0.15}
+#   stopwatch = Stopwatch::time(lambda)
+#
+# = Proc Example:
+#   proc = Proc.new {sleep 0.15}
+#   stopwatch = Stopwatch::time(proc)
+
+#   stopwatch = Stopwatch::create_started(:foo)
+#   sleep(0.1)
+#   puts "slept for #{stopwatch.get(:foo)}"
+#   Output: "slept for 0.1014ms"
+class Stopwatch
+
+  # Stopwatch methods are not idempotent; it is an error to start or stop a stopwatch that is already in the desired state.
+  class IllegalStateError < StandardError
+  end
+
+  @start_nanos
+  attr_reader :name
+  attr_reader :running
+  attr_reader :elapsed_nanos
+
+  def initialize(name = nil, elapsed_nanos) # optional variable
+    @name = name
+    @start_nanos = nil
+    @running = false
+    @elapsed_nanos = elapsed_nanos
+  end
+
+  def running?
+    @running
+  end
+
+  def stopped?
+    !@running
+  end
+
+  private_class_method :new # private constructor
+
+  class << self
+
+    def create_started(name = nil, elapsed_nanos: 0)
+      self.new(name, elapsed_nanos).start
+    end
+
+    def create_unstarted(name = nil, elapsed_nanos: 0)
+      self.new(name, elapsed_nanos)
+    end
+
+    def time(callable = nil, &block)
+      stopwatch = self.create_started
+      if callable
+        callable.call
+      elsif block_given?
+        block.call # yield also valid
+      else
+        raise "no callable/block given" # todo
+      end
+      stopwatch.stop
+    end
+  end
+
+  def start
+    raise IllegalStateError, "Stopwatch is already running" if @running
+    @running = true
+    @start_nanos = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+    self
+  end
+
+  def stop
+    raise IllegalStateError, "Stopwatch is already stopped" unless @running
+    @elapsed_nanos += Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond) - @start_nanos
+    @running = false
+    self
+  end
+
+  # reset the elapsed time and stop the stopwatch
+  def reset
+    @running = false
+    @elapsed_nanos = 0
+  end
+
+  def elapsed_nanos
+    if running?
+      now = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+      return (now - @start_nanos) + @elapsed_nanos
+    end
+    @elapsed_nanos
+  end
+
+  def elapsed_millis
+    elapsed_nanos / 1_000_000
+  end
+
+  def to_s
+    value_with_unit = PrettyUnitFormatter::scale_nanos_with_unit(elapsed_nanos)
+    return "'#{@name}' elapsed: #{value_with_unit}" if @name
+    "#{value_with_unit}"
+  end
+
+  class PrettyUnitFormatter
+    @units = [
+      { name: 'day', divisor: 1_000_000_000 * 60 * 60 * 24 },
+      { name: 'hour', divisor: 1_000_000_000 * 60 * 60 },
+      { name: 'min', divisor: 1_000_000_000 * 60 },
+      { name: 's',  divisor: 1_000_000_000 },
+      { name: 'ms', divisor: 1_000_000 },
+      { name: 'μs', divisor: 1_000 },
+      { name: 'ns', divisor: 1 }
+    ]
+
+    class << self
+
+      def get_unit(nanos)
+        found_unit = @units.find { |unit| nanos >= unit[:divisor] }
+        raise "No matching unit found for #{nanos}" if found_unit.nil?
+        found_unit
+      end
+
+      def scale_nanos_with_unit(nanos)
+        return "0 ns" if nanos.zero?
+        unit = get_unit(nanos)
+        value = nanos / unit[:divisor].to_f
+        "#{format_float(value)} #{unit[:name]}"
+      end
+
+      # format float to 3dp & remove trailing zeros
+      private def format_float(float)
+        sprintf('%f', float.round(3)).sub(/\.?0*$/, '')
+      end
+    end
+
+  end
+
+end

data/sig/pretty_stopwatch.rbs

@@ -0,0 +1,4 @@
+module PrettyStopwatch
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: pretty_stopwatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Mcfadyen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Pretty Stopwatch
+email:
+- ben.mcfadyen3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pretty_stopwatch.rb
+- lib/pretty_stopwatch/version.rb
+- sig/pretty_stopwatch.rbs
+homepage: https://github.com/BenMcFadyen/pretty_stopwatch_test
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/BenMcFadyen/pretty_stopwatch_test
+  source_code_uri: https://github.com/BenMcFadyen/pretty_stopwatch
+  changelog_uri: https://github.com/BenMcFadyen/pretty_stopwatch
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Pretty Stopwatch
+test_files: []