debtective 0.2.3.3 → 0.2.3.6

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.3"
+  VERSION = "0.2.3.6"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.3.3
+  version: 0.2.3.6
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,17 +132,22 @@ extra_rdoc_files: []
 files:
 - bin/debtective
 - lib/debtective.rb
-- lib/debtective/configuration.rb
-- lib/debtective/find_commit.rb
-- lib/debtective/find_end_of_statement.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/find.rb
-- lib/debtective/todos/list.rb
-- lib/debtective/todos/output.rb
-- lib/debtective/todos/print_table.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/find_commit.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "git"
-require "open3"
-
-module Debtective
-  # find the commit that introduced a 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 [String] line of code
-    def initialize(pathname, code)
-      @pathname = pathname
-      @code = code
-    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 [Git::Base]
-    def git
-      Git.open(".")
-    end
-
-    # @return [Git::Object::Commit]
-    def commit
-      git.gcommit(sha)
-    end
-
-    # commit sha
-    # @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
-
-    # characters " and ` can break the git command
-    # @return [String]
-    def safe_code
-      @code.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/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

data/lib/debtective/todos/build.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "debtective/todos/todo"
-require "debtective/find_end_of_statement"
-
-module Debtective
-  module Todos
-    # Find the todos comments and their boundaries
-    class Build
-      BEFORE_LINE_TODO_REGEX = /^\s*#\sTODO:\s/
-      INLINE_TODO_REGEX = /\s*#\sTODO:\s/
-      COMMENT_REGEX = /\s*#/
-
-      # @param pathname [Pathname]
-      # @param index [Integer]
-      def initialize(pathname, index)
-        @pathname = pathname
-        @index = index
-      end
-
-      # @return [Debtective::Todos::Todo]
-      def call
-        Debtective::Todos::Todo.new(
-          @pathname,
-          lines,
-          todo_boundaries,
-          statement_boundaries
-        )
-      end
-
-      private
-
-      # @return [Array<String>]
-      def lines
-        @lines ||= @pathname.readlines
-      end
-
-      # @return [Range]
-      def todo_boundaries
-        @index..([@index, statement_boundaries.min - 1].max)
-      end
-
-      # range of the concerned code
-      # @return [Range]
-      def statement_boundaries
-        @statement_boundaries ||=
-          case lines[@index]
-          when BEFORE_LINE_TODO_REGEX
-            first_line_index = statement_start
-            last_line_index = Debtective::FindEndOfStatement.new(lines, first_line_index).call
-            first_line_index..last_line_index
-          when INLINE_TODO_REGEX
-            @index..@index
-          end
-      end
-
-      # start index of the concerned code (i.e. below the TODO comment)
-      # @return [Integer]
-      def statement_start
-        lines.index.with_index do |line, i|
-          i > @index &&
-            !line.strip.empty? &&
-            !line.match?(COMMENT_REGEX)
-        end
-      end
-    end
-  end
-end

data/lib/debtective/todos/find.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "debtective/todos/build"
-
-module Debtective
-  module Todos
-    # Find and investigate todo comments and return a list of todos
-    class Find
-      TODO_REGEX = /#\sTODO:/
-
-      # @param paths [Array<String>]
-      def initialize(paths)
-        @paths = paths
-      end
-
-      # @return [Array<Debtective::Todos::Todo>]
-      def call
-        ruby_pathnames.flat_map { pathname_todos(_1) }
-      end
-
-      private
-
-      # @return [Array<Pathname>] only pathes to ruby files
-      def ruby_pathnames
-        @paths
-          .flat_map { Dir[_1] }
-          .map { Pathname(_1) }
-          .select { _1.file? && _1.extname == ".rb" }
-      end
-
-      # return todos in the pathname
-      # @return [Array<Debtective::Todos::Todo>]
-      def pathname_todos(pathname)
-        pathname.readlines.filter_map.with_index do |line, index|
-          next unless line.match?(TODO_REGEX)
-
-          Debtective::Todos::Todo.build(pathname, index)
-        end
-      end
-    end
-  end
-end

data/lib/debtective/todos/list.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todos/find"
-
-module Debtective
-  module Todos
-    # Information about the todos in the codebase
-    class List
-      Author = Struct.new(:email, :name, :todos)
-
-      # @param paths [Array<String>]
-      def initialize(paths)
-        @paths = paths
-      end
-
-      # @return [Array<Debtective::Todos::Todo>]
-      def todos
-        @todos ||= Debtective::Todos::Find.new(@paths).call
-      end
-
-      # @return [Array<Debtective::Todos::List::Author>]
-      def authors
-        todos
-          .map { [_1.commit.author.email, _1.commit.author.name] }
-          .uniq
-          .map { author(_1) }
-      end
-
-      # @return [Integer]
-      def extended_count
-        todos.sum(&:size)
-      end
-
-      # @return [Integer]
-      def combined_count
-        todos
-          .group_by(&:pathname)
-          .values
-          .sum do |pathname_todos|
-            pathname_todos
-              .map { _1.statement_boundaries.to_a }
-              .reduce(:|)
-              .length
-          end
-      end
-
-      private
-
-      # @param email_and_name [Array<String>]
-      # @return [Debtective::Todos::List::Author]
-      def author(email_and_name)
-        Author.new(
-          *email_and_name,
-          todos.select { email_and_name == [_1.commit.author.email, _1.commit.author.name] }
-        )
-      end
-    end
-  end
-end

data/lib/debtective/todos/output.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require "debtective/todos/print_table"
-
-module Debtective
-  module Todos
-    # Generate todolist
-    class Output
-      FILE_PATH = "todos.json"
-
-      # @param user_name [String] git user email to filter
-      def initialize(user_name = nil, quiet: false)
-        @user_name = user_name
-        @quiet = quiet
-      end
-
-      # @return [void]
-      def call
-        @list = log_table
-        @list ||= Debtective::Todos::List.new(Debtective.configuration&.paths || ["./**/*"])
-        filter_list!
-        log_counts
-        update_json_file
-        return if @quiet
-
-        puts FILE_PATH
-      end
-
-      private
-
-      # @return [void]
-      def log_table
-        return if @quiet
-
-        Debtective::Todos::PrintTable.new(@user_name).call
-      end
-
-      # @return [void]
-      def filter_list!
-        !@user_name.nil? && @list.todos.select! { _1.commit.author.name == @user_name }
-      end
-
-      # @return [void]
-      def log_counts
-        return if @quiet
-
-        puts "total: #{@list.todos.count}"
-        puts "combined lines count: #{@list.combined_count}"
-        puts "extended lines count: #{@list.extended_count}"
-      end
-
-      # @return [void]
-      def update_json_file
-        File.open(FILE_PATH, "w") do |file|
-          file.puts(
-            JSON.pretty_generate(
-              @list.todos.map(&:to_h)
-            )
-          )
-        end
-      end
-    end
-  end
-end

data/lib/debtective/todos/print_table.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todos/list"
-
-module Debtective
-  module Todos
-    # Print todos as a table in the stdout
-    class PrintTable
-      # @param user_name [String] git user email to filter
-      def initialize(user_name = nil)
-        @user_name = user_name
-      end
-
-      # @return [Debtective::Todos::List]
-      def call
-        log_table_headers
-        log_table_rows
-        list
-      end
-
-      private
-
-      # @return [void]
-      def log_table_headers
-        puts separator
-        puts table_row("location", "author", "days", "size")
-        puts separator
-      end
-
-      # @return [void]
-      def log_table_rows
-        trace.enable
-        list.todos
-        trace.disable
-        puts separator
-      end
-
-      # use a trace to log each todo as soon as it is found
-      # @return [Tracepoint]
-      def trace
-        TracePoint.new(:return) do |trace_point|
-          next unless trace_point.defined_class == Debtective::Todos::Build && trace_point.method_id == :call
-
-          todo = trace_point.return_value
-          log_todo(todo)
-        end
-      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_todo(todo)
-        row = table_row(
-          todo.location,
-          todo.commit.author.name || "?",
-          todo.days || "?",
-          todo.size
-        )
-        if @user_name.nil? || @user_name == todo.commit.author.name
-          puts row
-        else
-          print "#{row}\r"
-        end
-      end
-
-      # @return [Debtective::Todos::Todo]
-      def list
-        @list ||= Debtective::Todos::List.new(
-          Debtective.configuration&.paths || ["./**/*"]
-        )
-      end
-
-      # @return [String]
-      def table_row(location, author, days, size)
-        [
-          format("%-80.80s", location),
-          format("%-20.20s", author),
-          format("%-12.12s", days),
-          format("%-12.12s", size)
-        ].join(" | ")
-      end
-
-      # @return [String]
-      def separator
-        @separator ||= Array.new(table_row(nil, nil, nil, nil).size) { "-" }.join
-      end
-    end
-  end
-end