ruby3-backward-compatibility 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d949727b9c8b236fcf673511dd789fb18730bc77dad9ea7a9eeedeaad1614521
-  data.tar.gz: '0488f263cc00e3483b14634722ee893bb8ec4729cac1329b63a53d825b24258f'
+  metadata.gz: 4551e0985507c3ab5633b97825f059f34962dcfea27dfdb5ad9a3fe7d15a19f6
+  data.tar.gz: c211c8d15240c592d3ab2fd355f76dfb58ed88b548129e951b23764c577a9d51
 SHA512:
-  metadata.gz: fb554d8ab1435ef27db945530b579b7954544b13a2a8b281d9ce7429bf5bc059f95c30850726fdd5ed289ecc1c1f7676fbd1d1d44575dc9bfa29733e5e7a9e09
-  data.tar.gz: b5dc1372bb36f7eb3bbae7ddaab3d9094e1f480270cb837a3ac50661893d727e4ea8681c514fe75ee2db2538c45023b707d2e57c4cff77ae6c92c9d315565b4b
+  metadata.gz: a79863218e982c240626e13c6276e0cf1afd5a5bbffc823e427f75e126534c211efa94c5947cc253bc9e4011fe2a2bf1729d7e0ed37b3ac244353c22bd1fa115
+  data.tar.gz: c9f29e66e4162bfc9a8b0afee0e162dacca15eb2158cd51ba5e92cf01c0ba7c33e27255c485ac88257afa715af16823279f078cbf96cca03e5ea17995ff434d5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--force-color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.2] - 2022-10-25
+
+- `ruby3_keywords` does not change visibility of private or protected methods.
+
+## [0.1.1] - 2022-10-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby3-backward-compatibility.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    ruby3-backward-compatibility (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  ruby3-backward-compatibility!
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tobias Kraze
+
+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.

data/README.md

@@ -0,0 +1,191 @@
+# ruby3-backwards-compatibility
+
+This gem provides a compatibility layer to Ruby 3 projects that still have legacy code written against Ruby 2's stdlib. Only use this if you upgrade to Ruby 3 but still depend on some third-party code that breaks on Ruby 3.
+
+The gem will fix only some (but the most common) incompatibilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby3-backward-compatibility'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby3-backward-compatibility
+
+## Usage
+
+You need to require the specific backports yourself, see below.
+
+You can also require all included backports using
+
+```
+require 'ruby3-backward-compatibility/compatibility/all'
+```
+
+
+## List of backports
+
+### ruby3 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
+
+```
+class Ruby3Class
+  def some_method(foo:)
+    puts foo
+  end
+end
+
+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:
+
+```
+require 'ruby3_backward_compatibility'
+
+class Ruby3Class
+  # reopen the class
+
+  extend Ruby3BackwardCompatibility::Ruby3Keywords
+
+  ruby3_keywords :some_method
+end
+
+Ruby3Class.new.some_method(foo: 'bar') # still works
+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.
+
+### ERB
+
+`ERB.new` used to have the signature
+
+```
+ERB.new(string, safe_level, trim_mode, eoutvar = '_erbout')
+```
+
+but this was changed to
+
+```
+ERB.new(string, safe_level: nil, trim_mode: nil, eoutvar: '_erbout')
+```
+
+To allow both styles, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/erb'
+```
+
+
+### Object
+
+The methods `Object#taint` and `Object#untaint` were no-ops for a while but started to raise deprecation warnings.
+
+To add them back as no-ops, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/object'
+```
+
+
+### YAML (Psych)
+
+Psych version 4 (default for Ruby 3.1) has two changes:
+- `Psych.load` has been renamed to `Psych.unsafe_load`
+- The signature of `Psych.safe_load` has been changed from
+
+  ```
+  Psych.safe_load(yaml, permitted_classes = [], permitted_symbols = [], aliases = false, filename = nil)
+  ```
+
+  to
+
+  ```
+  Psych.safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil)
+  ```
+
+To alias `Psych.unsafe_load` as `Psych.load`, and to allow both styles of calling `Psych.safe_load`, use
+
+```
+require 'ruby3_backward_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.
+
+
+### String
+
+`String#encode` require keyword arguments. To allow it to be called with an options hash, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/string'
+```
+
+
+### URI
+
+The `URI` module allows other libraries to register their own URI schemes. In the past, it was possible to do something like
+
+```
+module URI
+  @schemes['MYSCHEME'] = MySchemeImplementation
+end
+```
+
+In Ruby 3, you have to use
+
+```
+URI.register_scheme 'MYSCHEME', MySchemeImplementation
+```
+
+To add back the old behavior, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/uri'
+```
+
+
+## Things we cannot fix
+
+### Proc.new
+
+In Ruby 2, it was possible to use `Proc.new` without giving a block. In this case, the Proc took the block from the current context. A common usecase worked like this:
+
+```
+def call_me(block = Proc.new)
+  block.call
+end
+
+block = proc do
+  puts "called"
+end
+
+call_me(block) # works
+call_me(&block) # also works
+call_me { puts "called" } # also works
+```
+
+This is no longer possible in Ruby 3 and we are not aware of a way to make a generic port for this.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ruby3_backward_compatibility'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby3_backward_compatibility/compatibility/all.rb

@@ -0,0 +1,7 @@
+require 'ruby3_backward_compatibility'
+
+require 'ruby3_backward_compatibility/compatibility/erb'
+require 'ruby3_backward_compatibility/compatibility/object'
+require 'ruby3_backward_compatibility/compatibility/psych'
+require 'ruby3_backward_compatibility/compatibility/string'
+require 'ruby3_backward_compatibility/compatibility/uri'

data/lib/ruby3_backward_compatibility/compatibility/erb.rb

@@ -0,0 +1,17 @@
+require 'erb'
+
+module Ruby3BackwardCompatibility
+  module ERBCompatibility
+    def initialize(str, safe_level = NOT_GIVEN, legacy_trim_mode = NOT_GIVEN, legacy_eoutvar = NOT_GIVEN, trim_mode: nil, eoutvar: '_erbout')
+      if legacy_trim_mode != NOT_GIVEN
+        trim_mode = legacy_trim_mode
+      end
+      if legacy_eoutvar != NOT_GIVEN
+        eoutvar = legacy_eoutvar
+      end
+      super(str, trim_mode: trim_mode, eoutvar: eoutvar)
+    end
+  end
+end
+
+ERB.prepend Ruby3BackwardCompatibility::ERBCompatibility

data/lib/ruby3_backward_compatibility/compatibility/object.rb

@@ -0,0 +1,14 @@
+module Ruby3BackwardCompatibility
+  module ObjectCompatibility
+    # Taint/untaint used to be a noop for a while.
+    def taint
+      self
+    end
+
+    def untaint
+      self
+    end
+  end
+end
+
+Object.include Ruby3BackwardCompatibility::ObjectCompatibility

data/lib/ruby3_backward_compatibility/compatibility/psych.rb

@@ -0,0 +1,36 @@
+require 'psych'
+
+module Ruby3BackwardCompatibility
+  module PsychCompatibility
+
+    def self.prepended(by)
+      by.singleton_class.prepend ClassMethods
+    end
+
+    module ClassMethods
+      if Psych::VERSION >= '4'
+        def load(...)
+          unsafe_load(...)
+        end
+      end
+
+      def safe_load(yaml, legacy_permitted_classes = NOT_GIVEN, legacy_permitted_symbols = NOT_GIVEN, legacy_aliases = NOT_GIVEN, legacy_filename = NOT_GIVEN, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, **args)
+        if legacy_permitted_classes != NOT_GIVEN
+          permitted_classes = legacy_permitted_classes
+        end
+        if legacy_permitted_symbols != NOT_GIVEN
+          permitted_symbols = legacy_permitted_symbols
+        end
+        if legacy_aliases != NOT_GIVEN
+          aliases = legacy_aliases
+        end
+        if legacy_filename != NOT_GIVEN
+          filename = legacy_filename
+        end
+        super(yaml, permitted_classes: permitted_classes, permitted_symbols: permitted_symbols, aliases: aliases, filename: filename, **args)
+      end
+    end
+  end
+end
+
+Psych.prepend Ruby3BackwardCompatibility::PsychCompatibility

data/lib/ruby3_backward_compatibility/compatibility/string.rb

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

data/lib/ruby3_backward_compatibility/compatibility/uri.rb

@@ -0,0 +1,19 @@
+require 'uri'
+
+module Ruby3BackwardCompatibility
+  module URICompatibility
+    class SchemeProxy
+      def [](scheme)
+        URI.scheme_list[scheme]
+      end
+
+      def []=(scheme, value)
+        URI.register_scheme(scheme, value)
+      end
+    end
+  end
+end
+
+module URI
+  @@schemes ||= Ruby3BackwardCompatibility::URICompatibility::SchemeProxy.new
+end

data/lib/ruby3_backward_compatibility/ruby3_keywords.rb

@@ -0,0 +1,33 @@
+module Ruby3BackwardCompatibility
+  module Ruby3Keywords
+    def ruby3_keywords(*methods)
+      methods.each do |method|
+        method_is_private = private_instance_methods.include?(method)
+        method_is_protected = protected_instance_methods.include?(method)
+
+        _ruby3_keywords_module.define_method(method) do |*args, **keyword_args|
+          if args.last.is_a?(Hash)
+            keyword_args.merge!(args.pop)
+          end
+          super(*args, **keyword_args)
+        end
+
+        if method_is_private
+          _ruby3_keywords_module.send(:private, method)
+        elsif method_is_protected
+          _ruby3_keywords_module.send(:protected, method)
+        end
+      end
+    end
+
+    private
+
+    def _ruby3_keywords_module
+      @_ruby3_keywords_module ||= begin
+        mod = Module.new
+        prepend mod
+        mod
+      end
+    end
+  end
+end

data/lib/ruby3_backward_compatibility/version.rb

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

data/lib/ruby3_backward_compatibility.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ruby3BackwardCompatibility
+  NOT_GIVEN = Object.new
+
+  # TODO private?
+end
+
+require 'ruby3_backward_compatibility/ruby3_keywords'
+require 'ruby3_backward_compatibility/version'

data/ruby3-backward-compatibility.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ruby3_backward_compatibility/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby3-backward-compatibility'
+  spec.version       = Ruby3BackwardCompatibility::VERSION
+  spec.authors       = ['Tobias Kraze']
+  spec.email         = ['tobias.kraze@makandra.de']
+
+  spec.summary       = 'Backward compatibility for Ruby 3 stdlib'
+  spec.homepage      = 'https://github.com/makandra/ruby3-backward-compatibility'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/makandra/ruby3-backward-compatibility'
+  spec.metadata['changelog_uri'] = 'https://github.com/makandra/ruby3-backward-compatibility/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split(/\x0|\u0000/).reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3-backward-compatibility
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -16,7 +16,27 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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/object.rb
+- 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
 licenses:
 - MIT