sober_swag 0.19.0 → 0.20.0

data/lib/sober_swag/nodes/nullable_primitive.rb

@@ -1,5 +1,8 @@
 module SoberSwag
   module Nodes
+    ##
+    # Exactly like a {SoberSwag::Nodes::Primitive} node, except it can be null.
+    # @todo: make this a boolean parameter of {SoberSwag::Nodes::Primitive}
     class NullablePrimitive < Primitive
     end
   end

data/lib/sober_swag/nodes/object.rb

@@ -2,8 +2,11 @@ module SoberSwag
   module Nodes
     ##
     # Objects might have attribute keys, so they're
-    # basically a list of attributes
+    # basically a list of attributes.
     class Object < SoberSwag::Nodes::Array
+      ##
+      # @return [Hash{Symbol => Array<SoberSwag::Nodes::Attribute>}]
+      #   the attributes, wrapped in an `attributes:` key.
       def deconstruct_keys(_)
         { attributes: @elements }
       end

data/lib/sober_swag/nodes/one_of.rb

@@ -1,11 +1,19 @@
 module SoberSwag
   module Nodes
     ##
-    # Swagges uses an array of OneOf types, so we
-    # transform our sum nodes into this
+    # OpenAPI v3 represents types that are a "choice" between multiple alternatives as an array.
+    # However, it is easier to model these as a sum type initially: if a type can be either an `A`, a `B`, or a `C`, we can model this as:
+    #
+    # `Sum.new(A, Sum.new(B, C))`.
+    #
+    # This means we only ever need to deal with two types at once.
+    # So, we initially serialize to a sum type, then later transform to this array type for further serialization.
     class OneOf < ::SoberSwag::Nodes::Array
+      ##
+      # @return [Hash{Symbol => SoberSwag::Nodes::Base}]
+      #   the alternatives, wrapped in an `alternatives:` key.
       def deconstruct_keys(_)
-        { alternatives: @elemenets }
+        { alternatives: @elements }
       end
     end
   end

data/lib/sober_swag/nodes/primitive.rb

@@ -1,27 +1,59 @@
 module SoberSwag
   module Nodes
     ##
-    # Root node of the tree
+    # Root node of the tree.
+    # This contains "primitive values."
+    # Initially, this is probably the types of attributes or array elements or whatever.
+    # As we use {#cata} to transform this, it will start containing swagger-compatible type objects.
+    #
+    # This node can contain metadata as well.
     class Primitive < Base
+      ##
+      # @param value [Object] the primitive value to store
+      # @param metadata [Hash] the metadata
       def initialize(value, metadata = {})
         @value = value
         @metadata = metadata
       end
 
-      attr_reader :value, :metadata
+      ##
+      # @return [Object] the contained value
+      attr_reader :value
 
+      ##
+      # @return [Hash] metadata associated with the contained value.
+      attr_reader :metadata
+
+      ##
+      # @see SoberSwag::Nodes::Base#map
+      #
+      # This will actually map over {#value}.
       def map(&block)
         self.class.new(block.call(value), metadata.dup)
       end
 
+      ##
+      # Deconstructs to the value and the metadata.
+      #
+      # @return [Array(Object, Hash)] containing value and metadata.
       def deconstruct
         [value, metadata]
       end
 
+      ##
+      # Wraps the attributes in a hash.
+      #
+      # @return [Hash{Symbol => Object, Hash}]
+      #   {#value} in `value:`, {#metadata} in `metadata:`
       def deconstruct_keys(_)
         { value: value, metadata: metadata }
       end
 
+      ##
+      # @see SoberSwag::Nodes::Base#cata
+      # As this is a root node, we actually call the block directly.
+      # @yieldparam node [SoberSwag::Nodes::Primitive] this node.
+      # @return whatever the block returns.
       def cata(&block)
         block.call(self.class.new(value, metadata))
       end

data/lib/sober_swag/nodes/sum.rb

@@ -1,5 +1,13 @@
 module SoberSwag
   module Nodes
+    ##
+    # A "Sum" type represents either one type or the other.
+    #
+    # It is called "Sum" because, if a type can be either type `A` or type `B`,
+    # the number of possible values for the type of `number_of_values(A) + number_of_values(B)`.
+    #
+    # Internally, this is primarily used when an object can be either one type or another.
+    # It will latter be flattened into {SoberSwag::Nodes::OneOf}
     class Sum < Binary
     end
   end

data/lib/sober_swag/output_object.rb

@@ -5,7 +5,7 @@ module SoberSwag
   # Create a serializer that is heavily inspired by the "Blueprinter" library.
   # This allows you to make "views" and such inside.
   #
-  # Under the hood, this is actually all based on {SoberSwag::Serialzier::Base}.
+  # Under the hood, this is actually all based on {SoberSwag::Serializer::Base}.
   class OutputObject < SoberSwag::Serializer::Base
     autoload(:Field, 'sober_swag/output_object/field')
     autoload(:Definition, 'sober_swag/output_object/definition')
@@ -20,7 +20,7 @@ module SoberSwag
     #
     #     PersonSerializer = SoberSwag::OutputObject.define do
     #       field :id, primitive(:Integer)
-    #       field :name, primtive(:String).optional
+    #       field :name, primitive(:String).optional
     #
     #       view :complex do
     #         field :age, primitive(:Integer)
@@ -32,9 +32,11 @@ module SoberSwag
     # However, this is only a hack to get rid of the weird naming issue when
     # generating swagger from dry structs: their section of the schema area
     # is defined by their *Ruby Class Name*. In the future, if we get rid of this,
-    # we might be able to keep this on the value-level, in which case {#define}
+    # we might be able to keep this on the value-level, in which case {.define}
     # can simply return an *instance* of SoberSwag::Serializer that does
     # the correct thing, with the name you give it. This works for now, though.
+    #
+    # @return [Class] the serializer generated.
     def self.define(&block)
       d = Definition.new.tap do |o|
         o.instance_eval(&block)
@@ -42,28 +44,51 @@ module SoberSwag
       new(d.fields, d.views, d.identifier)
     end
 
+    ##
+    # @param fields [Array<SoberSwag::OutputObject::Field>] the fields for this OutputObject
+    # @param views [Array<SoberSwag::OutputObject::View>] the views for this OutputObject
+    # @param identifier [String] the external identifier for this OutputObject
     def initialize(fields, views, identifier)
       @fields = fields
       @views = views
       @identifier = identifier
     end
 
-    attr_reader :fields, :views, :identifier
+    ##
+    # @return [Array<SoberSwag::OutputObject::Field>]
+    attr_reader :fields
+    ##
+    # @return [Array<SoberSwag::OutputObject::View>]
+    attr_reader :views
+    ##
+    # @return [String] the external ID to use for this object
+    attr_reader :identifier
 
+    ##
+    # Perform serialization.
     def serialize(obj, opts = {})
       serializer.serialize(obj, opts)
     end
 
+    ##
+    # Get a Dry::Struct of the type this OutputObject will serialize to.
     def type
       serializer.type
     end
 
+    ##
+    # Get a serializer for a single view contained in this output object.
+    # Note: given `:base`, it will return a serializer for the base OutputObject
+    # @param name [Symbol] the name of the view
+    # @return [SoberSwag::Serializer::Base] the serializer
     def view(name)
       return base_serializer if name == :base
 
       @views.find { |v| v.name == name }
     end
 
+    ##
+    # A serializer for the "base type" of this OutputObject, with no views.
     def base
       base_serializer
     end
@@ -72,6 +97,8 @@ module SoberSwag
     # Compile down this to an appropriate serializer.
     # It uses {SoberSwag::Serializer::Conditional} to do view-parsing,
     # and {SoberSwag::Serializer::FieldList} to do the actual serialization.
+    #
+    # @todo: optimize view selection to use binary instead of linear search
     def serializer # rubocop:disable Metrics/MethodLength
       @serializer ||=
         begin
@@ -92,10 +119,14 @@ module SoberSwag
         end
     end
 
+    ##
+    # @return [String]
     def to_s
       "<SoberSwag::OutputObject(#{identifier})>"
     end
 
+    ##
+    # @return [SoberSwag::Serializer::FieldList] serializer for this output object.
     def base_serializer
       @base_serializer ||= SoberSwag::Serializer::FieldList.new(fields).tap do |s|
         s.identifier(identifier)

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) }