sober_swag 0.15.0 → 0.20.0

data/lib/sober_swag/output_object/definition.rb

@@ -9,14 +9,30 @@ module SoberSwag
         @views = []
       end
 
-      attr_reader :fields, :views
+      ##
+      # @return [Array<SoberSwag::OutputObject::Field>]
+      attr_reader :fields
+
+      ##
+      # @return [Array<SoberSwag::OutputObject::View>]
+      attr_reader :views
 
       include FieldSyntax
 
+      ##
+      # Adds a new field to the fields array
+      # @param field [SoberSwag::OutputObject::Field]
       def add_field!(field)
         @fields << field
       end
 
+      ##
+      # Define a new view, with the view DSL
+      # @param name [Symbol] the name of the view
+      # @param inherits [Symbol] the name of another view this
+      #   view will "inherit" from
+      # @yieldself [SoberSwag::OutputObject::View]
+      # @return [nil] nothing interesting.
       def view(name, inherits: nil, &block)
         initial_fields =
           if inherits.nil? || inherits == :base
@@ -31,6 +47,14 @@ module SoberSwag
         @views << view
       end
 
+      ##
+      # @overload identifier()
+      #   Get the identifier of this output object.
+      #   @return [String] the identifier
+      # @overload identifier(arg)
+      #   Set the identifier of this output object.
+      #   @param arg [String] the external identifier to use for this OutputObject
+      #   @return [String] `arg`
       def identifier(arg = nil)
         @identifier = arg if arg
         @identifier
@@ -38,6 +62,12 @@ module SoberSwag
 
       private
 
+      ##
+      # Get the already-defined view with a specific name.
+      #
+      # @param name [Symbol] name of view to look up
+      # @return [SoberSwag::OutputObject::View] the view found
+      # @raise [ArgumentError] if no view with that name found
       def find_view(name)
         @views.find { |view| view.name == name } || (raise ArgumentError, "no view #{name.inspect} defined!")
       end

data/lib/sober_swag/output_object/field.rb

@@ -4,6 +4,18 @@ module SoberSwag
     # A single field in an output object.
     # Later used to make an actual serializer from this.
     class Field
+      ##
+      # @param name [Symbol] the name of this field
+      # @param serializer [SoberSwag::Serializer::Base, Proc, Lambda] how to serialize
+      #   the value in this field.
+      #   If given a `Proc` or `Lambda`, the `Proc` or `Lambda` should return
+      #   an instance of SoberSwag::Serializer::Base when called.
+      # @param from [Symbol] an optional parameter specifying
+      #   that this field should be plucked "from" another
+      #   attribute of a ruby object
+      # @param block [Proc] a proc to get this field from a serialized
+      #   object. If not given, will try to grab an attribute
+      #   with the same name, *or* with the name of `from:` if that was sent.
       def initialize(name, serializer, from: nil, &block)
         @name = name
         @root_serializer = serializer
@@ -11,12 +23,18 @@ module SoberSwag
         @block = block
       end
 
+      ##
+      # @return [Symbol] name of this field.
       attr_reader :name
 
+      ##
+      # @return [SoberSwag::Serializer::Base]
       def serializer
         @serializer ||= resolved_serializer.serializer.via_map(&transform_proc)
       end
 
+      ##
+      # @return [SoberSwag::Serializer::Base]
       def resolved_serializer
         if @root_serializer.is_a?(Proc)
           @root_serializer.call
@@ -27,17 +45,19 @@ module SoberSwag
 
       private
 
-      def transform_proc # rubocop:disable Metrics/MethodLength
-        if @block
-          @block
-        else
-          key = @from || @name
-          proc do |object, _|
-            if object.respond_to?(key)
-              object.public_send(key)
-            else
-              object[key]
-            end
+      ##
+      # @return [Proc]
+      def transform_proc
+        return @transform_proc if defined?(@transform_proc)
+
+        return @transform_proc = @block if @block
+
+        key = @from || @name
+        @transform_proc = proc do |object, _|
+          if object.respond_to?(key)
+            object.public_send(key)
+          else
+            object[key]
           end
         end
       end

data/lib/sober_swag/output_object/field_syntax.rb

@@ -3,6 +3,13 @@ module SoberSwag
     ##
     # Syntax for definitions that can add fields.
     module FieldSyntax
+      ##
+      # Defines a new field.
+      # @see SoberSwag::OutputObject::Field#initialize
+      # @param name [Symbol] name of this field
+      # @param serializer [SoberSwag::Serializer::Base] serializer to use for this field.
+      # @param from [Symbol] method name to extract this field from, for convenience.
+      # @param block [Proc] optional way to extract this field.
       def field(name, serializer, from: nil, &block)
         add_field!(Field.new(name, serializer, from: from, &block))
       end
@@ -10,22 +17,31 @@ module SoberSwag
       ##
       # Similar to #field, but adds multiple at once.
       # Named #multi because #fields was already taken.
+      #
+      # @param names [Array<Symbol>] the field names to add.
+      # @param serializer [SoberSwag::Serializer::Base] the serializer to use for all fields.
       def multi(names, serializer)
         names.each { |name| field(name, serializer) }
       end
 
       ##
       # Given a symbol to this, we will use a primitive name
+      # @param name [Symbol] symbol to look up.
+      # @return [SoberSwag::Serializer::Base] serializer to use.
       def primitive(name)
         SoberSwag::Serializer.primitive(SoberSwag::Types.const_get(name))
       end
 
       ##
       # Merge in anything that has a list of fields, and use it.
-      # Note that merging in a full blueprint *will not* also merge in views, just fields defined on the base.
-      def merge(other)
+      # Note that merging in a full output object *will not* also merge in views, just fields defined on the base.
+      #
+      # @param other [#fields] a field container, like a {SoberSwag::OutputObject} or something
+      # @param except [Array<Symbol>] optionally exclude a field from the output object being merged
+      # @return [void]
+      def merge(other, except: [])
         other.fields.each do |field|
-          add_field!(field)
+          add_field!(field) unless except.include?(field.name)
         end
       end
     end

data/lib/sober_swag/output_object/view.rb

@@ -3,44 +3,87 @@ module SoberSwag
     ##
     # DSL for defining a view.
     # Used in `view` blocks within {SoberSwag::OutputObject.define}.
+    #
+    # Views are "variants" of {SoberSwag::OutputObject}s that contain
+    # different fields.
     class View < SoberSwag::Serializer::Base
+      ##
+      # Define a new view with the given base fields.
+      # @param name [Symbol] name for this view
+      # @param base_fields [Array<SoberSwag::OutputObject::Field>] fields already defined
+      # @yieldself [SoberSwag::OutputObject::View]
+      #
+      # @return [SoberSwag::OutputObject::View]
       def self.define(name, base_fields, &block)
         new(name, base_fields).tap do |view|
           view.instance_eval(&block)
         end
       end
 
+      ##
+      # An error thrown when you try to nest views inside views.
       class NestingError < Error; end
 
       include FieldSyntax
 
+      ##
+      # @param name [Sybmol] name for this view.
+      # @param base_fields [Array<SoberSwag::OutputObject::Field>] already-defined fields.
       def initialize(name, base_fields = [])
         @name = name
         @fields = base_fields.dup
       end
 
-      attr_reader :name, :fields
+      ##
+      # @return [Symbol] the name of this view
+      attr_reader :name
+
+      ##
+      # @return [Array<SoberSwag::OutputObject::Fields>] the fields defined in this view.
+      attr_reader :fields
 
+      ##
+      # Serialize an object according to this view.
+      # @param object what to serialize
+      # @param opts [Hash] arbitrary options
+      # @return [Hash] the serialized result
       def serialize(obj, opts = {})
         serializer.serialize(obj, opts)
       end
 
+      ##
+      # Get the type of this view.
+      # @return [Class] the type, a subclass of {Dry::Struct}
       def type
         serializer.type
       end
 
+      ##
+      # Excludes a field with the given name from this view.
+      # @param name [Symbol] field to exclude.
+      # @return [nil] nothing interesting
       def except!(name)
         @fields.reject! { |f| f.name == name }
       end
 
+      ##
+      # Always raises {NestingError}
+      # @raise {NestingError} always
       def view(*)
         raise NestingError, 'no views in views'
       end
 
+      ##
+      # Adds a field do this view.
+      # @param field [SoberSwag::OutputObject::Field]
+      # @return [nil] nothing interesting
       def add_field!(field)
         @fields << field
       end
 
+      ##
+      # Pretty show for humans
+      # @return [String]
       def to_s
         "<SoberSwag::OutputObject::View(#{identifier})>"
       end
@@ -48,6 +91,8 @@ module SoberSwag
       ##
       # Get the serializer defined by this view.
       # WARNING: Don't add more fields after you call this.
+      #
+      # @return [SoberSwag::Serializer::FieldList]
       def serializer
         @serializer ||=
           SoberSwag::Serializer::FieldList.new(fields).tap { |s| s.identifier(identifier) }

data/lib/sober_swag/parser.rb

@@ -1,13 +1,19 @@
 module SoberSwag
   ##
   # Parses a *Dry-Types Schema* into a set of nodes we can use to compile.
-  # This is mostly because the vistior pattern sucks and catamorphisms are nice.
+  # This is mostly because the visitor pattern sucks and catamorphisms are nice.
+  #
+  # Do not use this class directly, as it is not part of the public api.
+  # Instead, use classes from the {SoberSwag::Compiler} namespace.
   class Parser
     def initialize(node)
       @node = node
       @found = Set.new
     end
 
+    ##
+    # Compile to one of our internal nodes.
+    # @return [SoberSwag::Nodes::Base] the node that describes this type.
     def to_syntax # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
       case @node
       when Dry::Types::Default

data/lib/sober_swag/serializer/array.rb

@@ -1,30 +1,54 @@
 module SoberSwag
   module Serializer
     ##
-    # Make a serialize of arrays out of a serializer of the elements
+    # Transform a serializer that works on elements to one that works on Arrays
     class Array < Base
+      ##
+      # Make an array serializer out of another serializer.
+      # @param element_serializer [SoberSwag::Serializer::Base] the serializer to use for each element.
       def initialize(element_serializer)
         @element_serializer = element_serializer
       end
 
+      ##
+      # The serializer that will be used for each element in the array.
+      #
+      # @return [SoberSwag::Serializer::Base]
+      attr_reader :element_serializer
+
+      ##
+      # Delegates to {#element_serializer}
       def lazy_type?
         @element_serializer.lazy_type?
       end
 
+      ##
+      # Delegates to {#element_serializer}, wrapped in an array
       def lazy_type
         SoberSwag::Types::Array.of(@element_serializer.lazy_type)
       end
 
+      ##
+      # Delegates to {#element_serializer}
       def finalize_lazy_type!
         @element_serializer.finalize_lazy_type!
       end
 
-      attr_reader :element_serializer
-
+      ##
+      # Serialize an array of objects that can be serialized with {#element_serializer}
+      # by calling `element_serializer.serialize` for each item in this array.
+      #
+      # Note: since ruby is duck-typed, anything that responds to the `#map` method from
+      # [Enumerable](https://ruby-doc.org/core-3.0.0/Enumerable.html) should work!
+      #
+      # @param object [Array<Object>,#map] collection of objects to serialize
+      # @return [Array<Object>] JSON-compatible array
       def serialize(object, options = {})
         object.map { |a| element_serializer.serialize(a, options) }
       end
 
+      ##
+      # The type of items returned from {#serialize}
       def type
         SoberSwag::Types::Array.of(element_serializer.type)
       end

data/lib/sober_swag/serializer/base.rb

@@ -1,34 +1,91 @@
 module SoberSwag
   module Serializer
     ##
-    # Base interface class that all other serializers are subclasses of.
-    # This also defines methods as stubs, which is sort of bad ruby style, but makes documentation
-    # easier to generate.
+    # Base class for everything that provides serialization functionality in SoberSwag.
+    # SoberSwag serializers transform Ruby types into JSON types, with some associated *schema*.
+    # This schema is then used in the generated OpenAPI V3 documentation.
     class Base
       ##
       # Return a new serializer that is an *array* of elements of this serializer.
+      # This serializer will take in an array, and use `self` to serialize every element.
+      #
+      # @return [SoberSwag::Serializer::Array]
       def array
         SoberSwag::Serializer::Array.new(self)
       end
 
       ##
-      # Returns a serializer that will pass `nil` values on unscathed
+      # Returns a serializer that will pass `nil` values on unscathed.
+      # That means that if you try to serialize `nil` with it, it will result in a JSON `null`.
+      # @return [SoberSwag::Serializer::Optional]
       def optional
         SoberSwag::Serializer::Optional.new(self)
       end
 
       alias nilable optional
 
+      ##
+      # Add metadata onto the *type* of a serializer.
+      # Note that this *returns a new serializer with metadata added* and does not perform mutation.
+      # @param hash [Hash] the metadata to set.
+      # @return [SoberSwag::Serializer::Meta] a serializer with metadata added
+      def meta(hash)
+        SoberSwag::Serializer::Meta.new(self, hash)
+      end
+
+      ##
+      # Get a new serializer that will first run the given block before serializing an object.
+      # For example, if you have a serializer for strings called `StringSerializer`,
+      # and you want to serialize `Date` objects via encoding them to a standardized string format,
+      # you can use:
+      #
+      # ```
+      #   DateSerializer = StringSerializer.via_map do |date|
+      #     date.strftime('%Y-%m-%d')
+      #   end
+      # ```
+      #
+      # @yieldparam [Object] the object before serialization
+      # @yieldreturn [Object] a transformed object, that will
+      #   be passed to {#serialize}
+      # @return [SoberSwag::Serializer::Mapped] the new serializer
+      def via_map(&block)
+        SoberSwag::Serializer::Mapped.new(self, block)
+      end
+
       ##
       # Is this type lazily defined?
       #
-      # Used for mutual recursion.
+      # If we have two serializers that are *mutually recursive*, we need to do some "fun" magic to make that work.
+      # This comes up in a case like:
+      #
+      # ```ruby
+      #   SchoolClass = SoberSwag::OutputObject.define do
+      #     field :name, primitive(:String)
+      #     view :detail do
+      #       field :students, -> { Student.view(:base) }
+      #     end
+      #   end
+      #
+      #   Student = SoberSwag::OutputObject.define do
+      #     field :name, primitive(:String)
+      #     view :detail do
+      #       field :classes, -> { SchoolClass.view(:base) }
+      #     end
+      #   end
+      # ```
+      #
+      # This would result in an infinite loop if we tried to define the type struct the easy way.
+      # So, we instead use mutation to achieve "laziness."
       def lazy_type?
         false
       end
 
       ##
       # The lazy version of this type, for mutual recursion.
+      # @see #lazy_type? for why this is needed
+      #
+      # Once you call {#finalize_lazy_type!}, the type will be "fleshed out," and can be actually used.
       def lazy_type
         type
       end
@@ -43,43 +100,36 @@ module SoberSwag
 
       ##
       # Serialize an object.
+      # @abstract
       def serialize(_object, _options = {})
         raise ArgumentError, 'not implemented!'
       end
 
       ##
       # Get the type that we serialize to.
+      # @abstract
       def type
         raise ArgumentError, 'not implemented!'
       end
 
       ##
-      # Add metadata onto the *type* of a serializer.
-      def meta(hash)
-        SoberSwag::Serializer::Meta.new(self, hash)
-      end
-
-      ##
-      # If I am a serializer for type 'a', and you give me a way to turn 'a's into 'b's,
-      # I can give you a serializer for type 'b' by running the funciton you gave.
-      # For example, if I am a serializer for {String}, and you know how to turn
-      # an {Int} into a {String}, I can now serialize {Int}s (by turning them into a string).
+      # Returns self.
       #
-      # Note that the *declared* type of this is *not* changed: from a user's perspective,
-      # they see a "string"
-      def via_map(&block)
-        SoberSwag::Serializer::Mapped.new(self, block)
-      end
-
-      ##
-      # Serializer lets you get a serializer from things that might be classes
-      # because of the blueprint naming hack.
+      # This exists due to a hack.
       def serializer
         self
       end
 
       ##
-      # Get the type name of this to be used externally, or set it if an argument is provided
+      # @overload identifier()
+      #   Returns the external identifier, used to uniquely identify this object within
+      #   the schemas section of an OpenAPI v3 document.
+      #   @return [String] the identifier.
+      # @overload identifier(arg)
+      #   Sets the external identifier to use to uniquely identify
+      #   this object within the schemas section of an OpenAPI v3 document.
+      #   @param arg [String] the identifier to use
+      #   @return [String] the identifer set
       def identifier(arg = nil)
         @identifier = arg if arg
         @identifier