obk 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34fd03b0e47f11f25a670c4c9c854df9898d707e996bc7435410a89bcdcb583
-  data.tar.gz: 1fef24bde0357f0f60bdc1831346519186e068babbfc222d6d06a7ba86652ee7
+  metadata.gz: 3588c2aaa0acb3233db4a2f44e7cd97debdfe7ea43395810ab967daa20f14bda
+  data.tar.gz: cb1a410f2f1e8ae32fdcb4454e7202971514ca39e3fee1a99a7ad90fc012f286
 SHA512:
-  metadata.gz: d7a482d7277343072200ac507b7f60500e89fd49c370caa12267b7175ec0a24e1777307661a107768ce7b9e12343956891e220ea309a4d4a2454750a6c647302
-  data.tar.gz: 72bd6de675fe5fe4bc387a88cff0081c408a9f027d1d4cc7d2f0d9ff2874ca586a7bde86eca100d70c3b0335f16902ef715ed05eccdb53d19ef38d60905284ab
+  metadata.gz: 8ce340dfaa95b7617bc4df8f329457610d6db9c6df4504177dc6a957d610d5bde9148fa0502a1f2a90adf10358b0820055abe4f22c5ad372ba4927f05edd7419
+  data.tar.gz: 2452a0fd858c897a627a650fb1c119a67a85f47f36ca7ae9adcbb503e6994634069c2a46c61547cb200aee5e66349f6c6c9eb042faaa868f604fc9f364904c7f

data/.github/workflows/codecov.yml

@@ -6,15 +6,16 @@ on:
       - master
 jobs:
   codecov:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.3
       - run: bundle update
       - run: bundle exec rake
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v4
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           file: coverage/.resultset.json
           fail_ci_if_error: true

data/.github/workflows/markdown-lint.yml

@@ -0,0 +1,19 @@
+---
+name: markdown-lint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+    paths-ignore: [ 'paper/**', 'sandbox/**' ]
+concurrency:
+  group: markdown-lint-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@b32f140b0c872d58512e0a66172253c302617b90
+      - uses: articulate/actions-markdownlint@v1

data/.github/workflows/pdd.yml

@@ -1,6 +1,6 @@
 ---
 name: pdd
-"on":
+on:
   push:
     branches:
       - master
@@ -9,7 +9,7 @@ name: pdd
       - master
 jobs:
   pdd:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: g4s8/pdd-action@master
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -8,15 +8,15 @@ on:
     branches:
       - master
 jobs:
-  test:
-    name: test
+  rake:
+    name: rake
     strategy:
       matrix:
-        os: [ubuntu-20.04]
-        ruby: [2.6]
+        os: [ubuntu-22.04]
+        ruby: [2.7, 3.3]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/xcop.yml

@@ -9,9 +9,9 @@ name: xcop
       - master
 jobs:
   xcop:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: g4s8/xcop-action@master
         with:
           files: '**/*.xml'

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 .DS_Store
 rdoc/
 .idea/
+coverage/

data/.rubocop.yml

@@ -18,3 +18,9 @@ Layout/ElseAlignment:
   Enabled: false
 Layout/IndentationWidth:
   Enabled: false
+Metrics/AbcSize:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Max: 15

data/.rultor.yml

@@ -1,10 +1,10 @@
 docker:
-  image: yegor256/rultor-image:1.9.1
+  image: yegor256/rultor-image:1.22.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
   pdd -f /dev/null
-  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+  bundle install --no-color
 release:
   script: |-
     bundle exec rake clean test rubocop copyright

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright (c) 2021-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
@@ -21,5 +21,11 @@
 # SOFTWARE.
 
 source 'https://rubygems.org'
-ruby '~>2.3'
 gemspec
+
+gem 'minitest', '5.22.2', require: false
+gem 'rake', '13.1.0', require: false
+gem 'rdoc', '6.6.2', require: false
+gem 'rubocop', '1.61.0', require: false
+gem 'rubocop-rspec', '2.27.1', require: false
+gem 'simplecov', '0.22.0', require: false

data/README.md

@@ -15,7 +15,7 @@
 First, install it:
 
 ```bash
-$ gem install obk
+gem install obk
 ```
 
 Then, use it like this:
@@ -39,9 +39,9 @@ Make sure you build is green before you contribute
 your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
 [Bundler](https://bundler.io/) installed. Then:
 
-```
-$ bundle update
-$ bundle exec rake
+```bash
+bundle update
+bundle exec rake
 ```
 
 If it's clean and you don't see any error messages, submit your pull request.

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright (c) 2021-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

data/lib/obk.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright (c) 2021-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
@@ -28,7 +28,7 @@
 # {README}[https://github.com/yegor256/obk/blob/master/README.md] file.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright:: Copyright (c) 2021-2024 Yegor Bugayenko
 # License:: MIT
 class Obk
   def initialize(origin, pause: 1000)
@@ -40,12 +40,21 @@ class Obk
   def method_missing(*args)
     left = @pause - (Time.now - @latest)
     sleep left if left.positive?
-    result = if block_given?
-      @origin.__send__(*args) do |*a|
-        yield(*a)
+    mtd = args.shift
+    result = if @origin.respond_to?(mtd)
+      params = @origin.method(mtd).parameters
+      reqs = params.count { |p| p[0] == :req }
+      if params.any? { |p| p[0] == :key } && args.size > reqs
+        @origin.__send__(mtd, *args[0...-1], **args.last) do |*a|
+          yield(*a) if block_given?
+        end
+      else
+        @origin.__send__(mtd, *args) do |*a|
+          yield(*a) if block_given?
+        end
       end
     else
-      @origin.__send__(*args)
+      super
     end
     @latest = Time.now
     result

data/obk.gemspec

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright (c) 2021-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
@@ -27,7 +27,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 = '>=2.3'
   s.name = 'obk'
-  s.version = '0.3.0'
+  s.version = '0.3.1'
   s.license = 'MIT'
   s.summary = 'Ruby decorator to throttle object method calls'
   s.description = 'Ruby decorator to throttle object method calls'
@@ -37,10 +37,5 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split($RS)
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md']
-  s.add_development_dependency 'minitest', '5.16.2'
-  s.add_development_dependency 'rake', '13.0.6'
-  s.add_development_dependency 'rdoc', '6.4.0'
-  s.add_development_dependency 'rubocop', '1.34.1'
-  s.add_development_dependency 'rubocop-rspec', '2.12.1'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

data/test/test__helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2021-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.
+
+$stdout.sync = true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/autorun'

data/test/test_obk.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright (c) 2021-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
@@ -28,7 +28,7 @@ require_relative '../lib/obk'
 
 # Obk test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2021-2022 Yegor Bugayenko
+# Copyright:: Copyright (c) 2021-2024 Yegor Bugayenko
 # License:: MIT
 class ObkTest < Minitest::Test
   def test_simple
@@ -36,11 +36,32 @@ class ObkTest < Minitest::Test
     def obj.read(foo)
       foo
     end
-    obj = Obk.new(obj, pause: 1000)
+    obj = Obk.new(obj, pause: 100)
     start = Time.now
     assert_equal(42, obj.read(42))
     assert_equal(42, obj.read(42))
     stop = Time.now
-    assert(stop - start > 1)
+    assert(stop - start > 0.1)
+  end
+
+  def test_works_with_optional_arguments
+    obj = Object.new
+    def obj.foo(first, _second, ext1: 'a', ext2: 'b')
+      first + ext1 + ext2
+    end
+    synced = Obk.new(obj, pause: 10)
+    assert_equal('.xy', synced.foo('.', {}, ext1: 'x', ext2: 'y'))
+    assert_equal('fzb', synced.foo('f', {}, ext1: 'z'))
+    assert_equal('-ab', synced.foo('-', {}))
+  end
+
+  def test_works_with_default_value
+    obj = Object.new
+    def obj.foo(first, second = 42)
+      first + second
+    end
+    synced = Obk.new(obj, pause: 10)
+    assert_equal(15, synced.foo(7, 8))
+    assert_equal(43, synced.foo(1))
   end
 end

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: obk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.16.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.16.2
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.4.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.34.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.34.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.12.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.12.1
+date: 2024-03-05 00:00:00.000000000 Z
+dependencies: []
 description: Ruby decorator to throttle object method calls
 email: yegor256@gmail.com
 executables: []
@@ -89,6 +19,7 @@ extra_rdoc_files:
 files:
 - ".0pdd.yml"
 - ".github/workflows/codecov.yml"
+- ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/xcop.yml"
@@ -103,6 +34,8 @@ files:
 - lib/obk.rb
 - logo.svg
 - obk.gemspec
+- renovate.json
+- test/test__helper.rb
 - test/test_obk.rb
 homepage: http://github.com/yegor256/obk
 licenses:
@@ -125,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby decorator to throttle object method calls