tiny_hooks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03bd1054909658e3d514127bfccb44fe64f987840a3a0b55873cc0a2dae53fb7
-  data.tar.gz: d052ca97c9e5b12efab72932e989d039a4dc72bb9f5911bd0a100fd97f95cf37
+  metadata.gz: 5b53066517bab59cf681b081724a473ea7eeaa18ad4cf94ce8d448af9a7f01a5
+  data.tar.gz: c1d4e8b2927345164162c5b76c1e9a743d4ca6bc0566d89b2c98feecb988bd04
 SHA512:
-  metadata.gz: c2bf43f43d5fa16caa64caff95e1b6dd2831f5a242e22cf01f732ffc3d312336e6b2a9f5b32cb24f9c8f774fe2d16e0de9ef547453760d8bf800723f31c7f9a0
-  data.tar.gz: e0f77aaf3299b760d8b6497850d35c99436b9d9e93d437c3b9cbdd309b865bc1ff5d3a8255c710a0c4aa039b04b56d0b5ae3117c44136a355f76166f4db5fba6
+  metadata.gz: 2d60d516f4d7e347504e7f167c0bc8e47c05b55a44acfc9265c9223400289aadbb720ce76a3f50938d8215fd8cb1fd26be8bc3a9fcf82af4ab61febc9c9a0aed
+  data.tar.gz: b05b43930d586e1f2c4bb6419c0353026e294bc3ef05b18d01a0e9fc414bd7cd69b1a3335ed8d7d8300c62bc9678a7923d35a9dc48c8413dd843a1f517ff7a95

data/.github/workflows/main.yml

@@ -4,15 +4,20 @@ on: [push,pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0, head]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.6
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.11
-        bundle install
         bundle exec rake
+

data/.rubocop.yml

@@ -15,7 +15,7 @@ AllCops:
     - 'tiny_hooks.gemspec'
   NewCops: enable
   EnabledByDefault: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.5
 
 # Oneline comment is not valid so until it gets valid, we disable it
 Bundler/GemComment:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-04-10
+
+- Support Ruby 2.5 and 2.6
+
 ## [0.1.0] - 2021-04-09
 
 - Initial release

data/README.md

@@ -1,8 +1,6 @@
 # TinyHooks
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tiny_hooks`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A tiny gem to define hooks.
 
 ## Installation
 
@@ -22,7 +20,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`extend TinyHooks` in your class/module and you're all set to use `define_hook`!
+
+```ruby
+class MyClass
+  extend TinyHooks
+
+  def my_method
+    puts 'my method'
+  end
+
+  define_hook :before, :my_method do
+    puts 'my before hook'
+  end
+end
+
+MyClass.new.my_method
+# => "my before hook\nmy method\n"
+```
+
+TinyHooks shines when the class/module is the base class/module of your library and your users will inherit/include it. In these cases, end users can define hooks to the methods you provide. The only thing you have to do is to provide the list of methods.
 
 ## Development
 

data/Rakefile

@@ -13,4 +13,5 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+default = ENV['CI'] ? %i[test] : %i[test rubocop]
+task default: default

data/lib/tiny_hooks.rb

@@ -8,51 +8,71 @@ require_relative 'tiny_hooks/version'
 module TinyHooks
   class Error < StandardError; end
 
-  # rubocop:disable Metrics/MethodLength
   # Define hook with kind and target method
   #
   # @param [Symbol, String] kind the kind of the hook, possible values are: :before, :after and :around
   # @param [Symbol, String] target the name of the targeted method
   def define_hook(kind, target, &block)
+    raise ArgumentError, 'You must provide a block' unless block
+
     original_method = instance_method(target)
     body = case kind.to_sym
            when :before
-             proc do |*args, **kwargs, &blk|
-               instance_exec(*args, **kwargs, &block)
-               original_method.bind_call(self, *args, **kwargs, &blk)
-             end
+             _before(original_method, &block)
            when :after
-             proc do |*args, **kwargs, &blk|
-               original_method.bind_call(self, *args, **kwargs, &blk)
-               instance_exec(*args, **kwargs, &block)
-             end
+             _after(original_method, &block)
            when :around
-             proc do |*args, **kwargs, &blk|
-               wrapper = -> { original_method.bind_call(self, *args, **kwargs, &blk) }
-               instance_exec(wrapper, *args, **kwargs, &block)
-             end
+             _around(original_method, &block)
            else
              raise Error, "#{kind} is not supported."
            end
     undef_method(target)
     define_method(target, &body)
   end
-  # rubocop:enable Metrics/MethodLength
 
   module_function :define_hook
 
-  # Restore original method from the registry
-  #
-  # @param [Symbol, String] target the name of the method to restore
-  def restore_original(target)
-    original = registry.fetch(target.to_sym) { instance_method(target) }
-    undef_method(target)
-    define_method(target, original)
+  private
+
+  def _before(original_method, &block)
+    if RUBY_VERSION >= '2.7'
+      proc do |*args, **kwargs, &blk|
+        instance_exec(*args, **kwargs, &block)
+        original_method.bind_call(self, *args, **kwargs, &blk)
+      end
+    else
+      proc do |*args, &blk|
+        instance_exec(*args, &block)
+        original_method.bind(self).call(*args, &blk)
+      end
+    end
   end
 
-  private
+  def _after(original_method, &block)
+    if RUBY_VERSION >= '2.7'
+      proc do |*args, **kwargs, &blk|
+        original_method.bind_call(self, *args, **kwargs, &blk)
+        instance_exec(*args, **kwargs, &block)
+      end
+    else
+      proc do |*args, &blk|
+        original_method.bind(self).call(*args, &blk)
+        instance_exec(*args, &block)
+      end
+    end
+  end
 
-  def registry
-    @registry ||= {}
+  def _around(original_method, &block)
+    if RUBY_VERSION >= '2.7'
+      proc do |*args, **kwargs, &blk|
+        wrapper = -> { original_method.bind_call(self, *args, **kwargs, &blk) }
+        instance_exec(wrapper, *args, **kwargs, &block)
+      end
+    else
+      proc do |*args, &blk|
+        wrapper = -> { original_method.bind(self).call(*args, &blk) }
+        instance_exec(wrapper, *args, &block)
+      end
+    end
   end
 end

data/lib/tiny_hooks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinyHooks
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/sider.yml

@@ -0,0 +1,59 @@
+# This is a configuration file to customize code analysis by Sider.
+#
+# For more information, see the documentation:
+# https://help.sider.review/getting-started/custom-configuration
+
+# Customize each tool. If analyses fail, try adjusting each option referencing the following example.
+linter:
+
+#   # Misspell example. See https://help.sider.review/tools/others/misspell
+#   misspell:
+#     root_dir: project/
+#     target: [src/, test/]
+#     exclude: ["**/*.min.*"]
+#     locale: UK
+#     ignore: [center, behavior]
+
+#   # Reek example. See https://help.sider.review/tools/ruby/reek
+#   reek:
+#     root_dir: project/
+#     dependencies:
+#       - { name: "reek", version: "6.0.0" }
+#     target: [lib/, test/]
+#     config: config/reek.yml
+
+#   # RuboCop example. See https://help.sider.review/tools/ruby/rubocop
+#   rubocop:
+#     root_dir: project/
+#     dependencies:
+#       - rubocop-rails
+#       - { name: "rubocop-rspec", version: "2.1.0" }
+#     config: config/.rubocop.yml
+#     safe: true
+
+#   # ShellCheck example. See https://help.sider.review/tools/shellscript/shellcheck
+#   shellcheck:
+#     root_dir: project/
+#     target:
+#       - "**/*.{sh,bash}"
+#       - shebang: true
+#     include: [SC2104, SC2105]
+#     exclude: [SC1000, SC1118]
+#     enable: all
+#     shell: bash
+#     severity: error
+#     norc: true
+
+# Ignore specific files. Example:
+# ignore:
+#   - "*.pdf"
+#   - "*.mp4"
+#   - "*.min.*"
+#   - "images/**"
+
+# Exclude specific branches. Example:
+# branches:
+#   exclude:
+#     - master
+#     - development
+#     - /^release-.*$/

data/tiny_hooks.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Simple, tiny and general hooks control."
   spec.homepage      = "https://github.com/okuramasafumi/tiny_hooks"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_hooks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OKURA Masafumi
@@ -30,6 +30,7 @@ files:
 - bin/setup
 - lib/tiny_hooks.rb
 - lib/tiny_hooks/version.rb
+- sider.yml
 - tiny_hooks.gemspec
 homepage: https://github.com/okuramasafumi/tiny_hooks
 licenses:
@@ -46,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.11
 signing_key:
 specification_version: 4
 summary: Simple, tiny and general hooks control.