obk 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af3e36c2357d3065b5c4817f2b582dbbaa356b2dc96f282fba15e910b040d98
-  data.tar.gz: 931c8f9d6c200cd54a45a3a8227687a6e3445ed53c751a477743579dade94264
+  metadata.gz: 3588c2aaa0acb3233db4a2f44e7cd97debdfe7ea43395810ab967daa20f14bda
+  data.tar.gz: cb1a410f2f1e8ae32fdcb4454e7202971514ca39e3fee1a99a7ad90fc012f286
 SHA512:
-  metadata.gz: 7f725b39d02c5f9f68ac4984141e78c5cc77502d1af1d8001cc3410331a96122151301e9873924f4843467588ad61f8148024b819f4495758f5196b720a4cba7
-  data.tar.gz: 714b2730f6a721256adb148887f2d32ea800236b9ead08d5e39a64c378382045c4fa1d6bffe4e54ca0d8169fee00e06b31398833946ade28dff603735e4b15fb
+  metadata.gz: 8ce340dfaa95b7617bc4df8f329457610d6db9c6df4504177dc6a957d610d5bde9148fa0502a1f2a90adf10358b0820055abe4f22c5ad372ba4927f05edd7419
+  data.tar.gz: 2452a0fd858c897a627a650fb1c119a67a85f47f36ca7ae9adcbb503e6994634069c2a46c61547cb200aee5e66349f6c6c9eb042faaa868f604fc9f364904c7f

data/.github/workflows/codecov.yml

@@ -0,0 +1,21 @@
+---
+name: codecov
+on:
+  push:
+    branches:
+      - master
+jobs:
+  codecov:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - run: bundle update
+      - run: bundle exec rake
+      - 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

@@ -0,0 +1,15 @@
+---
+name: pdd
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  pdd:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  rake:
+    name: rake
+    strategy:
+      matrix:
+        os: [ubuntu-22.04]
+        ruby: [2.7, 3.3]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle update
+      - run: bundle exec rake

data/.github/workflows/xcop.yml

@@ -0,0 +1,17 @@
+---
+name: xcop
+"on":
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  xcop:
+    runs-on: ubuntu-22.04
+    steps:
+      - 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

@@ -1,28 +1,26 @@
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
+  NewCops: enable
+  SuggestExtensions: false
 
 Layout/EndOfLine:
   EnforcedStyle: lf
-Style/MethodMissingSuper:
+Style/OptionalBooleanParameter:
   Enabled: false
-Layout/EmptyLineAfterGuardClause:
+Lint/MissingSuper:
   Enabled: false
-Layout/MultilineMethodCallIndentation:
+Metrics/MethodLength:
+  Max: 50
+Layout/EndAlignment:
+  Enabled: false
+Layout/ElseAlignment:
+  Enabled: false
+Layout/IndentationWidth:
   Enabled: false
 Metrics/AbcSize:
-  Max: 65
-Metrics/BlockLength:
   Max: 30
-Metrics/MethodLength:
-  Max: 50
-Metrics/ClassLength:
-  Max: 180
-Metrics/CyclomaticComplexity:
-  Max: 10
 Metrics/PerceivedComplexity:
-  Max: 10
-Metrics/ParameterLists:
-  Max: 10
-Layout/AlignParameters:
-  Enabled: false
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Max: 15

data/.rultor.yml

@@ -1,24 +1,19 @@
+docker:
+  image: yegor256/rultor-image:1.22.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
-install: |-
-  export GEM_HOME=~/.ruby
-  export GEM_PATH=$GEM_HOME:$GEM_PATH
-  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+install: |
+  pdd -f /dev/null
+  bundle install --no-color
 release:
   script: |-
-    bundle exec rake
-    rm -rf *.gem
+    bundle exec rake clean test rubocop copyright
     sed -i "s/0\.0\.0/${tag}/g" obk.gemspec
     git add obk.gemspec
-    git commit -m "Version set to ${tag}"
+    git commit -m "version set to ${tag}"
     gem build obk.gemspec
     chmod 0600 ../rubygems.yml
     gem push *.gem --config-file ../rubygems.yml
 merge:
   script: |-
-    bundle install
-    bundle exec rake
-deploy:
-  script: |-
-    echo 'Nothing to deploy'
-    exit -1
+    bundle exec rake clean test rubocop copyright

data/Gemfile

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

@@ -4,19 +4,18 @@
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/obk)](http://www.rultor.com/p/yegor256/obk)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
-[![Build Status](https://travis-ci.org/yegor256/obk.svg)](https://travis-ci.org/yegor256/obk)
-[![Build status](https://ci.appveyor.com/api/projects/status/pexc3cg49m75c0r6?svg=true)](https://ci.appveyor.com/project/yegor256/obk)
+[![rake](https://github.com/yegor256/obk/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/obk/actions/workflows/rake.yml)
+[![Test Coverage](https://img.shields.io/codecov/c/github/obk/cobench.svg)](https://codecov.io/github/yegor256/obk?branch=master)
 [![Gem Version](https://badge.fury.io/rb/obk.svg)](http://badge.fury.io/rb/obk)
-[![Maintainability](https://api.codeclimate.com/v1/badges/51b007d0eb24ceeeca94/maintainability)](https://codeclimate.com/github/yegor256/obk/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/e1be4e43e125fdc1e454/maintainability)](https://codeclimate.com/github/yegor256/obk/maintainability)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/obk/master/frames)
-
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/obk)](https://hitsofcode.com/view/github/yegor256/obk)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/obk/blob/master/LICENSE.txt)
 
 First, install it:
 
 ```bash
-$ gem install obk
+gem install obk
 ```
 
 Then, use it like this:
@@ -26,12 +25,12 @@ require 'obk'
 obj = Obk.new(obj, pause: 500)
 obj.foo
 # Forced 500ms delay here
-obj.foo
+obj.bar
 ```
 
-There will be a forced delay of 500 milliseconds between `.foo` calls.
+There will be a forced delay of 500 milliseconds between `.foo` and `.bar` calls.
 
-Keep in mind that `Obk` is thread-safe.
+Keep in mind that `Obk` is _not_ thread-safe.
 
 ## How to contribute
 
@@ -40,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 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
@@ -55,3 +55,11 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
   task.requires << 'rubocop-rspec'
 end
+
+task :copyright do
+  sh "grep -q -r '2021-#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/lib/obk.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2021 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,22 +28,36 @@
 # {README}[https://github.com/yegor256/obk/blob/master/README.md] file.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2021 Yegor Bugayenko
+# Copyright:: Copyright (c) 2021-2024 Yegor Bugayenko
 # License:: MIT
 class Obk
   def initialize(origin, pause: 1000)
     @origin = origin
-    @pause = pause
+    @pause = pause / 1000.0
+    @latest = Time.now
   end
 
   def method_missing(*args)
-    if block_given?
-      @origin.__send__(*args) do |*a|
-        yield(*a)
+    left = @pause - (Time.now - @latest)
+    sleep left if left.positive?
+    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
   end
 
   def respond_to?(method, include_private = false)

data/obk.gemspec

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2021 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
@@ -24,27 +24,18 @@
 
 require 'English'
 Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  if s.respond_to? :required_rubygems_version=
-    s.required_rubygems_version = Gem::Requirement.new('>= 0')
-  end
-  s.rubygems_version = '2.3.3'
+  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.1.0'
+  s.version = '0.3.1'
   s.license = 'MIT'
-  s.summary = 'Obk'
-  s.description = 'Obk'
+  s.summary = 'Ruby decorator to throttle object method calls'
+  s.description = 'Ruby decorator to throttle object method calls'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/obk'
   s.files = `git ls-files`.split($RS)
-  s.test_files = s.files.grep(%r{^(test)/})
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md']
-  s.add_development_dependency 'minitest', '5.11.3'
-  s.add_development_dependency 'rake', '12.3.3'
-  s.add_development_dependency 'rdoc', '4.3.0'
-  s.add_development_dependency 'rubocop', '0.62.0'
-  s.add_development_dependency 'rubocop-rspec', '1.31.0'
+  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 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 Yegor Bugayenko
+# Copyright:: Copyright (c) 2021-2024 Yegor Bugayenko
 # License:: MIT
 class ObkTest < Minitest::Test
   def test_simple
@@ -36,8 +36,32 @@ class ObkTest < Minitest::Test
     def obj.read(foo)
       foo
     end
-    foo = Obk.new(obj, pause: 100)
-    assert_equal(42, foo.read(42))
-    assert_equal(42, foo.read(42))
+    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 > 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,86 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: obk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.11.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.11.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.3.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.62.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.62.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.31.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.31.0
-description: Obk
+date: 2024-03-05 00:00:00.000000000 Z
+dependencies: []
+description: Ruby decorator to throttle object method calls
 email: yegor256@gmail.com
 executables: []
 extensions: []
@@ -88,24 +18,30 @@ extra_rdoc_files:
 - README.md
 files:
 - ".0pdd.yml"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/markdown-lint.yml"
+- ".github/workflows/pdd.yml"
+- ".github/workflows/rake.yml"
+- ".github/workflows/xcop.yml"
 - ".gitignore"
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - lib/obk.rb
 - logo.svg
 - obk.gemspec
+- renovate.json
+- test/test__helper.rb
 - test/test_obk.rb
 homepage: http://github.com/yegor256/obk
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -122,9 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.4.10
 signing_key: 
-specification_version: 2
-summary: Obk
-test_files:
-- test/test_obk.rb
+specification_version: 4
+summary: Ruby decorator to throttle object method calls
+test_files: []

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.0
-branches:
-  only:
-    - master
-install:
-  - bundle install
-script:
-  - set -e
-  - bundle exec rake
-

data/appveyor.yml

@@ -1,25 +0,0 @@
-version: '{build}'
-skip_tags: true
-clone_depth: 10
-branches:
-  only:
-    - master
-  except:
-    - gh-pages
-os: Windows Server 2012
-environment:
-  matrix:
-    - ruby_version: "25-x64"
-install:
-  - ps: |
-      $Env:PATH = "C:\Ruby${Env:ruby_version}\bin;${Env:PATH}"
-  - bundle config --local path vendor/bundle
-  - ruby -v
-  - bundle -v
-build_script:
-  - bundle update
-  - bundle install
-test_script:
-  - bundle exec rake --quiet
-cache:
-  - vendor/bundle