rubocop-shopify 2.15.0 → 2.15.1

data/lib/rubocop/shopify/gem_version_string_comparable_backport.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This is true for Ruby 3.2+, so once support for 3.1 is dropped, we can remove this.
+# Until then, some installations may have a recent enough version of RubyGems, but it is not guaranteed.
+return if Gem::Version.new(Gem::VERSION) >= Gem::Version.new("3.5.6")
+
+module RuboCop
+  module Shopify
+    # Backport rubygems/rubygems#5275, so we can compare `Gem::Version`s directly against `String`s.
+    #
+    #     Gem::Version.new("1.2.3") > "1.2"
+    #
+    # Without this, to support Ruby < 3.2, we would have to create a new `Gem::Version` instance ourselves.
+    #
+    #     Gem::Version.new("1.2.3") > Gem::Version.new("1.2")
+    #
+    # This would get very verbose in our RuboCop config files.
+    module GemVersionStringComparableBackport
+      def <=>(other)
+        return self <=> self.class.new(other) if (String === other) && self.class.correct?(other)
+
+        super
+      end
+
+      Gem::Version.prepend(self)
+    end
+  end
+end

data/lib/tasks/config.rake

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+namespace :config do
+  desc "Dump the full RuboCop config as a YAML file for testing"
+  task :dump, [:target] do |_task, args|
+    file = "rubocop.yml"
+    target = args.fetch(:target, "test/fixtures/full_config.yml")
+
+    file_config = RuboCop::ConfigLoader.load_file(file)
+    config = RuboCop::ConfigLoader.merge_with_default(file_config, file)
+    output = config.to_h.to_yaml.gsub(config.base_dir_for_path_parameters, "")
+
+    # Removing trailing whitespaces from each line due to older libyaml versions
+    # converting nil hash values into whitespaces. GitHub actions is still stuck
+    # with libyaml < 0.2.5. This line can be removed once it is upgraded. Psych
+    # can be used to check for the running libyaml version:
+    #
+    # ```ruby
+    # require "psych"
+    # puts Psych::LIBYAML_VERSION
+    # ```
+    #
+    # For more info, see: https://github.com/yaml/libyaml/pull/186
+    output.gsub!(/\s\n/, "\n")
+
+    File.write(target, output)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-shopify
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Shopify Engineering
@@ -32,13 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.md
+- README.md
+- lib/rubocop/shopify/gem_version_string_comparable_backport.rb
+- lib/tasks/config.rake
 - rubocop-cli.yml
 - rubocop.yml
 homepage: https://shopify.github.io/ruby-style-guide/
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Shopify/ruby-style-guide/tree/v2.15.0
+  source_code_uri: https://github.com/Shopify/ruby-style-guide/tree/v2.15.1
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []