openapi_kit-codegen 0.1.0.pre.2 → 0.1.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec1f32df6c9400314583020aa177ef82226c5cd564f2409b5e86bda736488540
-  data.tar.gz: 104cbcd05659b76c827be6bbf5ed95827f0e25440a69bc89d91084fa7235ba67
+  metadata.gz: 8293a1b8d230aaa789c5e396b3880647d38105f51275d7de098feefd895102c2
+  data.tar.gz: 361d781382d6026ab64b99f8e8c8562576df570e876f82a283b7ec67c450780e
 SHA512:
-  metadata.gz: e43e6effbac010acfef9f6763b8dd9e1160e7ae3cf94cc10c3d6df15dfaee93bd22cf8545b131bd42be9d6ad8681fa7d549b2351cad32c97cd4100fd0cfb6129
-  data.tar.gz: af5ea12308813f9e7d2510fa70b441f9257e8b8e8eca76843dd942d25166aac48e9cecfef399f6ddc8395ed457af22cecd7ab242961dcd15631c5cb5eae00501
+  metadata.gz: 97cd58e24d8d2595c562eccda0d4920367534feea814ced250364a93b002b5bd63233ea8db9b2169f88dd6d03ae418c8113251ea1bee98519cdab7cf20811c3f
+  data.tar.gz: 974edf608f17bfda87eecb94cad8b2457ae7b2ecd97485f4fd805d911651a89598eda058ea3808bb40c5645fc0d877971536c05b8639876e0daa093d37ef4b81

data/README.md

@@ -28,7 +28,7 @@ end
 ```yaml
 # openapi_kit.yml
 spec: openapi/petstore.yaml
-output: app/api
+output: app/api/petstore/v1
 modules: [Petstore, V1]
 controller_base: Api::BaseController
 principal: "::Petstore::Principal"
@@ -37,8 +37,8 @@ principal: "::Petstore::Principal"
 | Option | Meaning |
 | --- | --- |
 | `spec` | root OpenAPI document, resolved relative to this file |
-| `output` | directory the tree is written to, which openapi_kit owns |
-| `modules` | namespace for every generated constant, so `Petstore::V1::Types::Pet` |
+| `output` | directory the tree is written into, which openapi_kit owns |
+| `modules` | namespace every generated constant is declared in, so `Petstore::V1::Types::Pet` |
 | `controller_base` | class the generated controllers inherit from |
 | `principal` | the class a successful authentication produces |
 | `type_mappings` | your Ruby type for a `type:format` pair |
@@ -57,13 +57,16 @@ app/api/petstore/v1/registry.rb
 app/api/petstore/v1/routes.rb
 ```
 
-One constant per file at the path that constant implies, so Rails autoloads it. Each run
-wipes `output`, but only after checking openapi_kit generated every `.rb` in it.
+Nothing is written outside `output`, and `modules` decides only what the files declare. One
+constant per file at the path that constant implies, counting from `output`, so laying the
+directory out to match the namespace is what lets Rails autoload it. Each run wipes
+`output`, but only after checking openapi_kit generated every `.rb` in it.
 
 ## Integrating with Rails
 
-**Autoload the output**, if it is not already under `app/`. An acronym in `modules`
-becomes a directory, so it needs an inflection like any other acronym constant.
+**Autoload the tree**, if it is not already under `app/`. The root is the directory
+`modules` counts from, not `output` itself. An acronym in `modules` is a directory like any
+other, so it needs an inflection.
 
 ```ruby
 # config/application.rb
@@ -125,15 +128,15 @@ module Api
 end
 ```
 
-**Assign the registry.** openapi_kit generates a `Registry` struct with one slot per handler and
-authenticator, and controllers read it from `Petstore::V1.registry`. Rails instantiates
-controllers itself, so they cannot be handed one. Omit a slot, or pass something that does
-not implement its interface, and it does not compile.
+**Assign the registry.** openapi_kit generates a `Registry` struct with one slot per handler
+and authenticator, and controllers read the one you assigned. Rails instantiates controllers
+itself, so they cannot be handed one. Omit a slot, or pass something that does not
+implement its interface, and it does not compile.
 
 ```ruby
 # config/initializers/openapi_kit.rb
 Rails.application.config.to_prepare do
-  Petstore::V1.registry = Petstore::V1::Registry.new(
+  Petstore::V1::Registry.instance = Petstore::V1::Registry.new(
     pets: PetsHandler.new(repo: PetRepo.new),
     system: SystemHandler.new,
     bearer_auth: BearerAuthenticator.new(decoder: TokenDecoder.new)

data/lib/openapi_kit/codegen/config.rb

@@ -104,11 +104,13 @@ module OpenAPIKit
         (value || {}).to_h { |k, v| [k.to_s, v.to_s] }
       end
 
+      # The namespace as a path, which is what Rails routing wants in `to:`. File paths
+      # come from `output` instead, so this no longer decides where anything is written.
       sig { returns(String) }
-      def namespace = modules.join("::")
+      def module_path = modules.map { |name| Naming.snake(name) }.join("/")
 
       sig { returns(String) }
-      def module_path = modules.map { |name| Naming.snake(name) }.join("/")
+      def namespace = modules.join("::")
     end
   end
 end

data/lib/openapi_kit/codegen/emit/controllers.rb

@@ -28,7 +28,7 @@ module OpenAPIKit
         sig { override.returns(T::Array[SourceFile]) }
         def render
           @document.operations.group_by(&:tag).map do |tag, operations|
-            Source.file(path: "#{@config.module_path}/controllers/#{Naming.snake(tag)}_controller.rb",
+            Source.file(path: "controllers/#{Naming.snake(tag)}_controller.rb",
                         modules: @config.modules + ["Controllers"]) do |buffer|
               emit_controller(buffer, tag, operations)
             end
@@ -71,7 +71,7 @@ module OpenAPIKit
           interface = "#{@config.namespace}::Handlers::#{Handlers.module_name(tag)}"
 
           buffer.line("sig { returns(#{interface}) }")
-          buffer.line("def handler = #{@config.namespace}.registry.#{Naming.snake(tag)}")
+          buffer.line("def handler = #{@config.namespace}::Registry.instance.#{Naming.snake(tag)}")
         end
 
         sig { params(buffer: Buffer, operation: Model::Operation).void }
@@ -126,7 +126,7 @@ module OpenAPIKit
         def attempt(requirement)
           name = T.must(requirement.schemes.keys.first)
           scopes = T.must(requirement.schemes[name])
-          reader = "#{@config.namespace}.registry.#{Naming.snake(name)}"
+          reader = "#{@config.namespace}::Registry.instance.#{Naming.snake(name)}"
 
           "-> { #{reader}.authenticate(request: request, scopes: #{scopes.inspect}) }"
         end

data/lib/openapi_kit/codegen/emit/handlers.rb

@@ -20,7 +20,7 @@ module OpenAPIKit
         sig { override.returns(T::Array[SourceFile]) }
         def render
           by_tag.map do |tag, operations|
-            Source.file(path: "#{@config.module_path}/handlers/#{Naming.snake(tag)}.rb",
+            Source.file(path: "handlers/#{Naming.snake(tag)}.rb",
                         modules: @config.modules + ["Handlers"]) do |buffer|
               emit_interface(buffer, tag, operations)
             end

data/lib/openapi_kit/codegen/emit/operations.rb

@@ -18,7 +18,7 @@ module OpenAPIKit
         sig { override.returns(T::Array[SourceFile]) }
         def render
           @document.operations.map do |operation|
-            Source.file(path: "#{@config.module_path}/operations/#{Naming.snake(operation.id)}.rb",
+            Source.file(path: "operations/#{Naming.snake(operation.id)}.rb",
                         modules: @config.modules + ["Operations"]) do |buffer|
               emit_operation(buffer, operation)
             end

data/lib/openapi_kit/codegen/emit/registry.rb

@@ -6,7 +6,7 @@ module OpenAPIKit
     module Emit
       # The typed boundary between openapi_kit's interfaces and an application's objects. Rails
       # instantiates controllers itself, so a controller cannot be handed the registry: it
-      # reads it from the accessor, which an application assigns at boot.
+      # reads the one an application assigned at boot.
       class Registry
         extend T::Sig
         include Emitter
@@ -28,10 +28,8 @@ module OpenAPIKit
           return [] if slots.empty?
 
           [
-            Source.file(path: "#{@config.module_path}/registry.rb",
-                        modules: @config.modules) { |buffer| emit_registry(buffer) },
-            Source.file(path: "#{@config.module_path}.rb",
-                        modules: @config.modules) { |buffer| emit_accessor(buffer) }
+            Source.file(path: "registry.rb",
+                        modules: @config.modules) { |buffer| emit_registry(buffer) }
           ]
         end
 
@@ -62,37 +60,39 @@ module OpenAPIKit
         sig { params(buffer: Buffer).void }
         def emit_registry(buffer)
           buffer.nest("class Registry < T::Struct") do
+            buffer.line("extend T::Sig")
+            buffer.blank
             slots.each { |slot| buffer.line("const :#{slot.reader}, #{slot.interface}") }
+            buffer.blank
+            emit_accessor(buffer)
           end
         end
 
         # Rails instantiates controllers itself, so a controller cannot be handed the
-        # registry. It reads it from here, and an application assigns it at boot.
+        # registry. It reads the one here, which an application assigns at boot.
         sig { params(buffer: Buffer).void }
         def emit_accessor(buffer)
-          buffer.line("extend T::Sig")
-          buffer.blank
-          buffer.line("@registry = T.let(nil, T.nilable(Registry))")
+          buffer.line("@instance = T.let(nil, T.nilable(Registry))")
           buffer.blank
           buffer.line("sig { params(registry: Registry).void }")
-          buffer.nest("def self.registry=(registry)") do
-            buffer.line("@registry = registry")
+          buffer.nest("def self.instance=(registry)") do
+            buffer.line("@instance = registry")
           end
           buffer.blank
           buffer.line("sig { returns(Registry) }")
-          buffer.nest("def self.registry") do
-            buffer.line("@registry || raise(")
-            buffer.indent { unset_message.each { |line| buffer.line(line) } }
+          buffer.nest("def self.instance") do
+            buffer.line("@instance || raise(")
+            buffer.indent { unassigned_message.each { |line| buffer.line(line) } }
             buffer.line(")")
           end
         end
 
         sig { returns(T::Array[String]) }
-        def unset_message
+        def unassigned_message
           namespace = @config.namespace
           [
-            %("#{namespace}.registry has not been assigned. Build one in an initializer, " \\),
-            %("e.g. #{namespace}.registry = #{namespace}::Registry.new(...).")
+            %("#{namespace}::Registry.instance has not been assigned. Build one in an " \\),
+            %("initializer, e.g. #{namespace}::Registry.instance = #{namespace}::Registry.new(...).")
           ]
         end
       end

data/lib/openapi_kit/codegen/emit/routes.rb

@@ -19,7 +19,7 @@ module OpenAPIKit
           return [] if @document.operations.empty?
 
           [
-            Source.file(path: "#{@config.module_path}/routes.rb",
+            Source.file(path: "routes.rb",
                         modules: @config.modules + ["Routes"]) { |buffer| emit_body(buffer) }
           ]
         end

data/lib/openapi_kit/codegen/emit/security.rb

@@ -35,7 +35,7 @@ module OpenAPIKit
           return [] if @document.security_schemes.empty?
 
           [
-            Source.file(path: "#{@config.module_path}/security.rb",
+            Source.file(path: "security.rb",
                         modules: @config.modules + ["Security"]) { |buffer| emit_body(buffer) }
           ]
         end

data/lib/openapi_kit/codegen/emit/types.rb

@@ -21,7 +21,7 @@ module OpenAPIKit
         def render
           declared_types.map do |type|
             name = Model::TypeDef.name_of(type)
-            Source.file(path: "#{@config.module_path}/types/#{Naming.snake(name)}.rb",
+            Source.file(path: "types/#{Naming.snake(name)}.rb",
                         modules: @config.modules + ["Types"]) do |buffer|
               emit_declaration(buffer, type)
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_kit-codegen
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.2
+  version: 0.1.0.pre.3
 platform: ruby
 authors:
 - Jack Robertson
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.pre.2
+        version: 0.1.0.pre.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.pre.2
+        version: 0.1.0.pre.3
 - !ruby/object:Gem::Dependency
   name: prism
   requirement: !ruby/object:Gem::Requirement