sevencop 0.10.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +20 -0
- data/config/default.yml +6 -0
- data/lib/rubocop/cop/sevencop/method_definition_multiline_arguments.rb +72 -0
- data/lib/sevencop/version.rb +1 -1
- data/lib/sevencop.rb +1 -0
- metadata +3 -2
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: f5145711881e4ff729c76af2973e3c7af5c4ad5d7a72318dc28ea4346b7530e0
         | 
| 4 | 
            +
              data.tar.gz: 3bade2432dfd3a659d4c689c005cc36c0ecb16da14dd99d338a815876ec8951f
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 8011ea16ecaf3d1e8eb34156ca6b30f1f545d3d01406a4a1fa189b5cfb5bd74a4b0a6d177762c750023ac50c645e1ef8378028d44f4c710ea6744577fa7c5a64
         | 
| 7 | 
            +
              data.tar.gz: '0392eb84b36bff0120d79e637d84fa3d893935d10c4dfd5dbd004bacdff75bf524137dc38976705e69aaa6c420fe4ad01160b89c36a49bc6c764d8cccae4079c'
         | 
    
        data/Gemfile.lock
    CHANGED
    
    
    
        data/README.md
    CHANGED
    
    | @@ -124,6 +124,26 @@ RSpec.describe User | |
| 124 124 | 
             
            RSpec.describe User, type: :request
         | 
| 125 125 | 
             
            ```
         | 
| 126 126 |  | 
| 127 | 
            +
            ### Sevencop/MethodDefinitionMultilineArguments
         | 
| 128 | 
            +
             | 
| 129 | 
            +
            Inserts new lines between method definition parameters.
         | 
| 130 | 
            +
             | 
| 131 | 
            +
            ```ruby
         | 
| 132 | 
            +
            # bad
         | 
| 133 | 
            +
            def foo(a, b)
         | 
| 134 | 
            +
            end
         | 
| 135 | 
            +
             | 
| 136 | 
            +
            # good
         | 
| 137 | 
            +
            def foo(
         | 
| 138 | 
            +
              a,
         | 
| 139 | 
            +
              b
         | 
| 140 | 
            +
            )
         | 
| 141 | 
            +
             | 
| 142 | 
            +
            # good
         | 
| 143 | 
            +
            def foo(a)
         | 
| 144 | 
            +
            end
         | 
| 145 | 
            +
            ```
         | 
| 146 | 
            +
             | 
| 127 147 | 
             
            ### Sevencop/OrderField
         | 
| 128 148 |  | 
| 129 149 | 
             
            Identifies a String including "field" is passed to `order` or `reorder`.
         | 
    
        data/config/default.yml
    CHANGED
    
    | @@ -23,6 +23,12 @@ Sevencop/InferredSpecType: | |
| 23 23 | 
             
              Enabled: false
         | 
| 24 24 | 
             
              VersionAdded: '0.9'
         | 
| 25 25 |  | 
| 26 | 
            +
            Sevencop/MethodDefinitionMultilineArguments:
         | 
| 27 | 
            +
              Description: |
         | 
| 28 | 
            +
                Inserts new lines between method definition parameters.
         | 
| 29 | 
            +
              Enabled: false
         | 
| 30 | 
            +
              VersionAdded: '0.11'
         | 
| 31 | 
            +
             | 
| 26 32 | 
             
            Sevencop/OrderField:
         | 
| 27 33 | 
             
              Description: |
         | 
| 28 34 | 
             
                Wrap safe SQL String by `Arel.sql`.
         | 
| @@ -0,0 +1,72 @@ | |
| 1 | 
            +
            # frozen_string_literal: true
         | 
| 2 | 
            +
             | 
| 3 | 
            +
            module RuboCop
         | 
| 4 | 
            +
              module Cop
         | 
| 5 | 
            +
                module Sevencop
         | 
| 6 | 
            +
                  # Inserts new lines between method definition parameters.
         | 
| 7 | 
            +
                  #
         | 
| 8 | 
            +
                  # @example
         | 
| 9 | 
            +
                  #   # bad
         | 
| 10 | 
            +
                  #   def foo(a, b)
         | 
| 11 | 
            +
                  #   end
         | 
| 12 | 
            +
                  #
         | 
| 13 | 
            +
                  #   # good
         | 
| 14 | 
            +
                  #   def foo(
         | 
| 15 | 
            +
                  #     a,
         | 
| 16 | 
            +
                  #     b
         | 
| 17 | 
            +
                  #   )
         | 
| 18 | 
            +
                  #
         | 
| 19 | 
            +
                  #   # good
         | 
| 20 | 
            +
                  #   def foo(a)
         | 
| 21 | 
            +
                  #   end
         | 
| 22 | 
            +
                  class MethodDefinitionMultilineArguments < Base
         | 
| 23 | 
            +
                    extend AutoCorrector
         | 
| 24 | 
            +
             | 
| 25 | 
            +
                    MSG = 'Insert new lines between method definition parameters.'
         | 
| 26 | 
            +
             | 
| 27 | 
            +
                    # @param node [RuboCop::AST::ArgsNode]
         | 
| 28 | 
            +
                    def on_args(node)
         | 
| 29 | 
            +
                      return unless method_args?(node)
         | 
| 30 | 
            +
                      return if multilined?(node)
         | 
| 31 | 
            +
             | 
| 32 | 
            +
                      add_offense(node) do |corrector|
         | 
| 33 | 
            +
                        autocorrect(corrector, node)
         | 
| 34 | 
            +
                      end
         | 
| 35 | 
            +
                    end
         | 
| 36 | 
            +
             | 
| 37 | 
            +
                    private
         | 
| 38 | 
            +
             | 
| 39 | 
            +
                    # @param corrector [RuboCop::AST::Corrector]
         | 
| 40 | 
            +
                    # @param node [RuboCop::AST::ArgsNode]
         | 
| 41 | 
            +
                    # @return [String]
         | 
| 42 | 
            +
                    def autocorrect(corrector, node)
         | 
| 43 | 
            +
                      indent = ' ' * node.parent.location.expression.column
         | 
| 44 | 
            +
             | 
| 45 | 
            +
                      corrector.replace(
         | 
| 46 | 
            +
                        node.location.expression.with(
         | 
| 47 | 
            +
                          begin_pos: node.parent.location.name.end_pos
         | 
| 48 | 
            +
                        ),
         | 
| 49 | 
            +
                        [
         | 
| 50 | 
            +
                          "(\n#{indent}  ",
         | 
| 51 | 
            +
                          node.children.map(&:source).join(",\n#{indent}  "),
         | 
| 52 | 
            +
                          "\n#{indent})"
         | 
| 53 | 
            +
                        ].join
         | 
| 54 | 
            +
                      )
         | 
| 55 | 
            +
                    end
         | 
| 56 | 
            +
             | 
| 57 | 
            +
                    # @param node [RuboCop::AST::ArgsNode]
         | 
| 58 | 
            +
                    # @return [Boolean]
         | 
| 59 | 
            +
                    def multilined?(node)
         | 
| 60 | 
            +
                      node.children.map do |child|
         | 
| 61 | 
            +
                        child.location.expression.line
         | 
| 62 | 
            +
                      end.uniq.length == node.children.length
         | 
| 63 | 
            +
                    end
         | 
| 64 | 
            +
             | 
| 65 | 
            +
                    # @return [Boolean]
         | 
| 66 | 
            +
                    def method_args?(node)
         | 
| 67 | 
            +
                      !node.parent.nil? && node.parent.def_type?
         | 
| 68 | 
            +
                    end
         | 
| 69 | 
            +
                  end
         | 
| 70 | 
            +
                end
         | 
| 71 | 
            +
              end
         | 
| 72 | 
            +
            end
         | 
    
        data/lib/sevencop/version.rb
    CHANGED
    
    
    
        data/lib/sevencop.rb
    CHANGED
    
    | @@ -7,6 +7,7 @@ require_relative 'rubocop/cop/sevencop/belongs_to_optional' | |
| 7 7 | 
             
            require_relative 'rubocop/cop/sevencop/factory_bot_create_list'
         | 
| 8 8 | 
             
            require_relative 'rubocop/cop/sevencop/hash_literal_order'
         | 
| 9 9 | 
             
            require_relative 'rubocop/cop/sevencop/inferred_spec_type'
         | 
| 10 | 
            +
            require_relative 'rubocop/cop/sevencop/method_definition_multiline_arguments'
         | 
| 10 11 | 
             
            require_relative 'rubocop/cop/sevencop/order_field'
         | 
| 11 12 | 
             
            require_relative 'rubocop/cop/sevencop/redundant_existence_check'
         | 
| 12 13 | 
             
            require_relative 'rubocop/cop/sevencop/to_s_with_argument'
         | 
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: sevencop
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 0. | 
| 4 | 
            +
              version: 0.11.1
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Ryo Nakamura
         | 
| 8 8 | 
             
            autorequire:
         | 
| 9 9 | 
             
            bindir: exe
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date: 2022- | 
| 11 | 
            +
            date: 2022-09-21 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: rubocop
         | 
| @@ -45,6 +45,7 @@ files: | |
| 45 45 | 
             
            - lib/rubocop/cop/sevencop/factory_bot_create_list.rb
         | 
| 46 46 | 
             
            - lib/rubocop/cop/sevencop/hash_literal_order.rb
         | 
| 47 47 | 
             
            - lib/rubocop/cop/sevencop/inferred_spec_type.rb
         | 
| 48 | 
            +
            - lib/rubocop/cop/sevencop/method_definition_multiline_arguments.rb
         | 
| 48 49 | 
             
            - lib/rubocop/cop/sevencop/order_field.rb
         | 
| 49 50 | 
             
            - lib/rubocop/cop/sevencop/redundant_existence_check.rb
         | 
| 50 51 | 
             
            - lib/rubocop/cop/sevencop/to_s_with_argument.rb
         |