manageiq-style 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b3629a0d14ba1680e62920e1304effa28b6a8c00f1415c6496148eba75f804
-  data.tar.gz: 61704454dacf7bca212a9ec3301f567860d5d2aec867097c1d697e799de020b4
+  metadata.gz: 990c9480ed907d42d8fc314a30dd34826cfe773de229db4ff9159e21df609fde
+  data.tar.gz: a4b0ee736be350a01d31bd0aaed575e4b9e55cfe53300b478c031fce2184f301
 SHA512:
-  metadata.gz: d0a9486e38802b8ac853683e833dc95c26b53db3cb322633d63a558711d589b96a5e133b7d824f5f222ca17a4e1d015b372c5f094fe1a6a0d524d99068b8c443
-  data.tar.gz: 50b4a4af2740697a2f114b7eee18ff6d9af87c6462b20a2c5675fa380fc47527d8e7bfab5f331967dab6cce794725aa1e715113478cadfdcbdfc3de210801a41
+  metadata.gz: 84d62a4be38cf15303b7ec1576311e242c787acfccc06a620d092f19231ba59b98efcfd43661e717cf9697af597d2c4052cf96658fe893313c687b3707024ac6
+  data.tar.gz: d61750885ba8c60c747e03f20839eac9151baf775bc4fd9c0c9069610303358471ddb03bd9b226915e3f06bdccc1383bd88721b3be144775c5ee046f9e6e9aee

data/.codeclimate.yml

@@ -12,5 +12,5 @@ plugins:
   rubocop:
     enabled: true
     config: ".rubocop_cc.yml"
-    channel: rubocop-0-82
+    channel: rubocop-1-56-3
 version: '2'

data/.github/workflows/ci.yaml

@@ -12,22 +12,23 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-        - '2.5'
-        - '2.6'
         - '2.7'
         - '3.0'
+        - '3.1'
+        - '3.2'
     env:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
+      timeout-minutes: 30
     - name: Run tests
       run: bundle exec rake
     - name: Report code coverage
       if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.0' }}
       continue-on-error: true
-      uses: paambaati/codeclimate-action@v3.0.0
+      uses: paambaati/codeclimate-action@v5

data/.yamllint

@@ -0,0 +1,9 @@
+ignore: |-
+  /locale/**
+  /vendor/**
+extends: relaxed
+rules:
+  indentation:
+    indent-sequences: false
+  line-length:
+    max: 1000

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.4.0] - 2023-11-22
+### Added
+- Ensure .haml-lint.yml and .yamllint files [[#39](https://github.com/ManageIQ/manageiq-style/pull/39)]
+- Add lookup for existing rubocop channels [[#39](https://github.com/ManageIQ/manageiq-style/pull/39)]
+
+### Changed
+- Bump to rubocop 1.56.3 channel [[#39](https://github.com/ManageIQ/manageiq-style/pull/39)]
+- Bump to Ruby 2.7 [[#37](https://github.com/ManageIQ/manageiq-style/pull/37)]
+
+## [1.3.3] - 2022-10-20
+## [1.3.2] - 2022-06-21
+## [1.3.1] - 2021-06-17
+## [1.3.0] - 2021-04-27
+## [1.2.0] - 2021-01-27
+## [1.1.3] - 2021-01-05
+## [1.1.2] - 2020-12-17
+## [1.1.1] - 2020-11-10
+## [1.0.1] - 2020-08-26
+## [1.0.1] - 2020-06-19
+## [1.0.0] - 2020-05-19
+
+[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/ManageIQ/more_core_extensions/compare/v1.3.3...v1.4.0
+[1.3.3]: https://github.com/ManageIQ/more_core_extensions/compare/v1.3.2...v1.3.3
+[1.3.2]: https://github.com/ManageIQ/more_core_extensions/compare/v1.3.1...v1.3.2
+[1.3.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.3.0...v1.3.1
+[1.3.0]: https://github.com/ManageIQ/more_core_extensions/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.3...v1.2.0
+[1.1.3]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.2...v1.1.3
+[1.1.2]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.1...v1.1.1
+[1.0.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.1...v1.0.1
+[1.0.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/ManageIQ/more_core_extensions/tree/v1.0.0

data/lib/manageiq/style/cli.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module ManageIQ
   module Style
     class CLI
@@ -30,10 +32,14 @@ module ManageIQ
         require 'more_core_extensions/all'
 
         check_for_codeclimate_channel
+
         update_rubocop_yml
         write_rubocop_cc_yml
         ensure_rubocop_local_yml_exists
         update_codeclimate_yml
+        ensure_haml_lint_yml
+        update_yamllint
+
         update_generator
         update_gem_source
       end
@@ -41,16 +47,28 @@ module ManageIQ
       private
 
       def check_for_codeclimate_channel
-        begin
-          require 'open-uri'
-          URI::HTTPS.build(
-            :host => "raw.githubusercontent.com",
-            :path => File.join("/codeclimate", "codeclimate-rubocop", "channel", cc_rubocop_channel, "Gemfile")
-          ).open
-        rescue OpenURI::HTTPError
-          puts "RuboCop version #{rubocop_version.version} is not supported by CodeClimate."
-          exit 1
+        require 'open-uri'
+        uri = URI.parse("https://raw.githubusercontent.com/codeclimate/codeclimate-rubocop/channel/#{cc_rubocop_channel}/Gemfile")
+        uri.open
+      rescue OpenURI::HTTPError
+        STDERR.puts "RuboCop version #{rubocop_version.version} is not supported by CodeClimate."
+        STDERR.puts
+        STDERR.puts "Accepted versions are:"
+        fetch_all_codeclimate_channels.each_slice(10) do |versions|
+          STDERR.puts "    #{versions.join(", ")}"
         end
+        exit 1
+      end
+
+      def fetch_all_codeclimate_channels
+        `git ls-remote --heads https://github.com/codeclimate/codeclimate-rubocop 'channel/rubocop-*' 2>/dev/null`
+          .lines
+          .flat_map { |l| l.match(/rubocop-(.+)$/).captures }
+          .map { |v| v.split("-").join(".") }
+          .reject { |v| v == "1.70" } # This is not a real version, but the branch exists :shrug:
+          .sort_by { |v| v.split(".").map(&:to_i) }
+      rescue
+        []
       end
 
       def update_rubocop_yml(file = ".rubocop.yml")
@@ -63,7 +81,7 @@ module ManageIQ
         data.store_path("inherit_gem", "manageiq-style", ".rubocop_base.yml")
         data["inherit_from"] = [".rubocop_local.yml"]
 
-        File.write(".rubocop.yml", data.to_yaml.sub("---\n", ""))
+        File.write(file, data.to_yaml.sub("---\n", ""))
       end
 
       def write_rubocop_cc_yml(file = ".rubocop_cc.yml")
@@ -79,7 +97,6 @@ module ManageIQ
       end
 
       def ensure_rubocop_local_yml_exists(file = ".rubocop_local.yml")
-        require 'fileutils'
         FileUtils.touch(file)
       end
 
@@ -119,7 +136,33 @@ module ManageIQ
 
         data["version"] ||= "2"
 
-        File.write(".codeclimate.yml", data.to_yaml.sub("---\n", ""))
+        File.write(file, data.to_yaml.sub("---\n", ""))
+      end
+
+      def ensure_haml_lint_yml(file = ".haml-lint.yml")
+        return if File.exist?(file)
+
+        FileUtils.ln_s(".rubocop.yml", file)
+      end
+
+      def update_yamllint(file = ".yamllint")
+        data = begin
+          YAML.load_file(file)
+        rescue Errno::ENOENT
+          {}
+        end
+
+        data["ignore"] ||= ""
+        data["ignore"] << "/locale/**\n" unless data["ignore"].include?("/locale/**")
+        data["ignore"] << "/vendor/**\n" unless data["ignore"].include?("/vendor/**")
+        data["ignore"].chomp!
+
+        data["extends"] = "relaxed"
+
+        data.store_path("rules", "indentation", "indent-sequences", false)
+        data.store_path("rules", "line-length", "max", 1000)
+
+        File.write(file, data.to_yaml.sub("---\n", ""))
       end
 
       def update_gem_source
@@ -213,7 +256,7 @@ module ManageIQ
         indent = lines.first.match(/^\s+/).to_s
 
         lines.map! { |l| l.strip.gsub(/[()]/, " ").split(" ", 3) }             # Split to [prefix, gem, versions]
-        lines.each { |parts| parts[1].tr!("'", "\"")}                          # Ensure double quoted gem name
+        lines.each { |parts| parts[1].tr!("'", "\"") }                         # Ensure double quoted gem name
         max_width = lines.map { |parts| parts[1].size }.max                    # Determine the widest gem name
         lines.each { |parts| parts[1] = parts[1].ljust(max_width, " ") }       # Apply the width
         lines.map! { |parts| parts.join(" ").strip.insert(0, indent) << "\n" } # Back to strings

data/lib/manageiq/style/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Style
-    VERSION = "1.3.2"
+    VERSION = "1.4.0".freeze
   end
 end

data/manageiq-style.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/ManageIQ/manageiq-style"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
   spec.metadata["source_code_uri"] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "more_core_extensions"
   spec.add_runtime_dependency "optimist"
-  spec.add_runtime_dependency "rubocop", "~> 1.13"
+  spec.add_runtime_dependency "rubocop", "= 1.56.3"
   spec.add_runtime_dependency "rubocop-performance"
   spec.add_runtime_dependency "rubocop-rails"
 

data/styles/base.yml

@@ -8,7 +8,7 @@ AllCops:
     - spec/manageiq/**/*
     - vendor/**/*
   SuggestExtensions: false
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
@@ -120,7 +120,7 @@ Style/MethodCallWithArgsParentheses:
     - lib/tasks/**/*
     - spec/**/*
   Enabled: true
-  IgnoredMethods:
+  AllowedMethods:
     # Ruby
     - add_dependency
     - add_development_dependency
@@ -266,6 +266,8 @@ Style/PerlBackrefs:
   Enabled: false
 Style/ParallelAssignment:
   Enabled: false
+Style/QuotedSymbols:
+  Enabled: false # disabled because Style/StringLiterals is disabled
 Style/RedundantReturn:
   AllowMultipleReturnValues: true
 Style/RegexpLiteral:
@@ -283,7 +285,7 @@ Style/SingleLineMethods:
 Style/SpecialGlobalVars:
   AutoCorrect: false
 Style/StringLiterals:
-  Enabled: false
+  Enabled: false # Also see Style/QuotedSymbols
 Style/StringLiteralsInInterpolation:
   Enabled: false
 Style/SymbolArray:

data/styles/cc_base.yml

@@ -4,7 +4,7 @@
 #
 ---
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 Bundler:
   Enabled: true
 Gemspec:
@@ -44,4 +44,3 @@ Metrics/ParameterLists:
   Enabled: true
 Metrics/PerceivedComplexity:
   Enabled: false
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-style
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: more_core_extensions
@@ -42,16 +42,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.56.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.56.3
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,8 @@ files:
 - ".rubocop_cc_base.yml"
 - ".rubocop_local.yml"
 - ".whitesource"
+- ".yamllint"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -159,6 +161,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ManageIQ/manageiq-style
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/ManageIQ/manageiq-style
 post_install_message:
 rdoc_options: []
@@ -168,14 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Style and linting configuration for ManageIQ projects.