tiny_hooks 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b53066517bab59cf681b081724a473ea7eeaa18ad4cf94ce8d448af9a7f01a5
-  data.tar.gz: c1d4e8b2927345164162c5b76c1e9a743d4ca6bc0566d89b2c98feecb988bd04
+  metadata.gz: 0c9ab59bc23d29d510f328d7b6c0f19bfc9b561b37b6865174cccb1470e76513
+  data.tar.gz: 58f946a1c561d3a52d4f3cb5b1943a0af75cd20e7c6fb1db3386406b55266f3c
 SHA512:
-  metadata.gz: 2d60d516f4d7e347504e7f167c0bc8e47c05b55a44acfc9265c9223400289aadbb720ce76a3f50938d8215fd8cb1fd26be8bc3a9fcf82af4ab61febc9c9a0aed
-  data.tar.gz: b05b43930d586e1f2c4bb6419c0353026e294bc3ef05b18d01a0e9fc414bd7cd69b1a3335ed8d7d8300c62bc9678a7923d35a9dc48c8413dd843a1f517ff7a95
+  metadata.gz: 2faa91f190024c927083e05a50861c4a367aa7f1a16dd2d88e2925081b96b91ea5e235eff0e7e7ec9d85a778dd5bfbcbc20a93e77050fa0aa8d4562dc3ebc13f
+  data.tar.gz: db4bc764b7e46918680cd552cf7fdde2b968fe728c30e5e67a0da896a4b6a0a24d72e62b5b4e9100ce65f7cca28c31effe460aff82d2f949c6f9fcf18c929543

data/.rubocop.yml

@@ -33,6 +33,10 @@ Lint/ConstantResolution:
 Metrics/MethodLength:
   Max: 15
 
+Security/Eval:
+  Exclude:
+    - 'test/**/*.rb'
+
 Style/ConstantVisibility:
   Exclude:
     - 'lib/tiny_hooks/version.rb'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] - 2021-04-10
+
+- Implement restoration of original method
+
 ## [0.2.0] - 2021-04-10
 
 - Support Ruby 2.5 and 2.6

data/README.md

@@ -41,6 +41,16 @@ MyClass.new.my_method
 
 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.
 
+## Difference between TinyHooks and ActiveSupport::Callbacks
+
+While `TinyHooks` and `ActiveSupport::Callbacks` share the same purpose, there are a few major differences.
+
+* `TinyHooks` doesn’t support halting, but will support in the future.
+* While `ActiveSupport::Callbacks` has a set of methods for callbacks to work, `TinyHooks` has only one method.
+* You can apply callbacks/hooks into any existing methods without any changes with `TinyHooks`, while you need to change methods to call `run_callbacks` method within them to apply callbacks with `ActiveSupport::Callbacks`.
+
+In short, `TinyHooks` is simpler while `ActiveSupport::Callbacks` allows more control over callbacks.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/tiny_hooks.rb

@@ -8,6 +8,15 @@ require_relative 'tiny_hooks/version'
 module TinyHooks
   class Error < StandardError; end
 
+  # @api private
+  def self.extended(mod)
+    mod.class_eval { @@_originals ||= {} }
+    # mod.instance_variable_set(:@_originals, {}) unless mod.instance_variable_defined?(:@_originals)
+    # mod.define_singleton_method(:_originals) do
+    #   mod.instance_variable_get(:@_originals)
+    # end
+  end
+
   # Define hook with kind and target method
   #
   # @param [Symbol, String] kind the kind of the hook, possible values are: :before, :after and :around
@@ -16,6 +25,8 @@ module TinyHooks
     raise ArgumentError, 'You must provide a block' unless block
 
     original_method = instance_method(target)
+    @@_originals[target.to_sym] = original_method unless @@_originals[target.to_sym]
+
     body = case kind.to_sym
            when :before
              _before(original_method, &block)
@@ -32,6 +43,16 @@ module TinyHooks
 
   module_function :define_hook
 
+  # Restore original method
+  #
+  # @param [Symbol, String] target
+  def restore_original(target)
+    original_method = @@_originals[target.to_sym] || instance_method(target)
+
+    undef_method(target)
+    define_method(target, original_method)
+  end
+
   private
 
   def _before(original_method, &block)

data/lib/tiny_hooks/version.rb

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

data/sider.yml

@@ -23,13 +23,13 @@ linter:
 #     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
+  rubocop:
+    dependencies:
+      - rubocop-minitest
+      - rubocop-performance
+      - rubocop-rake
+      - rubocop-sensible
+    safe: true
 
 #   # ShellCheck example. See https://help.sider.review/tools/shellscript/shellcheck
 #   shellcheck:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_hooks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies: []
 description: Simple, tiny and general hooks control.
 email:
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Simple, tiny and general hooks control.