docit 0.1.0 → 0.2.0

data/lib/generators/docit/install/install_generator.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
+require "io/console"
+
 module Docit
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc "Creates a Docit initializer and mounts the engine in routes"
+      desc "Creates a Docit initializer, mounts the engine, and sets up documentation"
       source_root File.expand_path("templates", __dir__)
 
+      PROVIDER_OPTIONS = {
+        "1" => "openai",
+        "2" => "anthropic",
+        "3" => "groq"
+      }.freeze
+
       def copy_initializer
         template "initializer.rb", "config/initializers/docit.rb"
       end
@@ -14,15 +22,182 @@ module Docit
         route 'mount Docit::Engine => "/api-docs"'
       end
 
-      def print_instructions
+      def ask_doc_mode
+        say ""
+        say "How would you like to set up your API documentation?", :green
+        say "  1. AI automatic docs (generate docs using AI)"
+        say "  2. Manual docs (create scaffolded placeholders to fill in)"
+        say "  3. Skip for now, I'll do it myself (just set up the engine and initializer)"
+        say ""
+
+        @doc_mode = ask_choice("Enter choice (1-3):", %w[1 2 3])
+      end
+
+      def setup_docs
+        case @doc_mode
+        when "1"
+          run_ai_setup
+        when "2"
+          run_manual_scaffold
+        else
+          print_skip_instructions
+        end
+      end
+
+      private
+
+      def run_ai_setup
+        say ""
+        say "--- AI Documentation Setup ---", :yellow
+        say ""
+
+        provider = prompt_provider
+        api_key = prompt_api_key(provider)
+        save_ai_configuration(provider, api_key)
+        update_gitignore
+
+        say ""
+        say "Scanning project for undocumented endpoints...", :yellow
+        say ""
+
+        runner = Docit::Ai::AutodocRunner.new(output: shell_output)
+        runner.run
+
+        say ""
+        say "Docit installed and AI docs generated!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Review generated doc files in app/docs/"
+        say "  2. Edit config/initializers/docit.rb to customize settings"
+        say "  3. Start your server and visit /api-docs"
+        say ""
+        say "To regenerate docs later:"
+        say "  rails docit:autodoc"
+        say ""
+      end
+
+      def run_manual_scaffold
+        say ""
+        say "--- Manual Documentation Setup ---", :yellow
+        say ""
+        say "Scanning project for endpoints...", :yellow
+        say ""
+
+        scaffold = Docit::Ai::ScaffoldGenerator.new(output: shell_output)
+        scaffold.run
+
+        say ""
+        say "Docit installed with doc scaffolds!", :green
+        say ""
+        say "Next steps:"
+        say "  1. Fill in the TODO placeholders in your doc files under app/docs/"
+        say "  2. Edit config/initializers/docit.rb to customize settings"
+        say "  3. Start your server and visit /api-docs"
+        say ""
+      end
+
+      def print_skip_instructions
         say ""
         say "Docit installed successfully!", :green
         say ""
         say "Next steps:"
         say "  1. Edit config/initializers/docit.rb to customize your API docs"
-        say "  2. Add swagger_doc blocks to your controller actions"
+        say "  2. Add swagger_doc blocks or create doc files under app/docs/"
         say "  3. Visit /api-docs to see your Swagger UI"
         say ""
+        say "You can set up docs later with:"
+        say "  rails generate docit:ai_setup   # configure AI provider"
+        say "  rails docit:autodoc             # generate docs with AI"
+        say ""
+      end
+
+      def prompt_provider
+        say "Select your AI provider:"
+        say "  1. OpenAI"
+        say "  2. Anthropic"
+        say "  3. Groq (free tier available)"
+        say ""
+
+        choice = ask_choice("Enter choice (1-3):", PROVIDER_OPTIONS.keys)
+        provider = PROVIDER_OPTIONS[choice]
+
+        say "Selected: #{provider.capitalize}", :green
+        provider
+      end
+
+      def prompt_api_key(provider)
+        loop do
+          api_key = ask_secret("Enter your #{provider.capitalize} API key:")
+          return api_key if api_key.empty? == false
+
+          say "API key cannot be blank.", :red
+        end
+      end
+
+      def save_ai_configuration(provider, api_key)
+        model = Docit::Ai::Configuration::DEFAULT_MODELS[provider]
+        Docit::Ai::Configuration.save(
+          provider: provider,
+          model: model,
+          api_key: api_key
+        )
+        say "Saved AI configuration to .docit_ai.yml", :green
+      end
+
+      def update_gitignore
+        gitignore = Rails.root.join(".gitignore")
+        if !(File.exist?(gitignore))
+          say "Warning: .gitignore not found. Add .docit_ai.yml manually to avoid committing your API key.", :yellow
+          return
+        end
+
+        content = File.read(gitignore)
+        return if content.include?(".docit_ai.yml")
+
+        File.open(gitignore, "a") do |f|
+          f.puts "" unless content.end_with?("\n")
+          f.puts "# Docit AI configuration (contains API key)"
+          f.puts ".docit_ai.yml"
+        end
+        say "Added .docit_ai.yml to .gitignore", :green
+      end
+
+      def ask_choice(prompt, choices)
+        loop do
+          choice = ask(prompt).to_s.strip
+          return choice if choices.include?(choice)
+
+          say "Invalid choice. Please enter #{choices.join(', ')}.", :red
+        end
+      end
+
+      def ask_secret(prompt)
+        if $stdin.respond_to?(:noecho) && $stdin.tty?
+          shell.say(prompt, nil, false)
+          value = $stdin.noecho(&:gets).to_s.strip
+          shell.say("")
+          value
+        else
+          ask(prompt).to_s.strip
+        end
+      end
+
+      def shell_output
+        @shell_output ||= ShellOutput.new(shell)
+      end
+
+      class ShellOutput
+        def initialize(shell)
+          @shell = shell
+        end
+
+        def puts(msg = "")
+          @shell.say(msg)
+        end
+
+        def print(msg)
+          @shell.say(msg, nil, false)
+        end
       end
     end
   end

data/lib/tasks/docit.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+namespace :docit do
+  desc "Generate documentation for undocumented API endpoints using AI"
+  task :autodoc, [:controller] => :environment do |_t, args|
+    dry_run = ENV.fetch("DRY_RUN", "0") == "1" || ARGV.include?("--dry-run")
+    controller_filter = args[:controller]
+
+    runner = Docit::Ai::AutodocRunner.new(
+      controller_filter: controller_filter,
+      dry_run: dry_run
+    )
+
+    runner.run
+  rescue Docit::Error => e
+    warn e.message
+    exit 1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - S13G
@@ -23,9 +23,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
-description: Docit lets you write OpenAPI 3.0 docs as clean DSL macros directly on
-  your Rails controller actions. No RSpec integration required, no external doc files.
-  Just annotate and go.
+description: Write OpenAPI 3.0.3 documentation for Rails APIs with clean controller
+  DSL macros, separate doc modules, and optional AI-assisted doc generation for undocumented
+  endpoints.
 email:
 - siegdomain1@gmail.com
 executables: []
@@ -35,7 +35,6 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/ci.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -45,6 +44,18 @@ files:
 - app/controllers/docit/ui_controller.rb
 - config/routes.rb
 - lib/docit.rb
+- lib/docit/ai.rb
+- lib/docit/ai/anthropic_client.rb
+- lib/docit/ai/autodoc_runner.rb
+- lib/docit/ai/client.rb
+- lib/docit/ai/configuration.rb
+- lib/docit/ai/doc_writer.rb
+- lib/docit/ai/gap_detector.rb
+- lib/docit/ai/groq_client.rb
+- lib/docit/ai/openai_client.rb
+- lib/docit/ai/prompt_builder.rb
+- lib/docit/ai/scaffold_generator.rb
+- lib/docit/ai/tag_injector.rb
 - lib/docit/builders/parameter_builder.rb
 - lib/docit/builders/request_body_builder.rb
 - lib/docit/builders/response_builder.rb
@@ -58,17 +69,20 @@ files:
 - lib/docit/schema_definition.rb
 - lib/docit/schema_generator.rb
 - lib/docit/version.rb
+- lib/generators/docit/ai_setup/ai_setup_generator.rb
 - lib/generators/docit/install/install_generator.rb
 - lib/generators/docit/install/templates/initializer.rb
+- lib/tasks/docit.rake
 - sig/docit.rbs
-homepage: https://github.com/S13G/docket
+homepage: https://github.com/S13G/docit
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/S13G/docket
-  source_code_uri: https://github.com/S13G/docket
-  changelog_uri: https://github.com/S13G/docket/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/S13G/docit
+  source_code_uri: https://github.com/S13G/docit
+  changelog_uri: https://github.com/S13G/docit/blob/main/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/docit
+  bug_tracker_uri: https://github.com/S13G/docit/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -86,5 +100,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
-summary: Decorator-style Swagger/OpenAPI documentation generator for Ruby on Rails.
+summary: Decorator-style OpenAPI documentation for Rails with inline DSL, doc modules,
+  and AI-assisted scaffolding.
 test_files: []

data/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ["3.2", "3.3", "3.4"]
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: bundle exec rspec
-
-      - name: Run linter
-        run: bundle exec rubocop