ruby3-backward-compatibility 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72c4f9ed9be362ed3bcc227865c004eb1c87ba49a878f47fe8aa0af60503744
-  data.tar.gz: d362dbf046076652989f7530b7cbe5f6acc36dd5f45ed3d5be930f56cbedbbfb
+  metadata.gz: d727adf8f484386c84adf5f03c83b8b8e237d072e9755e34770f4c37c87c3f27
+  data.tar.gz: ccb5329f49247817fbc12f9b72d1a893a57ed53f2c71b7c769d7c397d2e074ec
 SHA512:
-  metadata.gz: 9ea7a3617ed5bcf3664d376827ee1f5a8e6c3b2aaac33af0460f3c43b8787e535b917a81d448d8e2b3935977c64b2e80c0bc8eba2d7fb7c0d6c06d673b8842bd
-  data.tar.gz: e2fdbf510be4111c4dc4611432eddd696b75db90dca65a023f98f7a61a9ca1a8a270dcbffaa905d480bdd04ef1de584bb41aff8b406e974c7fb646966071f134
+  metadata.gz: c92cb15cc48cf8c4c78c73ebad18e980a73cdd889993d68de2a4873666a1f81a6a2715140bddb8a14f8e8b6cfd3270eb7481d9bb33c74c702495606d623ca300
+  data.tar.gz: b8c56baf3948241066277afc1289d9421df3cb8854a11b38f35b5cd18155a51180f1935418e8ed294b82900e14a8e9d33d48452fe226c3eea8be0d6afc237470

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.3.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [1.3.0] - 2024-04-16
+
+- Ruby 3.2+: Add back third argument to Regexp.new, to allow passing "n" to set `Regexp::NOENCODING`.
+
+## [1.2.0] - 2024-04-10
+
+- First release with dedicated suport to Ruby 3.3.
+- Added back `File.exists?` and `Dir.exists?` on Ruby 3.2+.
+- Added back `Fixnum` as an alias for `Integer`.
+
 ## [1.1.1] - 2022-12-01
 
 - Gem no longer requires Ruby 3. It will not do anything when used on Ruby 2.x, but you can add it to your Gemfile if you need that for a Ruby migration strategy. (Thanks to @BigAirJosh)

data/Gemfile.lock

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

data/README.md

@@ -71,6 +71,16 @@ This will wrap the given method and convert a hash given as the last argument in
 
 *Note:* In case the method is also defined in a prepended module, you need to put the `extend Ruby3BackwardCompatibility::CallableWithHash` above the `prepend`.
 
+### Dir
+
+`Dir.exists?` has been removed in favor of `Dir.exist?`.
+
+To add `Dir.exists?` as an alias for `Dir.exist?`, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/dir'
+```
+
 ### ERB
 
 `ERB.new` used to have the signature
@@ -91,6 +101,25 @@ To allow both styles, use
 require 'ruby3_backward_compatibility/compatibility/erb'
 ```
 
+### File
+
+`File.exists?` has been removed in favor of `File.exist?`.
+
+To add `File.exists?` as an alias for `File.exist?`, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/file'
+```
+
+### Fixnum
+
+`Fixnum` has been an alias for `Integer` for a while, but was removed.
+
+To add back `Fixnum` as an alias for `Integer`, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/fixnum'
+```
 
 ### I18n
 
@@ -113,6 +142,17 @@ To add them back as no-ops, use
 require 'ruby3_backward_compatibility/compatibility/object'
 ```
 
+### Regexp (Ruby 3.2+)
+
+It was possible to instantiate a Regexp with `Regexp.new('foo', Regexp::IGNORECASE, 'n')`. The last argument used to indicate the encoding in Ruby 1.8. Up to Ruby 3.2 an argument of "n" or "N" indicated a regexp that ignores encoding (same as the Regexp::NOENCODING flag).
+
+In Ruby 3 this raises an `ArgumentError`.
+
+To bring back the old behavior, use
+
+```
+require 'ruby3_backward_compatibility/compatibility/regexp'
+```
 
 ### YAML (Psych)
 
@@ -130,13 +170,13 @@ Psych version 4 (default for Ruby 3.1) has two changes:
   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
+To allow both styles of calling `Psych.safe_load`, use
 
 ```
 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.
+**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. For that reason, this library does not change the safe behavior of `YAML.load`.
 
 
 ### String

data/Rakefile

@@ -3,6 +3,18 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+ruby2_specs = 'spec/ruby2/**/*_spec.rb'
+rake_task = RSpec::Core::RakeTask.new(:spec)
+
+if RUBY_VERSION < '3'
+  rake_task.pattern = 'spec/ruby2/**/*_spec.rb'
+  task default: :spec
+else
+  rake_task.exclude_pattern = 'spec/{ruby2,isolated}/**/*_spec.rb'
+
+  isolated_rake_task = RSpec::Core::RakeTask.new(:isolated_specs)
+  isolated_rake_task.pattern = 'spec/isolated/**/*_spec.rb'
+
+  task default: [:spec, :isolated_specs]
+end
 
-task default: :spec

data/lib/ruby3_backward_compatibility/compatibility/all.rb

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

data/lib/ruby3_backward_compatibility/compatibility/dir.rb

@@ -0,0 +1,5 @@
+class Dir
+  class << self
+    alias_method :exists?, :exist? unless method_defined?(:exists?)
+  end
+end

data/lib/ruby3_backward_compatibility/compatibility/file.rb

@@ -0,0 +1,5 @@
+class File
+  class << self
+    alias_method :exists?, :exist? unless method_defined?(:exists?)
+  end
+end

data/lib/ruby3_backward_compatibility/compatibility/fixnum.rb

@@ -0,0 +1,3 @@
+unless defined?(::Fixnum)
+  Fixnum = Integer
+end

data/lib/ruby3_backward_compatibility/compatibility/regexp.rb

@@ -0,0 +1,51 @@
+if RUBY_VERSION >= '3.2'
+  # on 3.2 exactly, we get deprecation errors
+  # however, this is somewhat hard to fix, since 3.2 added some different ways to pass "options" that we do not want to rebuild
+
+  module Ruby3BackwardCompatibility
+    module RegexpCompatibility
+      LEGITIMATE_FLAGS = /\A[mix]+\z/
+
+      def self.prepended(by)
+        by.singleton_class.prepend ClassMethods
+      end
+
+      module ClassMethods
+        def new(regexp_or_string, options = NOT_GIVEN, n_flag = NOT_GIVEN, **kwargs)
+          if options == NOT_GIVEN
+            super(regexp_or_string, **kwargs)
+          elsif n_flag == 'n' || n_flag == 'N'
+            unless options.is_a?(Integer)
+              if RUBY_VERSION < '3.3' && options.is_a?(String) && options =~ LEGITIMATE_FLAGS
+                # on Ruby 3.2 we can legitimately have options "mix" treated as flags, so parse them
+                # on Ruby 3.3 this would never have been legitimate, since a third argument would not have been allowed
+                new_options = 0
+                new_options |= Regexp::MULTILINE if options.include?('m')
+                new_options |= Regexp::IGNORECASE if options.include?('i')
+                new_options |= Regexp::EXTENDED if options.include?('x')
+                options = new_options
+              else
+                # on all other Ruby, truish is IGNORECASE
+                options = options ? Regexp::IGNORECASE : 0
+              end
+            end
+            super(regexp_or_string, options | Regexp::NOENCODING, **kwargs)
+          elsif options.is_a?(String)
+            if options =~ LEGITIMATE_FLAGS && n_flag == NOT_GIVEN
+              # this (like any trueish value) would have been "ignore case" in Ruby < 3.2, but now is not
+              # we have to assume this is Ruby 3.2 syntax
+              super(regexp_or_string, options, **kwargs)
+            else
+              # this crashes on Ruby 3.2, so assume it is < 3.2 syntax
+              super(regexp_or_string, true, **kwargs)
+            end
+          else
+            super(regexp_or_string, options, **kwargs)
+          end
+        end
+      end
+    end
+  end
+
+  Regexp.prepend Ruby3BackwardCompatibility::RegexpCompatibility
+end

data/lib/ruby3_backward_compatibility/version.rb

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

data/lib/ruby3_backward_compatibility.rb

@@ -3,8 +3,6 @@
 if RUBY_VERSION.start_with?('3')
   module Ruby3BackwardCompatibility
     NOT_GIVEN = Object.new
-
-    # TODO private?
   end
 
   require 'ruby3_backward_compatibility/callable_with_hash'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3-backward-compatibility
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -45,10 +45,14 @@ files:
 - 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/dir.rb
 - lib/ruby3_backward_compatibility/compatibility/erb.rb
+- lib/ruby3_backward_compatibility/compatibility/file.rb
+- lib/ruby3_backward_compatibility/compatibility/fixnum.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/regexp.rb
 - lib/ruby3_backward_compatibility/compatibility/string.rb
 - lib/ruby3_backward_compatibility/compatibility/uri.rb
 - lib/ruby3_backward_compatibility/version.rb
@@ -75,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Backward compatibility for Ruby 3 stdlib