debtective 0.2.2 → 0.2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa54bf140a87eeb794cba1f8823d00a9ab5407b77f7d8b18c39414857e301edc
-  data.tar.gz: 2169b279c88a1527c3e1107921aaacd7b81905442361804ac4eaf3731856357e
+  metadata.gz: 5337f50843d65198958e3c2a2f63b1b618f69070ec5445203c2615cc548ce833
+  data.tar.gz: 128f58647d0da0046a99088fa1e7cd0c06c8fe0a557a8e1e3304e0f84a2644b3
 SHA512:
-  metadata.gz: e3c5d0c77005f8b6d410339b9e649ba774d4a677ccc60cb7ee96c4761b24bc740880d648871cc65309b542935008a13df8fcd30cd89b7c968243231046fdd728
-  data.tar.gz: 8a9e4f628f36eb6d21eef51464d068e24fd696c8e8335127a2d95cc683bbca0c59bc91272e0450c8daac662f8f7f5014ff060bc692e7699925778c2f64725d9c
+  metadata.gz: 34e11cc316b6a64489873769db16d2125a61643c8f70abf602f399df51d033a2e57df267520ca46caf2b4186600f38b9c00b8cc23159d8729316c25dfafb81d5
+  data.tar.gz: 74a9440b99fb2b9d4888b19e64efa5c6de67742cdad82e8c89b706293074a902292b7826f0e5092ec31cbd45f863aa5ea14878b30c988d5922d14dd9acc47505

data/bin/debtective

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "debtective"
+require "debtective/output_todos"
+
+user_name = `git config user.name`.strip if ARGV.include?("--me")
+quiet = ARGV.include?("--quiet")
+Debtective::OutputTodos.new(user_name, quiet: quiet).call

data/lib/debtective/build_todo.rb

@@ -0,0 +1,67 @@
+# 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/{end_of_statement.rb → find_end_of_statement.rb}

@@ -5,19 +5,20 @@ require "debtective/stderr_helper"
 module Debtective
   # Find the index of the line ending a statement
   #
-  # EndOfStatement.new(
-  #   [
-  #     "class User",
-  #     "  def example",
-  #     "    x + y",
-  #     "  end"
-  #     "end"
-  #   ],
-  #   1
-  # ).call
-  # => 3
+  # @example
+  #   FindEndOfStatement.new(
+  #     [
+  #       "class User",
+  #       "  def example",
+  #       "    x + y",
+  #       "  end"
+  #       "end"
+  #     ],
+  #     1
+  #   ).call
+  #   => 3
   #
-  class EndOfStatement
+  class FindEndOfStatement
     include StderrHelper
 
     # @param lines [Array<String>] lines of code

data/lib/debtective/find_todos.rb

@@ -0,0 +1,41 @@
+# 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/git_commit.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "git"
+require "open3"
+
+module Debtective
+  # find the commit that introduced a line of code
+  class GitCommit
+    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::GitCommit::Commit]
+    def call
+      Commit.new(sha, author, time)
+    rescue Git::GitExecuteError
+      author = Author.new(nil, nil)
+      Commit.new(nil, author, nil)
+    end
+
+    # @return [Debtective::GitCommit::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/output_todos.rb

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

@@ -0,0 +1,87 @@
+# 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,37 +1,69 @@
 # frozen_string_literal: true
 
-require "debtective/end_of_statement"
+require "debtective/git_commit"
 
 module Debtective
   # Hold todo information
   class Todo
-    attr_accessor :pathname, :todo_index, :boundaries
+    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 todo_index [Integer] first line of todo comment
-    # @param boundaries [Range] first and last index of the concerned code
-    def initialize(pathname, todo_index, boundaries)
+    # @param lines [Array<String>]
+    # @param todo_boundaries [Range]
+    # @param statement_boundaries [Range]
+    def initialize(pathname, lines, todo_boundaries, statement_boundaries)
       @pathname = pathname
-      @todo_index = todo_index
-      @boundaries = boundaries
+      @lines = lines
+      @todo_boundaries = todo_boundaries
+      @statement_boundaries = statement_boundaries
     end
 
     # location in the codebase
     # @return [String]
     def location
-      "#{pathname}:#{todo_index + 1}"
+      "#{@pathname}:#{@todo_boundaries.min + 1}"
     end
 
     # size of the todo code
     # @return [Integer]
     def size
-      boundaries.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
 
-    # line numbers (like displayed in an IDE)
-    # @return [Range]
-    def line_numbers
-      (boundaries.min + 1)..(boundaries.max + 1)
+    # @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,37 +1,33 @@
 # frozen_string_literal: true
 
-require "debtective/file_todos"
+require "debtective/find_todos"
 
 module Debtective
-  # Find and investigate todo comments
+  # Information about the todos in the codebase
   class TodoList
-    DEFAULT_PATHS = ["./**/*"].freeze
+    Author = Struct.new(:email, :name, :todos)
 
-    # @return [Array<FileTodos::Result>]
-    def call
-      ruby_pathnames
-        .flat_map { FileTodos.new(_1).call }
+    # @param paths [Array<String>]
+    def initialize(paths)
+      @paths = paths
     end
 
-    private
-
-    # @return [Array<String>]
-    def paths
-      Debtective.configuration&.paths || DEFAULT_PATHS
+    # @return [Array<Debtective::Todo>]
+    def todos
+      @todos ||= Debtective::FindTodos.new(@paths).call
     end
 
-    # @return [Array<Pathname>] only pathes to ruby files
-    def ruby_pathnames
-      paths
-        .flat_map { File.extname(_1) == "" ? Dir[_1] : [_1] }
-        .map { Pathname(_1) }
-        .select { _1.file? && _1.extname == ".rb" }
+    # @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 { _1.boundaries.size }
+      todos.sum(&:size)
     end
 
     # @return [Integer]
@@ -39,12 +35,23 @@ module Debtective
       todos
         .group_by(&:pathname)
         .values
-        .sum do |file_todos|
-          file_todos
-            .map { _1.boundaries.to_a }
+        .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/debtective/version.rb

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

data/lib/tasks/debtective/todo_list.rake

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "debtective/todo_list"
-require "debtective/todo_list_counts"
+require "debtective/output_todos"
 
 begin
   require "#{Rails.root}/config/initializers/debtective" if defined?(Rails)
@@ -12,40 +11,12 @@ end
 namespace :debtective do
   desc "Todo List"
   task :todo_list do
-    array_row =
-      lambda do |value1, value2, value3|
-        [
-          value1.to_s.ljust(120),
-          value2.to_s.rjust(12),
-          value3.to_s.rjust(12)
-        ].join(" | ").prepend("| ").concat(" |")
-      end
-
-    separator = Array.new(array_row.call(nil, nil, nil).size) { "-" }.join
-
-    todo_list = Debtective::TodoList.new.call
-    todos = todo_list.sort_by { _1.boundaries.size }.reverse
-    todo_list_counts = Debtective::TodoListCounts.new(todos)
-
-    puts separator
-    puts "todo list"
-    puts separator
-    puts array_row.call("pathname", "line numbers", "lines count")
-    puts separator
-    todos.each { puts array_row.call(_1.location, _1.line_numbers, _1.size) }
-
-    puts separator
-    puts "todos count"
-    puts todos.count
-
-    puts separator
-    puts "combined lines count"
-    puts todo_list_counts.combined_count
-
-    puts separator
-    puts "extended lines count"
-    puts todo_list_counts.extended_count
-
-    puts separator
+    if ARGV.include?("--me")
+      user_name = `git config user.name`.strip
+      puts "Searching TODOs from #{user_name}..."
+    else
+      puts "Searching TODOs..."
+    end
+    Debtective::OutputTodos.new(user_name, quiet: ARGV.include?("--quiet")).call
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3.1
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  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
@@ -97,22 +111,24 @@ dependencies:
 description: Find TODOs and compute debt size
 email:
 - ed.piron@gmail.com
-executables: []
+executables:
+- debtective
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- Rakefile
+- bin/debtective
 - lib/debtective.rb
+- lib/debtective/build_todo.rb
 - lib/debtective/configuration.rb
-- lib/debtective/end_of_statement.rb
-- lib/debtective/file_todos.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/railtie.rb
 - lib/debtective/stderr_helper.rb
 - lib/debtective/todo.rb
 - lib/debtective/todo_list.rb
-- lib/debtective/todo_list_counts.rb
 - lib/debtective/version.rb
 - lib/tasks/debtective/todo_list.rake
 homepage: https://github.com/BigBigDoudou/debtective

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2021 Edouard Piron
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,53 +0,0 @@
-# Debtective
-
-Find todos in your codebase so you don't forget to pay off your debts! 💰
-
-## Usage
-
-Run the task with:
-
-```bash
-bundle exec rake debtective:todo_list
-```
-
-It outputs the todos positions with the concerned lines of code and some counts.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-group :development do
-  gem "debtective"
-end
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-
-```bash
-$ gem install debtective
-```
-
-Configure the paths that should be analyzed (all by default):
-
-```ruby
-# config/initializers/debtective.rb
-
-Debtective.configure do |config|
-  config.paths = ["app/**/*", "lib/**/*"]
-end
-```
-
-## Contributing
-
-This gem is still a work in progress. You can use GitHub issue to start a discussion.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/lib/debtective/file_todos.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todo"
-require "debtective/end_of_statement"
-
-module Debtective
-  # Find the todos comments and their boundaries
-  class FileTodos
-    BEFORE_LINE_TODO_REGEX = /^\s*#\sTODO:\s/
-    INLINE_TODO_REGEX = /\s*#\sTODO:\s/
-    COMMENT_REGEX = /\s*#/
-
-    # @param pathname [Pathname]
-    def initialize(pathname)
-      @pathname = pathname
-    end
-
-    # @return [Array<FileTodos::Result>]
-    def call
-      lines.filter_map.with_index do |line, index|
-        boundaries = boundaries(line, index)
-        next if boundaries.nil?
-
-        Todo.new(@pathname, index, boundaries)
-      end
-    end
-
-    private
-
-    # return todo boundaries if there is a todo
-    # @param line [String]
-    # @param index [Integer]
-    # @return [Range, nil]
-    def boundaries(line, index)
-      case line
-      when BEFORE_LINE_TODO_REGEX
-        first_line_index = statement_first_line_index(index)
-        last_line_index = EndOfStatement.new(@lines, first_line_index).call
-        first_line_index..last_line_index
-      when INLINE_TODO_REGEX
-        index..index
-      end
-    end
-
-    # @return [Array<String>]
-    def lines
-      @lines ||= @pathname.readlines
-    end
-
-    # @param todo_index [Integer]
-    # @return [Integer]
-    def statement_first_line_index(todo_index)
-      @lines.index.with_index do |line, i|
-        i > todo_index &&
-          !line.strip.empty? &&
-          !line.match?(COMMENT_REGEX)
-      end
-    end
-  end
-end

data/lib/debtective/todo_list_counts.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Debtective
-  # Apply calculations on a todo list
-  class TodoListCounts
-    # @param todo_list [Array<Debtective::Todo>]
-    def initialize(todos)
-      @todos = todos
-    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.boundaries.to_a }
-            .reduce(:|)
-            .length
-        end
-    end
-  end
-end