rubocop-grape 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f465c44799edf9ecb17a837d1e85bde5b628c29cb15aad03131878f9c46760
-  data.tar.gz: 8b788b780a6503f2ee4fd540271221c88d644a3616d8f21f0c3033a151a80e2e
+  metadata.gz: d1ddcfa8ca8f07c8b82d051f1b962d106b7e9390f505bce166901deb3d9421c4
+  data.tar.gz: c7de3f5ff9600b83a730d347278e52d0f3f4553389c184b2c04be425193079b3
 SHA512:
-  metadata.gz: c17941eb7ca48f32fbc0d3f53654a8917c847b00df6b1145aab1093ef86be29e628bec85c3d35400208ebc7c19374dc15f8649568506564d9749202875232539
-  data.tar.gz: 0f2163c4f45959cce98ce8682ddc4f188ff642559e62085bcd09fd0b32b764f2d983e1830aae338e1cb510e83923349886d7185e6cf5cb1b0edd61b0b23265e6
+  metadata.gz: 204e3c444825e10ab0c90bdfbb3dac71db90d5aeb56a718a6124ef1b19a3883e93e5815131aefbc8bcc8ba5c20d46c2bdf987f145914167299a33f7cbf95fd44
+  data.tar.gz: 02ebbff3326f417c71983683ed98aa7a414e9a2d3456b671b4a5fe7f19ae4cb84ccb42723f47ee1ed5085f359d6fb70557b1703045f053430e4726c32417f80a

data/config/default.yml

@@ -1,6 +1,18 @@
 AllCops:
   GrapeDir: 'app/api'
 
+Grape/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Reference:
+    - http://c2.com/cgi/wiki?AbcMetric
+    - https://en.wikipedia.org/wiki/ABC_Software_Metric
+    - https://www.rubydoc.info/gems/rubocop/0.27.0/RuboCop/Cop/Metrics/AbcSize
+  Enabled: true
+  Max: 20
+  CountRepeatedAttributes: true
+
 Grape/FieldName:
   EnforcedStyle: snake_case
   SupportedStyles:

data/lib/rubocop/cop/grape/abc_size.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # Checks that the ABC size of endpoints is not higher than the
+      # configured maximum. The ABC size is based on assignments, branches
+      # (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
+      # and https://en.wikipedia.org/wiki/ABC_Software_Metric.
+      class AbcSize < Base
+        extend ExcludeLimit
+
+        exclude_limit 'Max'
+
+        MSG = 'Assignment Branch Condition size is too high. [%<abc_vector>s %<complexity>d/%<max>d]'
+
+        def_node_matcher :http_method_node?, <<~PATTERN
+          (block (send _ {:get :post :put :patch :delete} ...) ...)
+        PATTERN
+
+        def on_block(node)
+          return unless http_method_node?(node)
+
+          check_complexity(node)
+        end
+
+        def check_complexity(node)
+          return unless node.body
+
+          max = cop_config['Max']
+          complexity, abc_vector = complexity(node.body)
+          return unless complexity > max
+
+          msg = format(self.class::MSG, abc_vector: abc_vector, complexity: complexity, max: max)
+          add_offense(node, message: msg) { self.max = complexity.ceil }
+        end
+
+        def complexity(node)
+          Metrics::Utils::AbcSizeCalculator.calculate(
+            node,
+            discount_repeated_attributes: !cop_config['CountRepeatedAttributes']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape_cops.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'grape/abc_size'
 require_relative 'grape/field_name'
 require_relative 'grape/ivar'
 require_relative 'grape/params_position'

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,7 @@ files:
 - bin/console
 - config/default.yml
 - lib/rubocop-grape.rb
+- lib/rubocop/cop/grape/abc_size.rb
 - lib/rubocop/cop/grape/field_name.rb
 - lib/rubocop/cop/grape/ivar.rb
 - lib/rubocop/cop/grape/params_position.rb