debtective 0.2.3.4 → 0.2.3.7

data/lib/debtective/comments/find_end_of_statement.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Debtective
+  module Comments
+    # Find the index of the line ending a statement
+    #
+    # @example
+    #   FindEndOfStatement.new(
+    #     [
+    #       "class User",
+    #       "  def example",
+    #       "    x + y",
+    #       "  end"
+    #       "end"
+    #     ],
+    #     1
+    #   ).call
+    #   => 3
+    #
+    class FindEndOfStatement
+      # @param lines [Array<String>] lines of code
+      # @param first_line_index [Integer] index of the statement first line
+      def initialize(lines:, first_line_index:)
+        @lines = lines
+        @first_line_index = first_line_index
+      end
+
+      # @return [Integer] index of the line ending the statement
+      # @note suppress_stderr prevents outputs from RubyVM::InstructionSequence.compile
+      def call
+        last_line_index
+      end
+
+      private
+
+      # Recursively find index of the line ending the statement
+      # (it is possible that no line ends the statement
+      # especially if the first line is not the start of a statement)
+      def last_line_index(index = @first_line_index)
+        return @first_line_index if index >= @lines.size
+        return index if !chained?(index) && statement?(index)
+
+        last_line_index(index + 1)
+      end
+
+      # Check if the code from first index to given index is a statement,
+      # e.i. can be parsed by a ruby parser (using whitequark/parser)
+      def statement?(index)
+        code = @lines[@first_line_index..index].join("\n")
+        RubyVM::InstructionSequence.compile(code)
+      rescue SyntaxError
+        false
+      end
+
+      # Check if current line is chained, e.i. next line start with a "."
+      def chained?(index)
+        @lines[index + 1]&.match?(/^(\s*)\./)
+      end
+    end
+  end
+end

data/lib/debtective/comments/print.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "export"
+
+module Debtective
+  module Comments
+    # Print elements as a table in the stdout and return the block result
+    class Print
+      Column = Struct.new(:name, :format, :lambda)
+
+      COLUMNS = [
+        Column.new(
+          "location",
+          "%-100.100s",
+          -> { _1.location }
+        ),
+        Column.new(
+          "type",
+          "%-7.7s",
+          -> { _1.type }
+        ),
+        Column.new(
+          "author",
+          "%-20.20s",
+          -> { _1.commit.author.name || "?" }
+        )
+      ].freeze
+
+      # @param user_name [String] git user name to filter with
+      def initialize(user_name: nil)
+        @user_name = user_name
+      end
+
+      # @return [Object] yielded bloc result
+      def call
+        puts separator
+        puts headers_row
+        puts separator
+        trace.enable
+        result = yield
+        trace.disable
+        puts separator
+        result
+      end
+
+      private
+
+      # Use a trace to log each element as soon as it is exported
+      # @return [Tracepoint]
+      def trace
+        TracePoint.new(:return) do |trace_point|
+          next unless trace_point.defined_class == Export && trace_point.method_id == :export_comment
+
+          log_comment(trace_point.return_value)
+        end
+      end
+
+      def headers_row
+        COLUMNS.map { format(_1.format, _1.name) }.join(" | ")
+      end
+
+      def comment_row(comment)
+        COLUMNS.map { format(_1.format, _1.lambda.call(comment)) }.join(" | ")
+      end
+
+      # If a user_name is given and is not the commit author
+      # the line is temporary and will be replaced by the next one
+      def log_comment(comment)
+        return if comment.nil?
+
+        if @user_name.nil? || @user_name == comment.commit.author.name
+          puts comment_row(comment)
+        else
+          print "#{comment_row(comment)}\r"
+        end
+      end
+
+      def separator
+        @separator ||= "-" * COLUMNS.map { format(_1.format, "") }.join("---").size
+      end
+    end
+  end
+end

data/lib/debtective/stderr_helper.rb

@@ -3,6 +3,7 @@
 module Debtective
   # Silence the $stderr
   module StderrHelper
+    # Prevent logs in stderr
     # @return void
     def suppress_stderr
       original_stderr = $stderr.clone

data/lib/debtective/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Debtective
-  VERSION = "0.2.3.4"
+  VERSION = "0.2.3.7"
 end

data/lib/debtective.rb

@@ -1,20 +1,6 @@
 # frozen_string_literal: true
 
 require "debtective/version"
-require "debtective/configuration"
-require "debtective/railtie" if defined?(Rails)
 
 # Entrypoint
-module Debtective
-  class << self
-    attr_accessor :configuration
-
-    # Configures Debtective
-    # @return Debtective::Configuration
-    # @yieldparam [Proc] configuration to apply
-    def configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
-    end
-  end
-end
+module Debtective; end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.3.4
+  version: 0.2.3.7
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-19 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -118,18 +132,22 @@ extra_rdoc_files: []
 files:
 - bin/debtective
 - lib/debtective.rb
-- lib/debtective/configuration.rb
-- lib/debtective/export.rb
-- lib/debtective/find_commit.rb
-- lib/debtective/find_end_of_statement.rb
-- lib/debtective/offenses/export.rb
-- lib/debtective/offenses/offense.rb
-- lib/debtective/print.rb
-- lib/debtective/railtie.rb
+- lib/debtective/command.rb
+- lib/debtective/comments/build_comment.rb
+- lib/debtective/comments/command.rb
+- lib/debtective/comments/comment/base.rb
+- lib/debtective/comments/comment/fixme.rb
+- lib/debtective/comments/comment/magic.rb
+- lib/debtective/comments/comment/note.rb
+- lib/debtective/comments/comment/offense.rb
+- lib/debtective/comments/comment/shebang.rb
+- lib/debtective/comments/comment/todo.rb
+- lib/debtective/comments/comment/yard.rb
+- lib/debtective/comments/export.rb
+- lib/debtective/comments/find_commit.rb
+- lib/debtective/comments/find_end_of_statement.rb
+- lib/debtective/comments/print.rb
 - lib/debtective/stderr_helper.rb
-- lib/debtective/todos/build.rb
-- lib/debtective/todos/export.rb
-- lib/debtective/todos/todo.rb
 - lib/debtective/version.rb
 homepage: https://github.com/BigBigDoudou/debtective
 licenses:

data/lib/debtective/configuration.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Debtective
-  # Manage gem configuration
-  class Configuration
-    attr_accessor :paths
-  end
-end

data/lib/debtective/export.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require "pathname"
-require "debtective/print"
-
-module Debtective
-  # Export elements in a JSON file
-  class Export
-    # @param user_name [String] git user email to filter
-    # @param quiet [boolean]
-    def initialize(user_name: nil, quiet: false)
-      @user_name = user_name
-      @quiet = quiet
-    end
-
-    # @return [void]
-    def call
-      @elements = @quiet ? find_elements : log_table
-      filter_elements!
-      log_counts unless @quiet
-      update_json_file
-      puts(FILE_PATH) unless @quiet
-    end
-
-    private
-
-    FILE_PATH = ""
-
-    # list of paths to search in
-    # @return [Array<String>]
-    def pathnames
-      (Debtective.configuration&.paths || ["./**/*"])
-        .flat_map { Dir[_1] }
-        .map { Pathname(_1) }
-        .select { _1.file? && _1.extname == ".rb" }
-    end
-
-    # select only elements commited by the given user
-    # @return [void]
-    def filter_elements!
-      return if @user_name.nil?
-
-      @elements.select! { _1.commit.author.name == @user_name }
-    end
-
-    # @return [void]
-    def log_counts
-      puts "total: #{@elements.count}"
-    end
-
-    # write elements into the JSON file
-    # @return [void]
-    def update_json_file
-      File.open(self.class::FILE_PATH, "w") do |file|
-        file.puts(
-          JSON.pretty_generate(
-            @elements.map(&:to_h)
-          )
-        )
-      end
-    end
-  end
-end

data/lib/debtective/find_commit.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require "git"
-require "open3"
-
-module Debtective
-  # Find the commit that introduced the given line of code
-  class FindCommit
-    Author = Struct.new(:email, :name)
-    Commit = Struct.new(:sha, :author, :time)
-
-    SPECIAL_CHARACTER_REGEX = /(?!\w|\s|#|:).+/
-
-    # @param pathname [Pathname] file path
-    # @param code_line [String] line of code_line
-    def initialize(pathname:, code_line:)
-      @pathname = pathname
-      @code_line = code_line
-    end
-
-    # @return [Debtective::FindCommit::Commit]
-    def call
-      Commit.new(sha, author, time)
-    rescue Git::GitExecuteError
-      author = Author.new(nil, nil)
-      Commit.new(nil, author, nil)
-    end
-
-    # @return [Debtective::FindCommit::Author]
-    def author
-      Author.new(commit.author.email, commit.author.name)
-    end
-
-    # @return [Time]
-    def time
-      commit.date
-    end
-
-    # @return [String]
-    def sha
-      @sha ||=
-        begin
-          cmd = "git log -S \"#{safe_code}\" #{@pathname}"
-          stdout, _stderr, _status = ::Open3.capture3(cmd)
-          stdout[/commit (\w{40})\n/, 1]
-        end
-    end
-
-    private
-
-    # @return [Git::Base]
-    def git
-      Git.open(".")
-    end
-
-    # @return [Git::Object::Commit]
-    def commit
-      git.gcommit(sha)
-    end
-
-    # characters " and ` can break the git command
-    # @return [String]
-    def safe_code
-      @code_line.gsub(/"/, "\\\"").gsub("`", "\\\\`")
-    end
-  end
-end

data/lib/debtective/find_end_of_statement.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/stderr_helper"
-
-module Debtective
-  # Find the index of the line ending a statement
-  #
-  # @example
-  #   FindEndOfStatement.new(
-  #     [
-  #       "class User",
-  #       "  def example",
-  #       "    x + y",
-  #       "  end"
-  #       "end"
-  #     ],
-  #     1
-  #   ).call
-  #   => 3
-  #
-  class FindEndOfStatement
-    include StderrHelper
-
-    # @param lines [Array<String>] lines of code
-    # @param index [Integer] index of the statement first line
-    def initialize(lines:, first_line_index:)
-      @lines = lines
-      @first_line_index = first_line_index
-    end
-
-    # index of the line ending the statement
-    # @return [Integer]
-    # @note use suppress_stderr to prevent error outputs
-    #   from RubyVM::InstructionSequence.compile
-    def call
-      suppress_stderr { last_line_index }
-    end
-
-    private
-
-    # recursively find index of the line ending the statement
-    # @param index [Integer] used for recursion
-    # @return[Integer, void]
-    # @note it is possible that no line ends the statement
-    # especially if first line is not the start of a statement
-    def last_line_index(index = @first_line_index)
-      return @first_line_index if index >= @lines.size
-      return index if !chained?(index) && statement?(index)
-
-      last_line_index(index + 1)
-    end
-
-    # check if the code from first index to given index is a statement
-    # e.i. can be parsed by a ruby parser (using whitequark/parser)
-    # @param index [Integer]
-    # @return boolean
-    def statement?(index)
-      code = @lines[@first_line_index..index].join("\n")
-      RubyVM::InstructionSequence.compile(code)
-    rescue SyntaxError
-      false
-    end
-
-    # check if current line is chained
-    # e.i. next line start with a .
-    # @param index [Integer]
-    # @return boolean
-    def chained?(index)
-      @lines[index + 1]&.match?(/^(\s*)\./)
-    end
-  end
-end

data/lib/debtective/offenses/export.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/export"
-require "debtective/print"
-require "debtective/offenses/offense"
-
-module Debtective
-  module Offenses
-    # Export offenses in a JSON file
-    class Export < Debtective::Export
-      private
-
-      FILE_PATH = "offenses.json"
-
-      TABLE_COLUMNS = [
-        Debtective::Print::Column.new(
-          "location",
-          "%-80.80s",
-          -> { _1.location }
-        ),
-        Debtective::Print::Column.new(
-          "author",
-          "%-20.20s",
-          -> { _1.commit.author.name || "?" }
-        ),
-        Debtective::Print::Column.new(
-          "cop",
-          "%-27.27s",
-          -> { _1.cop || "?" }
-        )
-      ].freeze
-
-      # @return [Array<Debtective::Offenses::Offense>]
-      def log_table
-        Debtective::Print.new(
-          columns: TABLE_COLUMNS,
-          track: Debtective::Offenses::Offense,
-          user_name: @user_name
-        ).call { find_elements }
-      end
-
-      # @return [Array<Debtective::Offenses::Offense>]
-      def find_elements
-        pathnames.flat_map do |pathname|
-          pathname.readlines.filter_map.with_index do |line, index|
-            next unless line =~ /\s# rubocop:disable (.*)/
-
-            Debtective::Offenses::Offense.new(
-              pathname: pathname,
-              index: index,
-              cop: Regexp.last_match[1]
-            )
-          end
-        end
-      end
-    end
-  end
-end

data/lib/debtective/offenses/offense.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/find_commit"
-
-module Debtective
-  module Offenses
-    # Hold offense information
-    class Offense
-      attr_accessor :pathname, :cop
-
-      # @param pathname [Pathname]
-      # @param cop [Array<String>]
-      def initialize(pathname:, index:, cop:)
-        @pathname = pathname
-        @index = index
-        @cop = cop
-      end
-
-      # location in the codebase
-      # @return [String]
-      def location
-        "#{@pathname}:#{@index + 1}"
-      end
-
-      # return commit that introduced the offense
-      # @return [Debtective::FindCommit::Commit]
-      def commit
-        @commit ||=
-          Debtective::FindCommit.new(
-            pathname: @pathname,
-            code_line: @pathname.readlines[@index]
-          ).call
-      end
-
-      # @return [Integer]
-      def days
-        return if commit.time.nil?
-
-        ((Time.now - commit.time) / (24 * 60 * 60)).round
-      end
-
-      # @return [Hash]
-      def to_h
-        {
-          pathname: @pathname,
-          location: location,
-          index: @index,
-          commit: {
-            sha: commit.sha,
-            author: commit.author.to_h,
-            time: commit.time
-          }
-        }
-      end
-    end
-  end
-end

data/lib/debtective/print.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Debtective
-  # Print elements as a table in the stdout
-  class Print
-    Column = Struct.new(:name, :format, :lambda)
-
-    # @param columns [Array<Debtective::Print::Column>]
-    # @param track [Class]
-    # @param user_name [String] git user name to filter
-    def initialize(columns:, track:, user_name: nil)
-      @columns = columns
-      @track = track
-      @user_name = user_name
-    end
-
-    # @return [Array]
-    def call
-      puts separator
-      puts headers_row
-      puts separator
-      trace.enable
-      result = yield
-      trace.disable
-      puts separator
-      result
-    end
-
-    private
-
-    # use a trace to log each element as soon as it is found
-    # @return [Tracepoint]
-    def trace
-      TracePoint.new(:return) do |trace_point|
-        next unless trace_point.defined_class == @track && trace_point.method_id == :initialize
-
-        object = trace_point.self
-        log_object(object)
-      end
-    end
-
-    # @return [String]
-    def headers_row
-      @columns.map do |column|
-        format(column.format, column.name)
-      end.join(" | ")
-    end
-
-    # @return [String]
-    def object_row(object)
-      @columns.map do |column|
-        format(column.format, column.lambda.call(object))
-      end.join(" | ")
-    end
-
-    # if a user_name is given and is not the commit author
-    # the line is temporary and will be replaced by the next one
-    # @return [void]
-    def log_object(object)
-      if @user_name.nil? || @user_name == object.commit.author.name
-        puts object_row(object)
-      else
-        print "#{object_row(object)}\r"
-      end
-    end
-
-    # @return [String]
-    def separator
-      @separator ||=
-        begin
-          size = @columns.map { format(_1.format, "") }.join("---").size
-          "-" * size
-        end
-    end
-  end
-end

data/lib/debtective/railtie.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Debtective
-  # Makes Rails aware of the tasks
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      load "tasks/debtective/todo_list.rake"
-    end
-  end
-end