debtective 0.2.3.4 → 0.2.3.7

data/lib/debtective/todos/build.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/todos/todo"
-require "debtective/find_end_of_statement"
-
-module Debtective
-  module Todos
-    # 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*#/
-
-      # @param pathname [Pathname]
-      # @param index [Integer]
-      def initialize(pathname:, index:)
-        @pathname = pathname
-        @index = index
-      end
-
-      # @return [Debtective::Todos::Todo]
-      def call
-        Debtective::Todos::Todo.new(
-          pathname: @pathname,
-          lines: lines,
-          todo_boundaries: todo_boundaries,
-          statement_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 = Debtective::FindEndOfStatement.new(lines: lines, first_line_index: 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
-end

data/lib/debtective/todos/export.rb

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require "debtective/find_commit"
-
-module Debtective
-  module Todos
-    # Hold todo information
-    class Todo
-      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:)
-        @pathname = pathname
-        @lines = lines
-        @todo_boundaries = todo_boundaries
-        @statement_boundaries = statement_boundaries
-      end
-
-      # location in the codebase
-      # @return [String]
-      def location
-        "#{@pathname}:#{@todo_boundaries.min + 1}"
-      end
-
-      # size of the todo code
-      # @return [Integer]
-      def size
-        @statement_boundaries.size
-      end
-
-      # return commit that introduced the todo
-      # @return [Debtective::FindCommit::Commit]
-      def commit
-        @commit ||=
-          Debtective::FindCommit.new(
-            pathname: @pathname,
-            code_line: @lines[@todo_boundaries.min]
-          ).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,
-          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
-end