debtective 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 609f9971e421988a317405b19b0cb8aacc172ee246e29d2484d290f6fb6649ab
+  data.tar.gz: b084f3772dfb519af3a3e254fa04f576d0edcbe59961841192cd5370c2daf7ac
+SHA512:
+  metadata.gz: 84a8a437407fba597289be78946a41094d34cca1eeb27fed496c010e0d062adba149f47832f2e9c558d92d9b0b23e13bd2fbd551168761eafeb02757c7816861
+  data.tar.gz: 0fb7f4326d4e3e9ee29c54117287f4eb3f9fd74083e0706b99bf2b30e68e31ef4b4f865511a80857f3b5aea49a2000f14d1f214427cdf3078115fb08b2be470a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Edouard Piron
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Debtective
+
+Help find out todos in your application.
+
+## Usage
+
+Run the task:
+
+- `bundle exec rake debtective:todo_list`
+
+More tasks to come!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'debtective'
+end
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install debtective
+```
+
+## Contributing
+
+This gem is still a work in progress. You can use GitHub issue to start a discussion.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/debtective/configuration.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Debtective
+  # Manage gem configuration
+  class Configuration
+    attr_accessor :paths
+  end
+end

data/lib/debtective/end_of_statement.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+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)
+  #
+  # With a single line (no block)
+  #
+  # 0   do_this <--
+  # 1   do_that
+  # 2 end
+  #
+  # Then the end is the first line (index 0)
+  #
+  class EndOfStatement
+    NON_ENDING_KEYWORDS_REGEX = /^(\s*)(else$|elsif\s|(rescue(\s|$))|ensure)/
+
+    # @param lines [Array<String>] lines of code
+    def initialize(lines)
+      @lines = lines
+    end
+
+    # ends of the statement
+    # @return [Integer]
+    def call
+      @lines[1..]&.index { end_of_statement?(_1) } || 0
+    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
+
+    # 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)
+
+      indent(line) <= first_line_indent
+    end
+
+    # returns the indent (number of spaces) of the line
+    # @param line [String]
+    # @return [Integer]
+    def indent(line)
+      line.match(/^(\s*).*$/)[1].length
+    end
+  end
+end

data/lib/debtective/file_todos.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+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
+
+    # @param pathname [Pathname]
+    def initialize(pathname)
+      @pathname = pathname
+    end
+
+    # @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
+      end
+    end
+
+    private
+
+    # @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]
+    # @return [Integer]
+    def end_line(index)
+      next_lines = lines[(index + 1)..]
+      EndOfStatement.new(next_lines).call
+    end
+  end
+end

data/lib/debtective/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Debtective
+  # Makes Rails aware of the tasks
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/debtective/todo_list.rake"
+    end
+  end
+end

data/lib/debtective/report.rb

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

data/lib/debtective/todo_list.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "debtective/file_todos"
+
+module Debtective
+  # Find and investigate todo comments
+  class TodoList
+    DEFAULT_PATHS = ["./**/*"].freeze
+
+    REPORTS = %i[
+      combined_count
+      extended_count
+      todos
+    ].freeze
+
+    Result = Struct.new(*REPORTS)
+
+    # @return [TodoList::Result]
+    def call
+      Result.new(*REPORTS.map { __send__(_1) })
+    end
+
+    private
+
+    # @return [Array<String>]
+    def paths
+      Debtective.configuration&.paths || DEFAULT_PATHS
+    end
+
+    # @return [Array<Pathname>] only path to ruby files
+    def ruby_pathnames
+      paths
+        .flat_map { File.extname(_1) == "" ? Dir[_1] : [_1] }
+        .map { Pathname(_1) }
+        .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
+        .sum { _1.boundaries.size }
+    end
+
+    # @return [Integer]
+    def combined_count
+      todos
+        .group_by(&:pathname)
+        .values
+        .sum do |file_todos|
+          file_todos
+            .map { _1.boundaries.to_a }
+            .reduce(:|)
+            .length
+        end
+    end
+  end
+end

data/lib/debtective/version.rb

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

data/lib/debtective.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "debtective/version"
+require "debtective/configuration"
+require "debtective/railtie" if defined?(Rails)
+
+# Entrypoint
+module Debtective
+  class << self
+    attr_accessor :configuration
+
+    # Configures Debtective
+    # @return Debtective::Configuration
+    # @yieldparam [Proc] configuration to apply
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/lib/tasks/debtective/todo_list.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "debtective/report"
+
+begin
+  require "#{Rails.root}/config/initializers/debtective" if defined?(Rails)
+rescue LoadError
+  nil
+end
+
+namespace :debtective do
+  desc "Todo List"
+  task :todo_list do
+    Debtective::Report.new.call
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: debtective
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Edouard Piron
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find TODOs and compute debt size
+email:
+- ed.piron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/debtective.rb
+- lib/debtective/configuration.rb
+- lib/debtective/end_of_statement.rb
+- lib/debtective/file_todos.rb
+- lib/debtective/railtie.rb
+- lib/debtective/report.rb
+- lib/debtective/todo_list.rb
+- lib/debtective/version.rb
+- lib/tasks/debtective/todo_list.rake
+homepage: https://github.com/BigBigDoudou/debtective
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BigBigDoudou/debtective
+  source_code_uri: https://github.com/perangusta/debtective
+  changelog_uri: https://github.com/perangusta/debtective/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Find TODOs and compute debt size
+test_files: []