debtective 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 609f9971e421988a317405b19b0cb8aacc172ee246e29d2484d290f6fb6649ab
-  data.tar.gz: b084f3772dfb519af3a3e254fa04f576d0edcbe59961841192cd5370c2daf7ac
+  metadata.gz: fa54bf140a87eeb794cba1f8823d00a9ab5407b77f7d8b18c39414857e301edc
+  data.tar.gz: 2169b279c88a1527c3e1107921aaacd7b81905442361804ac4eaf3731856357e
 SHA512:
-  metadata.gz: 84a8a437407fba597289be78946a41094d34cca1eeb27fed496c010e0d062adba149f47832f2e9c558d92d9b0b23e13bd2fbd551168761eafeb02757c7816861
-  data.tar.gz: 0fb7f4326d4e3e9ee29c54117287f4eb3f9fd74083e0706b99bf2b30e68e31ef4b4f865511a80857f3b5aea49a2000f14d1f214427cdf3078115fb08b2be470a
+  metadata.gz: e3c5d0c77005f8b6d410339b9e649ba774d4a677ccc60cb7ee96c4761b24bc740880d648871cc65309b542935008a13df8fcd30cd89b7c968243231046fdd728
+  data.tar.gz: 8a9e4f628f36eb6d21eef51464d068e24fd696c8e8335127a2d95cc683bbca0c59bc91272e0450c8daac662f8f7f5014ff060bc692e7699925778c2f64725d9c

data/README.md

@@ -1,14 +1,16 @@
 # Debtective
 
-Help find out todos in your application.
+Find todos in your codebase so you don't forget to pay off your debts! 💰
 
 ## Usage
 
-Run the task:
+Run the task with:
 
-- `bundle exec rake debtective:todo_list`
+```bash
+bundle exec rake debtective:todo_list
+```
 
-More tasks to come!
+It outputs the todos positions with the concerned lines of code and some counts.
 
 ## Installation
 
@@ -16,7 +18,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 group :development do
-  gem 'debtective'
+  gem "debtective"
 end
 ```
 
@@ -32,6 +34,16 @@ Or install it yourself as:
 $ 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.

data/lib/debtective/end_of_statement.rb

@@ -1,69 +1,71 @@
 # frozen_string_literal: true
 
+require "debtective/stderr_helper"
+
 module Debtective
-  # Find end of a block given its first line and the next lines
-  #
-  # With a class, a def, an if statement... or any "block statement"
-  #
-  # 0   def foo
-  # 1     do_this <--
-  # 2   end
-  # 3 end
-  #
-  # The end of the block is the last line before the `end` keyword (index 1)
-  #
-  # With a carriage return
-  #
-  # 0   User
-  # 1     .where(draft: true)
-  # 2     .preload(:tasks)    <--
-  # 3 end
-  #
-  # The end of the block is the last line of the statement (index 2)
+  # Find the index of the line ending a statement
   #
-  # With a single line (no block)
-  #
-  # 0   do_this <--
-  # 1   do_that
-  # 2 end
-  #
-  # Then the end is the first line (index 0)
+  # EndOfStatement.new(
+  #   [
+  #     "class User",
+  #     "  def example",
+  #     "    x + y",
+  #     "  end"
+  #     "end"
+  #   ],
+  #   1
+  # ).call
+  # => 3
   #
   class EndOfStatement
-    NON_ENDING_KEYWORDS_REGEX = /^(\s*)(else$|elsif\s|(rescue(\s|$))|ensure)/
+    include StderrHelper
 
     # @param lines [Array<String>] lines of code
-    def initialize(lines)
+    # @param index [Integer] index of the statement first line
+    def initialize(lines, first_line_index)
       @lines = lines
+      @first_line_index = first_line_index
     end
 
-    # ends of the statement
+    # index of the line ending the statement
     # @return [Integer]
+    # @note use suppress_stderr to prevent error outputs
+    #   from RubyVM::InstructionSequence.compile
     def call
-      @lines[1..]&.index { end_of_statement?(_1) } || 0
+      suppress_stderr { last_line_index }
     end
 
     private
 
-    # indent (number of spaces) of the first line | for memoization
-    # @return [Integer]
-    def first_line_indent
-      @first_line_indent ||= indent(@lines[0])
-    end
+    # 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)
 
-    # return true if the line is the end of the statement
-    # @return [Boolean]
-    def end_of_statement?(line)
-      return false if line.match?(NON_ENDING_KEYWORDS_REGEX)
+      last_line_index(index + 1)
+    end
 
-      indent(line) <= first_line_indent
+    # 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
 
-    # returns the indent (number of spaces) of the line
-    # @param line [String]
-    # @return [Integer]
-    def indent(line)
-      line.match(/^(\s*).*$/)[1].length
+    # 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/file_todos.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
+require "debtective/todo"
 require "debtective/end_of_statement"
 
 module Debtective
   # Find the todos comments and their boundaries
   class FileTodos
-    Result = Struct.new(:pathname, :boundaries)
-
-    BEFORE_LINE_TODO_REGEX = /^\s*#\stodo:\s/i
-    INLINE_TODO_REGEX = /\s*#\stodo:\s/i
+    BEFORE_LINE_TODO_REGEX = /^\s*#\sTODO:\s/
+    INLINE_TODO_REGEX = /\s*#\sTODO:\s/
+    COMMENT_REGEX = /\s*#/
 
     # @param pathname [Pathname]
     def initialize(pathname)
@@ -18,34 +18,43 @@ module Debtective
     # @return [Array<FileTodos::Result>]
     def call
       lines.filter_map.with_index do |line, index|
-        case line
-        when BEFORE_LINE_TODO_REGEX
-          Result.new(@pathname, boundaries(index))
-        when INLINE_TODO_REGEX
-          Result.new(@pathname, index..index)
-        end
+        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 index [Integer]
-    # @return [Boundaries]
-    def boundaries(index)
-      offset = index + 2
-      offset..end_line(index) + offset
-    end
-
-    # @param index [Integer]
+    # @param todo_index [Integer]
     # @return [Integer]
-    def end_line(index)
-      next_lines = lines[(index + 1)..]
-      EndOfStatement.new(next_lines).call
+    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/stderr_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Debtective
+  # Silence the $stderr
+  module StderrHelper
+    # @return void
+    def suppress_stderr
+      original_stderr = $stderr.clone
+      $stderr.reopen(File.new("/dev/null", "w"))
+      yield
+    ensure
+      $stderr.reopen(original_stderr)
+    end
+  end
+end

data/lib/debtective/todo.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "debtective/end_of_statement"
+
+module Debtective
+  # Hold todo information
+  class Todo
+    attr_accessor :pathname, :todo_index, :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)
+      @pathname = pathname
+      @todo_index = todo_index
+      @boundaries = boundaries
+    end
+
+    # location in the codebase
+    # @return [String]
+    def location
+      "#{pathname}:#{todo_index + 1}"
+    end
+
+    # size of the todo code
+    # @return [Integer]
+    def size
+      boundaries.size
+    end
+
+    # line numbers (like displayed in an IDE)
+    # @return [Range]
+    def line_numbers
+      (boundaries.min + 1)..(boundaries.max + 1)
+    end
+  end
+end

data/lib/debtective/todo_list.rb

@@ -7,17 +7,10 @@ module Debtective
   class TodoList
     DEFAULT_PATHS = ["./**/*"].freeze
 
-    REPORTS = %i[
-      combined_count
-      extended_count
-      todos
-    ].freeze
-
-    Result = Struct.new(*REPORTS)
-
-    # @return [TodoList::Result]
+    # @return [Array<FileTodos::Result>]
     def call
-      Result.new(*REPORTS.map { __send__(_1) })
+      ruby_pathnames
+        .flat_map { FileTodos.new(_1).call }
     end
 
     private
@@ -27,7 +20,7 @@ module Debtective
       Debtective.configuration&.paths || DEFAULT_PATHS
     end
 
-    # @return [Array<Pathname>] only path to ruby files
+    # @return [Array<Pathname>] only pathes to ruby files
     def ruby_pathnames
       paths
         .flat_map { File.extname(_1) == "" ? Dir[_1] : [_1] }
@@ -35,14 +28,6 @@ module Debtective
         .select { _1.file? && _1.extname == ".rb" }
     end
 
-    # @return [Array<FileTodos::Result>]
-    def todos
-      @todos ||=
-        ruby_pathnames
-        .flat_map { FileTodos.new(_1).call }
-        .select(&:any?)
-    end
-
     # @return [Integer]
     def extended_count
       todos

data/lib/debtective/todo_list_counts.rb

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

data/lib/debtective/version.rb

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

data/lib/tasks/debtective/todo_list.rake

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "debtective/report"
+require "debtective/todo_list"
+require "debtective/todo_list_counts"
 
 begin
   require "#{Rails.root}/config/initializers/debtective" if defined?(Rails)
@@ -11,6 +12,40 @@ end
 namespace :debtective do
   desc "Todo List"
   task :todo_list do
-    Debtective::Report.new.call
+    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
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -109,8 +109,10 @@ files:
 - lib/debtective/end_of_statement.rb
 - lib/debtective/file_todos.rb
 - lib/debtective/railtie.rb
-- lib/debtective/report.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/lib/debtective/report.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todo_list"
-
-module Debtective
-  # Output information about the debt
-  class Report
-    # output todo list
-    def call
-      puts_separator
-      puts "todo list"
-      puts_separator
-      puts table_header
-      puts_separator
-      puts_table_content
-      puts_separator
-      puts_todos_count
-      puts_separator
-      puts_combines_lines_count
-      puts_separator
-      puts_extended_lines_count
-      puts_separator
-    end
-
-    private
-
-    # @return [TodoList::Result]
-    def todo_list
-      @todo_list ||= Debtective::TodoList.new.call
-    end
-
-    # @return [Array<FileTodos::Result>]
-    def todos
-      @todos ||= todo_list.todos.sort_by { _1.boundaries.size }.reverse
-    end
-
-    # @return [String]
-    def puts_separator
-      puts Array.new(table_header.length) { "-" }.join
-    end
-
-    # @return [void]
-    def table_header
-      @table_header ||= [
-        "pathname".ljust(120),
-        "boundaries".rjust(12),
-        "lines".rjust(12)
-      ].join(" | ")
-    end
-
-    # @return [void]
-    def puts_table_content
-      todos.each do |todo|
-        puts(
-          [
-            todo.pathname.to_s.ljust(120),
-            todo.boundaries.to_s.rjust(12),
-            todo.boundaries.size.to_s.rjust(12)
-          ].join(" | ")
-        )
-      end
-    end
-
-    # @return [void]
-    def puts_todos_count
-      puts "todos count"
-      puts todos.count
-    end
-
-    # @return [void]
-    def puts_combines_lines_count
-      puts "combined lines count"
-      puts todo_list.combined_count
-    end
-
-    # @return [void]
-    def puts_extended_lines_count
-      puts "extended lines count"
-      puts todo_list.extended_count
-    end
-  end
-end