sober_swag 0.15.0 → 0.20.0

data/lib/sober_swag/nodes/base.rb

@@ -1,28 +1,44 @@
 module SoberSwag
   module Nodes
     ##
+    # @abstract
     # Base Node that all other nodes inherit from.
     # All nodes should define the following:
     #
-    # - #deconstruct, which returns an array of *everything needed to idenitfy the node.*
+    #
+    # - `#deconstruct`, which returns an array of *everything needed to identify the node.*
     #   We base comparisons on the result of deconstruction.
-    # - #deconstruct_keys, which returns a hash of *everything needed to identify the node*.
+    # - `#deconstruct_keys`, which returns a hash of *everything needed to identify the node*.
     #   We use this later.
     class Base
       include Comparable
 
       ##
       # Value-level comparison.
+      # Returns `-1`, `0`, or `+1`
+      # if this object is less than, equal to, or greater than `other`.
+      #
+      # @param other [Object] the other object
+      #
+      # @return [Integer]
+      #   comparison result
       def <=>(other)
-        return other.class.name <=> self.class.name unless other.class == self.class
+        return other.class.name <=> self.class.name unless other.instance_of?(self.class)
 
         deconstruct <=> other.deconstruct
       end
 
+      ##
+      # Is this object equal to the other object?
+      # @param other [Object] the object to compare
+      # @return [Boolean] yes or no
       def eql?(other)
         deconstruct == other.deconstruct
       end
 
+      ##
+      # Standard hash key.
+      # @return [Integer]
       def hash
         deconstruct.hash
       end
@@ -37,17 +53,21 @@ module SoberSwag
       #
       # When working with these definition nodes, we very often want to transform something recursively.
       # This method allows us to do so by focusing on a single level at a time, keeping the actual recursion *abstract*.
+      #
+      # @yieldparam node nodes contained within this node, from the bottom-up.
+      #   This block will first transform the innermost node, then the second layer, and so on, until we get to the node you originally called `#cata` on.
+      # @yieldreturn [Object] the object you wish to transform into.
       def cata
         raise ArgumentError, 'Base is abstract'
       end
 
+      ##
+      # Map over the inner, contained type of this node.
+      # This will *only* map over values wrapped in a `SoberSwag::Nodes::Primitive` object.
+      # Unlike {#cata}, it does not transform the entire node tree.
       def map
         raise ArgumentError, 'Base is abstract'
       end
-
-      def flatten_one_ofs
-        raise ArgumentError, 'Base is abstract'
-      end
     end
   end
 end

data/lib/sober_swag/nodes/binary.rb

@@ -1,37 +1,43 @@
 module SoberSwag
   module Nodes
     ##
-    # A
-    #
-    # It's cool I promise.
+    # A binary node: has a left and right hand side.
+    # Basically a node of a binary tree.
     class Binary < Base
+      ##
+      # @param lhs [SoberSwag::Nodes::Base] the left-hand node.
+      # @param rhs [SoberSwag::Nodes::Base] the right-hand node.
       def initialize(lhs, rhs)
         @lhs = lhs
         @rhs = rhs
       end
 
-      attr_reader :lhs, :rhs
+      ##
+      # @return [SoberSwag::Nodes::Base] the left-hand node
+      attr_reader :lhs
 
       ##
-      # Map the root values of the node.
-      # This just calls map on the lhs and the rhs
-      def map(&block)
-        self.class.new(
-          lhs.map(&block),
-          rhs.map(&block)
-        )
-      end
+      # @return [SoberSwag::Nodes::Base] the right-hand node
+      attr_reader :rhs
 
+      ##
+      # Deconstructs into an array of `[lhs, rhs]`
+      #
+      # @return [Array(SoberSwag::Nodes::Base, SoberSwag::Nodes::Base)]
       def deconstruct
         [lhs, rhs]
       end
 
+      ##
+      # Deconstruct into a hash of attributes.
       def deconstruct_keys(_keys)
         { lhs: lhs, rhs: rhs }
       end
 
       ##
-      # Perform a catamorphism on this node.
+      # @see SoberSwag::Nodes::Base#cata
+      #
+      # Maps over the LHS side first, then the RHS side, then the root.
       def cata(&block)
         block.call(
           self.class.new(
@@ -40,6 +46,17 @@ module SoberSwag
           )
         )
       end
+
+      ##
+      # @see SoberSwag::Nodes::Base#map
+      #
+      # Maps over the LHS side first, then the RHS side, then the root.
+      def map(&block)
+        self.class.new(
+          lhs.map(&block),
+          rhs.map(&block)
+        )
+      end
     end
   end
 end

data/lib/sober_swag/nodes/enum.rb

@@ -2,26 +2,41 @@ module SoberSwag
   module Nodes
     ##
     # Compiler node to represent an enum value.
-    # Enums are special enough to have their own node.
+    # Enums are special enough to have their own node, as they are basically a constant list of always-string values.
     class Enum < Base
       def initialize(values)
         @values = values
       end
 
+      ##
+      # @return [Array<Symbol,String>] values of the enum.
       attr_reader :values
 
+      ##
+      # Since there is nothing to map over, this node will never actually call the block given.
+      #
+      # @see SoberSwag::Nodes::Base#map
       def map
         dup
       end
 
+      ##
+      # Deconstructs into the enum values.
+      #
+      # @return [Array(Array<Symbol,String>)] the cases of the enum.
       def deconstruct
         [values]
       end
 
+      ##
+      # @return [Hash{Symbol => Array<Symbol,String>}]
+      #   the values, wrapped in a `values:` key.
       def deconstruct_keys(_keys)
         { values: values }
       end
 
+      ##
+      # @see SoberSwag::Nodes::Base#cata
       def cata(&block)
         block.call(dup)
       end

data/lib/sober_swag/nodes/list.rb

@@ -6,21 +6,37 @@ module SoberSwag
     # Unlike {SoberSwag::Nodes::Array}, this actually models arrays.
     # The other one is a node that *is* an array in terms of what it contains.
     # Kinda confusing, but oh well.
+    #
+    # @todo swap the names of this and {SoberSwag::Nodes::Array} so it's less confusing.
     class List < Base
+      ##
+      # Initialize with a node representing the type of elements in the list.
+      # @param element [SoberSwag::Nodes::Base] the type
       def initialize(element)
         @element = element
       end
 
+      ##
+      # @return [SoberSwag::Nodes::Base]
       attr_reader :element
 
+      ##
+      # @return [Array(SoberSwag::Nodes::Base)]
       def deconstruct
         [element]
       end
 
+      ##
+      # @return [Hash{Symbol => SoberSwag::Nodes::Base}]
+      #   the contained type wrapped in an `element:` key.
       def deconstruct_keys(_)
         { element: element }
       end
 
+      ##
+      # @see SoberSwag::Nodes::Base#cata
+      #
+      # Maps over the element type, then this `List` type.
       def cata(&block)
         block.call(
           self.class.new(
@@ -29,6 +45,10 @@ module SoberSwag
         )
       end
 
+      ##
+      # @see SoberSwag::Nodes::Base#map
+      #
+      # Maps over the element type.
       def map(&block)
         self.class.new(
           element.map(&block)

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)