pretty_stopwatch 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba3811db87aefda87dc46290686c31917665972a1f14d80739015d4fe288ddf1
-  data.tar.gz: 23b860704b818babfb475e803211fe1055065ac1ecfd29aa6a2711a99f88796c
+  metadata.gz: 7fcddcb209f62c6aa2dd5590919a588c549cd40a9d2b5719870b9d2d5d5b8f22
+  data.tar.gz: 36244820de0bcee5d516eb7c78691dfd0dd3c1b4ad45d35a8e9151da79c41aa3
 SHA512:
-  metadata.gz: 4b5d2a2482c85fa0098d03b213583645e21de723152750704b38b164d73a7888b1fee5316767df34449bec2b40d10bbe35cb2051ad17e38dc271bed39062964f
-  data.tar.gz: e0f4a8cb22040e7a42037fbf33620060b00b2dec59c03fd46557614930c7881c8fdff5be8084b21b639c70bdaf370a762eb8698be936589317fb02201a6ca97d
+  metadata.gz: cb1fc44fb109dd7ed499330f537274071fbdbcae2c9fc0f4ca6811635f63a16fd64c41a3eba3007a137facaa9501866083ed9a320dfec9c36ab4565be8971834
+  data.tar.gz: 7fb43e0f69b476c2dc2ab6d41cfed5b85f84501d3044749f129ad161db8f073292618f96d205e52af35f2ddd0e0c7f929fea1e259ec97d703ecd29bc0699d51c

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.0"
-end
+# frozen_string_literal: true
+
+module PrettyStopwatch
+  VERSION = "0.1.2"
+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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ben Mcfadyen
@@ -39,12 +39,12 @@ files:
 - lib/pretty_stopwatch.rb
 - lib/pretty_stopwatch/version.rb
 - sig/pretty_stopwatch.rbs
-homepage: https://github.com/BenMcFadyen/pretty_stopwatch_test
+homepage: https://github.com/BenMcFadyen/pretty_stopwatch
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/BenMcFadyen/pretty_stopwatch_test
+  homepage_uri: https://github.com/BenMcFadyen/pretty_stopwatch
   source_code_uri: https://github.com/BenMcFadyen/pretty_stopwatch
   changelog_uri: https://github.com/BenMcFadyen/pretty_stopwatch
 post_install_message: