monotonic.rb 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17e3187f97eede654634d62e5eeba6595b19df22dd6e38be3d5a64f5ee9cbc68
-  data.tar.gz: d72962badf2f68b748d8fe48ebab3e3e1fcf78a8a4fd133d3c1bce663459fc5f
+  metadata.gz: a9992e2194aa62416707e8ee507f68f870e4eea0cbee2770879017d07d2ff7e7
+  data.tar.gz: 8221c6232e0c2f1df21d9d5faaf42c7292ed1052801c8fe7f8cd6b819fdd4bde
 SHA512:
-  metadata.gz: 74ec59b8280c65b333fd22b4293370784c6756a4980d316700833645f6a67305393a06098ce5d1950c9e4b331049d3662b7fbd1915590cbb40074c1aaafd9217
-  data.tar.gz: 0b31c5c4dad215a636b7053008353af3097db2fbdb0e2fb1654bbf7fd2ed341f065c5a867a9d072c96107d7d9e486458e741e76df012d2cc31cdef941e1b78e0
+  metadata.gz: 7a827ddd7420e8ff5911ca543cc5dbf46765063f521fefb55f0be0f883fe73c21b2552f43d5e6890e6a01e826c335c8d86ddfdb8db087983f25fd029d91e3cf0
+  data.tar.gz: 35d7a1115045c486bd49074f31098a6d0c6d2e21fa795a0f07fd842120a1b3a407c9f3b76456b31dd8a185c4659212ba8bd85e08cd7968d7bd33beede84c8a19

data/CHANGELOG

@@ -0,0 +1,143 @@
+# CHANGELOG
+
+## 20260716
+
+0.6.7: Block exception bug fix, relicensing, and gem packaging changes.
+
+1. ~ Monotonic::Timer#time: - the `return total_time` from the ensure clause, since returning from an ensure swallowed any exception raised by the block, handing back a duration in place of the error. The exception is now allowed to propagate. The ensure itself is kept, and narrowed to the block, so that stop still runs when the block is interrupted: the time up to an interruption is worth having, and without the stop total_time would go on running rather than hold at the point of interruption. It is read from the timer, since the return value belongs to the exception.
+2. ~ test/Monotonic/Timer_test.rb: + a test to demonstrate that an exception raised within the block is no longer swallowed.
+3. ~ test/Monotonic/Timer_test.rb: + a test to demonstrate that the time up to an interruption holds rather than goes on running.
+4. - test/monotonic_test.rb: A Rakefile has been introduced to run all files.
+5. ~ monotonic.rb.gemspec: /Ruby/MIT/ for the license.
+6. ~ monotonic.rb.gemspec: Gem::Specification#dependencies= and #development_dependencies=, so that dependencies may be enumerated as a list rather than a call apiece.
+7. ~ monotonic.rb.gemspec: spec.files to include CHANGELOG, Gemfile, the gemspec, the Rakefile, README.md and the tests, rather than lib/**/*.rb alone.
+8. ~ monotonic.rb.gemspec: spec.require_paths, since spec.files is no longer confined to lib/.
+9. + monotonic.rb.gemspec: rake as a development dependency.
+10. + Rakefile: a test task, run by default.
+11. ~ lib/Monotonic/Time.rb: - empty lines from within the class body.
+12. ~ lib/Monotonic/Timer.rb: - empty lines from within the class body.
+13. ~ CHANGELOG: Reformat headers, number the changes, and remove `.md`.
+14. ~ Monotonic::VERSION: /0.6.6/0.6.7/
+
+
+## 20260716
+
+0.6.6: Case-sensitive filesystem fixes.
+
+1. ~ lib/monotonic/ --> lib/Monotonic/: the directory was the only reference using lowercase, while the entry require, the test requires and the gemspec all already used Monotonic/, so the published gem failed to load on case-sensitive (Linux) filesystems.
+2. ~ lib/Monotonic/VERSION.rb: /class Monotonic/module Monotonic/ so it matches the module reopened in Time.rb and Timer.rb, rather than raising TypeError when loaded alongside them.
+3. + lib/monotonic.rb: require_relative './Monotonic/VERSION' (as Duration.rb does for its own VERSION), so Monotonic::VERSION is available after requiring the gem. VERSION.rb being off the load path is what let the class/module error above go unnoticed: nothing loaded it alongside Time.rb and Timer.rb, so the conflict never fired.
+
+
+## 20240822
+
+0.6.5: Block usage bug fix
+
+1. ~ lib/monotonic/Timer.rb: The total_time must be explicitly returned since values in ensure are not returned as the default return value.
+
+
+## 20240822
+
+0.6.4: Correct README.md.
+
+1. ~ README.md: In the Usage section: /MonotonicTime/Monotonic::Time/
+2. ~ lib/monotonic/VERSION.rb: 0.6.3 --> 0.6.4 because I mistakenly pulled the 0.6.3 gem.
+
+
+## 20210627
+
+0.6.3: Using gemspec in Gemfile.
+
+1. ~ Gemfile to use gemspec rather than having dependencies enumerated there
+
+
+## 20210625
+
+0.6.2: Fixed missing sys-uptime dependency.
+
+1. ~ montonic.rb.gemspec to include the sys-uptime dependency
+
+
+## 20210623
+
+0.6.1: README fix and a small refactor
+
+1. ~ README.md: /monotonic/monotonic.rb/
+2. ~ Monotonic::Timer.time to make use of the same-named instance method now that it's available.
+
+
+## 20210623
+
+0.6.0: Version number bump due to name change from monotony.rb to monotonic.rb
+
+1. /Monotony//, Monotonic::Timer is shorter than Monotony::MonotonicTimer
+
+
+## 20210607
+
+0.5.0: Added timing block on an instance of MonotonicTimer
+
+1. + MonotonicTime#+
+2. + MonotonicTime#-
+3. ~ MonotonicTimer#start: - use of MonotonicTime#to_time (using MonotonicTime#- instead)
+4. ~ MonotonicTimer#stop: - use of MonotonicTime#to_time (using MonotonicTime#- instead)
+5. + MonotonicTimer#time
+
+
+## 20210607
+
+0.4.1: Fixed starting and stopping
+
+1. - MonotonicTimer#initialize: - @total_time as it just made things more complicated unless needing splits
+2. ~ MonotonicTimer#start: - @start_monotonic_time as it wasn't really needed
+3. ~ MonotonicTimer#stop: - @stop_monotonic_time as it wasn't really needed
+4. ~ MonotonicTimer#total_time: - @total_time as it just made things more complicated unless needing splits
+
+
+## 20210606
+
+0.4.0: Named Monotony and prepped as a gem.
+
+1. /monotonic_time.rb/MonotonicTime.rb/
+2. /monotonic_timer.rb/MonotonicTimer.rb/
+3. + Monotony namespace
+4. + monotony.gemspec
+
+
+## 20210604
+
+0.3.0
+
+1. ~ MonotonicTimer.time, so that it returns the total time to the value of the block
+2. + ./test/monotonic_time_test.rb
+3. ~ ./test/monotonic_timer_test.rb
+
+
+## 20210510
+
+0.2.0: Added somewhat proper testing
+
+1. + ./test/monotonic_timer_test.rb
+2. ~ ./lib/monotonic_timer.rb: - self-run section test
+
+
+## 20200510
+
+0.1.1
+
+1. ~ ./lib/monotonic_timer.rb: + self-run section test
+
+
+## 20200115
+
+0.1.0: Added classes for better structure
+
+1. + MonotonicTime
+2. + MonotonicTimer
+
+
+## 20200115
+
+0.0.0
+
+1. + timer()

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://www.rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,99 @@
+# monotonic.rb
+
+## Description
+
+Create accurate timings of excution in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+  gem 'monotonic.rb'
+```
+And then execute:
+```bash
+  $ bundle
+```
+Or install it yourself as:
+```bash
+  $ gem install monotonic.rb
+```
+
+## Usage
+
+### Monotonic::Time
+
+```ruby
+  require 'monotonic.rb'
+  monotonic_time = Monotonic::Time.new
+  monotonic_time.seconds_since_boot
+  # => 1208799.325906
+  monotonic_time + Monotonic::Time.now
+  # => 2417598.681896
+  monotonic_time - Monotonic::Time.now
+  # => -0.044104999862611294
+  monotonic_time.to_s
+  # => "1164320.268127 seconds since boot."
+  monotonic_time.to_time
+  # => 2021-06-07 09:27:08 8249692651179/8388608000000 +1000
+```
+
+### Monotonic::Timer without a block
+
+```ruby
+  require 'monotonic.rb'
+  timer = Monotonic::Timer.new
+  timer.start
+  i = 0
+  1_000_000.times{puts i += 1}
+  timer.stop
+  timer.total_time
+  # => 7.166559999808669
+```
+
+### Monotonic::Timer with a block
+
+```ruby
+  require 'monotonic.rb'
+  time = Monotonic::Timer.time do
+    i = 0
+    1_000_000.times{puts i += 1}
+  end
+  time
+  # => 6.975823000073433
+```
+
+### Monotonic::Timer with a block and block variable
+
+```ruby
+  require 'monotonic.rb'
+  time = Monotonic::Timer.time do |timer|
+    i = 0
+    500_000.times{puts i += 1}
+    p timer.total_time
+    500_000.times{puts i += 1}
+  end
+  time
+  # => 6.975823000073433
+```
+
+### Monotonic::Timer with a block on a timer instance
+
+```ruby
+  require 'monotonic.rb'
+  timer = Monotonic::Timer.new
+  time = timer.time do
+    i = 0
+    1_000_000.times{puts i += 1}
+  end
+  time
+  # => 7.033131000120193
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/thoran/monotonic.rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request

data/Rakefile

@@ -0,0 +1,9 @@
+# Rakefile
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/Monotonic/Time.rb

@@ -5,13 +5,10 @@ require 'sys-uptime'
 
 module Monotonic
   class Time
-
     class << self
-
       def now
         self.new
       end
-
     end # class << self
 
     attr_reader :seconds_since_boot
@@ -36,6 +33,5 @@ module Monotonic
     def to_time
       @boot_time + @seconds_since_boot
     end
-
   end
 end

data/lib/Monotonic/Timer.rb

@@ -5,14 +5,11 @@ require_relative './Time'
 
 module Monotonic
   class Timer
-
     class << self
-
       def time(&block)
         timer = Timer.new
         timer.time(&block)
       end
-
     end # class << self
 
     def start
@@ -34,11 +31,12 @@ module Monotonic
 
     def time
       start
-      yield self
-    ensure
-      stop
-      return total_time
+      begin
+        yield self
+      ensure
+        stop
+      end
+      total_time
     end
-
   end
 end

data/lib/Monotonic/VERSION.rb

@@ -2,5 +2,5 @@
 # Monotonic::VERSION
 
 module Monotonic
-  VERSION = '0.6.6'
+  VERSION = '0.6.7'
 end

data/monotonic.rb.gemspec

@@ -0,0 +1,47 @@
+require_relative './lib/Monotonic/VERSION'
+
+class Gem::Specification
+  def dependencies=(gems)
+    gems.each{|gem| add_dependency(*gem)}
+  end
+
+  def development_dependencies=(gems)
+    gems.each{|gem| add_development_dependency(*gem)}
+  end
+end
+
+Gem::Specification.new do |spec|
+  spec.name = 'monotonic.rb'
+  spec.version = Monotonic::VERSION
+
+  spec.summary = "Monotonic timing made easy."
+  spec.description = "Create accurate timings of excution in Ruby."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'https://github.com/thoran/monotonic.rb'
+  spec.license = 'MIT'
+
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.files = [
+    'CHANGELOG',
+    'Gemfile',
+    Dir['lib/**/*.rb'],
+    'monotonic.rb.gemspec',
+    'Rakefile',
+    'README.md',
+    Dir['test/**/*.rb'],
+  ].flatten
+
+  spec.dependencies = %w{
+    sys-uptime
+  }
+
+  spec.development_dependencies = %w{
+    minitest
+    minitest-spec-context
+    rake
+  }
+end

data/test/Monotonic/Time_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../lib/Monotonic/Time'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+describe Monotonic::Time do
+  subject{Monotonic::Time.now}
+
+  describe "#initialize" do
+    it "the time spent in the block is returned as the value of the block" do
+      expect(subject.instance_variable_get(:@boot_time)) \
+        .must_equal(Sys::Uptime.boot_time)
+    end
+
+    it "the time spent in the block is returned as the value of the block" do
+      expect(subject.instance_variable_get(:@seconds_since_boot).round(2)) \
+        .must_equal(Process.clock_gettime(Process::CLOCK_MONOTONIC).round(2))
+    end
+  end
+
+  describe "#seconds_since_boot" do
+    it "returns an instance of string" do
+      expect((subject.seconds_since_boot).class).must_equal(Float)
+    end
+  end
+
+  describe "#+" do
+    it "returns an instance of string" do
+      expect((subject + Monotonic::Time.now).class).must_equal(Float)
+    end
+  end
+
+  describe "#-" do
+    it "returns an instance of time" do
+      expect((subject - Monotonic::Time.now).class).must_equal(Float)
+    end
+  end
+
+  describe "#to_s" do
+    it "returns an instance of string" do
+      expect(subject.to_s.class).must_equal(String)
+    end
+  end
+
+  describe "#to_time" do
+    it "returns an instance of time" do
+      expect(subject.to_time.class).must_equal(Time)
+    end
+  end
+end

data/test/Monotonic/Timer_test.rb

@@ -0,0 +1,110 @@
+require_relative '../../lib/Monotonic/Timer'
+
+require 'minitest/autorun'
+require 'minitest-spec-context'
+
+describe Monotonic::Timer do
+  context "with a block" do
+    it "the time spent in the block is returned as the value of the block" do
+      block_time = Monotonic::Timer.time do |timer|
+        sleep 3
+      end
+      expect(block_time.round).must_equal(3)
+    end
+
+    # Test introduced in 0.6.5 to demonstrate that the bug had been fixed.
+    it "the time spent in the block is returned as the value of the block and not a value at the end of the block" do
+      block_time = Monotonic::Timer.time do |timer|
+        sleep 3
+        4
+      end
+      expect(block_time.round).must_equal(3)
+    end
+
+    # Test introduced in 0.6.7 to demonstrate that the bug had been fixed.
+    it "an exception raised within the block is not swallowed" do
+      expect{Monotonic::Timer.time{raise(ArgumentError)}}.must_raise(ArgumentError)
+    end
+
+    it "allows the timer to be started and stopped within the block" do
+      Monotonic::Timer.time do |timer|
+        sleep 1
+        expect(timer.total_time.round).must_equal(1)
+        timer.stop
+        expect(timer.total_time.round).must_equal(1)
+        timer.start
+        expect(timer.total_time.round).must_equal(0)
+        sleep 1
+        expect(timer.total_time.round).must_equal(1)
+        sleep 1
+        expect(timer.total_time.round).must_equal(2)
+        timer.start
+        expect(timer.total_time.round).must_equal(0)
+      end
+    end
+
+    it "alters the block time if it is started and stopped within the block" do
+      block_time = Monotonic::Timer.time do |timer|
+        sleep 1
+        timer.stop
+        sleep 1
+        timer.start
+        sleep 1
+      end
+      expect(block_time.round).must_equal(1)
+    end
+  end
+
+  context "without a block" do
+    it 'works' do
+      timer = Monotonic::Timer.new
+      timer.start
+      sleep 1
+      expect(timer.total_time.round).must_equal(1)
+      timer.stop
+      expect(timer.total_time.round).must_equal(1)
+      timer.start
+      expect(timer.total_time.round).must_equal(0)
+      sleep 1
+      expect(timer.total_time.round).must_equal(1)
+      sleep 1
+      expect(timer.total_time.round).must_equal(2)
+      timer.start
+      expect(timer.total_time.round).must_equal(0)
+    end
+  end
+
+  context "with a block on an timer instance" do
+    it 'works' do
+      timer = Monotonic::Timer.new
+      time = timer.time do |timer|
+        sleep 1
+        expect(timer.total_time.round).must_equal(1)
+        timer.stop
+        expect(timer.total_time.round).must_equal(1)
+        sleep 1
+        expect(timer.total_time.round).must_equal(1)
+        timer.start
+        expect(timer.total_time.round).must_equal(0)
+        sleep 1
+      end
+      expect(time.round).must_equal(1)
+      expect(timer.total_time.round).must_equal(1)
+    end
+
+    # Test introduced in 0.6.7 to demonstrate that the time up to an
+    # interruption is not left running.
+    it "the time up to an interruption remains available from the timer" do
+      timer = Monotonic::Timer.new
+      begin
+        timer.time do
+          sleep 1
+          raise(ArgumentError)
+        end
+      rescue ArgumentError
+      end
+      sleep 1
+      expect(timer.total_time.round).must_equal(1)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monotonic.rb
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - thoran
@@ -51,19 +51,40 @@ dependencies:
     - - ">="
       - !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'
 description: Create accurate timings of excution in Ruby.
 email: code@thoran.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
 - lib/Monotonic/Time.rb
 - lib/Monotonic/Timer.rb
 - lib/Monotonic/VERSION.rb
 - lib/monotonic.rb
+- monotonic.rb.gemspec
+- test/Monotonic/Time_test.rb
+- test/Monotonic/Timer_test.rb
 homepage: https://github.com/thoran/monotonic.rb
 licenses:
-- Ruby
+- MIT
 metadata: {}
 rdoc_options: []
 require_paths: