docit 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19ca1ea84419aa3ec1c1605fec67c6355027d866de1b9e6b0d8fb27472b91602
-  data.tar.gz: a8fc557d32361a3729a9133791100bea3c7bf94e4c2f0ca55351eff4760efafe
+  metadata.gz: 3ac8acf7fd2b736bb2c89c63a63bca482239783457d7572d864e0257a3a2c6cd
+  data.tar.gz: 1605b07b832dc73f4e7f00e0840aa72267cbb60262e17baba6842134ee576e19
 SHA512:
-  metadata.gz: 4614b2cc382920b578400ddbccb8afb0eb8a32830307e0fd75fc3a175678f218d7f658e82b61678422d520c6f6c841fa5643d36d563b6cacf0bd4233bbed655f
-  data.tar.gz: fe46a50539ba08a2783b8e1f4d95a2e313fc1a043f78dee017ad4dd47cba8166f5cb8341bf5cbf732b4e7f7a776e9966e12efcce4c1a1b3a3b2c08cf2887acf1
+  metadata.gz: a72fa34e950fdf918daab680c287311401a4059fa3b8d0bf16a0ebcef210ed607b697d3ad58a3343bf7d105a2a11d717efd0f8ee239464a82f58ca5f934b1e79
+  data.tar.gz: 96516820d968faae672a4caa7b6c52c9d79356b6366d09edaa019badb2c6949c0b4087115e6f306f559904b5dbcb02b594c2e0e58e864458c0c460e381d4d894

data/README.md

@@ -5,6 +5,12 @@
 
 Decorator-style API documentation for Ruby on Rails. Write OpenAPI 3.0.3 docs with clean controller DSL macros, separate doc modules, or AI-assisted scaffolding for undocumented endpoints.
 
+### Scalar (default)
+![Scalar API Reference](docs/images/scalar_image.png)
+
+### Swagger
+![Swagger UI](docs/images/swagger_image.png)
+
 ## Table Of Contents
 
 - Getting started

data/lib/docit/ai/doc_block_validator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Docit
+  module Ai
+    class InvalidDocBlockError < Error; end
+
+    class DocBlockValidator
+      def initialize(controller:, action:, doc_block:)
+        @controller = controller
+        @action = action.to_sym
+        @doc_block = doc_block
+      end
+
+      def validate!
+        doc_module = Module.new
+        doc_module.extend(Docit::DocFile)
+        doc_module.module_eval(@doc_block, "(generated Docit block)", 1)
+
+        validate_actions!(doc_module.actions)
+
+        operation = Docit::Operation.new(controller: @controller, action: @action)
+        operation.instance_eval(&doc_module[@action])
+
+        true
+      rescue SyntaxError, StandardError => e
+        raise InvalidDocBlockError, error_message_for(e)
+      end
+
+      private
+
+      def validate_actions!(actions)
+        return if actions == [@action]
+
+        raise InvalidDocBlockError, "Generated output did not define a doc block" if actions.empty?
+
+        action_list = actions.map { |action| ":#{action}" }.join(", ")
+        raise InvalidDocBlockError,
+              "Generated output must define only doc :#{@action}, got #{action_list}"
+      end
+
+      def error_message_for(error)
+        return error.message if error.is_a?(InvalidDocBlockError)
+
+        "#{error.class}: #{error.message}"
+      end
+    end
+  end
+end

data/lib/docit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Docit
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - S13G
@@ -43,12 +43,15 @@ files:
 - Rakefile
 - app/controllers/docit/ui_controller.rb
 - config/routes.rb
+- docs/images/scalar_image.png
+- docs/images/swagger_image.png
 - 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_block_validator.rb
 - lib/docit/ai/doc_writer.rb
 - lib/docit/ai/gap_detector.rb
 - lib/docit/ai/groq_client.rb
@@ -83,7 +86,7 @@ licenses:
 metadata:
   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
+  changelog_uri: https://github.com/S13G/docit/blob/master/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/docit
   bug_tracker_uri: https://github.com/S13G/docit/issues
   rubygems_mfa_required: 'true'