elapsed 0.0.1 → 0.2.0

data/test/test_elapsed.rb

@@ -1,42 +1,34 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2024 Yegor Bugayenko
-#
-# 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.
-
-require 'minitest/autorun'
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
 require 'loog'
+require_relative 'test__helper'
 require_relative '../lib/elapsed'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class TestElapsed < Minitest::Test
   def test_simple
     loog = Loog::Buffer.new
     r =
-      elapsed(loog, intro: 'Everything was good') do
+      elapsed(loog, good: 'Everything was good') do
         4 + 5
       end
     assert_equal(9, r)
-    assert(loog.to_s.include?('was good'))
+    assert_includes(loog.to_s, 'was good')
+  end
+
+  def test_with_failure
+    loog = Loog::Buffer.new
+    assert_raises(StandardError) do
+      elapsed(loog, bad: 'Failed miserably') do
+        raise 'oops'
+      end
+    end
   end
 
   def test_with_throw
@@ -44,7 +36,7 @@ class TestElapsed < Minitest::Test
     elapsed(loog) do
       throw :'Perfectly works'
     end
-    assert(loog.to_s.include?('works'))
+    assert_includes(loog.to_s, 'works')
   end
 
   def test_to_stdout
@@ -52,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,60 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: elapsed
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".0pdd.yml"
 - ".gitattributes"
 - ".github/workflows/actionlint.yml"
 - ".github/workflows/codecov.yml"
-- ".github/workflows/license.yml"
+- ".github/workflows/copyrights.yml"
 - ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
+- ".github/workflows/reuse.yml"
+- ".github/workflows/typos.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
 - ".gitignore"
@@ -65,19 +66,20 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- LICENSES/MIT.txt
 - README.md
+- REUSE.toml
 - Rakefile
 - elapsed.gemspec
 - lib/elapsed.rb
 - renovate.json
 - test/test__helper.rb
 - test/test_elapsed.rb
-homepage: http://github.com/yegor256/elapsed
+homepage: https://github.com/yegor256/elapsed
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -93,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A simple Ruby function to measure the time elapsed by the execution of a
   block

data/.github/workflows/license.yml

@@ -1,57 +0,0 @@
-# Copyright (c) 2024 Yegor Bugayenko
-#
-# 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.
----
-name: license
-'on':
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  license:
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - shell: bash
-        run: |
-          header="Copyright (c) $(date +%Y) Yegor Bugayenko"
-          failed="false"
-          while IFS= read -r file; do
-            if ! grep -q "${header}" "${file}"; then
-              failed="true"
-              echo "⚠️ Copyright header is not found in: ${file}"
-            else
-              echo "File looks good: ${file}"
-            fi
-          done < <(find . -type f \( \
-            -name "Dockerfile" -o \
-            -name "LICENSE.txt" -o \
-            -name "Makefile" -o \
-            -name "Rakefile" -o \
-            -name "*.sh" -o \
-            -name "*.rb" -o \
-            -name "*.fe" -o \
-            -name "*.yml" \
-            \) -print)
-          if [ "${failed}" = "true" ]; then
-            exit 1
-          fi