rubocop-grape 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f465c44799edf9ecb17a837d1e85bde5b628c29cb15aad03131878f9c46760
-  data.tar.gz: 8b788b780a6503f2ee4fd540271221c88d644a3616d8f21f0c3033a151a80e2e
+  metadata.gz: 590df7af3dec0374453d4f8ba4282b6d2981492c4e25d0ea537dd9e7b1de8eca
+  data.tar.gz: d52f772ffb08ba797df64f30298362ce04872477b36544614430e7dd157540d4
 SHA512:
-  metadata.gz: c17941eb7ca48f32fbc0d3f53654a8917c847b00df6b1145aab1093ef86be29e628bec85c3d35400208ebc7c19374dc15f8649568506564d9749202875232539
-  data.tar.gz: 0f2163c4f45959cce98ce8682ddc4f188ff642559e62085bcd09fd0b32b764f2d983e1830aae338e1cb510e83923349886d7185e6cf5cb1b0edd61b0b23265e6
+  metadata.gz: 32c44eac0eee98cee4c97de9e3ff829c7f7d65ef532ee5066985804cc430aff642c93402712240023b430a5a02578806f9a2864e1550147dbc6e9a12e56dbf0c
+  data.tar.gz: 6692df01c1c324431ba0625d5f2042447afb7b882977dd36fa3f556a9bf448f79cf5e9884240a66f9af1263d04b31e70ec8a1fd212975b6e0758816e9d899b29

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:
@@ -16,3 +28,9 @@ Grape/ParamsPosition:
   Enabled: true
   Safe: false
   VersionAdded: '0.1'
+
+Grape/PresentWith:
+  Enabled: true
+  Safe: false
+  SafeAutoCorrect: false
+  VersionAdded: '0.4.2'

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

@@ -0,0 +1,44 @@
+# 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
+        include EndpointHelper
+
+        exclude_limit 'Max'
+
+        MSG = 'Assignment Branch Condition size is too high. [%<abc_vector>s %<complexity>d/%<max>d]'
+
+        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/field_name.rb

@@ -31,20 +31,16 @@ module RuboCop
       #
       class FieldName < Base
         include ConfigurableNaming
-        include RangeHelp
+        include EndpointHelper
 
         MSG = 'Use %<style>s for field names.'
 
-        def_node_matcher :params_block?, <<~PATTERN
-          (block (send _ :params) _ $_)
-        PATTERN
-
         def_node_matcher :field_name, <<~PATTERN
           (send _ {:requires :optional} (sym $_) ...)
         PATTERN
 
         def on_block(node)
-          return unless (body = params_block?(node))
+          return unless (body = params_node?(node))
 
           find_field_node(body)
         end

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

@@ -20,15 +20,9 @@ module RuboCop
       #   end
       #
       class ParamsPosition < Base
-        MSG = "It's no sense to define params in HTTP method's scope"
-
-        def_node_matcher :params_block?, <<~PATTERN
-          (block (send _ :params) ...)
-        PATTERN
+        include EndpointHelper
 
-        def_node_matcher :http_method_node?, <<~PATTERN
-          (block (send _ {:get :post :put :patch :delete} ...) ...)
-        PATTERN
+        MSG = "It's no sense to define params in HTTP method's scope"
 
         def on_block(node)
           return unless http_method_node?(node)
@@ -37,7 +31,7 @@ module RuboCop
         end
 
         def collect_violating_nodes(node, collector = [])
-          collector.push(node) if node.type == :block && params_block?(node)
+          collector.push(node) if node.type == :block && params_node?(node)
 
           node.children.each do |descendant|
             collect_violating_nodes(descendant, collector) if descendant.is_a?(Parser::AST::Node)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # @example
+      #
+      #   # bad
+      #   get do
+      #     present users: users, with: API::Entities::User
+      #   end
+      #
+      #   # good
+      #   get do
+      #     present :users, users, with: API::Entities::User
+      #   end
+      #
+      class PresentWith < Base
+        extend AutoCorrector
+        include EndpointHelper
+
+        MSG_TEMPLATE = 'Maybe you mistyped "`%<current>s`", it should be "`%<correct>s`"'
+
+        def_node_matcher :one_hash_arg_with_key_name_with?, <<~PATTERN
+          (send _ :present
+            (hash
+              (pair (sym $_key)
+                {(send _ $_val) (lvar $_val)})
+              (pair (sym :with) _)))
+        PATTERN
+
+        def on_send(present_node)
+          one_hash_arg_with_key_name_with?(present_node) do |key, val|
+            kwarg = present_node.children.last
+
+            add_offense(kwarg.children.first, message: message(key, val)) do |corrector|
+              corrector.remove(kwarg.children.first)
+              corrector.insert_before(kwarg, ":#{key}, #{val}")
+            end
+          end
+        end
+
+        def message(key, val)
+          format(MSG_TEMPLATE, current: "#{key}: #{val}", correct: ":#{key}, #{val}")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape_cops.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'mixin/endpoint_helper'
+
+require_relative 'grape/abc_size'
 require_relative 'grape/field_name'
 require_relative 'grape/ivar'
 require_relative 'grape/params_position'
+require_relative 'grape/present_with'
 require_relative 'grape/route_param_type'

data/lib/rubocop/cop/mixin/endpoint_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # EndpointHelper is a set of AST definitions for endpoint definition by Grape DSL
+    module EndpointHelper
+      extend NodePattern::Macros
+
+      def_node_matcher :http_method_node?, <<~PATTERN
+        (block (send _ {:get :post :put :patch :delete} ...) ...)
+      PATTERN
+
+      def_node_matcher :params_node?, <<~PATTERN
+        (block (send _ :params) _ $_)
+      PATTERN
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.3.0'
+    VERSION = '0.4.2'
   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.2
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,11 +44,14 @@ 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
+- lib/rubocop/cop/grape/present_with.rb
 - lib/rubocop/cop/grape/route_param_type.rb
 - lib/rubocop/cop/grape_cops.rb
+- lib/rubocop/cop/mixin/endpoint_helper.rb
 - lib/rubocop/grape.rb
 - lib/rubocop/grape/grape_files.rb
 - lib/rubocop/grape/inject.rb
@@ -76,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Automatice Grape code style checking tool.