debtective 0.2.3.3 → 0.2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5c39390d5b43a335045481e47b106c30facd0d66ea88359209ecc57887f6a4e
-  data.tar.gz: 182beede8ace506b42e175bdd9fec0748464bfe4aa75ff1e95c7d100df4c5444
+  metadata.gz: '09e2ba02faff3be09a87e2babe120bb59e28f0ea509ad8cc8ef1f9a12cf55ae6'
+  data.tar.gz: e1c5d6197706783907a1756671928eac854d1d771eb541d58b18dba8053da003
 SHA512:
-  metadata.gz: c846a7c047b667926d576a51331820b26e98d8e25ff16bdb192a2c8aa080aceac69f9cb7f747c90d8e3c25ed6c7c59bd3fbd6642a2da2572ffeeb304c54aa10d
-  data.tar.gz: 4870ac4fcc0b9fa93eeaf2f72e410b06bd7b9bcea56e44557f32ee2788c572186cdea8177a6168c24cc6917360e5d02e90793b951d5d1bcdb58806cad00ca28b
+  metadata.gz: f1641ef5d5031d12d7c85665a252ab168cf456297621b81c400f22c8a8017868eb3c7873eade9ae2c8b0cb21c93a85d702ff16ffd4a45b822edd0d450ca42835
+  data.tar.gz: f371a5a826c7daff0c6cc2a31e7e5686731f29d74b568e96174de0000bdec70c62318481ff2a21ef98ff84d279053fbbb747511f75b0e0c79c8adb160f540bcb

data/bin/debtective

@@ -14,9 +14,12 @@ quiet = ARGV.include?("--quiet")
 
 case ARGV[0]
 when "--todos"
-  require "debtective/todos/output"
-  Debtective::Todos::Output.new(user_name, quiet: quiet).call
-when "--offenses", "--gems"
+  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 "Please pass one of this options: [--todos, --offenses, --gems]"

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/find_commit.rb

@@ -4,7 +4,7 @@ require "git"
 require "open3"
 
 module Debtective
-  # find the commit that introduced a line of code
+  # Find the commit that introduced the given line of code
   class FindCommit
     Author = Struct.new(:email, :name)
     Commit = Struct.new(:sha, :author, :time)
@@ -12,10 +12,10 @@ module Debtective
     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::FindCommit::Commit]
@@ -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

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
-require "pathname"
 require "debtective/todos/todo"
 require "debtective/find_end_of_statement"
 
 module Debtective
   module Todos
-    # Find the todos comments and their boundaries
+    # 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*#/
+      COMMENT_REGEX = /^\s*#/
 
       # @param pathname [Pathname]
       # @param index [Integer]
-      def initialize(pathname, index)
+      def initialize(pathname:, index:)
         @pathname = pathname
         @index = index
       end
@@ -22,10 +21,10 @@ module Debtective
       # @return [Debtective::Todos::Todo]
       def call
         Debtective::Todos::Todo.new(
-          @pathname,
-          lines,
-          todo_boundaries,
-          statement_boundaries
+          pathname: @pathname,
+          lines: lines,
+          todo_boundaries: todo_boundaries,
+          statement_boundaries: statement_boundaries
         )
       end
 
@@ -48,7 +47,7 @@ module Debtective
           case lines[@index]
           when BEFORE_LINE_TODO_REGEX
             first_line_index = statement_start
-            last_line_index = Debtective::FindEndOfStatement.new(lines, first_line_index).call
+            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

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

@@ -6,20 +6,13 @@ module Debtective
   module Todos
     # Hold todo information
     class Todo
-      class << self
-        # @return [Debtective::Todos::Todo]
-        def build(pathname, index)
-          Build.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)
+      def initialize(pathname:, lines:, todo_boundaries:, statement_boundaries:)
         @pathname = pathname
         @lines = lines
         @todo_boundaries = todo_boundaries
@@ -39,9 +32,13 @@ module Debtective
       end
 
       # return commit that introduced the todo
-      # @return [Git::Object::Commit]
+      # @return [Debtective::FindCommit::Commit]
       def commit
-        @commit ||= Debtective::FindCommit.new(@pathname, @lines[@todo_boundaries.min]).call
+        @commit ||=
+          Debtective::FindCommit.new(
+            pathname: @pathname,
+            code_line: @lines[@todo_boundaries.min]
+          ).call
       end
 
       # @return [Integer]
@@ -54,7 +51,7 @@ module Debtective
       # @return [Hash]
       def to_h
         {
-          pathname: pathname,
+          pathname: @pathname,
           location: location,
           todo_boundaries: todo_boundaries.minmax,
           statement_boundaries: statement_boundaries.minmax,

data/lib/debtective/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Debtective
-  VERSION = "0.2.3.3"
+  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.3
+  version: 0.2.3.4
 platform: ruby
 authors:
 - Edouard Piron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-18 00:00:00.000000000 Z
+date: 2023-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -119,15 +119,16 @@ files:
 - bin/debtective
 - lib/debtective.rb
 - lib/debtective/configuration.rb
+- lib/debtective/export.rb
 - lib/debtective/find_commit.rb
 - lib/debtective/find_end_of_statement.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/todos/build.rb
-- lib/debtective/todos/find.rb
-- lib/debtective/todos/list.rb
-- lib/debtective/todos/output.rb
-- lib/debtective/todos/print_table.rb
+- lib/debtective/todos/export.rb
 - lib/debtective/todos/todo.rb
 - lib/debtective/version.rb
 homepage: https://github.com/BigBigDoudou/debtective

data/lib/debtective/todos/find.rb

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

data/lib/debtective/todos/list.rb

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

data/lib/debtective/todos/output.rb

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

data/lib/debtective/todos/print_table.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todos/list"
-
-module Debtective
-  module Todos
-    # 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::Todos::List]
-      def call
-        log_table_headers
-        log_table_rows
-        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
-        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::Todos::Build && 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::Todos::Todo]
-      def list
-        @list ||= Debtective::Todos::List.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
-end