sober_swag 0.19.0 → 0.20.0

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,24 +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
 
@@ -42,8 +85,25 @@ module SoberSwag
       end
 
       ##
-      # .primitive is already defined on Dry::Struct, so forward to the superclass if
-      # not called as a way to get a primitive type
+      # 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)
@@ -52,8 +112,31 @@ module SoberSwag
         end
       end
 
-      def param(sym)
-        SoberSwag::Types::Params.const_get(sym)
+      ##
+      # 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
 
       private

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

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)