pretty_stopwatch 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc13ff6a5acab33b4e2ddabd5b13132cebb33ab62e559ab93341326d228a85e
-  data.tar.gz: 0c5cf9078b6c57adea68080d260c3b1527e2d5c89ab3151a313233fc1c7a7dee
+  metadata.gz: f6c38e209a9aed274b4b020c88f62f806d627b7f4f52b1bf6ac25c8d4ef90ca1
+  data.tar.gz: cbf674f15bd8ba525a3a22ed957f7de8eab06fe228c2dc749b9e56811cf97116
 SHA512:
-  metadata.gz: 7be811ebd615a0a341cf6312d9c6ab2ae26f73afedb3bedcec0934c110aa67a0f8583df2b1bf34b405d1d07a8d5bc225590992a1a5cd34f0ea282735d69c6800
-  data.tar.gz: 5752c08a7122c2f151ba9050df5a57a70f659eef2e79aa996b66663a4424084d36e1f18667cde9b38d46d096a564660b1a1335a6758e522dcacd1849365b3f02
+  metadata.gz: 6eea6338238a1def7bb6421e0183c9f19d7f5f22eb2909b293e8bdcda3809c32bd5f7cd9b9fb9bbd68e8c999ddcef423a59c5abb284b051766de4b5dc4ee19c4
+  data.tar.gz: 1caa1fd00ec324547fe0074deb304ebc3240abe4b314299a76440f8efadc823bb495c145c2cdfbd114ce9e1a62472b2ba4e829a62146eece0d7f25bd2770a475

data/README.md

@@ -1,20 +1,27 @@
 # PrettyStopwatch
 
-TODO: Delete this and the text below, and describe your gem
+A simple Stopwatch with nanosecond precision and readable formatting.
 
-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.
+Basic Usage:
+
+    stopwatch = Stopwatch::create_started
+    sleep(0.1)
+    stopwatch.stop # optional
+    puts "slept for #{stopwatch}" # to_s optional
+    # slept for 100.02 ms
 
-## 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.
+Based on the Guava Stopwatch com.google.common.base.Stopwatch. Credit: The Guava Authors
+
+## Installation
 
 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
+    $ bundle add pretty_stopwatch
 
 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
+    $ gem install pretty_stopwatch
 
 ## Usage
 

data/Rakefile

@@ -1,10 +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]
+# 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

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

data/lib/pretty_stopwatch.rb

@@ -1,160 +1,152 @@
-# 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
+# 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
+  attr_reader :name
+  attr_reader :running
+
+  def initialize(name = nil, elapsed_nanos = 0) # 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)
+      new(name, elapsed_nanos).start
+    end
+
+    def create_unstarted(name = nil, elapsed_nanos: 0)
+      new(name, elapsed_nanos)
+    end
+
+    def time(callable = nil, &block)
+      stopwatch = create_started
+      if callable
+        callable.call
+      elsif block
+        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.to_s
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pretty_stopwatch
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ben Mcfadyen
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: Pretty Stopwatch
+description: A simple Stopwatch with nanosecond precision and readable formatting.
 email:
 - ben.mcfadyen3@gmail.com
 executables: []
@@ -65,5 +65,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Pretty Stopwatch
+summary: A simple Stopwatch with nanosecond precision and readable formatting.
 test_files: []