sober_swag 0.19.0 → 0.20.0

data/lib/sober_swag/compiler/type.rb

@@ -1,45 +1,95 @@
 module SoberSwag
   class Compiler
     ##
-    # A compiler for DRY-Struct data types, essentially.
-    # It only consumes one type at a time.
+    # A compiler for swagger-able types.
+    #
+    # This class turns Swagger-able types into a *schema*.
+    # This Schema may be:
+    # - a [schema object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#schemaObject) with {#object_schema}
+    # - a [path schema](https://swagger.io/docs/specification/describing-parameters/#path-parameters) with {#path_schema}
+    # - a [query schema](https://swagger.io/docs/specification/describing-parameters/#query-parameters) with {#query_schema}
+    #
+    # As such, it compiles all types to all applicable schemas.
+    #
+    # While this class compiles *one* type at a time, it *keeps track* of the other types needed to describe this schema.
+    # It stores these types in a set, available at {#found_types}.
+    #
+    # For example, with a schema like:
+    #
+    # ```ruby
+    # class Bar < SoberSwag::InputObject
+    #   attribute :baz, primitive(:String)
+    # end
+    #
+    # class Foo < SoberSwag::InputObject
+    #   attribute :bar, Bar
+    # end
+    # ```
+    #
+    # If you compile `Foo` with this class, {#found_types} will include `Bar`.
+    #
     class Type # rubocop:disable Metrics/ClassLength
+      ##
+      # An error raised when a type is too complicated for a given schema.
+      # This may be due to containing too many layers of nesting.
       class TooComplicatedError < ::SoberSwag::Compiler::Error; end
+      ##
+      # An error raised when a type is too complicated to transform into a *path* schema.
       class TooComplicatedForPathError < TooComplicatedError; end
+      ##
+      # An error raised when a type is too complicated to transform into a *query* schema.
       class TooComplicatedForQueryError < TooComplicatedError; end
 
+      ##
+      # A list of acceptable keys to use as metadata for an object schema.
+      # All other metadata keys defined on a type with {SoberSwag::InputObject.meta} will be ignored.
+      #
+      # @return [Array<Symbol>] valid keys.
       METADATA_KEYS = %i[description deprecated].freeze
 
+      ##
+      # Create a new compiler for a swagger-able type.
+      # @param type [Class] the type to compile
       def initialize(type)
         @type = type
       end
 
+      ##
+      # @return [Class] the type we are compiling.
       attr_reader :type
 
       ##
       # Is this type standalone, IE, worth serializing on its own
       # in the schemas section of our schema?
+      # @return [true,false]
       def standalone?
         type.is_a?(Class)
       end
 
+      ##
+      # Get back the [schema object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#schemaObject)
+      # for the type described.
+      #
+      # @return [Hash]
       def object_schema
         @object_schema ||=
           make_object_schema
       end
 
-      def object_schema_meta
-        return {} unless standalone? && type <= SoberSwag::Type::Named
-
-        {
-          description: type.description
-        }.reject { |_, v| v.nil? }
-      end
-
+      ##
+      # Give a "stub type" for this schema.
+      # This is suitable to use as the schema for attributes of other schemas.
+      # Almost always generates a ref object.
+      # @return [Hash] the OpenAPI V3 schema stub
       def schema_stub
         @schema_stub ||= generate_schema_stub
       end
 
+      ##
+      # The schema for this type when it is path of the path.
+      #
+      # @raise [TooComplicatedForPathError] when the compiled type is too complicated to use in a path
+      # @return [Hash] a [path parameters hash](https://swagger.io/docs/specification/describing-parameters/#path-parameters) for this type.
       def path_schema
         path_schema_stub.map do |e|
           ensure_uncomplicated(e[:name], e[:schema])
@@ -51,16 +101,30 @@ module SoberSwag
 
       DEFAULT_QUERY_SCHEMA_ATTRS = { in: :query, style: :deepObject, explode: true }.freeze
 
+      ##
+      # The schema for this type when it is part of the query.
+      # @raise [TooComplicatedForQueryError] when this type is too complicated to use in a query schema
+      # @return [Hash] a [query parameters hash](https://swagger.io/docs/specification/describing-parameters/#query-parameters) for this type.
       def query_schema
         path_schema_stub.map { |e| DEFAULT_QUERY_SCHEMA_ATTRS.merge(e) }
       rescue TooComplicatedError => e
         raise TooComplicatedForQueryError, e.message
       end
 
+      ##
+      # Get the name of this type if it is to be used in a `$ref` key.
+      # This is useful if we are going to use this type compiler to compile an *attribute* of another object.
+      #
+      # @return [String] a reference specifier for this type
       def ref_name
         SoberSwag::Compiler::Primitive.new(type).ref_name
       end
 
+      ##
+      # Get a set of all other types needed to compile this type.
+      # This set will *not* include the type being compiled.
+      #
+      # @return [Set<Class>]
       def found_types
         @found_types ||=
           begin
@@ -69,32 +133,51 @@ module SoberSwag
           end
       end
 
-      def mapped_type
-        @mapped_type ||= parsed_type.map { |v| SoberSwag::Compiler::Primitive.new(v).type_hash }
-      end
-
-      def parsed_type
-        @parsed_type ||=
-          begin
-            (parsed,) = parsed_result
-            parsed
-          end
-      end
-
+      ##
+      # This type, parsed into an AST.
       def parsed_result
         @parsed_result ||= Parser.new(type_for_parser).run_parser
       end
 
+      ##
+      # Standard ruby equality.
       def eql?(other)
         other.class == self.class && other.type == type
       end
 
+      ##
+      # Standard ruby hashing method.
+      # Compilers hash to the same value if they are compiling the same type.
       def hash
         [self.class, type].hash
       end
 
       private
 
+      ##
+      # Get metadata attributes to be used if compiling an object schema.
+      #
+      # @return [Hash]
+      def object_schema_meta
+        return {} unless standalone? && type <= SoberSwag::Type::Named
+
+        {
+          description: type.description
+        }.reject { |_, v| v.nil? }
+      end
+
+      def parsed_type
+        @parsed_type ||=
+          begin
+            (parsed,) = parsed_result
+            parsed
+          end
+      end
+
+      def mapped_type
+        @mapped_type ||= parsed_type.map { |v| SoberSwag::Compiler::Primitive.new(v).type_hash }
+      end
+
       def generate_schema_stub
         if type.is_a?(Class)
           SoberSwag::Compiler::Primitive.new(type).type_hash

data/lib/sober_swag/controller.rb

@@ -2,7 +2,8 @@ require 'active_support/concern'
 
 module SoberSwag
   ##
-  # Controller concern
+  # This module can be included in any subclass of `ActionController` or `ActionController::API` to make it `SoberSwag`-able.
+  # This means that you can use the mechanics of SoberSwag to define a type-safe API, with generated Swagger documentation!
   module Controller
     extend ActiveSupport::Concern
 
@@ -17,14 +18,18 @@ module SoberSwag
       include ::Dry::Types()
     end
 
-    class_methods do
+    ##
+    # Module containing class methods.
+    # Any class that `include`s {SoberSwag::Controller} will also `extend` {SoberSwag::Controller::ClassMethods}.
+    module ClassMethods
       ##
       # Define a new action with the given HTTP method, action name, and path.
-      # This will eventaully delegate to making an actual method on your controller,
+      # This will eventually delegate to making an actual method on your controller,
       # so you can use controllers as you wish with no harm.
       #
       # This method takes a block, evaluated in the context of a {SoberSwag::Controller::Route}.
       # Used like:
+      #
       #     define(:get, :show, '/posts/{id}') do
       #       path_params do
       #         attribute :id, Types::Integer
@@ -36,32 +41,46 @@ module SoberSwag
       #     end
       #
       # This will define an "action module" on this class to contain the generated types.
-      # In the above example, the following constants will be deifned on the controller:
-      #     PostsController::Show # the container module for everything in this action
-      #     PostsController::Show::PathParams # the dry-struct type for the path attribute.
+      # In the above example, the following constants will be defined on the controller:
+      #
+      # - `PostsController::Show` - the container module for everything in this action
+      # - `PostsController::Show::PathParams` - the dry-struct type for the path attribute.
+      #
       # So, in the same controller, you can refer to Show::PathParams to get the type created by the 'path_params' block above.
+      #
+      # The block given evaluates in the context of `SoberSwag::Controller::Route`.
+      #
+      # @todo Explore parsing the `path` parameter from rails routes so we can avoid forcing the duplicate boilerplate.
+      #
+      # @param method [Symbol] the HTTP method of this route
+      # @param action [Symbol] the name of the controller method this maps onto
+      # @param path [String] an OpenAPI v3 Path Specifier
       def define(method, action, path, &block)
         r = Route.new(method, action, path)
         r.instance_eval(&block)
         const_set(r.action_module_name, r.action_module)
         defined_routes << r
-        define_method(action, r.action) if r.action
       end
 
       ##
       # All the routes that this controller knows about.
+      # @return [Array<SoberSwag::Controller::Route>
       def defined_routes
         @defined_routes ||= []
       end
 
       ##
       # Find a route with the given name.
+      # @param name [Symbol] the name
+      # @return [SoberSwag::Controller::Route]
       def find_route(name)
         defined_routes.find { |r| r.action_name.to_s == name.to_s }
       end
 
       ##
-      # A swagger definition for *this controller only*.
+      # Get the OpenAPI v3 definition for this controller.
+      #
+      # @return [Hash]
       def swagger_info
         @swagger_info ||=
           begin
@@ -74,14 +93,19 @@ module SoberSwag
       end
     end
 
+    included do |base|
+      base.extend ClassMethods
+    end
+
     ##
-    # Action to get the singular swagger for this entire API.
+    # ActiveController action to get the swagger definition for this API.
+    # It renders a JSON of the OpenAPI v3 schema for this API.
     def swagger
       render json: self.class.swagger_info
     end
 
     ##
-    # Get the path parameters, parsed into the type you defined with {SoberSwag::Controller.define}
+    # Get the path parameters, parsed into the type you defined with {SoberSwag::Controller::ClassMethods#define}
     # @raise [UndefinedPathError] if there's no path params defined for this route
     # @raise [Dry::Struct::Error] if we cannot convert the path params to the defined type.
     def parsed_path
@@ -95,7 +119,7 @@ module SoberSwag
     end
 
     ##
-    # Get the request body, parsed into the type you defined with {SoberSwag::Controller.define}.
+    # Get the request body, parsed into the type you defined with {SoberSwag::Controller::ClassMethods#define}.
     # @raise [UndefinedBodyError] if there's no request body defined for this route
     # @raise [Dry::Struct::Error] if we cannot convert the path params to the defined type.
     def parsed_body
@@ -109,7 +133,7 @@ module SoberSwag
     end
 
     ##
-    # Get the query params, parsed into the type you defined with {SoberSwag::Controller.define}
+    # Get the query params, parsed into the type you defined with {SoberSwag::Controller::ClassMethods#define}
     # @raise [UndefinedQueryError] if there's no query params defined for this route
     # @raise [Dry::Struct::Error] if we cannot convert the path params to the defined type.
     def parsed_query
@@ -140,6 +164,8 @@ module SoberSwag
     # This kinda violates the "be liberal in what you accept" principle,
     # but it keeps the docs honest: parameters sent in the body *must* be
     # in the body.
+    #
+    # @return [Hash]
     def body_params
       request.request_parameters
     end
@@ -147,6 +173,7 @@ module SoberSwag
     ##
     # Get the action-definition for the current action.
     # Under the hood, delegates to the `:action` key of rails params.
+    # @return [SoberSwag::Controller::Route]
     def current_action_def
       self.class.find_route(params[:action])
     end

data/lib/sober_swag/controller/route.rb

@@ -3,6 +3,12 @@ module SoberSwag
     ##
     # Describe a single controller endpoint.
     class Route
+      ##
+      # @param method [Symbol] the HTTP method to get
+      # @param action_name [Symbol] the name of the rails action
+      #   (the name of the controller method, usually)
+      # @param path [String] an OpenAPI V3 path template,
+      #   which should [match this format](https://swagger.io/docs/specification/describing-parameters/#path-parameters)
       def initialize(method, action_name, path)
         @method = method
         @path = path
@@ -12,20 +18,56 @@ module SoberSwag
         @tags = []
       end
 
-      attr_reader :response_serializers, :response_descriptions, :controller, :method, :path, :action_name
+      ##
+      # A hash of response code -> response serializer
+      # @return [Hash{Symbol => SoberSwag::Serializer::Base}]
+      #   response code to response serializer
+      attr_reader :response_serializers
+
+      ##
+      # A hash of response code -> response description
+      # @return [Hash{Symbol => String}]
+      #   response code to response description
+      attr_reader :response_descriptions
+
+      ##
+      # The HTTP method of this route.
+      # @return [Symbol]
+      attr_reader :method
+
+      ##
+      # The swagger path specifier of this route.
+      # @return [String]
+      attr_reader :path
+
+      ##
+      # The name of the rails action (usually the controller method) of this route.
+      # @return [Symbol]
+      attr_reader :action_name
 
       ##
       # What to parse the request body into.
+      # @return [Class] a swagger-able class type for a request body.
       attr_reader :request_body_class
       ##
       # What to parse the request query_params into.
+      # @return [Class] a swagger-able class type for query parameters.
       attr_reader :query_params_class
       ##
       # What to parse the path params into.
+      # @return [Class] a swagger-able class type for path parameters.
       attr_reader :path_params_class
 
       ##
       # Standard swagger tags.
+      #
+      # @overload tags()
+      #   Get the tags for this route.
+      #   @return [Array<String,Symbol>] the tags.
+      # @overload tags(*args)
+      #   Set the tags for this route.
+      #   @param tags [Array<String,Symbol>] the tags to set
+      #   @return [Array<String,Symbol>] the tags used
       def tags(*args)
         return @tags if args.empty?
 
@@ -34,8 +76,13 @@ module SoberSwag
 
       ##
       # Define the request body, using SoberSwag's type-definition scheme.
-      # The block passed will be used to define the body of a new sublcass of `base` (defaulted to {SoberSwag::InputObject}.)
-      # If you want, you can also define utility methods in here
+      # The block passed will be used to define the body of a new subclass of `base` (defaulted to {SoberSwag::InputObject}.)
+      # @overload request_body(base)
+      #   Give a Swagger-able type that will be used to parse the request body, and used in generated docs.
+      #   @param base [Class] a swagger-able class
+      # @overload request_body(base = SoberSwag::InputObject, &block)
+      #   Define a Swagger-able type inline to use to parse the request body.
+      #   @see SoberSwag.input_object
       def request_body(base = SoberSwag::InputObject, &block)
         @request_body_class = make_input_object!(base, &block)
         action_module.const_set('RequestBody', @request_body_class)
@@ -48,9 +95,12 @@ module SoberSwag
       end
 
       ##
-      # Define the shape of the query_params parameters, using SoberSwag's type-definition scheme.
-      # The block passed is the body of the newly-defined type.
-      # You can also include a base type.
+      # @overload query_params(base)
+      #   Give a Swagger-able type that will be used to parse the query params, and used in generated docs.
+      #   @param base [Class] a swagger-able class
+      # @overload query_params(base = SoberSwag::InputObject, &block)
+      #   Define a Swagger-able type inline to use to parse the query params.
+      #   @see SoberSwag.input_object
       def query_params(base = SoberSwag::InputObject, &block)
         @query_params_class = make_input_object!(base, &block)
         action_module.const_set('QueryParams', @query_params_class)
@@ -63,9 +113,12 @@ module SoberSwag
       end
 
       ##
-      # Define the shape of the *path* parameters, using SoberSwag's type-definition scheme.
-      # The block passed will be the body of a new subclass of `base` (defaulted to {SoberSwag::InputObject}).
-      # Names of this should match the names in the path template originally passed to {SoberSwag::Controller::Route.new}
+      # @overload path_params(base)
+      #   Give a Swagger-able type that will be used to parse the path params, and used in generated docs.
+      #   @param base [Class] a swagger-able class
+      # @overload path_params(base = SoberSwag::InputObject, &block)
+      #   Define a Swagger-able type inline to use to parse the path params.
+      #   @see SoberSwag.input_object
       def path_params(base = SoberSwag::InputObject, &block)
         @path_params_class = make_input_object!(base, &block)
         action_module.const_set('PathParams', @path_params_class)
@@ -78,19 +131,27 @@ module SoberSwag
       end
 
       ##
-      # Define the body of the action method in the controller.
-      def action(&body)
-        return @action if body.nil?
-
-        @action ||= body
-      end
-
+      # @overload description()
+      #   Get a description of this route object.
+      #   @return [String] markdown-formatted description
+      # @overload description(desc)
+      #   Set the description of this route object.
+      #   @param desc [String] markdown-formatted description
+      #   @return [String] `desc`.
       def description(desc = nil)
         return @description if desc.nil?
 
         @description = desc
       end
 
+      ##
+      # @overload summary()
+      #   Get the summary of this route object, a short string that identifies
+      #   what it does.
+      #   @return [String] markdown-formatted summary
+      # @overload summary(sum)
+      #   Set a short, markdown-formatted summary of what this route does.
+      #   @param sum [String] markdown-formatted summary
       def summary(sum = nil)
         return @summary if sum.nil?
 
@@ -100,14 +161,35 @@ module SoberSwag
       ##
       # The container module for all the constants this will eventually define.
       # Each class generated by this Route will be defined within this module.
+      # @return [Module] the module under which constants will be defined.
       def action_module
         @action_module ||= Module.new
       end
 
       ##
-      # Define a serializer for a response with the given status code.
-      # You may either give a serializer you defined elsewhere, or define one inline as if passed to
-      # {SoberSwag::OutputObject.define}
+      # @overload response(status_code, description, &block)
+      #   Define a new response from this route, by defining a serializer inline.
+      #   This serializer will be defined as if with {SoberSwag::OutputObject.define}
+      #
+      #   Generally, you want to define your serializers elsewhere for independent testing and such.
+      #   However, if you have a really quick thing to serialize, this works.
+      #   @param status_code [Symbol]
+      #     the name of the HTTP status of this response.
+      #   @param description [String]
+      #     a description of what this response is, markdown-formatted
+      #   @param block [Proc]
+      #     passed to {SoberSwag::OutputObject.define}
+      #
+      # @overload response(status_code, description, serializer)
+      #   Define a new response from this route, with an existing serializer.
+      #   The generated swagger will document this response's format using the serializer.
+      #
+      #   @param status_code [Symbol]
+      #     the name of the HTTP status of this response
+      #   @param description [String]
+      #     a description of what this response is, markdown-formatted
+      #   @param serializer [SoberSwag::Serializer::Base] a serializer to use for the
+      #     body of this response
       def response(status_code, description, serializer = nil, &block)
         status_key = Rack::Utils.status_code(status_code)
 
@@ -120,7 +202,8 @@ module SoberSwag
       end
 
       ##
-      # What you should call the module of this action in your controller
+      # What you should call the module of this action in your controller.
+      # @return [String]
       def action_module_name
         action_name.to_s.classify
       end