sober_swag 0.19.0 → 0.23.0

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

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/definition.rb

@@ -9,14 +9,56 @@ 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 "type key", which is basically a field that will be
+      # serialized out to a constant value.
+      #
+      # This is useful if you have multiple types you may want to serialize out, and want consumers of your API to distinguish between them.
+      #
+      # By default this will have the key "type" but you can set it with the keyword arg.
+      # ```ruby
+      #   type_key('MyObject')
+      #   # is equivalent to
+      #   field :type, SoberSwag::Serializer::Primitive.new(SoberSwag::Types::String.enum('MyObject')) do |_, _|
+      #   'MyObject'
+      #   end
+      # ```
+      # @param str [String, Symbol] the value to serialize (will be converted to a string)
+      # @param
+      def type_key(str, field_name: :type)
+        str = str.to_s
+        field(
+          field_name,
+          SoberSwag::Serializer::Primitive.new(
+            SoberSwag::Types::String.enum(str)
+          )
+        ) { |_, _| str }
+      end
+
+      ##
+      # 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 +73,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 +88,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