debtective 0.2.3.2 → 0.2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dbc3a3e7ee53fc04a2759fcf0e538773d2e03633e8d8770b536c6ce49d81466
-  data.tar.gz: 3ae9df343e6cee84e979ccc66fe35fda106df0a69bf2c6c570cdfb76f92859f3
+  metadata.gz: '09e2ba02faff3be09a87e2babe120bb59e28f0ea509ad8cc8ef1f9a12cf55ae6'
+  data.tar.gz: e1c5d6197706783907a1756671928eac854d1d771eb541d58b18dba8053da003
 SHA512:
-  metadata.gz: 0c1e6dacb2bbf1b23102add21f05f1872700ac71975b20e7fc70f1078e2a8faef5a3c4ac8daad30047e1e46ae287fac178c6916e7e4a54439ea1085f589a7155
-  data.tar.gz: ed2f39253ec62220a150e7639628f2e8420375b7fef444a0c2d4f8bdd1f4a65f62449d9f7ab968001cada37fc57aaec80097931aebb259f61d09fa3943cbf3fb
+  metadata.gz: f1641ef5d5031d12d7c85665a252ab168cf456297621b81c400f22c8a8017868eb3c7873eade9ae2c8b0cb21c93a85d702ff16ffd4a45b822edd0d450ca42835
+  data.tar.gz: f371a5a826c7daff0c6cc2a31e7e5686731f29d74b568e96174de0000bdec70c62318481ff2a21ef98ff84d279053fbbb747511f75b0e0c79c8adb160f540bcb

data/bin/debtective

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require "debtective"
-require "debtective/output_todos"
 
 user_name =
   if ARGV.include?("--me")
@@ -11,11 +10,17 @@ user_name =
     ARGV[ARGV.index("--user") + 1]
   end
 
-if user_name
-  puts "Searching TODOs from #{user_name}..."
+quiet = ARGV.include?("--quiet")
+
+case ARGV[0]
+when "--todos"
+  require "debtective/todos/export"
+  Debtective::Todos::Export.new(user_name: user_name, quiet: quiet).call
+when "--offenses"
+  require "debtective/offenses/export"
+  Debtective::Offenses::Export.new(user_name: user_name, quiet: quiet).call
+when "--gems"
+  puts "Upcoming feature"
 else
-  puts "Searching TODOs..."
+  puts "Please pass one of this options: [--todos, --offenses, --gems]"
 end
-
-quiet = ARGV.include?("--quiet")
-Debtective::OutputTodos.new(user_name, quiet: quiet).call

data/lib/debtective/export.rb

@@ -0,0 +1,64 @@
+# 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/{git_commit.rb → find_commit.rb}

@@ -4,21 +4,21 @@ require "git"
 require "open3"
 
 module Debtective
-  # find the commit that introduced a line of code
-  class GitCommit
+  # 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 [String] line of code
-    def initialize(pathname, code)
+    # @param code_line [String] line of code_line
+    def initialize(pathname:, code_line:)
       @pathname = pathname
-      @code = code
+      @code_line = code_line
     end
 
-    # @return [Debtective::GitCommit::Commit]
+    # @return [Debtective::FindCommit::Commit]
     def call
       Commit.new(sha, author, time)
     rescue Git::GitExecuteError
@@ -26,7 +26,7 @@ module Debtective
       Commit.new(nil, author, nil)
     end
 
-    # @return [Debtective::GitCommit::Author]
+    # @return [Debtective::FindCommit::Author]
     def author
       Author.new(commit.author.email, commit.author.name)
     end
@@ -36,17 +36,6 @@ module Debtective
       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 ||=
@@ -57,10 +46,22 @@ module Debtective
         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.gsub(/"/, "\\\"").gsub("`", "\\\\`")
+      @code_line.gsub(/"/, "\\\"").gsub("`", "\\\\`")
     end
   end
 end

data/lib/debtective/find_end_of_statement.rb

@@ -23,7 +23,7 @@ module Debtective
 
     # @param lines [Array<String>] lines of code
     # @param index [Integer] index of the statement first line
-    def initialize(lines, first_line_index)
+    def initialize(lines:, first_line_index:)
       @lines = lines
       @first_line_index = first_line_index
     end

data/lib/debtective/offenses/export.rb

@@ -0,0 +1,58 @@
+# 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

@@ -0,0 +1,57 @@
+# 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

@@ -0,0 +1,76 @@
+# 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/todos/build.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "debtective/todos/todo"
+require "debtective/find_end_of_statement"
+
+module Debtective
+  module Todos
+    # Build a Todo object given the pathname and the comment index
+    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: @pathname,
+          lines: lines,
+          todo_boundaries: todo_boundaries,
+          statement_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: lines, first_line_index: 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/export.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "debtective/export"
+require "debtective/print"
+require "debtective/todos/build"
+require "debtective/todos/todo"
+
+module Debtective
+  module Todos
+    # Export todos in a JSON file
+    class Export < Debtective::Export
+      private
+
+      FILE_PATH = "todos.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(
+          "days",
+          "%-12.12s",
+          -> { _1.days || "?" }
+        ),
+        Debtective::Print::Column.new(
+          "size",
+          "%-12.12s",
+          -> { _1.size }
+        )
+      ].freeze
+
+      # @return [Array<Debtective::Todos::Todo>]
+      def log_table
+        Debtective::Print.new(
+          columns: TABLE_COLUMNS,
+          track: Debtective::Todos::Todo,
+          user_name: @user_name
+        ).call { find_elements }
+      end
+
+      # @return [Array<Debtective::Todos::Todo>]
+      def find_elements
+        pathnames.flat_map do |pathname|
+          pathname.readlines.filter_map.with_index do |line, index|
+            next unless line =~ /#\sTODO:/
+
+            Debtective::Todos::Build.new(
+              pathname: pathname,
+              index: index
+            ).call
+          end
+        end
+      end
+
+      # @return [void]
+      def log_counts
+        puts "total: #{@elements.count}"
+        puts "extended lines count: #{extended_count}"
+        puts "combined lines count: #{combined_count}"
+      end
+
+      # @return [Integer]
+      def extended_count
+        @elements.sum(&:size)
+      end
+
+      # @return [Integer]
+      def combined_count
+        @elements
+          .group_by(&:pathname)
+          .values
+          .sum do |pathname_todos|
+            pathname_todos
+              .map { _1.statement_boundaries.to_a }
+              .reduce(:|)
+              .length
+          end
+      end
+    end
+  end
+end

data/lib/debtective/todos/todo.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "debtective/find_commit"
+
+module Debtective
+  module Todos
+    # Hold todo information
+    class Todo
+      attr_accessor :pathname, :todo_boundaries, :statement_boundaries
+
+      # @param pathname [Pathname]
+      # @param lines [Array<String>]
+      # @param todo_boundaries [Range]
+      # @param statement_boundaries [Range]
+      def initialize(pathname:, lines:, todo_boundaries:, statement_boundaries:)
+        @pathname = pathname
+        @lines = lines
+        @todo_boundaries = todo_boundaries
+        @statement_boundaries = statement_boundaries
+      end
+
+      # location in the codebase
+      # @return [String]
+      def location
+        "#{@pathname}:#{@todo_boundaries.min + 1}"
+      end
+
+      # size of the todo code
+      # @return [Integer]
+      def size
+        @statement_boundaries.size
+      end
+
+      # return commit that introduced the todo
+      # @return [Debtective::FindCommit::Commit]
+      def commit
+        @commit ||=
+          Debtective::FindCommit.new(
+            pathname: @pathname,
+            code_line: @lines[@todo_boundaries.min]
+          ).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,
+          todo_boundaries: todo_boundaries.minmax,
+          statement_boundaries: statement_boundaries.minmax,
+          size: size,
+          commit: {
+            sha: commit.sha,
+            author: commit.author.to_h,
+            time: commit.time
+          }
+        }
+      end
+    end
+  end
+end

data/lib/debtective/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.3.2
+  version: 0.2.3.4
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -118,19 +118,19 @@ extra_rdoc_files: []
 files:
 - bin/debtective
 - lib/debtective.rb
-- lib/debtective/build_todo.rb
 - lib/debtective/configuration.rb
+- lib/debtective/export.rb
+- lib/debtective/find_commit.rb
 - lib/debtective/find_end_of_statement.rb
-- lib/debtective/find_todos.rb
-- lib/debtective/git_commit.rb
-- lib/debtective/output_todos.rb
-- lib/debtective/print_table.rb
+- lib/debtective/offenses/export.rb
+- lib/debtective/offenses/offense.rb
+- lib/debtective/print.rb
 - lib/debtective/railtie.rb
 - lib/debtective/stderr_helper.rb
-- lib/debtective/todo.rb
-- lib/debtective/todo_list.rb
+- lib/debtective/todos/build.rb
+- lib/debtective/todos/export.rb
+- lib/debtective/todos/todo.rb
 - lib/debtective/version.rb
-- lib/tasks/debtective/todo_list.rake
 homepage: https://github.com/BigBigDoudou/debtective
 licenses:
 - MIT

data/lib/debtective/build_todo.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "debtective/todo"
-require "debtective/find_end_of_statement"
-
-module Debtective
-  # Find the todos comments and their boundaries
-  class BuildTodo
-    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::Todo]
-    def call
-      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 = 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

data/lib/debtective/find_todos.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "debtective/build_todo"
-
-module Debtective
-  # Find and investigate todo comments and return a list of todos
-  class FindTodos
-    TODO_REGEX = /#\sTODO:/
-
-    # @param paths [Array<String>]
-    def initialize(paths)
-      @paths = paths
-    end
-
-    # @return [Array<Debtective::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::Todo>]
-    def pathname_todos(pathname)
-      pathname.readlines.filter_map.with_index do |line, index|
-        next unless line.match?(TODO_REGEX)
-
-        Todo.build(pathname, index)
-      end
-    end
-  end
-end

data/lib/debtective/output_todos.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require "debtective/print_table"
-require "pry"
-
-module Debtective
-  # Generate todolist
-  class OutputTodos
-    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
-      @todo_list = log_table
-      @todo_list ||= Debtective::TodoList.new(Debtective.configuration&.paths || ["./**/*"])
-      filter_todo_list!
-      log_counts
-      update_json_file
-      puts FILE_PATH
-    end
-
-    private
-
-    # @return [void]
-    def log_table
-      return if @quiet
-
-      Debtective::PrintTable.new(@user_name).call
-    end
-
-    # @return [void]
-    def filter_todo_list!
-      !@user_name.nil? && @todo_list.todos.select! { _1.commit.author.name == @user_name }
-    end
-
-    # @return [void]
-    def log_counts
-      @return if @quiet
-
-      puts "total: #{@todo_list.todos.count}"
-      puts "combined lines count: #{@todo_list.combined_count}"
-      puts "extended lines count: #{@todo_list.extended_count}"
-    end
-
-    # @return [void]
-    def update_json_file
-      File.open(FILE_PATH, "w") do |file|
-        file.puts(
-          JSON.pretty_generate(
-            @todo_list.todos.map(&:to_h)
-          )
-        )
-      end
-    end
-  end
-end

data/lib/debtective/print_table.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todo_list"
-
-module Debtective
-  # 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::TodoList]
-    def call
-      log_table_headers
-      log_table_rows
-      todo_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
-      todo_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::BuildTodo && 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::Todo]
-    def todo_list
-      @todo_list ||= Debtective::TodoList.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

data/lib/debtective/todo.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/git_commit"
-
-module Debtective
-  # Hold todo information
-  class Todo
-    class << self
-      # @return [Debtective::Todo]
-      def build(pathname, index)
-        BuildTodo.new(pathname, index).call
-      end
-    end
-
-    attr_accessor :pathname, :todo_boundaries, :statement_boundaries
-
-    # @param pathname [Pathname]
-    # @param lines [Array<String>]
-    # @param todo_boundaries [Range]
-    # @param statement_boundaries [Range]
-    def initialize(pathname, lines, todo_boundaries, statement_boundaries)
-      @pathname = pathname
-      @lines = lines
-      @todo_boundaries = todo_boundaries
-      @statement_boundaries = statement_boundaries
-    end
-
-    # location in the codebase
-    # @return [String]
-    def location
-      "#{@pathname}:#{@todo_boundaries.min + 1}"
-    end
-
-    # size of the todo code
-    # @return [Integer]
-    def size
-      @statement_boundaries.size
-    end
-
-    # return commit that introduced the todo
-    # @return [Git::Object::Commit]
-    def commit
-      @commit ||= Debtective::GitCommit.new(@pathname, @lines[@todo_boundaries.min]).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,
-        todo_boundaries: todo_boundaries.minmax,
-        statement_boundaries: statement_boundaries.minmax,
-        size: size,
-        commit: {
-          sha: commit.sha,
-          author: commit.author.to_h,
-          time: commit.time
-        }
-      }
-    end
-  end
-end

data/lib/debtective/todo_list.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/find_todos"
-
-module Debtective
-  # Information about the todos in the codebase
-  class TodoList
-    Author = Struct.new(:email, :name, :todos)
-
-    # @param paths [Array<String>]
-    def initialize(paths)
-      @paths = paths
-    end
-
-    # @return [Array<Debtective::Todo>]
-    def todos
-      @todos ||= Debtective::FindTodos.new(@paths).call
-    end
-
-    # @return [Array<TodoList::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 [TodoList::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

data/lib/tasks/debtective/todo_list.rake

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/output_todos"
-
-begin
-  require "#{Rails.root}/config/initializers/debtective" if defined?(Rails)
-rescue LoadError
-  nil
-end
-
-namespace :debtective do
-  desc "Todo List"
-  task :todo_list do
-    user_name =
-      if ARGV.include?("--me")
-        `git config user.name`.strip
-      elsif ARGV.include?("--user")
-        ARGV[ARGV.index("--user") + 1]
-      end
-
-    if user_name
-      puts "Searching TODOs from #{user_name}..."
-    else
-      puts "Searching TODOs..."
-    end
-
-    Debtective::OutputTodos.new(user_name, quiet: ARGV.include?("--quiet")).call
-  end
-end