elapsed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c09ed435ac26fa14241180aa1dd3321fae8cdaa61f97582a550ba34a9a68440c
-  data.tar.gz: 113cf2f6f1306f15500d08d401b2c33a79d80b21d2cbbafc2ff35b18103a7c1c
+  metadata.gz: 656ec628cbba4ac5b3af2e93ab092aa4d863c01d8ba260e1beeff647680f8e32
+  data.tar.gz: 90691a2d1cdafef93e8f7d829e3830ca58e6f275f49c1ee48ee2e0863dcaba1e
 SHA512:
-  metadata.gz: 0cb513a4b8c60d5b1940c5ddf46ac0714006f663746bc55b2156d65f672b526f721f0b03565b1d26f2529c247f669aace79aad343d95cb97dcde7a03eaec7e3d
-  data.tar.gz: 40695f5cdf209e33160d76df374a0ecd6f6c6a728c95612c717a57568d0a237c95a60d05d94dc23b4e611415655802e5dcfbd9396b4a9d2ef6492c3178cf6c9c
+  metadata.gz: a252c7949ec588e9ea1bb747f398f8c204f038974be9ecd407f764e1bd73f2b6176aaf5b177c768521c9f18de178b62ca9781a3cae77728095c8ed7c0a01464a
+  data.tar.gz: 6ffed0945dc6efef7aa0ba5e9b797c926180f9a6097af482bca07d2e69f90c27be39d1d319a85890f88f28adeaad60d5d3765ef05606e0eeb92bbe1d39a0fe9a

data/.gitignore

@@ -1,8 +1,9 @@
+*.gem
 .bundle/
+.claude/
 .DS_Store
 .idea/
 .yardoc/
-*.gem
 coverage/
 doc/
 node_modules/

data/Gemfile

@@ -14,5 +14,5 @@ gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false
 gem 'rubocop-rake', '~>0.7', require: false
 gem 'simplecov', '~>0.22', require: false
-gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'simplecov-cobertura', '~>3.0', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -2,8 +2,8 @@ PATH
   remote: .
   specs:
     elapsed (0.0.0)
-      loog (> 0)
-      tago (> 0)
+      loog (~> 0.6)
+      tago (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
     ast (2.4.3)
     builder (3.3.0)
     docile (1.4.1)
-    json (2.12.2)
+    json (2.13.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -25,7 +25,7 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
@@ -34,7 +34,7 @@ GEM
     rake (13.3.0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.77.0)
+    rubocop (1.79.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -42,10 +42,11 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.45.1, < 2.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
+      tsort (>= 0.2.0)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
+    rubocop-ast (1.46.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.1)
@@ -64,12 +65,13 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
+    simplecov-cobertura (3.0.0)
       rexml
       simplecov (~> 0.19)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     tago (0.1.0)
+    tsort (0.2.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
@@ -95,7 +97,7 @@ DEPENDENCIES
   rubocop-performance (~> 1.25)
   rubocop-rake (~> 0.7)
   simplecov (~> 0.22)
-  simplecov-cobertura (~> 2.1)
+  simplecov-cobertura (~> 3.0)
   yard (~> 0.9)
 
 BUNDLED WITH

data/README.md

@@ -48,6 +48,15 @@ elapsed do
 end
 ```
 
+You can also filter out small durations using the `over:` parameter:
+
+```ruby
+elapsed(Loog::VERBOSE, over: 0.5) do
+  # This message will only be logged if the block takes more than 0.5 seconds
+  run_something_that_might_be_fast
+end
+```
+
 That's it.
 
 ## How to contribute

data/elapsed.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'elapsed'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'A simple Ruby function to measure the time elapsed by the execution of a block'
   s.description =
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-  s.add_dependency 'loog', '>0'
-  s.add_dependency 'tago', '>0'
+  s.add_dependency 'loog', '~>0.6'
+  s.add_dependency 'tago', '~>0.1'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/elapsed.rb

@@ -23,9 +23,13 @@ require 'tago'
 # @param [String] good The message to print on success finish
 # @param [String] bad The message to print on failure finish
 # @param [Integer] level The level of logging to use
-def elapsed(log = nil, good: 'Finished', level: Logger::DEBUG, bad: 'Failed')
+# @param [Float] over The minimum duration in seconds to report
+def elapsed(log = nil, good: 'Finished', level: Logger::DEBUG, bad: 'Failed', over: 0)
   start = Time.now
   print_it = lambda do |m|
+    duration = Time.now - start
+    return if duration < over
+
     m += " in #{start.ago}"
     if log.nil?
       puts m

data/test/test_elapsed.rb

@@ -44,4 +44,58 @@ class TestElapsed < Minitest::Test
       4 + 5
     end
   end
+
+  def test_with_over_threshold_reports
+    loog = Loog::Buffer.new
+    elapsed(loog, over: 0.001) do
+      sleep(0.01)
+    end
+    assert_includes(loog.to_s, 'Finished')
+  end
+
+  def test_with_over_threshold_does_not_report
+    loog = Loog::Buffer.new
+    elapsed(loog, over: 1.0) do
+      4 + 5
+    end
+    assert_equal('', loog.to_s)
+  end
+
+  def test_with_over_threshold_on_error_reports
+    loog = Loog::Buffer.new
+    assert_raises(StandardError) do
+      elapsed(loog, over: 0.001, bad: 'Error occurred') do
+        sleep(0.01)
+        raise 'error'
+      end
+    end
+    assert_includes(loog.to_s, 'Error occurred')
+  end
+
+  def test_with_over_threshold_on_error_does_not_report
+    loog = Loog::Buffer.new
+    assert_raises(StandardError) do
+      elapsed(loog, over: 1.0, bad: 'Error occurred') do
+        raise 'error'
+      end
+    end
+    assert_equal('', loog.to_s)
+  end
+
+  def test_with_over_threshold_on_throw_reports
+    loog = Loog::Buffer.new
+    elapsed(loog, over: 0.001) do
+      sleep(0.01)
+      throw :done
+    end
+    assert_includes(loog.to_s, 'done')
+  end
+
+  def test_with_over_threshold_on_throw_does_not_report
+    loog = Loog::Buffer.new
+    elapsed(loog, over: 1.0) do
+      throw :done
+    end
+    assert_equal('', loog.to_s)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elapsed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -13,30 +13,30 @@ dependencies:
   name: loog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: tago
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: You simply pass a code block to the elapsed() function and it will print
   the summary of execution to the log with the time it took
 email: yegor256@gmail.com