ruby3-backward-compatibility 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d573d3c08d404195e71dd9c7a1c4deee4de8c5277486c382f6be9fc633955a4
-  data.tar.gz: d854da5c1956e17bfb887a46f768828f96bd8dd8241568c4e1eaea768e2619dc
+  metadata.gz: 6a63c38a468a5c3aac7da7774abed32e9878d46ab60fcce3b842f21526b483bf
+  data.tar.gz: 54776548a860546d7f63426e55794e0061ccb7784712469b5fe2260d904b0b3f
 SHA512:
-  metadata.gz: 35e33c63d438e5ea0d03ca0cdc5ca5f6938ab1b9cddcb02a2ea85a27580ee3cc5d83d11a721ada769abfefcdc30896e972dd07869639071bfc28bc4a98e374e4
-  data.tar.gz: 866e11431ce3380725f9d82a161729132359da6fff9587e2cd6db35d6ac43b187c3f62db42605a742194130db0a1bcf555c657934cc91c0efa0ae57dd8a4d4d9
+  metadata.gz: 5648d5b980179b3a2ccac12175e96db04ac6e3d2c91f980c3da34195db91c91a730b192282e3774e31604dd8ed15e6b2fdf49fbe43cdee24e7d67c92473350dd
+  data.tar.gz: ee03c7f8bbdc69fb6529f0104112a85b4b2bd6a3af24b19a4d1becd27316876c66930ae7457befb6fc9055e89aaa496c96ef000bd367f068421873cd52917371

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2022-11-04
+
+- Fix `ruby3_keywords` for prepended methods.
+
+## [0.2.0] - 2022-10-26
+
+- Add `ruby3_backward_compatibility/compatibility/i18n`.
+
 ## [0.1.3] - 2022-10-25
 
 - Allow `ruby3_keywords` to work if method is also defined in a prepended module.

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem 'rake', '~> 13.0'
 
 gem 'rspec', '~> 3.0'
+
+gem 'i18n'

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    ruby3-backward-compatibility (0.1.3)
+    ruby3-backward-compatibility (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     rake (13.0.6)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -26,6 +30,8 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
+  i18n
   rake (~> 13.0)
   rspec (~> 3.0)
   ruby3-backward-compatibility!

data/README.md

@@ -30,6 +30,8 @@ You can also require all included backports using
 require 'ruby3-backward-compatibility/compatibility/all'
 ```
 
+Note however that this will not patch anything that has not been required yet. You can always require single patches as shown below.
+
 
 ## List of backports
 
@@ -90,6 +92,17 @@ require 'ruby3_backward_compatibility/compatibility/erb'
 ```
 
 
+### I18n
+
+`I18n` has a few methods (`translate`, `localize`, etc.) that requires to be called with keywords.
+
+To allow calling it with option hashes, too, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/i18n'
+```
+
+
 ### Object
 
 The methods `Object#taint` and `Object#untaint` were no-ops for a while but started to raise deprecation warnings.
@@ -120,7 +133,7 @@ Psych version 4 (default for Ruby 3.1) has two changes:
 To alias `Psych.unsafe_load` as `Psych.load`, and to allow both styles of calling `Psych.safe_load`, use
 
 ```
-require 'ruby3_backward_compatibility/psych'
+require 'ruby3_backward_compatibility/compatibility/psych'
 ```
 
 **Attention:** There has been a very good reason why Psych renamed the `.load` method: You may never use `.load` on any external strings. It is possible to create valid YAML strings that lead to the execution of arbitrary code, so calling `YAML.load` on user input is a major security vulnerability.

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/ruby3_backward_compatibility/compatibility/all.rb

@@ -1,7 +1,8 @@
 require 'ruby3_backward_compatibility'
 
-require 'ruby3_backward_compatibility/compatibility/erb'
+require 'ruby3_backward_compatibility/compatibility/erb' if defined?(ERB)
+require 'ruby3_backward_compatibility/compatibility/i18n' if defined?(I18n)
 require 'ruby3_backward_compatibility/compatibility/object'
-require 'ruby3_backward_compatibility/compatibility/psych'
+require 'ruby3_backward_compatibility/compatibility/psych' if defined?(Psych)
 require 'ruby3_backward_compatibility/compatibility/string'
-require 'ruby3_backward_compatibility/compatibility/uri'
+require 'ruby3_backward_compatibility/compatibility/uri' if defined?(URI)

data/lib/ruby3_backward_compatibility/compatibility/i18n.rb

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

data/lib/ruby3_backward_compatibility/ruby3_keywords.rb

@@ -1,27 +1,45 @@
 module Ruby3BackwardCompatibility
   module Ruby3Keywords
+    def self.find_owned_instance_method(mod, method_name)
+      method = mod.send(:instance_method, method_name)
+      while method.owner > mod
+        # 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}`?"
+          return method
+        else
+          method = super_method
+        end
+      end
+      method
+    end
+
     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)
     end
 
-    def ruby3_keywords(*methods)
-      methods.each do |method|
-        method_is_private = private_instance_methods.include?(method)
-        method_is_protected = protected_instance_methods.include?(method)
+    def ruby3_keywords(*method_names)
+      method_names.each do |method_name|
+        method_is_private = private_instance_methods.include?(method_name)
+        method_is_protected = protected_instance_methods.include?(method_name)
 
-        _ruby3_keywords_module.define_method(method) do |*args, **keyword_args|
-          if args.last.is_a?(Hash)
-            keyword_args.merge!(args.pop)
+        required_param_count = Ruby3Keywords.find_owned_instance_method(self, method_name).parameters.sum { |(kind, _name)| kind == :req ? 1 : 0 }
+        _ruby3_keywords_module.define_method(method_name) do |*args|
+          if args.last.respond_to?(:to_hash) && args.size > required_param_count
+            keyword_args = args.pop
+            super(*args, **keyword_args)
+          else
+            super(*args)
           end
-          super(*args, **keyword_args)
         end
 
         if method_is_private
-          _ruby3_keywords_module.send(:private, method)
+          _ruby3_keywords_module.send(:private, method_name)
         elsif method_is_protected
-          _ruby3_keywords_module.send(:protected, method)
+          _ruby3_keywords_module.send(:protected, method_name)
         end
       end
     end

data/lib/ruby3_backward_compatibility/version.rb

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

data/ruby3-backward-compatibility.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency 'example-gem', '~> 1.0'
+  spec.add_development_dependency 'byebug'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby3-backward-compatibility
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tobias.kraze@makandra.de
@@ -26,10 +40,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - lib/ruby3_backward_compatibility.rb
 - lib/ruby3_backward_compatibility/compatibility/all.rb
 - lib/ruby3_backward_compatibility/compatibility/erb.rb
+- lib/ruby3_backward_compatibility/compatibility/i18n.rb
 - lib/ruby3_backward_compatibility/compatibility/object.rb
 - lib/ruby3_backward_compatibility/compatibility/psych.rb
 - lib/ruby3_backward_compatibility/compatibility/string.rb
@@ -59,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Backward compatibility for Ruby 3 stdlib