debtective 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9c75632f4f3a8785af1c96209c22b68772f8bde253cbd76e2bdb774a3812a8
-  data.tar.gz: d4b50399a0806ad8e4a6fb20305429882847ef79dd42bd176d17be3f5f1df786
+  metadata.gz: fa54bf140a87eeb794cba1f8823d00a9ab5407b77f7d8b18c39414857e301edc
+  data.tar.gz: 2169b279c88a1527c3e1107921aaacd7b81905442361804ac4eaf3731856357e
 SHA512:
-  metadata.gz: 59b68258f51e5f7a83992c8d24d0bc028fcb7dcdea2f379d0af011a8ec9c5dba645d6ffef4f94652d3ce7f0662185597934b96a6c8d2fa74ccc392b027b207fe
-  data.tar.gz: a5556a654c194fc442727c67f6c06686c6df851fe4008540670603d5aac8203e67e96a62d498b0eb57b91bdae76a2c967d789b29709659b84d3178632e7b893f
+  metadata.gz: e3c5d0c77005f8b6d410339b9e649ba774d4a677ccc60cb7ee96c4761b24bc740880d648871cc65309b542935008a13df8fcd30cd89b7c968243231046fdd728
+  data.tar.gz: 8a9e4f628f36eb6d21eef51464d068e24fd696c8e8335127a2d95cc683bbca0c59bc91272e0450c8daac662f8f7f5014ff060bc692e7699925778c2f64725d9c

data/lib/debtective/end_of_statement.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "parser/current"
+require "debtective/stderr_helper"
 
 module Debtective
   # Find the index of the line ending a statement
@@ -18,6 +18,8 @@ module Debtective
   # => 3
   #
   class EndOfStatement
+    include StderrHelper
+
     # @param lines [Array<String>] lines of code
     # @param index [Integer] index of the statement first line
     def initialize(lines, first_line_index)
@@ -27,24 +29,24 @@ module Debtective
 
     # 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 do
-        last_line_index || @first_line_index
-      end
+      suppress_stderr { last_line_index }
     end
 
     private
 
-    # index of the line ending the statement
+    # 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
-      @lines.index.with_index do |_line, index|
-        index >= @first_line_index &&
-          statement?(index) &&
-          !chained?(index)
-      end
+    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
@@ -53,9 +55,8 @@ module Debtective
     # @return boolean
     def statement?(index)
       code = @lines[@first_line_index..index].join("\n")
-      ::Parser::CurrentRuby.parse(code)
-      true
-    rescue Parser::SyntaxError
+      RubyVM::InstructionSequence.compile(code)
+    rescue SyntaxError
       false
     end
 
@@ -66,16 +67,5 @@ module Debtective
     def chained?(index)
       @lines[index + 1]&.match?(/^(\s*)\./)
     end
-
-    # silence the $stderr
-    # to avoid logs from the parser
-    # @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/file_todos.rb

@@ -1,12 +1,11 @@
 # 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, :todo_index, :boundaries)
-
     BEFORE_LINE_TODO_REGEX = /^\s*#\sTODO:\s/
     INLINE_TODO_REGEX = /\s*#\sTODO:\s/
     COMMENT_REGEX = /\s*#/
@@ -22,7 +21,7 @@ module Debtective
         boundaries = boundaries(line, index)
         next if boundaries.nil?
 
-        Result.new(@pathname, index, boundaries)
+        Todo.new(@pathname, index, boundaries)
       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
@@ -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.1"
+  VERSION = "0.2.2"
 end

data/lib/tasks/debtective/todo_list.rake

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "debtective/todo_list"
+require "debtective/todo_list_counts"
 
 begin
   require "#{Rails.root}/config/initializers/debtective" if defined?(Rails)
@@ -11,51 +12,39 @@ end
 namespace :debtective do
   desc "Todo List"
   task :todo_list do
-    todo_list = Debtective::TodoList.new.call
-    todos = todo_list.todos.sort_by { _1.boundaries.size }.reverse
+    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(120 + 3 + 12 + 3 + 12) { "-" }.join
+    separator = Array.new(array_row.call(nil, nil, nil).size) { "-" }.join
 
-    puts separator
+    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(
-      [
-        "pathname".ljust(120),
-        "lines".rjust(12)
-      ].join(" | ")
-    )
-
+    puts array_row.call("pathname", "line numbers", "lines count")
     puts separator
-
-    todos.each do |todo|
-      location = "#{todo.pathname}:#{todo.todo_index + 1}".ljust(120)
-      puts(
-        [
-          location,
-          [todo.boundaries.first + 1, todo.boundaries.last + 1].join(":").rjust(12),
-          todo.boundaries.size.to_s.rjust(12)
-        ].join(" | ")
-      )
-    end
+    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.combined_count
+    puts todo_list_counts.combined_count
 
     puts separator
-
     puts "extended lines count"
-    puts todo_list.extended_count
+    puts todo_list_counts.extended_count
 
     puts separator
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: debtective
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
-- !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
@@ -123,7 +109,10 @@ files:
 - lib/debtective/end_of_statement.rb
 - lib/debtective/file_todos.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