Merge pull request #2 from Zopolis4/bureau

Add Chromebrew/OrderedCompatibility cop

Author: uberhacker

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'

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

lib/rubocop/cop/chromebrew_cops.rb

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

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