rubocop_todo_corrector 0.11.1 → 0.12.0
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/CHANGELOG.md +6 -0
- data/Gemfile.lock +1 -1
- data/lib/rubocop_todo_corrector/cop_document_parser.rb +29 -7
- data/lib/rubocop_todo_corrector/version.rb +1 -1
- data/templates/description.md.erb +6 -0
- metadata +2 -2
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 45d1eb10f7da8503c49e40459f9ad3634be640b16df9cd9d6d39f3a3e1201247
         | 
| 4 | 
            +
              data.tar.gz: 6e696ba691aaa2f61946ae58f267ed5de87571199a2a6cd8e7636a7ec2d056a1
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: c36fe6f928ecad20c2817c2bc67a232998577b77d233239f1969fccc6381938fd2c6f00453c4c727f747abb276f15ed967871bc93aa29165f1140347e0e854c1
         | 
| 7 | 
            +
              data.tar.gz: dca597c40eed65bfcb583b6e6ad219a62b8285ad18009eeb0288a014d27957e70cecc7e0ed98ab6e959106bf9def7f11101d3362754468a789e7091b660b754b
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    
    
        data/Gemfile.lock
    CHANGED
    
    
| @@ -27,18 +27,40 @@ module RubocopTodoCorrector | |
| 27 27 | 
             
                  return unless yard_class_object
         | 
| 28 28 |  | 
| 29 29 | 
             
                  {
         | 
| 30 | 
            -
                    description | 
| 31 | 
            -
                    examples | 
| 32 | 
            -
             | 
| 33 | 
            -
                        name: tag.name,
         | 
| 34 | 
            -
                        text: tag.text
         | 
| 35 | 
            -
                      }
         | 
| 36 | 
            -
                    end
         | 
| 30 | 
            +
                    description:,
         | 
| 31 | 
            +
                    examples:,
         | 
| 32 | 
            +
                    safety:
         | 
| 37 33 | 
             
                  }
         | 
| 38 34 | 
             
                end
         | 
| 39 35 |  | 
| 40 36 | 
             
                private
         | 
| 41 37 |  | 
| 38 | 
            +
                # @return [String]
         | 
| 39 | 
            +
                def description
         | 
| 40 | 
            +
                  yard_class_object.docstring
         | 
| 41 | 
            +
                end
         | 
| 42 | 
            +
             | 
| 43 | 
            +
                # @return [Array<Hash>]
         | 
| 44 | 
            +
                def examples
         | 
| 45 | 
            +
                  yard_class_object.tags('example').map do |tag|
         | 
| 46 | 
            +
                    {
         | 
| 47 | 
            +
                      name: tag.name,
         | 
| 48 | 
            +
                      text: tag.text
         | 
| 49 | 
            +
                    }
         | 
| 50 | 
            +
                  end
         | 
| 51 | 
            +
                end
         | 
| 52 | 
            +
             | 
| 53 | 
            +
                # @return [Hash, nil]
         | 
| 54 | 
            +
                def safety
         | 
| 55 | 
            +
                  tag = yard_class_object.tag('safety')
         | 
| 56 | 
            +
                  return unless tag
         | 
| 57 | 
            +
             | 
| 58 | 
            +
                  {
         | 
| 59 | 
            +
                    name: tag.name,
         | 
| 60 | 
            +
                    text: tag.text
         | 
| 61 | 
            +
                  }
         | 
| 62 | 
            +
                end
         | 
| 63 | 
            +
             | 
| 42 64 | 
             
                # @return [YARD::CodeObjects::ClassObject]
         | 
| 43 65 | 
             
                def yard_class_object
         | 
| 44 66 | 
             
                  @yard_class_object ||= begin
         | 
| @@ -11,6 +11,12 @@ Auto-corrected [<%= @cop_name %>](<%= cop_url %>). | |
| 11 11 | 
             
            <% @cop_document[:description].each_line do |line| -%>
         | 
| 12 12 | 
             
            <%= "> #{line}".strip %>
         | 
| 13 13 | 
             
            <% end -%>
         | 
| 14 | 
            +
            <% if @cop_document[:safety] -%>
         | 
| 15 | 
            +
            >
         | 
| 16 | 
            +
            > #### Safety
         | 
| 17 | 
            +
            >
         | 
| 18 | 
            +
            > <%= @cop_document[:safety][:text].gsub("\n", " ").strip %>
         | 
| 19 | 
            +
            <% end -%>
         | 
| 14 20 | 
             
            <% unless @cop_document[:examples].empty? -%>
         | 
| 15 21 | 
             
            >
         | 
| 16 22 | 
             
            > #### Examples
         | 
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: rubocop_todo_corrector
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 0. | 
| 4 | 
            +
              version: 0.12.0
         | 
| 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-08- | 
| 11 | 
            +
            date: 2022-08-07 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: bundler
         |