sober_swag 0.15.0 → 0.20.0

data/lib/sober_swag/controller/route.rb

@@ -3,34 +3,89 @@ 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
         @action_name = action_name
         @response_serializers = {}
         @response_descriptions = {}
+        @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
 
       ##
-      # What to parse the request body in to.
+      # 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 in to
+      # 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
+      # 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?
+
+        @tags = args.flatten
+      end
+
       ##
       # 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('ResponseBody', @request_body_class)
+        action_module.const_set('RequestBody', @request_body_class)
       end
 
       ##
@@ -40,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)
@@ -55,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)
@@ -70,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?
 
@@ -92,18 +161,39 @@ 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)
 
-        raise ArgumentError, 'Response defiend!' if @response_serializers.key?(status_key)
+        raise ArgumentError, 'Response defined!' if @response_serializers.key?(status_key)
 
         serializer ||= SoberSwag::OutputObject.define(&block)
         response_module.const_set(status_code.to_s.classify, serializer)
@@ -112,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
@@ -124,8 +215,22 @@ module SoberSwag
       end
 
       def make_input_object!(base, &block)
-        Class.new(base, &block).tap do |e|
-          e.transform_keys(&:to_sym) if [SoberSwag::InputObject, Dry::Struct].include?(base)
+        if base.is_a?(Class)
+          make_input_class(base, block)
+        elsif block
+          raise ArgumentError, 'passed a non-class base and a block to an input'
+        else
+          base
+        end
+      end
+
+      def make_input_class(base, block)
+        if block
+          Class.new(base, &block).tap do |e|
+            e.transform_keys(&:to_sym) if [SoberSwag::InputObject, Dry::Struct].include?(base)
+          end
+        else
+          base
         end
       end
     end

data/lib/sober_swag/input_object.rb

@@ -1,6 +1,6 @@
 module SoberSwag
   ##
-  # A variant of Dry::Struct that allows you to set a "model name" that is publically visible.
+  # A variant of Dry::Struct that allows you to set a "model name" that is publicly visible.
   # If you do not set one, it will be the Ruby class name, with any '::' replaced with a '.'.
   #
   # This otherwise behaves exactly like a Dry::Struct.
@@ -12,12 +12,67 @@ module SoberSwag
     class << self
       ##
       # The name to use for this type in external documentation.
-      def identifier(arg = nil)
-        @identifier = arg if arg
+      #
+      # @param new_ident [String] what to call this InputObject in external documentation.
+      def identifier(new_ident = nil)
+        @identifier = new_ident if new_ident
 
         @identifier || name.to_s.gsub('::', '.')
       end
 
+      ##
+      # @overload attribute(key, parent = SoberSwag::InputObject, &block)
+      #   Defines an attribute as a direct sub-object.
+      #   This block will be called as in {SoberSwag.input_object}.
+      #   This might be useful in a case like the following:
+      #
+      #   ```ruby
+      #   class Classroom < SoberSwag::InputObject
+      #     attribute :biographical_detail do
+      #       attribute :student_name, primitive(:String)
+      #     end
+      #   end
+      #   ```
+      #
+      #   @param key [Symbol] the attribute name
+      #   @param parent [Class] the parent class to use for the sub-object
+      # @overload attribute(key, type)
+      #   Defines a new attribute with the given type.
+      #   @param key [Symbol] the attribute name
+      #   @param type the attribute type
+      def attribute(key, parent = SoberSwag::InputObject, &block)
+        raise ArgumentError, "parent class #{parent} is not an input object type!" unless valid_field_def?(parent, block)
+
+        super(key, parent, &block)
+      end
+
+      ##
+      # @overload attribute(key, parent = SoberSwag::InputObject, &block)
+      #   Defines an optional attribute by defining a sub-object inline.
+      #   This differs from a nil-able attribute as it can be *not provided*, while nilable attributes must be set to `null`.
+      #
+      #   Yields to the block like in {SoberSwag.input_object}
+      #
+      #   @param key [Symbol] the attribute name
+      #   @param parent [Class] the parent class to use for the sub-object
+      # @overload attribute(key, type)
+      #   Defines an optional attribute with a given type.
+      #   This differs from a nil-able attribute as it can be *not provided*, while nilable attributes must be set to `null`.
+      #
+      #   @param key [Symbol] the attribute name
+      #   @param type the attribute type, another parsable object.
+      def attribute?(key, parent = SoberSwag::InputObject, &block)
+        raise ArgumentError, "parent class #{parent} is not an input object type!" unless valid_field_def?(parent, block)
+
+        super(key, parent, &block)
+      end
+
+      ##
+      # Add metadata keys, like `:description`, to the defined type.
+      # Note: does NOT mutate the type, returns a new type with the metadata added.
+      #
+      # @param args [Hash] the argument values
+      # @return [SoberSwag::InputObject] the new input object class
       def meta(*args)
         original = self
 
@@ -29,12 +84,67 @@ module SoberSwag
         end
       end
 
-      def primitive(sym)
-        SoberSwag::Types.const_get(sym)
+      ##
+      # Convenience method: you can use `.primitive` get a primitive parser for a given type.
+      # This lets you write:
+      #
+      #  ```ruby
+      #  class Foo < SoberSwag::InputObject
+      #    attribute :bar, primitive(:String)
+      #  end
+      #  ```
+      #
+      # instead of
+      #
+      # ```ruby
+      # class Foo < SoberSwag::InputObject
+      #   attribute :bar, SoberSwag::Types::String
+      # end
+      # ```
+      #
+      # @param args [Symbol] a symbol
+      # @return a primitive parser
+      def primitive(*args)
+        if args.length == 1
+          SoberSwag::Types.const_get(args.first)
+        else
+          super
+        end
+      end
+
+      ##
+      # Convenience method: you can use `.param` to get a parameter parser of a given type.
+      # Said parsers are more loose: for example, `param(:Integer)` will parse the string `"10"` into `10`, while
+      # `primitive(:Integer)` will throw an error.
+      #
+      # This method lets you write:
+      #
+      # ```ruby
+      # class Foo < SoberSwag::InputObject
+      #   attribute :bar, param(:Integer)
+      # end
+      # ```
+      #
+      # instead of
+      #
+      # ```ruby
+      # class Foo < SoberSwag::InputObject
+      #   attribute :bar, SoberSwag::Types::Param::Integer
+      # end
+      # ```
+      #
+      # @param name [Symbol] the name of the parameter type to get
+      # @return a parameter parser
+      def param(name)
+        SoberSwag::Types::Params.const_get(name)
       end
 
-      def param(sym)
-        SoberSwag::Types::Params.const_get(sym)
+      private
+
+      def valid_field_def?(parent, block)
+        return true if block.nil?
+
+        parent.is_a?(Class) && parent <= SoberSwag::InputObject
       end
     end
   end

data/lib/sober_swag/nodes/array.rb

@@ -10,18 +10,37 @@ module SoberSwag
 
       attr_reader :elements
 
+      ##
+      # @see SoberSwag::Nodes::Array#map
+      #
       def map(&block)
         self.class.new(elements.map { |elem| elem.map(&block) })
       end
 
+      ##
+      # @see SoberSwag::Nodes::Array#cata
+      #
+      # The block will be called with each element contained in this array node in turn, then called with a {SoberSwag::Nodes::Array} constructed
+      # from the resulting values.
+      #
+      # @return whatever the block yields.
       def cata(&block)
         block.call(self.class.new(elements.map { |elem| elem.cata(&block) }))
       end
 
+      ##
+      # Deconstructs into the elements.
+      #
+      # @return [Array<SoberSwag::Nodes::Base>]
       def deconstruct
         @elements
       end
 
+      ##
+      # Deconstruction for pattern-matching
+      #
+      # @return [Hash{Symbol => ::Array<SoberSwag::Nodes::Base>}]
+      #   a hash with the elements in the `:elements` key.
       def deconstruct_keys(_keys)
         { elements: @elements }
       end

data/lib/sober_swag/nodes/attribute.rb

@@ -1,8 +1,16 @@
 module SoberSwag
   module Nodes
     ##
-    # One attribute of an object.
+    # This is a node for one attribute of an object.
+    # An object type is represented by a `SoberSwag::Nodes::Object` full of these keys.
+    #
+    #
     class Attribute < Base
+      ##
+      # @param key [Symbol] the key of this attribute
+      # @param required [Boolean] if this attribute must be set or not
+      # @param value [Class] the type of this attribute
+      # @param meta [Hash] the metadata associated with this attribute
       def initialize(key, required, value, meta = {})
         @key = key
         @required = required
@@ -10,22 +18,55 @@ module SoberSwag
         @meta = meta
       end
 
+      ##
+      # Deconstruct into the {#key}, {#required}, {#value}, and {#meta} attributes
+      # of this {Attribute} object.
+      #
+      # @return [Array(Symbol, Boolean, Class, Hash)] the attributes of this object
       def deconstruct
         [key, required, value, meta]
       end
 
-      def deconstruct_keys
+      ##
+      # Deconstructs into {#key}, {#required}, {#value}, and {#meta} attributes, as a
+      # hash with the attribute names as the keys.
+      #
+      # @param _keys [void] ignored
+      # @return [Hash] the attributes as keys.
+      def deconstruct_keys(_keys)
         { key: key, required: required, value: value, meta: meta }
       end
 
-      attr_reader :key, :required, :value, :meta
+      ##
+      # @return [Symbol]
+      attr_reader :key
 
+      ##
+      # @return [Boolean] true if this attribute must be set, false otherwise.
+      attr_reader :required
+
+      ##
+      # @return [Class] the type of this attribute
+      attr_reader :value
+
+      ##
+      # @return [Hash] the metadata for this attribute.
+      attr_reader :meta
+
+      ##
+      # @see SoberSwag::Nodes::Base#map
       def map(&block)
         self.class.new(key, required, value.map(&block), meta)
       end
 
+      ##
+      # @see SoberSwag::Nodes::Base#cata
       def cata(&block)
-        block.call(self.class.new(key, required, value.cata(&block), meta))
+        block.call(
+          self.class.new(
+            key, required, value.cata(&block), meta
+          )
+        )
       end
     end
   end