rubocop-chromebrew 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecb3bc18dd4abfd786ff273b8f1f8bf364d6abe2ca2d90290fa6f9e4a937d960
-  data.tar.gz: 56893f21d3a6c790a957e59f8944472c056edb4ffefc93443ac2943da630b461
+  metadata.gz: '0607503886d47cd386967c421e1cbd48cf548b603bef64f6cfd1ebafbd65f9b0'
+  data.tar.gz: ecce859a1eca8fb82bbf17b2735be68e4bcfbfd2344cedb11dd9607fca03b583
 SHA512:
-  metadata.gz: b1b3d2016c459a8031ad691e1a8b182d90f03ef59b42f4a079f3689ef29dbbd4bd7c13d3161b42dd568b226e9b2e1a55db477387558b46dc12a072c693922be6
-  data.tar.gz: e0da3533e92e926102351accd60b0c6019a3809dde85b1b2086b33c7ab2d8770f1e868b95ecb23f9222c4aa9bbbb0c84da0ac566280e4d3f164f86eb5d88ee35
+  metadata.gz: 4ceb68e04f6bc65d767507eb2b0a17b3990af3d0407724426762ab55dbe0f74d88ab6bdce89f40ceb6d23aa7b98bc6b09491603334957f6edd8e7adcaf0c6e97
+  data.tar.gz: 57839de0cfff500323a8d5237d344edd1f6c50e2b487e642d4870ea57ff4f14eafc0aaaf22805d24103fea8dfb9d12e781467ce803491609d75df8a830bab88c

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4.1'
+      # TODO: Convert this to a Gemfile when we have multiple/versioned dependencies.
+      - name: Install dependencies
+        run: gem install rspec rubocop
+      - name: Run spec
+        run: rspec

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.0.3 (2025-02-10)
+
+### New features
+
+* Add Chromebrew/OrderedCompatibility cop ([@zopolis4][])
+
+### Changes
+
+* Limit Chromebrew/CompatibilityAll offense reporting to the offensive compatibility value rather than the whole node ([@zopolis4][])
+
+## 0.0.2 (2025-02-02)
+
+### Bug fixes
+
+* Fix cop loading ([@zopolis4][])
+
 ## 0.0.1 (2024-06-18)
 
 ### New features

data/config/default.yml

@@ -5,3 +5,8 @@ Chromebrew/CompatibilityAll:
   Description: "This cop checks for compatibility values that can be replaced by 'all'."
   Enabled: true
   VersionAdded: '0.0.1'
+
+Chromebrew/OrderedCompatibility:
+  Description: 'This cop checks for compatibility values that are not in alphabetical order.'
+  Enabled: true
+  VersionAdded: '0.0.3'

data/lib/rubocop/cop/chromebrew/compatibility_all.rb

@@ -28,9 +28,9 @@ module RuboCop
           # Check if the compatibility value includes all four architectures.
           return unless architectures.all? { |arch| value.include?(arch) }
 
-          # If requested, replace the offending line with compatibility 'all'.
-          add_offense(node) do |corrector|
-            corrector.replace(node, "compatibility 'all'")
+          # If requested, replace the offending compatibility value with 'all'.
+          add_offense(node.children.last) do |corrector|
+            corrector.replace(node.children.last, "'all'")
           end
         end
       end

data/lib/rubocop/cop/chromebrew/ordered_compatibility.rb

@@ -0,0 +1,39 @@
+module RuboCop
+  module Cop
+    module Chromebrew
+      # Compatibility values should be in alphabetic order.
+      #
+      # @example
+      #   # bad
+      #   compatibility 'x86_64 aarch64 armv7l'
+      #
+      #   # good
+      #   compatibility 'aarch64 armv7l x86_64'
+      #
+      class OrderedCompatibility < Base
+        extend AutoCorrector
+        MSG = 'Compatibility values should be in alphabetical order.'
+
+        def_node_matcher :compatibility?, <<~PATTERN
+          (send nil? :compatibility
+            (str $_))
+        PATTERN
+
+        def on_send(node)
+          # Check that we're operating on the compatibility property.
+          value = compatibility?(node)
+          return unless value
+
+          sorted_value = value.split.sort.join(' ')
+
+          return if sorted_value == value
+
+          # If requested, replace the offending compatibility value with the sorted version.
+          add_offense(node.children.last) do |corrector|
+            corrector.replace(node.children.last, "'#{sorted_value}'")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chromebrew_cops.rb

@@ -1 +1,2 @@
 require_relative 'chromebrew/compatibility_all'
+require_relative 'chromebrew/ordered_compatibility'

data/lib/rubocop-chromebrew.rb

@@ -5,4 +5,4 @@ require_relative 'rubocop/chromebrew/inject'
 
 RuboCop::Chromebrew::Inject.defaults!
 
-require_relative 'rubocop/chromebrew/chromebrew_cops'
+require_relative 'rubocop/cop/chromebrew_cops'

data/rubocop-chromebrew.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |spec|
   spec.name     = 'rubocop-chromebrew'
   spec.summary  = 'A RuboCop extension for Chromebrew-specific practices.'
-  spec.version  = '0.0.1'
+  spec.version  = '0.0.3'
   spec.license  = 'GPL-3.0-or-later'
   spec.author   = 'Zopolis4'
   spec.email    = 'creatorsmithmdt@gmail.com'
-  spec.homepage = 'https://github.com/Zopolis4/rubocop-chromebrew'
+  spec.homepage = 'https://github.com/chromebrew/rubocop-chromebrew'
 
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ['lib']

data/spec/rubocop/cop/chromebrew/compatibility_all_spec.rb

@@ -0,0 +1,40 @@
+RSpec.describe RuboCop::Cop::Chromebrew::CompatibilityAll, :config do
+  it 'registers an offense when all four architectures are listed' do
+    expect_offense(<<~'RUBY')
+      compatibility 'aarch64 armv7l i686 x86_64'
+                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Compatibility properties which match all architectures should be replaced with 'all'
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      compatibility 'all'
+    RUBY
+  end
+
+  it 'registers an offense when all four architectures are listed with commas' do
+    expect_offense(<<~'RUBY')
+      compatibility 'aarch64, armv7l, i686, x86_64'
+                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Compatibility properties which match all architectures should be replaced with 'all'
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      compatibility 'all'
+    RUBY
+  end
+
+  it 'registers an offense when all four architectures are listed in a different order' do
+    expect_offense(<<~'RUBY')
+      compatibility 'i686 armv7l x86_64 aarch64'
+                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Compatibility properties which match all architectures should be replaced with 'all'
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      compatibility 'all'
+    RUBY
+  end
+
+  it 'does not register an offense when only some architectures are listed' do
+    expect_no_offenses(<<~'RUBY')
+      compatibility 'i686 x86_64'
+    RUBY
+  end
+end

data/spec/rubocop/cop/chromebrew/ordered_compatibility_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe RuboCop::Cop::Chromebrew::OrderedCompatibility, :config do
+  it 'registers an offense when compatibiltiy is not in alphabetical order with three elements' do
+    expect_offense(<<~'RUBY')
+      compatibility 'x86_64 aarch64 armv7l'
+                    ^^^^^^^^^^^^^^^^^^^^^^^ Compatibility values should be in alphabetical order.
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      compatibility 'aarch64 armv7l x86_64'
+    RUBY
+  end
+
+  it 'registers an offense when compatibiltiy is not in alphabetical order with two elements' do
+    expect_offense(<<~'RUBY')
+      compatibility 'x86_64 i686'
+                    ^^^^^^^^^^^^^ Compatibility values should be in alphabetical order.
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      compatibility 'i686 x86_64'
+    RUBY
+  end
+
+  it 'does not register an offense when compatibility is in alphabetical order' do
+    expect_no_offenses(<<~'RUBY')
+      compatibility 'aarch64 armv7l x86_64'
+    RUBY
+  end
+
+  it 'does not register an offense when compatibility is a single architecture' do
+    expect_no_offenses(<<~'RUBY')
+      compatibility 'x86_64'
+    RUBY
+  end
+
+  it 'does not register an offense when compatibility is all' do
+    expect_no_offenses(<<~'RUBY')
+      compatibility 'all'
+    RUBY
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubocop-chromebrew'
+require 'rubocop/rspec/support'
+
+RSpec.configure do |config|
+  config.include RuboCop::RSpec::ExpectOffense
+
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+  config.raise_on_warning = true
+  config.fail_if_no_examples = true
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-chromebrew
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Zopolis4
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -28,7 +28,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -37,9 +39,13 @@ files:
 - lib/rubocop/chromebrew.rb
 - lib/rubocop/chromebrew/inject.rb
 - lib/rubocop/cop/chromebrew/compatibility_all.rb
+- lib/rubocop/cop/chromebrew/ordered_compatibility.rb
 - lib/rubocop/cop/chromebrew_cops.rb
 - rubocop-chromebrew.gemspec
-homepage: https://github.com/Zopolis4/rubocop-chromebrew
+- spec/rubocop/cop/chromebrew/compatibility_all_spec.rb
+- spec/rubocop/cop/chromebrew/ordered_compatibility_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chromebrew/rubocop-chromebrew
 licenses:
 - GPL-3.0-or-later
 metadata: {}
@@ -57,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A RuboCop extension for Chromebrew-specific practices.
 test_files: []