barsoom_utils 0.2.0.63 → 0.2.0.64

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70092b4e0d8903d1a3bcd29112d4081ffde6433da0df6343a0bd82a2a2af0dfd
-  data.tar.gz: 10cea16c1658c3cd356e211619e671253e34e9768a43c55e7da641750227bacf
+  metadata.gz: 2cccdc6fc4265ea2cd6ae9f045fef87d7ef796ca5b330c35abff20006872c59d
+  data.tar.gz: b4fdf5c17d092dad93656925955f87cbbd0590307269ae7acea6a30b49127474
 SHA512:
-  metadata.gz: d728afd4f42036aea8c766931f15cc43e9b2fa6438cd16dc3dc4b5bf648515705dc6cad3ee832eb38b3abf923b6650eab28ee1ac355e131660de71b501c4f059
-  data.tar.gz: 887a2c2153a4c595dff2e3d0d568d93a72977b5d5b6268664c9a484bd43c3d5cf64a466b24238e22a9d1c07f559bb532e931ee5c1553745e75b7075da7021da3
+  metadata.gz: 7cc2fec26acb707bcff01af5f29ea62db07b41c90f157687d9591a452fe3281a8a3a7111063418daeb4da0560621995b58412db59c94691e33c7d0949a519e6c
+  data.tar.gz: d44aebbadb9488b219d881a61f35da778168894e2b4cf23468f34b82ed02741dd02c112c85fae1850b11e8875b24ba4db16dfc778c1267d397bf65eea989d3dc

data/.gitignore

@@ -1,9 +1,3 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
 # Ignore bundler config.
 /.bundle
 
@@ -12,3 +6,5 @@
 
 Gemfile.lock
 *.gem
+
+.claude

data/Gemfile

@@ -15,4 +15,5 @@ group :development, :test do
   gem "redis"
   gem "rspec"
   gem "rubocop"
+  gem "rubocop-rspec"  # For `expect_offense` test helpers.
 end

data/VERSION

@@ -1 +1 @@
-0.2.0.63
+0.2.0.64

data/lib/barsoom_utils/exception_notifier.rb

@@ -34,10 +34,5 @@ module BarsoomUtils
         context: context.to_h,
       )
     end
-
-    # Wrap this around code to add context when reporting errors.
-    def self.run_with_context(context, &block)
-      Honeybadger.context(context, &block)
-    end
   end
 end

data/lib/barsoom_utils/rubocop/cop/barsoom/trailing_comma_in_arguments.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Barsoom
+      # Require a trailing comma in multiline method arguments when the
+      # closing `)` is on its own line. Disallow it when `)` is on the
+      # same line as the last argument.
+      #
+      # This differs from the built-in `Style/TrailingCommaInArguments`:
+      # - `comma` disallows trailing commas when args share a line.
+      # - `consistent_comma` requires them even when `)` is on the same line.
+      #
+      # @example
+      #   # good
+      #   foo(
+      #     a,
+      #     b,
+      #   )
+      #
+      #   # good – args sharing a line is fine as long as there's a trailing comma
+      #   foo(
+      #     a, b,
+      #   )
+      #
+      #   # good – single-line
+      #   foo(a, b)
+      #
+      #   # good – closing paren on same line as last arg
+      #   foo(
+      #     a, b)
+      #
+      #   # bad – missing trailing comma
+      #   foo(
+      #     a,
+      #     b
+      #   )
+      #
+      #   # bad – trailing comma but closing paren on same line
+      #   foo(
+      #     a, b,)
+      class TrailingCommaInArguments < Base
+        extend AutoCorrector
+
+        MSG_MISSING = "Put a trailing comma after the last argument when `)` is on the next line."
+        MSG_UNWANTED = "Remove the trailing comma when `)` is on the same line as the last argument."
+
+        def on_send(node)
+          check(node)
+        end
+        alias on_csend on_send
+
+        private
+
+        def check(node)
+          return unless node.arguments? && node.parenthesized?
+
+          close_paren_line = node.source_range.end.line
+          last_arg = node.last_argument
+          last_arg_line = last_arg.source_range.end.line
+
+          return if close_paren_line == last_arg_line && close_paren_line == node.first_argument.first_line
+
+          # A trailing comma after `&` is a syntax error.
+          return if last_arg.block_pass_type?
+
+          trailing_comma = trailing_comma_token(node)
+          paren_on_own_line = close_paren_line > last_arg_line
+
+          if paren_on_own_line && !trailing_comma
+            add_offense_missing(last_arg)
+          elsif !paren_on_own_line && trailing_comma
+            add_offense_unwanted(trailing_comma)
+          end
+        end
+
+        def add_offense_missing(last_arg)
+          add_offense(last_arg, message: MSG_MISSING) do |corrector|
+            corrector.insert_after(last_arg, ",")
+          end
+        end
+
+        def add_offense_unwanted(comma_token)
+          range = comma_token.pos
+          add_offense(range, message: MSG_UNWANTED) do |corrector|
+            corrector.remove(range)
+          end
+        end
+
+        def trailing_comma_token(node)
+          close_paren_idx = node.loc.end
+          tokens = processed_source.tokens
+
+          # Find the non-whitespace token just before the closing paren.
+          tokens.reverse_each do |token|
+            next if token.pos.end_pos > close_paren_idx.begin_pos
+            next if token.comment? || token.type == :tNL
+            return token if token.comma?
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/barsoom_utils/rubocop.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rubocop/cop/barsoom/trailing_comma_in_arguments"

data/shared_rubocop.yml

@@ -1,5 +1,8 @@
 # Configuration for the Rubocop code linting tool. See README.
 
+require:
+  - barsoom_utils/rubocop
+
 AllCops:
   ActiveSupportExtensionsEnabled: true
   DisabledByDefault: true
@@ -228,10 +231,10 @@ Style/RedundantBegin:
 Style/MethodCallWithoutArgsParentheses:
   Enabled: true
 
-# https://docs.rubocop.org/rubocop/cops_style.html#enforcedstyleformultiline-comma
-Style/TrailingCommaInArguments:
+# Replaces Style/TrailingCommaInArguments, which doesn't support our preferred style:
+# require trailing comma only when `)` is on its own line.
+Barsoom/TrailingCommaInArguments:
   Enabled: true
-  EnforcedStyleForMultiline: comma
 
 # https://docs.rubocop.org/rubocop/cops_style.html#stylereturnnilinpredicatemethoddefinition
 Style/ReturnNilInPredicateMethodDefinition:

data/spec/exception_notifier_spec.rb

@@ -73,26 +73,4 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
       )
     end
   end
-
-  describe ".run_with_context" do
-    it "updates the context just within the block" do
-      allow(Honeybadger).to receive(:context).and_call_original
-      Honeybadger.context({ my_old_context: "hello" })
-
-      context_in_block = nil
-
-      expect {
-        BarsoomUtils::ExceptionNotifier.run_with_context({ my_new_context: "what up" }) do
-          context_in_block = Honeybadger.get_context
-          raise "boom"
-        end
-      }.to raise_error /boom/
-
-      # Adds the new context while running the code.
-      expect(context_in_block).to eq({ my_old_context: "hello", my_new_context: "what up" })
-
-      # Resets the old context, without keeping the new.
-      expect(Honeybadger.get_context).to eq({ my_old_context: "hello" })
-    end
-  end
 end

data/spec/rubocop/cop/barsoom/trailing_comma_in_arguments_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop/rspec/support"
+require "barsoom_utils/rubocop"
+
+RSpec.describe RuboCop::Cop::Barsoom::TrailingCommaInArguments, :config do
+  include RuboCop::RSpec::ExpectOffense
+
+  context "when closing paren is on its own line" do
+    it "registers an offense when trailing comma is missing" do
+      expect_offense(<<~RUBY)
+        foo(
+          a,
+          b
+          ^ Put a trailing comma after the last argument when `)` is on the next line.
+        )
+      RUBY
+
+      expect_correction(<<~RUBY)
+        foo(
+          a,
+          b,
+        )
+      RUBY
+    end
+
+    it "accepts trailing comma" do
+      expect_no_offenses(<<~RUBY)
+        foo(
+          a,
+          b,
+        )
+      RUBY
+    end
+
+    it "accepts trailing comma when args share a line" do
+      expect_no_offenses(<<~RUBY)
+        foo(
+          a, b,
+        )
+      RUBY
+    end
+
+    it "registers an offense for missing comma when args share a line" do
+      expect_offense(<<~RUBY)
+        foo(
+          a, b
+             ^ Put a trailing comma after the last argument when `)` is on the next line.
+        )
+      RUBY
+
+      expect_correction(<<~RUBY)
+        foo(
+          a, b,
+        )
+      RUBY
+    end
+  end
+
+  context "when closing paren is on the same line as last arg" do
+    it "registers an offense when trailing comma is present" do
+      expect_offense(<<~RUBY)
+        foo(
+          a,
+          b,)
+           ^ Remove the trailing comma when `)` is on the same line as the last argument.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        foo(
+          a,
+          b)
+      RUBY
+    end
+
+    it "accepts no trailing comma" do
+      expect_no_offenses(<<~RUBY)
+        foo(
+          a,
+          b)
+      RUBY
+    end
+  end
+
+  context "single-line calls" do
+    it "accepts no trailing comma" do
+      expect_no_offenses(<<~RUBY)
+        foo(a, b)
+      RUBY
+    end
+
+    it "accepts a single argument" do
+      expect_no_offenses(<<~RUBY)
+        foo(a)
+      RUBY
+    end
+  end
+
+  context "safe navigation calls" do
+    it "registers an offense when trailing comma is missing" do
+      expect_offense(<<~RUBY)
+        foo&.bar(
+          a,
+          b
+          ^ Put a trailing comma after the last argument when `)` is on the next line.
+        )
+      RUBY
+
+      expect_correction(<<~RUBY)
+        foo&.bar(
+          a,
+          b,
+        )
+      RUBY
+    end
+  end
+
+  context "with keyword arguments" do
+    it "registers an offense when trailing comma is missing" do
+      expect_offense(<<~RUBY)
+        foo(
+          key: "value"
+          ^^^^^^^^^^^^ Put a trailing comma after the last argument when `)` is on the next line.
+        )
+      RUBY
+
+      expect_correction(<<~RUBY)
+        foo(
+          key: "value",
+        )
+      RUBY
+    end
+
+    it "accepts trailing comma" do
+      expect_no_offenses(<<~RUBY)
+        foo(
+          key: "value",
+        )
+      RUBY
+    end
+
+    it "accepts trailing comma followed by a comment" do
+      expect_no_offenses(<<~RUBY)
+        foo(
+          key: "value", # some comment
+        )
+      RUBY
+    end
+  end
+
+  context "with block pass argument" do
+    it "ignores block pass on its own line" do
+      expect_no_offenses(<<~RUBY)
+        bar(
+          a,
+          &block
+        )
+      RUBY
+    end
+  end
+
+  context "without parentheses" do
+    it "ignores calls without parentheses" do
+      expect_no_offenses(<<~RUBY)
+        foo a,
+          b
+      RUBY
+    end
+  end
+
+  context "without arguments" do
+    it "ignores calls without arguments" do
+      expect_no_offenses(<<~RUBY)
+        foo()
+      RUBY
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barsoom_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0.63
+  version: 0.2.0.64
 platform: ruby
 authors:
 - Tomas Skogberg
@@ -29,6 +29,8 @@ files:
 - lib/barsoom_utils.rb
 - lib/barsoom_utils/exception_notifier.rb
 - lib/barsoom_utils/feature_toggle.rb
+- lib/barsoom_utils/rubocop.rb
+- lib/barsoom_utils/rubocop/cop/barsoom/trailing_comma_in_arguments.rb
 - lib/barsoom_utils/spec/debug_helpers.rb
 - lib/barsoom_utils/version.rb
 - script/test
@@ -36,6 +38,7 @@ files:
 - shared_rubocop_rails.yml
 - spec/exception_notifier_spec.rb
 - spec/feature_toggle_spec.rb
+- spec/rubocop/cop/barsoom/trailing_comma_in_arguments_spec.rb
 - spec/spec/debug_helpers_spec.rb
 - spec/spec_helper.rb
 homepage: https://dev.auctionet.com/