rdoc_rubocop 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ec1f1f83f72d7d0d3a52826863bde165b9591a6c2de4c65e3e0d8e1d171304
-  data.tar.gz: 3d7d930cfe7fdbd1be58116536bb25a4977ce37f3fb13bfea7d36286b2a04da1
+  metadata.gz: b7269874a91137d88ca85006a12c4648aa3a12c8720265a7cc583409668faa75
+  data.tar.gz: a91582e932953cbd855dfed031e97f25be3ee4d2d35cdc89cb39b941ecf8862f
 SHA512:
-  metadata.gz: 77e715471260f29ed62a3def4673bc4060bf043965c572393c52db3d7e6d34861a34d3d74ebf5d41c2e66724d66c6b85759ad221077f6818865bce3c3fc1157b
-  data.tar.gz: 948ba86f073bd6c9205540116e96026f9c59a5591d4f1381f7ef2a8335e70800df426346615c772bdc3b72a177477db707ac2b9666d66ce43f79e7a09936748d
+  metadata.gz: 7e169d14f61ccd2dd385281924b23df9ada5307844689a16e2fc4935038933348f30f33724f04b0f01937043f56ad1ffbd377ee77608208c6b88203264fe0f62
+  data.tar.gz: 13e0d4521a81793b26622f2fad729c80fce61be9f0adff35864e025337e50757dc95b9e71a9d164df3a4c944258b4e700b9af9a2574bad30a3a8d96e6553fa23

data/README.md

@@ -65,6 +65,8 @@ Or install it yourself as:
     # Correct the code
     $ rdoc-rubocop -a
 
+If you do not specify any file, rdoc_rubocop finds for files recursively from current directory. The extension of the target file is used to determine programming language. If it is .rb, it is parsed as Ruby, and if it is .c, it is parsed as C.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/rdoc-rubocop

@@ -13,7 +13,7 @@ paths =
   flat_map do |path|
     path = Pathname.new(path)
     if path.directory?
-      path.glob("**/*.rb")
+      path.glob(["**/*.c", "**/*.rb"]).sort
     else
       path
     end

data/lib/rdoc_rubocop.rb

@@ -1,10 +1,8 @@
 require "rubocop"
 require "rdoc_rubocop/version"
-require "rdoc_rubocop/comment_extractor"
 require "rdoc_rubocop/options"
-require "rdoc_rubocop/source_file"
-require "rdoc_rubocop/rubocop_modifier"
 require "rdoc_rubocop/rubocop_runner"
+require "rdoc_rubocop/rubocop_modifier"
 
 module RDocRuboCop
   class Error < StandardError; end

data/lib/rdoc_rubocop/file_path.rb

@@ -1,5 +1,3 @@
-require "rdoc_rubocop/comment/source_code"
-
 module RDocRuboCop
   class FilePath < String
     attr_reader :source_code

data/lib/rdoc_rubocop/indent_util.rb

@@ -0,0 +1,19 @@
+module RDocRuboCop
+  module IndentUtil
+    refine String do
+      def indent
+        scan(/^ *(?=\S)/).min
+      end
+
+      def strip_indent
+        gsub(/^#{indent}/, "")
+      end
+
+      # Since space indent and tab indent are mixed in Ruby source code,
+      # it is unified with space indent.
+      def expand_tab
+        gsub(/\t/, "    ")
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang.rb

@@ -0,0 +1,7 @@
+module RDocRuboCop
+  module Lang
+  end
+end
+
+require "rdoc_rubocop/lang/c"
+require "rdoc_rubocop/lang/ruby"

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

@@ -0,0 +1,36 @@
+require "rdoc_rubocop/rdoc"
+
+module RDocRuboCop
+  module Lang
+    module Base
+      class Comment
+        # def initialize(comment, source_file = nil)
+        #   @comment = comment
+        #   @source_file = source_file
+        # end
+
+        def rdoc
+          @rdoc ||= RDoc.new(text_without_commentchar)
+        end
+
+        def source_codes
+          @source_codes ||= extract_source_codes
+        end
+
+        # def corrected_text
+        #   rdoc.apply
+        # end
+
+        private
+
+        def extract_source_codes
+          rdoc.ruby_snippets
+        end
+
+        # def text_without_commentchar
+        #   @comment
+        # end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require "digest"
+
+module RDocRuboCop
+  module Lang
+    module Base
+      class SourceFile
+        attr_reader :source
+        attr_reader :filename
+
+        def self.build(filename)
+          klass =
+            case filename
+            when /\.c\z/ then Lang::C::SourceFile
+            when /\.rb\z/ then Lang::Ruby::SourceFile
+            end
+
+          return unless klass
+
+          source = File.open(filename, "r").read
+          klass.new(source, filename)
+        end
+
+        def initialize(source, filename)
+          @source = source
+          @filename = filename
+
+          reset
+        end
+
+        def source_code_file_paths
+          @source_code_file_paths ||=
+            comments.
+              flat_map(&:source_codes).
+              map { |source_code| source_code.build_file_path(@filename) }
+        end
+
+        def comments
+          @comments ||=
+            begin
+              comment_extractor = comment_extractor_class.new(self)
+              comment_extractor.extract
+              comment_extractor.comments
+            end
+        end
+
+        # def comment_extractor_class
+        #   CommentExtractor
+        # end
+
+        def correct!
+          correct
+          save if changed?
+          reset
+        end
+
+        def correct
+          corrector = corrector_class.new(self)
+          corrector.correct
+
+          @source = corrector.corrected_source
+        end
+
+        # def corrector_class
+        #   Corrector
+        # end
+
+        private
+
+        def reset
+          @checksum = compute_digest(@source)
+          @source_code_file_paths = nil
+        end
+
+        def compute_digest(str)
+          Digest::MD5.hexdigest(str)
+        end
+
+        def save
+          File.open(@filename, "w") do |f|
+            f.puts @source
+          end
+        end
+
+        def changed?
+          compute_digest(@source) != @checksum
+        end
+      end
+    end
+  end
+end
+
+require "rdoc_rubocop/lang/c/source_file"
+require "rdoc_rubocop/lang/ruby/source_file"

data/lib/rdoc_rubocop/lang/c.rb

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

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

@@ -0,0 +1,58 @@
+require "rdoc_rubocop/lang/base/comment"
+
+module RDocRuboCop
+  module Lang
+    module C
+      class Comment < Lang::Base::Comment
+        attr_reader :comment_text
+        attr_reader :source_file
+        attr_reader :offset_begin
+        attr_reader :offset_end
+
+        def self.build(comment_text, source_file, offset_begin, offset_end)
+          body = comment_text.dup
+          first_line = body.slice!(/\A.*\R/)
+
+          klass =
+            if first_line.nil?
+              Comment::OneLine
+            elsif first_line.match?(%r(^/\*[\x21-\x2f\x3a-\x3f])) || !body.match?(/\A *\*/)
+              Comment::Banner
+            else
+              Comment::Normal
+            end
+
+          klass.new(comment_text, source_file, offset_begin, offset_end)
+        end
+
+        def initialize(comment_text, source_file, offset_begin, offset_end)
+          @comment_text = comment_text
+          @source_file = source_file
+          @offset_begin = offset_begin
+          @offset_end = offset_end
+        end
+
+        # def corrected_text
+        # end
+
+        def length
+          @offset_end - @offset_begin
+        end
+
+        private
+
+        def text_without_commentchar
+          parse unless @body
+          @body
+        end
+
+        # def parse
+        # end
+      end
+    end
+  end
+end
+
+require "rdoc_rubocop/lang/c/comment/one_line"
+require "rdoc_rubocop/lang/c/comment/normal"
+require "rdoc_rubocop/lang/c/comment/banner"

data/lib/rdoc_rubocop/lang/c/comment/banner.rb

@@ -0,0 +1,68 @@
+require "rdoc_rubocop/indent_util"
+
+using RDocRuboCop::IndentUtil
+
+module RDocRuboCop
+  module Lang
+    module C
+      class Comment < Lang::Base::Comment
+        #
+        # This class manages comments of the following form:
+        #
+        #   /**********************
+        #    * Document-class: Foo
+        #    *
+        #    *   code1
+        #    *   code2
+        #    **********************/
+        #
+        # Those whose body is before the column position of the comment
+        # start are also included.
+        #
+        #   /*
+        #    Document-class: Foo
+        #
+        #      code1
+        #      code2
+        #    */
+        #
+        class Banner < self
+          def corrected_text
+            body = rdoc.apply
+
+            text = body.gsub(/^/, indent).gsub(/ *$/, "")
+            text = "#{@padding_begin_str}#{text}"
+
+            "#{text}#{@end_str}"
+          end
+
+          private
+
+          def parse
+            body = @comment_text.expand_tab
+
+            #
+            # /*********  <- @padding_begin_str
+            #  * comment1 <- first_line
+            #  *
+            #  * comment2
+            #  #********/ <- @end_str
+            #
+            @padding_begin_str = body.slice!(/\A.*\R/)
+            @end_str = body.slice!(%r(^.*\*/\z))
+
+            @indent_before_asterisk = body.scan(/^ *\*/).min || ""
+            @indent_after_asterisk = body.gsub(/^ *\*/, "").indent || ""
+            indent = @indent_before_asterisk + @indent_after_asterisk
+
+            @body = body.gsub(/^.{0,#{indent.length}}/, "")
+          end
+
+          def indent
+            @indent_before_asterisk + @indent_after_asterisk
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/c/comment/normal.rb

@@ -0,0 +1,62 @@
+require "rdoc_rubocop/indent_util"
+
+using RDocRuboCop::IndentUtil
+
+module RDocRuboCop
+  module Lang
+    module C
+      class Comment < Lang::Base::Comment
+        #
+        # This class manages comments of the following form:
+        #
+        #   /*
+        #    * Document-class: Foo
+        #    *
+        #    *   code1
+        #    *   code2
+        #    */
+        #
+        class Normal < self
+          def corrected_text
+            body = rdoc.apply
+
+            first_line = body.slice!(/\A.*\R/)
+            body.gsub!(/^/, indent)
+
+            text = "/*#{@indent_after_asterisk}#{first_line}#{body}".gsub(/ *$/, "")
+            "#{text}#{@end_str}"
+          end
+
+          private
+
+          def parse
+            body = @comment_text.expand_tab
+
+            #
+            # /*          <- first_line
+            #  * comment1
+            #  *
+            #  * comment2
+            #  */         <- @end_str
+            #
+            first_line = body.slice!(/\A.*\R/)
+            @end_str = body.slice!(%r(^.*\*/\z))
+
+            tmp_indent = @end_str[/^ */]
+            body = tmp_indent + "*" + first_line.sub(%r(/\*), "") + body
+
+            @indent_before_asterisk = body.scan(/^ *\*/).min || ""
+            @indent_after_asterisk = body.gsub(/^ *\*/, "").indent || ""
+            indent = @indent_before_asterisk + @indent_after_asterisk
+
+            @body = body.gsub(/^.{0,#{indent.length}}/, "")
+          end
+
+          def indent
+            @indent_before_asterisk + @indent_after_asterisk
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdoc_rubocop/lang/c/comment/one_line.rb

@@ -0,0 +1,22 @@
+module RDocRuboCop
+  module Lang
+    module C
+      class Comment < Lang::Base::Comment
+        class OneLine < self
+          def corrected_text
+            "#{@begin_str}#{rdoc.apply}#{@end_str}"
+          end
+
+          private
+
+          def parse
+            @body = @comment_text.dup
+
+            @begin_str = @body.slice!(%r(^/\*\s*))
+            @end_str = @body.slice!(%r(\s*\*/$))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require "rdoc_rubocop/lang/c/comment"
+
+module RDocRuboCop
+  module Lang
+    module C
+      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
+          pos = 0
+          comments = []
+
+          while match_data = %r(/\*.*?\*/)m.match(@source_file.source, pos) do
+            comments << Comment.build(match_data[0], self, match_data.begin(0), match_data.end(0))
+            pos = match_data.end(0)
+          end
+
+          comments
+        end
+      end
+    end
+  end
+end