rdoc_rubocop 0.1.3 → 0.1.4

data/lib/rdoc_rubocop/lang/c/corrector.rb

@@ -0,0 +1,26 @@
+module RDocRuboCop
+  module Lang
+    module C
+      class Corrector
+        attr_reader :corrected_source
+
+        def initialize(source_file)
+          @source_file = source_file
+          @corrected_source = nil
+        end
+
+        def correct
+          @corrected_source = @source_file.source.dup
+
+          @source_file.comments.reverse_each do |comment|
+            next if comment.source_codes.empty?
+
+            index = comment.offset_begin
+            length = comment.length
+            @corrected_source[index, length] = comment.corrected_text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/c/source_file.rb

@@ -0,0 +1,18 @@
+require "rdoc_rubocop/lang/c/comment_extractor"
+require "rdoc_rubocop/lang/c/corrector"
+
+module RDocRuboCop
+  module Lang
+    module C
+      class SourceFile < Lang::Base::SourceFile
+        def comment_extractor_class
+          C::CommentExtractor
+        end
+
+        def corrector_class
+          C::Corrector
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/ruby.rb

@@ -0,0 +1,8 @@
+module RDocRuboCop
+  module Lang
+    module Ruby
+    end
+  end
+end
+
+require "rdoc_rubocop/lang/ruby/source_file"

data/lib/rdoc_rubocop/lang/ruby/comment.rb

@@ -0,0 +1,52 @@
+require "rdoc_rubocop/lang/base/comment"
+require "rdoc_rubocop/indent_util"
+
+using RDocRuboCop::IndentUtil
+
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class Comment < Lang::Base::Comment
+        attr_reader :comment_tokens
+        attr_reader :source_file
+
+        def initialize(comment_tokens, source_file = nil)
+          @comment_tokens = comment_tokens
+          @source_file = source_file
+        end
+
+        def corrected_text
+          rdoc.
+            apply.
+            gsub(/^/, indent_and_commentchar).
+            gsub(/ *$/, "")
+        end
+
+        def lineno
+          @lineno ||= @comment_tokens.map(&:lineno).minmax
+        end
+
+        def number_of_lines
+          lineno[1] - lineno[0] + 1
+        end
+
+        private
+
+        def text_without_commentchar
+          text.gsub(/^ *#/, "").strip_indent
+        end
+
+        def indent_and_commentchar
+          indent = " " * @comment_tokens.map(&:column).min
+          commentchar_and_indent = text.scan(/^# *(?=\S)/).min
+
+          "#{indent}#{commentchar_and_indent}"
+        end
+
+        def text
+          @text ||= @comment_tokens.map(&:token).join
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/ruby/comment_extractor.rb

@@ -0,0 +1,57 @@
+require 'ripper'
+require 'rdoc_rubocop/lang/ruby/token'
+require 'rdoc_rubocop/lang/ruby/comment'
+
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class CommentExtractor
+        attr_reader :comments
+
+        def initialize(source_file)
+          @source_file = source_file
+          @comments = []
+        end
+
+        def extract
+          @comments = extract_comments
+        end
+
+        private
+
+        def extract_comments
+          chunk = []
+          comments = []
+
+          tokens.each do |tokens_in_line|
+            token = tokens_in_line.pop
+
+            if token.comment?
+              if tokens_in_line.all?(&:sp?)
+                chunk << token
+              else
+                comments << Comment.new(chunk, @source_file) if chunk.any?
+                chunk = []
+              end
+            else
+              if chunk.any?
+                comments << Comment.new(chunk, @source_file)
+                chunk = []
+              end
+            end
+          end
+          comments << Comment.new(chunk, @source_file) if chunk.any?
+
+          comments
+        end
+
+        def tokens
+          Ripper.
+            lex(@source_file.source).
+            map { |token| Token.build(*token) }.
+            slice_when { |token_before, token_after| token_before.lineno != token_after.lineno }
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/ruby/corrector.rb

@@ -0,0 +1,30 @@
+require "rdoc_rubocop/lang/ruby/token/comment_token"
+
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class Corrector
+        attr_reader :corrected_source
+
+        def initialize(source_file)
+          @source_file = source_file
+          @corrected_source = nil
+        end
+
+        def correct
+          source_lines = @source_file.source.lines
+
+          @source_file.comments.reverse_each do |comment|
+            next if comment.source_codes.empty?
+
+            index = comment.lineno[0] - 1
+            number_of_lines = comment.number_of_lines
+            source_lines[index, number_of_lines] = comment.corrected_text
+          end
+
+          @corrected_source = source_lines.join
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/ruby/source_file.rb

@@ -0,0 +1,18 @@
+require "rdoc_rubocop/lang/ruby/comment_extractor"
+require "rdoc_rubocop/lang/ruby/corrector"
+
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class SourceFile < Lang::Base::SourceFile
+        def comment_extractor_class
+          CommentExtractor
+        end
+
+        def corrector_class
+          Corrector
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/ruby/token.rb

@@ -0,0 +1,43 @@
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class Token
+        attr_reader :locate, :type, :token, :state
+
+        def self.build(locate, type, token, state)
+          case type
+          when :on_comment
+            CommentToken.new(locate, type, token, state)
+          else
+            new(locate, type, token, state)
+          end
+        end
+
+        def initialize(locate, type, token, state)
+          @locate = locate
+          @type   = type
+          @token  = token
+          @state  = state
+        end
+
+        def lineno
+          @locate[0]
+        end
+
+        def column
+          @locate[1]
+        end
+
+        %i(on_sp on_comment).each do |type|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{type.to_s.sub(/^on_/, "")}? # def sp?
+              type == :#{type}                #   type == :on_sp
+            end                               # end
+          RUBY
+        end
+      end
+    end
+  end
+end
+
+require "rdoc_rubocop/lang/ruby/token/comment_token"

data/lib/rdoc_rubocop/lang/ruby/token/comment_token.rb

@@ -0,0 +1,13 @@
+module RDocRuboCop
+  module Lang
+    module Ruby
+      class Token
+        class CommentToken < self
+          def comment?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/rdoc.rb

@@ -0,0 +1,69 @@
+require "rdoc_rubocop/rdoc/line"
+require "rdoc_rubocop/rdoc/ruby_snippet"
+
+module RDocRuboCop
+  class RDoc
+    attr_reader :text
+    attr_reader :ruby_snippets
+
+    def initialize(text)
+      @text = text
+
+      @ruby_snippets = []
+      @parsed = false
+    end
+
+    def ruby_snippets
+      parse unless @parsed
+      @ruby_snippets
+    end
+
+    def apply
+      lines = text_lines
+
+      @ruby_snippets.reverse_each do |ruby_snippet|
+        next unless ruby_snippet.corrected_text_with_indent
+
+        index = ruby_snippet.lineno[0] - 1
+        number_of_lines = ruby_snippet.number_of_lines
+        lines[index, number_of_lines] = ruby_snippet.corrected_text_with_indent
+      end
+
+      lines.join
+    end
+
+    private
+
+    def parse
+      @ruby_snippets = []
+      ruby_snippet = RubySnippet.new
+      is_in_call_seq = false
+
+      lines = text_lines.map.with_index { |line, i| Line.new(1 + i, line) }
+      lines.each do |line|
+        if line.blank?
+          ruby_snippet.append(line) if !ruby_snippet.empty?
+        elsif line.indent.length > 0
+          ruby_snippet.append(line) if !is_in_call_seq
+        elsif line.str.match?(/^call-seq:/)
+          is_in_call_seq = true
+          ruby_snippet = RubySnippet.new
+        else
+          is_in_call_seq = false
+
+          if !ruby_snippet.empty?
+            @ruby_snippets << ruby_snippet.tap(&:trim!)
+            ruby_snippet = RubySnippet.new
+          end
+        end
+      end
+      @ruby_snippets << ruby_snippet.tap(&:trim!) if !ruby_snippet.empty?
+
+      @parsed = true
+    end
+
+    def text_lines
+      @text_lines ||= @text.lines
+    end
+  end
+end

data/lib/rdoc_rubocop/rdoc/line.rb

@@ -0,0 +1,24 @@
+require "rdoc_rubocop/indent_util"
+
+using RDocRuboCop::IndentUtil
+
+module RDocRuboCop
+  class RDoc
+    class Line
+      attr_reader :lineno, :str
+
+      def initialize(lineno, str)
+        @lineno = lineno
+        @str = str
+      end
+
+      def blank?
+        /^ *$/.match?(@str)
+      end
+
+      def indent
+        @str.expand_tab.indent
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/rdoc/ruby_snippet.rb

@@ -0,0 +1,62 @@
+require "rdoc_rubocop/indent_util"
+require "rdoc_rubocop/rdoc/line"
+require "rdoc_rubocop/file_path"
+
+using RDocRuboCop::IndentUtil
+
+module RDocRuboCop
+  class RDoc
+    class RubySnippet
+      attr_reader :file_path
+
+      def initialize
+        @lines = []
+      end
+
+      def append(line)
+        @lines << line
+      end
+
+      def empty?
+        @lines.empty?
+      end
+
+      def trim!
+        i = @lines.size - 1
+        while i >= 0 && @lines[i].blank? do
+          @lines.delete_at(i)
+          i -= 1
+        end
+      end
+
+      def text
+        text_with_indent.strip_indent
+      end
+
+      def lineno
+        @lineno ||= @lines.map(&:lineno).minmax
+      end
+
+      def number_of_lines
+        lineno[1] - lineno[0] + 1
+      end
+
+      def build_file_path(filename)
+        @file_path = FilePath.new(filename, self)
+      end
+
+      def corrected_text_with_indent
+        return unless @file_path
+
+        indent = text_with_indent.indent
+        @file_path.source.gsub(/^( *)(?=\S)/, "#{indent}\\1")
+      end
+
+      private
+
+      def text_with_indent
+        @lines.map(&:str).join
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/rubocop_modifier.rb

@@ -1,5 +1,3 @@
-require "rdoc_rubocop/file_path"
-
 module RDocRuboCop
   module RuboCopModifier
     module HijackSTDIN