docquet 1.0.0

data/config/defaults/thread_safety.yml

@@ -0,0 +1,45 @@
+# Department 'ThreadSafety' (6):
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetyclassandmoduleattributes
+ThreadSafety/ClassAndModuleAttributes:
+  Description: Avoid mutating class and module attributes.
+  Enabled: true
+  ActiveSupportClassAttributeAllowed: false
+
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetyclassinstancevariable
+ThreadSafety/ClassInstanceVariable:
+  Description: Avoid class instance variables.
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetydirchdir
+ThreadSafety/DirChdir:
+  Description: Avoid using `Dir.chdir` due to its process-wide effect.
+  Enabled: true
+  AllowCallWithBlock: false
+
+# Supports --autocorrect
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetymutableclassinstancevariable
+ThreadSafety/MutableClassInstanceVariable:
+  Description: Do not assign mutable objects to class instance variables.
+  Enabled: true
+  EnforcedStyle: literals
+  SafeAutoCorrect: false
+  SupportedStyles:
+  - literals
+  - strict
+
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetynewthread
+ThreadSafety/NewThread:
+  Description: Avoid starting new threads. Let a framework like Sidekiq handle the threads.
+  Enabled: true
+
+# https://docs.rubocop.org/rubocop-thread_safety/cops_thread_safety.html#threadsafetyrackmiddlewareinstancevariable
+ThreadSafety/RackMiddlewareInstanceVariable:
+  Description: Avoid instance variables in Rack middleware.
+  Enabled: true
+  Include:
+  - app/middleware/**/*.rb
+  - lib/middleware/**/*.rb
+  - app/middlewares/**/*.rb
+  - lib/middlewares/**/*.rb
+  AllowedIdentifiers: []
+

data/exe/docquet

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/docquet"
+require "dry/cli"
+
+Dry::CLI.new(Docquet::Commands).call

data/lib/docquet/cli/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry/cli"
+
+module Docquet
+  module CLI
+    class Base < Dry::CLI::Command
+      private def rubocop_yml_exists?
+        File.exist?(".rubocop.yml")
+      end
+
+      private def rubocop_command
+        bundle_exec_available? ? "bundle exec rubocop" : "rubocop"
+      end
+
+      private def bundle_exec_available?
+        system("which bundle > /dev/null 2>&1")
+      end
+    end
+  end
+end

data/lib/docquet/cli/install_config.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Docquet
+  module CLI
+    class InstallConfig < Base
+      desc "Install RuboCop configuration and generate TODO file"
+
+      option :force, type: :boolean, default: false, desc: "Overwrite existing files"
+
+      def call(force: false, **)
+        check_existing_files(force)
+
+        # Processing order is important for correct TODO file generation:
+        # 1. Create empty .rubocop_todo.yml first to prevent reference errors
+        # 2. Generate .rubocop.yml with gem configuration
+        # 3. Generate actual .rubocop_todo.yml with gem rules applied
+        # This ensures TODO file reflects violations against gem configuration
+
+        create_empty_todo_file
+
+        generator = Generators::RuboCopYMLGenerator.new
+        generator.generate
+        puts "✓ Generated .rubocop.yml"
+
+        generate_todo_file
+
+        show_completion_message
+      end
+
+      private def check_existing_files(force)
+        existing_files = %w[.rubocop.yml .rubocop_todo.yml].select {|file| File.exist?(file) }
+
+        return if existing_files.none? || force
+
+        puts "Error: Files already exist: #{existing_files.join(", ")}. Use --force to overwrite."
+        exit 1
+      end
+
+      private def create_empty_todo_file
+        File.write(".rubocop_todo.yml", <<~TODO)
+          # This file contains configuration to temporarily disable cops
+          # Configuration will be generated by running: rubocop --regenerate-todo
+        TODO
+      end
+
+      private def generate_todo_file
+        puts "Generating .rubocop_todo.yml..."
+
+        command = build_todo_command
+        if system(command)
+          puts "✓ Generated .rubocop_todo.yml"
+        else
+          puts "Error: Failed to generate .rubocop_todo.yml"
+          exit 1
+        end
+      end
+
+      private def build_todo_command
+        "#{rubocop_command} --regenerate-todo --no-exclude-limit --no-offense-counts --no-auto-gen-timestamp"
+      end
+
+      private def show_completion_message
+        puts <<~MESSAGE
+
+          ✓ RuboCop setup complete!
+
+          Next steps:
+            1. Review .rubocop_todo.yml and gradually fix violations
+            2. Use 'docquet regenerate-todo' for future updates
+            3. Run 'bundle exec rubocop' to check your code
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/docquet/cli/regenerate_todo.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Docquet
+  module CLI
+    class RegenerateTodo < Base
+      desc "Regenerate .rubocop_todo.yml"
+
+      def call(**)
+        unless rubocop_yml_exists?
+          puts "Error: .rubocop.yml not found. Run 'docquet install-config' first."
+          exit 1
+        end
+
+        before_hash = calculate_file_hash(".rubocop_todo.yml")
+        command = build_command
+
+        puts "Running: #{command}"
+        if system(command)
+          after_hash = calculate_file_hash(".rubocop_todo.yml")
+          changed = before_hash != after_hash
+
+          puts <<~MESSAGE
+            ✓ Regenerated .rubocop_todo.yml
+            #{changed ? "📝 TODO file was updated with changes" : "✅ TODO file unchanged (no new violations)"}
+            Review the updated TODO file and continue fixing violations.
+          MESSAGE
+        else
+          puts "Error: Failed to regenerate .rubocop_todo.yml"
+          exit 1
+        end
+      end
+
+      private def build_command
+        "#{rubocop_command} --regenerate-todo --no-exclude-limit --no-offense-counts --no-auto-gen-timestamp"
+      end
+
+      private def calculate_file_hash(file_path)
+        return nil unless File.exist?(file_path)
+
+        Digest::SHA256.hexdigest(File.read(file_path))
+      end
+    end
+  end
+end

data/lib/docquet/cli.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Docquet
+  module CLI
+  end
+end

data/lib/docquet/commands.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "dry/cli"
+
+module Docquet
+  module Commands
+    extend Dry::CLI::Registry
+
+    register "install-config", CLI::InstallConfig
+    register "regenerate-todo", CLI::RegenerateTodo
+  end
+end

data/lib/docquet/config_processor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Docquet
+  class ConfigProcessor
+    def initialize(plugin_names)
+      @plugin_names = plugin_names
+    end
+
+    def process(content, department, gem_name, base)
+      content = add_department_header(content, department)
+      content = enable_all_cops(content)
+      content = remove_deprecated_config(content)
+      content = add_documentation_links(content, department, gem_name, base)
+      content = normalize_paths(content)
+      remove_trailing_whitespace(content)
+    end
+
+    private def add_department_header(content, department)
+      cop_count = content.scan(%r{^#{Regexp.escape(department)}/}).length
+      header = "# Department '#{department}' (#{cop_count}):\n"
+      header + content
+    end
+
+    private def enable_all_cops(content)
+      content.gsub(/(?<=^  )Enabled: (false|pending)$/) { "Enabled: true # was #{$1}" }
+    end
+
+    private def remove_deprecated_config(content)
+      content.gsub(/^\s+AllowOnlyRestArgument:.*\n/, "")
+    end
+
+    private def add_documentation_links(content, department, gem_name, base)
+      content.gsub(%r{(?=^#{department}/(.+):$)}) do
+        cop_name = $1
+        path = "/#{gem_name}/cops_#{base}.html"
+        fragment = "#{department}#{cop_name}".downcase.delete("/_")
+
+        "# #{URI::HTTPS.build(scheme: "https", host: "docs.rubocop.org", path:, fragment:)}\n"
+      end
+    end
+
+    private def normalize_paths(content)
+      content.gsub("#{Dir.pwd}/", "")
+    end
+
+    private def remove_trailing_whitespace(content)
+      content.gsub(/ +$/, "")
+    end
+  end
+end

data/lib/docquet/generators/rubocop_yml_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Docquet
+  module Generators
+    class RuboCopYMLGenerator
+      def initialize
+        @inflector = Inflector.instance
+        @detected_plugin_names = PluginDetector.detect_plugin_names
+        @filtered_configs = filtered_config_files
+      end
+
+      def generate
+        content = ERB.new(File.read(template_path("rubocop.yml.erb")), trim_mode: "-").result(binding)
+        File.write(".rubocop.yml", content)
+      end
+
+      private def detected_ruby_version
+        # Detect from .ruby-version or Gemfile
+        if File.exist?(".ruby-version")
+          File.read(".ruby-version").strip
+        else
+          RUBY_VERSION[/\A\d+\.\d+/]
+        end
+      end
+
+      private def template_path(filename)
+        File.join(File.dirname(__dir__, 3), "templates", filename)
+      end
+
+      private def detect_available_config_files
+        gem_config_dir = File.join(File.dirname(__dir__, 3), "config", "cops")
+        Dir.glob("#{gem_config_dir}/*.yml").map {|path| File.basename(path, ".yml") }
+      end
+
+      private def filtered_config_files
+        available_configs = detect_available_config_files
+        core_departments = %w[style layout lint metrics security gemspec bundler naming]
+
+        available_configs.select do |config|
+          # Extract department name from config file name
+          department = extract_department_from_config(config)
+
+          if core_departments.include?(@inflector.underscore(department))
+            true # Core departments are always included
+          else
+            # Check if corresponding plugin is detected
+            plugin_name = @inflector.underscore(department)
+            @detected_plugin_names.include?(plugin_name)
+          end
+        end
+      end
+
+      private def extract_department_from_config(config)
+        # Extract department name from the corresponding defaults file
+        cops_file = File.join(File.dirname(__dir__, 3), "config", "cops", "#{config}.yml")
+
+        if File.exist?(cops_file)
+          cops_content = File.read(cops_file)
+          if cops_content =~ %r{inherit_from:\s*\.\./defaults/(.+)\.yml}
+            defaults_file = File.join(File.dirname(__dir__, 3), "config", "defaults", "#{$1}.yml")
+
+            if File.exist?(defaults_file)
+              defaults_content = File.read(defaults_file)
+              if defaults_content =~ /^# Department '(.+)'/
+                return $1
+              end
+            end
+          end
+        end
+
+        # Fallback: use the simple split method
+        config.split("_").first
+      end
+    end
+  end
+end

data/lib/docquet/inflector.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+
+module Docquet
+  # Provides a centralized inflector with consistent acronym rules.
+  #
+  # This module ensures all classes use the same inflection rules,
+  # preventing inconsistencies in department name transformations.
+  module Inflector
+    # Returns a configured Dry::Inflector instance with custom acronyms.
+    #
+    # @return [Dry::Inflector] configured inflector instance
+    def self.instance
+      @instance ||= Dry::Inflector.new do |inflections|
+        inflections.acronym("RSpec")
+        inflections.acronym("GetText")
+        inflections.acronym("RailsI18n")
+      end
+    end
+  end
+end

data/lib/docquet/plugin_detector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Docquet
+  # Detects available RuboCop plugins and provides consistent naming.
+  #
+  # Terminology:
+  # - Plugin Gem Name: Full gem name (e.g., "rubocop-performance", "rubocop-rspec")
+  # - Plugin Name: Short name without prefix (e.g., "performance", "rspec")
+  #
+  # Both forms are used in different contexts:
+  # - Plugin Gem Names: For gem operations, --plugin CLI arguments
+  # - Plugin Names: For config file matching, department filtering
+  module PluginDetector
+    # Returns full gem names of detected RuboCop plugins.
+    #
+    # @return [Array<String>] plugin gem names (e.g., ["rubocop-performance", "rubocop-rspec"])
+    module_function def detect_plugin_gem_names
+      plugins = Gem::Specification.select {|spec| /\ARuboCop::.*::Plugin\z/ =~ spec.metadata["default_lint_roller_plugin"] }
+      plugins.map(&:name)
+    end
+
+    # Returns short names of detected RuboCop plugins (without "rubocop-" prefix).
+    #
+    # @return [Array<String>] plugin names (e.g., ["performance", "rspec"])
+    module_function def detect_plugin_names
+      detect_plugin_gem_names.map {|name| name.delete_prefix("rubocop-") }
+    end
+  end
+end

data/lib/docquet/rake_task.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+# Only load in docquet gem development environment
+unless File.exist?("docquet.gemspec")
+  warn "Warning: docquet/rake_task loaded outside of docquet project - skipping loading"
+  return
+end
+
+# Standard library and framework requires
+require "fileutils"
+require "open3"
+require "rake/tasklib"
+require "uri"
+require "yaml"
+
+# RuboCop core
+require "rubocop"
+
+# RuboCop plugins
+require "rubocop-capybara"
+require "rubocop-i18n"
+require "rubocop-performance"
+require "rubocop-rake"
+require "rubocop-rspec"
+require "rubocop-sequel"
+require "rubocop-thread_safety"
+
+# Load docquet for zeitwerk autoloading
+require_relative "../docquet"
+
+module Docquet
+  class RakeTask < Rake::TaskLib
+    def initialize
+      super
+      @inflector = Inflector.instance
+
+      @plugin_gem_names = PluginDetector.detect_plugin_gem_names
+      departments = RuboCop::Cop::Registry.global.map {|c| c.department.to_s }
+      departments.sort!
+      departments.uniq!
+      @departments = departments
+
+      define_tasks
+    end
+
+    private def define_tasks
+      desc "Create defaults directory"
+      directory "config/defaults"
+
+      desc "Generate default configuration files"
+      task generate_defaults: "config/defaults"
+
+      desc "Check cops configuration inheritance"
+      task check_cops: :generate_defaults do
+        check_cops_configurations
+      end
+
+      desc "Clean existing default configuration files"
+      task :clean_defaults do
+        FileUtils.rm_rf("config/defaults")
+      end
+
+      desc "Clean and regenerate all configuration files"
+      task regenerate: %i[clean_defaults generate_defaults check_cops]
+
+      # Department-specific file generation tasks
+      @departments.each do |department|
+        base = @inflector.underscore(department).tr("/", "_")
+        target_file = "config/defaults/#{base}.yml"
+
+        desc "Generate configuration for #{department}"
+        file target_file => "config/defaults" do |t|
+          generate_default_config(department, t.name)
+        end
+
+        task generate_defaults: target_file
+      end
+    end
+
+    private def generate_default_config(department, target_file)
+      puts "Generating #{department} configuration..."
+
+      base = @inflector.underscore(department).tr("/", "_")
+      plugin_name = @inflector.underscore(department.sub(%r{/.*}, ""))
+      gem_name = "rubocop-#{plugin_name}"
+      gem_name = "rubocop" unless @plugin_gem_names.include?(gem_name)
+
+      options = %W[--show-cops=#{department}/* --force-default-config --display-cop-names --extra-details --display-style-guide]
+
+      cmd = ["bin/rubocop", *options, *@plugin_gem_names.sort.flat_map {|name| %W[--plugin #{name}] }]
+
+      puts "Running: #{cmd.join(" ")}"
+      content, status = Open3.capture2e(*cmd)
+
+      if status.success?
+        processor = ConfigProcessor.new(@plugin_gem_names)
+        processed_content = processor.process(content, department, gem_name, base)
+        File.write(target_file, processed_content)
+        puts "✓ Generated #{target_file}"
+      else
+        puts "✗ Failed to generate #{department} configuration"
+        exit 1
+      end
+    end
+
+    private def check_cops_configurations
+      puts "Checking cops configurations..."
+
+      Dir["config/defaults/*.yml"].each do |default_file|
+        base_name = File.basename(default_file)
+        cops_file = "config/cops/#{base_name}"
+
+        next unless File.exist?(cops_file)
+
+        puts "Checking #{cops_file}..."
+
+        cops_content = File.read(cops_file)
+        if cops_content.include?("inherit_from: ../defaults/#{base_name}")
+          puts "  ✓ Inheritance looks good"
+        else
+          puts "  Warning: #{cops_file} may need inherit_from update"
+        end
+      end
+    end
+  end
+end

data/lib/docquet/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Docquet
+  VERSION = "1.0.0"
+  public_constant :VERSION
+end

data/lib/docquet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require_relative "docquet/version"
+
+module Docquet
+  class Error < StandardError; end
+
+  loader = Zeitwerk::Loader.for_gem
+  loader.inflector.inflect(
+    "cli" => "CLI",
+    "rubocop_yml_generator" => "RuboCopYMLGenerator"
+  )
+  loader.ignore("#{__dir__}/docquet/version.rb")
+  loader.ignore("#{__dir__}/docquet/rake_task.rb")
+  loader.setup
+end

data/templates/rubocop.yml.erb

@@ -0,0 +1,35 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  EnabledByDefault: true
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+  ExtraDetails: true
+  NewCops: enable
+  TargetRubyVersion: <%= detected_ruby_version %>
+  UseCache: true
+
+inherit_mode:
+  merge:
+    - Exclude
+
+<% unless @detected_plugin_names.empty? -%>
+plugins:
+<% @detected_plugin_names.each do |plugin| -%>
+  - rubocop-<%= plugin %>
+<% end -%>
+
+<% end -%>
+inherit_gem:
+  docquet:
+<% @filtered_configs.each do |config| -%>
+    - config/cops/<%= config %>.yml
+<% end -%>
+
+inherit_from: .rubocop_todo.yml
+
+# Project-specific settings can be added here
+# Example:
+# Style/Documentation:
+#   Enabled: false