debtective 0.2.3 → 0.2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9cd2c9eaaa35023797d69a854fd1b749269c03e029a1fd9447b993d653b917
-  data.tar.gz: 7b3cff2afb3474d1ec0ba8449f88e4795f91d35c4b49af4337e9eb64693443e2
+  metadata.gz: 5337f50843d65198958e3c2a2f63b1b618f69070ec5445203c2615cc548ce833
+  data.tar.gz: 128f58647d0da0046a99088fa1e7cd0c06c8fe0a557a8e1e3304e0f84a2644b3
 SHA512:
-  metadata.gz: 3ad250e7e42470f6404de2eaff106319c5c7f6f543276e02ef28afba2a6fc301f3bb35ecea069737e21f5ceeb70126fc968e70118f3f4196f75eeebd0ad1c724
-  data.tar.gz: d648747191b567134e238e4692014ef211c5715bd5524245e524626de5b8ee8fd87979641a6a3238755a2512171266081072c9ca3a5fc47f3b16d7ce7084f752
+  metadata.gz: 34e11cc316b6a64489873769db16d2125a61643c8f70abf602f399df51d033a2e57df267520ca46caf2b4186600f38b9c00b8cc23159d8729316c25dfafb81d5
+  data.tar.gz: 74a9440b99fb2b9d4888b19e64efa5c6de67742cdad82e8c89b706293074a902292b7826f0e5092ec31cbd45f863aa5ea14878b30c988d5922d14dd9acc47505

data/bin/debtective

@@ -4,4 +4,6 @@
 require "debtective"
 require "debtective/output_todos"
 
-Debtective::OutputTodos.new.call
+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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "debtective/todo"
 require "debtective/find_end_of_statement"
 

data/lib/debtective/find_todos.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "debtective/build_todo"
 
 module Debtective

data/lib/debtective/output_todos.rb

@@ -1,112 +1,62 @@
 # frozen_string_literal: true
 
 require "json"
-require "debtective/todo_list"
+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
-      log_table_headers
-      log_table_rows
+      @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 update_json_file
-      File.open(FILE_PATH, "w") do |file|
-        file.puts(
-          JSON.pretty_generate(
-            todo_list.todos.map(&:to_h)
-          )
-        )
-      end
-      puts FILE_PATH
-      puts separator
-    end
-
-    # @return [void]
-    def create_directory
-      return if File.directory?(DIRECTORY_PATH)
+    def log_table
+      return if @quiet
 
-      FileUtils.mkdir_p(DIRECTORY_PATH)
+      Debtective::PrintTable.new(@user_name).call
     end
 
     # @return [void]
-    def log_table_headers
-      puts separator
-      puts table_row("location", "author", "days", "size")
-      puts separator
-    end
-
-    # @return [void]
-    def log_table_rows
-      with_trace_logs(
-        lambda do |todo|
-          puts(
-            table_row(
-              todo.location,
-              todo.commit.author.name || "?",
-              todo.days || "?",
-              todo.size
-            )
-          )
-        end
-      ) do
-        todo_list.todos
-      end
-      puts separator
-    end
-
-    # @param lambda [Lambda]
-    # @yield
-    def with_trace_logs(lambda)
-      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
-          lambda.call(todo)
-        end
-      trace.enable
-      yield
-      trace.disable
-    end
-
-    # @return [Debtective::Todo]
-    def todo_list
-      @todo_list ||= Debtective::TodoList.new(
-        Debtective.configuration&.paths || ["./**/*"]
-      )
+    def filter_todo_list!
+      !@user_name.nil? && @todo_list.todos.select! { _1.commit.author.name == @user_name }
     end
 
     # @return [void]
     def log_counts
-      puts "count: #{todo_list.todos.count}"
-      puts "combined lines count: #{todo_list.combined_count}"
-      puts "extended lines count: #{todo_list.extended_count}"
-      puts separator
-    end
+      @return if @quiet
 
-    # @return [String]
-    def separator
-      @separator ||= Array.new(table_row(nil, nil, nil, nil).size) { "-" }.join
+      puts "total: #{@todo_list.todos.count}"
+      puts "combined lines count: #{@todo_list.combined_count}"
+      puts "extended lines count: #{@todo_list.extended_count}"
     end
 
-    # @return [String]
-    def table_row(col1, col2, col3, col4)
-      [
-        format("%-80.80s", col1.to_s),
-        format("%-20.20s", col2.to_s),
-        format("%-12.12s", col3.to_s),
-        format("%-12.12s", col4.to_s)
-      ].join(" | ")
+    # @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/version.rb

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

data/lib/tasks/debtective/todo_list.rake

@@ -11,6 +11,12 @@ end
 namespace :debtective do
   desc "Todo List"
   task :todo_list do
-    Debtective::OutputTodos.new.call
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.3.1
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -111,7 +111,8 @@ dependencies:
 description: Find TODOs and compute debt size
 email:
 - ed.piron@gmail.com
-executables: []
+executables:
+- debtective
 extensions: []
 extra_rdoc_files: []
 files:
@@ -123,6 +124,7 @@ files:
 - 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