ruby3-backward-compatibility 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced5ff7ed2f076e330be4b444f418d6ea102ba732bedf7540a6594c1bd4703b4
-  data.tar.gz: 36314617ae1e2e10e04e6b7db71a93a70226bacceec9ef1591f4ede1925d7f26
+  metadata.gz: d863bc999c8d389ecc066c1e205d29599f8126296c177937bf61e054245765ee
+  data.tar.gz: bd87ac80c634fa8292c8a7f09bf7cbb6c2c1e84e7a8eae02fab1ade564c05b12
 SHA512:
-  metadata.gz: 238d11616add2f0cb7253a52f781735244d5ad0009033710319382e9c10f76109b7d48a6b90bc089937d9f597e86d900479815eb93dda1f2ffa3f88f05599b90
-  data.tar.gz: b9707b24ece18a5da64d85cff697102d4491ddf34a828395d50882f2a84f77a6c97dff28eabd4c44ce50b97624f8a0aa369b40b32ba417e3df4213f656424914
+  metadata.gz: 06b02c646e5f753bf7e7f6ad908fc7687c11d96eace311e4e962264b9087e2f7c9b7f5613d72893d384b8ebb3c66a7dec27297e7e383dea4f675b44d80f220fb
+  data.tar.gz: 84cb5c14e91f7c0272f7a56527aada55ea2785db50278584e3152265a43d435f68f4803f22693ffb750d2e6ca173df2fbd6a9771bd5181570eed87489b02092b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [1.0.0] - 2022-12-01
+
+- Now 1.0, adhering to semantic versioning.
+- Breaking: Rename `ruby3_keywords` to `callable_with_hash`.
+
 ## [0.3.0] - 2022-11-22
 
 - Security fix: `ruby3_backward_compatibility/compatibility/psych` no longer aliases YAML.load to YAML.safe_load.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby3-backward-compatibility (0.3.0)
+    ruby3-backward-compatibility (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -35,7 +35,7 @@ Note however that this will not patch anything that has not been required yet. Y
 
 ## List of backports
 
-### ruby3 keyword arguments
+### Ruby 3 keyword arguments
 
 One breaking change in Ruby 3 is that methods defined using keyword arguments have to be called with keyword arguments, not with option hashes. For example
 
@@ -50,7 +50,7 @@ Ruby3Class.new.some_method(foo: 'bar') # works
 Ruby3Class.new.some_method({ foo: 'bar' }) # raises an ArgumentError
 ```
 
-To fix this for arbitrary methods, you can use the `ruby3_keywords` method included in this gem, like this:
+To fix this for arbitrary methods, you can use the `callable_with_hash` method included in this gem, like this:
 
 ```
 require 'ruby3_backward_compatibility'
@@ -58,9 +58,9 @@ require 'ruby3_backward_compatibility'
 class Ruby3Class
   # reopen the class
 
-  extend Ruby3BackwardCompatibility::Ruby3Keywords
+  extend Ruby3BackwardCompatibility::CallableWithHash
 
-  ruby3_keywords :some_method
+  callable_with_hash :some_method
 end
 
 Ruby3Class.new.some_method(foo: 'bar') # still works
@@ -69,7 +69,7 @@ Ruby3Class.new.some_method({ foo: 'bar' }) # now works as well
 
 This will wrap the given method and convert a hash given as the last argument into keywords, similar to how it worked in Ruby 2.
 
-*Note:* In case the method is also defined in a prepended module, you need to put the `extend Ruby3BackwardCompatibility::Ruby3Keywords` above the `prepend`.
+*Note:* In case the method is also defined in a prepended module, you need to put the `extend Ruby3BackwardCompatibility::CallableWithHash` above the `prepend`.
 
 ### ERB
 

data/lib/ruby3_backward_compatibility/{ruby3_keywords.rb → callable_with_hash.rb}

@@ -1,5 +1,5 @@
 module Ruby3BackwardCompatibility
-  module Ruby3Keywords
+  module CallableWithHash
     def self.find_owned_instance_method(mod, method_name, ignore_missing: false)
       method = begin
         mod.send(:instance_method, method_name)
@@ -11,7 +11,7 @@ module Ruby3BackwardCompatibility
         # we found the method in a prepended module
         super_method = method.super_method
         if super_method.nil?
-          warn "Called `ruby3_keywords #{method_name.inspect}` on `#{mod}`, which appears not to be the correct owner. Did you mean to call it on `#{method.owner}`?"
+          warn "Called `callable_with_hash #{method_name.inspect}` on `#{mod}`, which appears not to be the correct owner. Did you mean to call it on `#{method.owner}`?"
           return method
         else
           method = super_method
@@ -23,19 +23,19 @@ module Ruby3BackwardCompatibility
     def self.extended(by)
       # prepend the anonymous module now, so the user has a chance to control where exactly we will end 
       # up in the prepend chain...
-      by.send(:_ruby3_keywords_module)
+      by.send(:_ruby3_callable_with_hash_module)
     end
 
-    def ruby3_keywords(*method_names, ignore_missing: false)
+    def callable_with_hash(*method_names, ignore_missing: false)
       method_names.each do |method_name|
         method_is_private = private_instance_methods.include?(method_name)
         method_is_protected = protected_instance_methods.include?(method_name)
 
-        method = Ruby3Keywords.find_owned_instance_method(self, method_name, ignore_missing: ignore_missing)
+        method = CallableWithHash.find_owned_instance_method(self, method_name, ignore_missing: ignore_missing)
         next unless method
 
         required_param_count = method.parameters.sum { |(kind, _name)| kind == :req ? 1 : 0 }
-        _ruby3_keywords_module.define_method(method_name) do |*args, &block|
+        _ruby3_callable_with_hash_module.define_method(method_name) do |*args, &block|
           if args.last.respond_to?(:to_hash) && args.size > required_param_count
             keyword_args = args.pop
             super(*args, **keyword_args, &block)
@@ -45,17 +45,17 @@ module Ruby3BackwardCompatibility
         end
 
         if method_is_private
-          _ruby3_keywords_module.send(:private, method_name)
+          _ruby3_callable_with_hash_module.send(:private, method_name)
         elsif method_is_protected
-          _ruby3_keywords_module.send(:protected, method_name)
+          _ruby3_callable_with_hash_module.send(:protected, method_name)
         end
       end
     end
 
     private
 
-    def _ruby3_keywords_module
-      @_ruby3_keywords_module ||= begin
+    def _ruby3_callable_with_hash_module
+      @_ruby3_callable_with_hash_module ||= begin
         mod = Module.new
         prepend mod
         mod

data/lib/ruby3_backward_compatibility/compatibility/i18n.rb

@@ -1,7 +1,7 @@
 require 'i18n'
 
 module I18n::Base
-  extend Ruby3BackwardCompatibility::Ruby3Keywords
+  extend Ruby3BackwardCompatibility::CallableWithHash
 
-  ruby3_keywords :translate, :translate!, :localize, :t, :l, :transliterate, ignore_missing: true
+  callable_with_hash :translate, :translate!, :localize, :t, :l, :transliterate, ignore_missing: true
 end

data/lib/ruby3_backward_compatibility/compatibility/string.rb

@@ -1,5 +1,5 @@
 class String
-  extend Ruby3BackwardCompatibility::Ruby3Keywords
+  extend Ruby3BackwardCompatibility::CallableWithHash
 
-  ruby3_keywords :encode
+  callable_with_hash :encode
 end

data/lib/ruby3_backward_compatibility/version.rb

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

data/lib/ruby3_backward_compatibility.rb

@@ -6,5 +6,5 @@ module Ruby3BackwardCompatibility
   # TODO private?
 end
 
-require 'ruby3_backward_compatibility/ruby3_keywords'
+require 'ruby3_backward_compatibility/callable_with_hash'
 require 'ruby3_backward_compatibility/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3-backward-compatibility
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -43,6 +43,7 @@ files:
 - bin/rspec
 - bin/setup
 - lib/ruby3_backward_compatibility.rb
+- lib/ruby3_backward_compatibility/callable_with_hash.rb
 - lib/ruby3_backward_compatibility/compatibility/all.rb
 - lib/ruby3_backward_compatibility/compatibility/erb.rb
 - lib/ruby3_backward_compatibility/compatibility/i18n.rb
@@ -50,7 +51,6 @@ files:
 - lib/ruby3_backward_compatibility/compatibility/psych.rb
 - lib/ruby3_backward_compatibility/compatibility/string.rb
 - lib/ruby3_backward_compatibility/compatibility/uri.rb
-- lib/ruby3_backward_compatibility/ruby3_keywords.rb
 - lib/ruby3_backward_compatibility/version.rb
 - ruby3-backward-compatibility.gemspec
 homepage: https://github.com/makandra/ruby3-backward-compatibility