sober_swag 0.11.0 → 0.16.0

data/lib/sober_swag/controller.rb

@@ -17,12 +17,6 @@ module SoberSwag
       include ::Dry::Types()
     end
 
-    included do
-      rescue_from Dry::Struct::Error do
-        head :bad_request
-      end
-    end
-
     class_methods do
       ##
       # Define a new action with the given HTTP method, action name, and path.
@@ -96,7 +90,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedPathError unless r&.path_params_class
 
-          r.path_params_class.new(request.path_parameters)
+          r.path_params_class.call(request.path_parameters)
         end
     end
 
@@ -110,7 +104,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedBodyError unless r&.request_body_class
 
-          r.request_body_class.new(body_params)
+          r.request_body_class.call(body_params)
         end
     end
 
@@ -124,7 +118,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedQueryError unless r&.query_params_class
 
-          r.query_params_class.new(request.query_parameters)
+          r.query_params_class.call(request.query_parameters)
         end
     end
 

data/lib/sober_swag/controller/route.rb

@@ -14,14 +14,13 @@ module SoberSwag
       attr_reader :response_serializers, :response_descriptions, :controller, :method, :path, :action_name
 
       ##
-      # What to parse the request body in to.
+      # What to parse the request body into.
       attr_reader :request_body_class
       ##
-      # What to parse the request query_params in to
+      # What to parse the request query_params into.
       attr_reader :query_params_class
-
       ##
-      # What to parse the path params into
+      # What to parse the path params into.
       attr_reader :path_params_class
 
       ##
@@ -30,7 +29,7 @@ module SoberSwag
       # If you want, you can also define utility methods in here
       def request_body(base = SoberSwag::InputObject, &block)
         @request_body_class = make_input_object!(base, &block)
-        action_module.const_set('ResponseBody', @request_body_class)
+        action_module.const_set('RequestBody', @request_body_class)
       end
 
       ##
@@ -103,7 +102,7 @@ module SoberSwag
       def response(status_code, description, serializer = nil, &block)
         status_key = Rack::Utils.status_code(status_code)
 
-        raise ArgumentError, 'Response defiend!' if @response_serializers.key?(status_key)
+        raise ArgumentError, 'Response defined!' if @response_serializers.key?(status_key)
 
         serializer ||= SoberSwag::OutputObject.define(&block)
         response_module.const_set(status_code.to_s.classify, serializer)
@@ -124,8 +123,22 @@ module SoberSwag
       end
 
       def make_input_object!(base, &block)
-        Class.new(base, &block).tap do |e|
-          e.transform_keys(&:to_sym) if [SoberSwag::InputObject, Dry::Struct].include?(base)
+        if base.is_a?(Class)
+          make_input_class(base, block)
+        elsif block
+          raise ArgumentError, 'passed a non-class base and a block to an input'
+        else
+          base
+        end
+      end
+
+      def make_input_class(base, block)
+        if block
+          Class.new(base, &block).tap do |e|
+            e.transform_keys(&:to_sym) if [SoberSwag::InputObject, Dry::Struct].include?(base)
+          end
+        else
+          base
         end
       end
     end

data/lib/sober_swag/input_object.rb

@@ -7,22 +7,62 @@ module SoberSwag
   # Please see the documentation for that class to see how it works.
   class InputObject < Dry::Struct
     transform_keys(&:to_sym)
+    include SoberSwag::Type::Named
 
     class << self
       ##
       # The name to use for this type in external documentation.
       def identifier(arg = nil)
         @identifier = arg if arg
+
         @identifier || name.to_s.gsub('::', '.')
       end
 
-      def primitive(sym)
-        SoberSwag::Types.const_get(sym)
+      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
+
+      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
+
+      def meta(*args)
+        original = self
+
+        super(*args).tap do |result|
+          return result unless result.is_a?(Class)
+
+          result.define_singleton_method(:alias?) { true }
+          result.define_singleton_method(:alias_of) { original }
+        end
+      end
+
+      ##
+      # .primitive is already defined on Dry::Struct, so forward to the superclass if
+      # not called as a way to get a primitive type
+      def primitive(*args)
+        if args.length == 1
+          SoberSwag::Types.const_get(args.first)
+        else
+          super
+        end
       end
 
       def param(sym)
         SoberSwag::Types::Params.const_get(sym)
       end
+
+      private
+
+      def valid_field_def?(parent, block)
+        return true if block.nil?
+
+        parent.is_a?(Class) && parent <= SoberSwag::InputObject
+      end
     end
   end
 end

data/lib/sober_swag/nodes/attribute.rb

@@ -2,29 +2,30 @@ module SoberSwag
   module Nodes
     ##
     # One attribute of an object.
-    class Attribute
-      def initialize(key, required, value)
+    class Attribute < Base
+      def initialize(key, required, value, meta = {})
         @key = key
         @required = required
         @value = value
+        @meta = meta
       end
 
       def deconstruct
-        [key, required, value]
+        [key, required, value, meta]
       end
 
       def deconstruct_keys
-        { key: key, required: required, value: value }
+        { key: key, required: required, value: value, meta: meta }
       end
 
-      attr_reader :key, :required, :value
+      attr_reader :key, :required, :value, :meta
 
       def map(&block)
-        self.class.new(key, required, value.map(&block))
+        self.class.new(key, required, value.map(&block), meta)
       end
 
       def cata(&block)
-        block.call(self.class.new(key, required, value.cata(&block)))
+        block.call(self.class.new(key, required, value.cata(&block), meta))
       end
     end
   end

data/lib/sober_swag/nodes/enum.rb

@@ -10,8 +10,8 @@ module SoberSwag
 
       attr_reader :values
 
-      def map(&block)
-        self.class.new(@values.map(&block))
+      def map
+        dup
       end
 
       def deconstruct

data/lib/sober_swag/nodes/primitive.rb

@@ -11,7 +11,7 @@ module SoberSwag
       attr_reader :value, :metadata
 
       def map(&block)
-        self.class.new(block.call(value))
+        self.class.new(block.call(value), metadata.dup)
       end
 
       def deconstruct

data/lib/sober_swag/output_object/definition.rb

@@ -17,8 +17,14 @@ module SoberSwag
         @fields << field
       end
 
-      def view(name, &block)
-        view = View.define(name, fields, &block)
+      def view(name, inherits: nil, &block)
+        initial_fields =
+          if inherits.nil? || inherits == :base
+            fields
+          else
+            find_view(inherits).fields
+          end
+        view = View.define(name, initial_fields, &block)
 
         view.identifier("#{@identifier}.#{name.to_s.classify}") if identifier
 
@@ -29,6 +35,12 @@ module SoberSwag
         @identifier = arg if arg
         @identifier
       end
+
+      private
+
+      def find_view(name)
+        @views.find { |view| view.name == name } || (raise ArgumentError, "no view #{name.inspect} defined!")
+      end
     end
   end
 end

data/lib/sober_swag/output_object/field_syntax.rb

@@ -7,11 +7,27 @@ module SoberSwag
         add_field!(Field.new(name, serializer, from: from, &block))
       end
 
+      ##
+      # Similar to #field, but adds multiple at once.
+      # Named #multi because #fields was already taken.
+      def multi(names, serializer)
+        names.each { |name| field(name, serializer) }
+      end
+
       ##
       # Given a symbol to this, we will use a primitive name
       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)
+        other.fields.each do |field|
+          add_field!(field)
+        end
+      end
     end
   end
 end

data/lib/sober_swag/parser.rb

@@ -25,7 +25,8 @@ module SoberSwag
         Nodes::Attribute.new(
           @node.name,
           @node.required? && !@node.type.default?,
-          bind(Parser.new(@node.type))
+          bind(Parser.new(@node.type)),
+          @node.meta
         )
       when Dry::Types::Sum
         left = bind(Parser.new(@node.left))
@@ -46,13 +47,18 @@ module SoberSwag
       when Dry::Types::Constrained
         bind(Parser.new(@node.type))
       when Dry::Types::Nominal
-        # start off with the moral equivalent of NodeTree[String]
-        Nodes::Primitive.new(@node.primitive, @node.meta)
+        if @node.respond_to?(:type) && @node.type.is_a?(Dry::Types::Constrained)
+          bind(Parser.new(@node.type))
+        else
+          old_meta = @node.primitive.respond_to?(:meta) ? @node.primitive.meta : {}
+          # start off with the moral equivalent of NodeTree[String]
+          Nodes::Primitive.new(@node.primitive, old_meta.merge(@node.meta))
+        end
       else
         # Inside of this case we have a class that is some user-defined type
         # We put it in our array of found types, and consider it a primitive
         @found.add(@node)
-        Nodes::Primitive.new(@node)
+        Nodes::Primitive.new(@node, @node.respond_to?(:meta) ? @node.meta : {})
       end
     end
 

data/lib/sober_swag/serializer/base.rb

@@ -17,6 +17,8 @@ module SoberSwag
         SoberSwag::Serializer::Optional.new(self)
       end
 
+      alias nilable optional
+
       ##
       # Is this type lazily defined?
       #

data/lib/sober_swag/serializer/meta.rb

@@ -20,20 +20,24 @@ module SoberSwag
         self.class.new(base, metadata.merge(hash))
       end
 
-      ##
-      # Delegates to `base`, adds metadata, pumbs identifiers
       def lazy_type
-        @base.lazy_type.meta(**metadata).tap { |t| t.identifier(@base.identifier) }
+        @lazy_type ||= @base.lazy_type.meta(**metadata)
       end
 
-      ##
-      # Delegates to `base`, adds metadata, plumbs identifiers
       def type
-        @base.type.meta(**metadata).tap { |t| t.identifier(@base.identifier) }
+        @type ||= @base.type.meta(**metadata)
       end
 
       def finalize_lazy_type!
         @base.finalize_lazy_type!
+        # Using .meta on dry-struct returns a *new type* that wraps the old one.
+        # As such, we need to be a bit clever about when we tack on the identifier
+        # for this type.
+        %i[lazy_type type].each do |sym|
+          if @base.public_send(sym).respond_to?(:identifier) && public_send(sym).respond_to?(:identifier)
+            public_send(sym).identifier(@base.public_send(sym).identifier)
+          end
+        end
       end
 
       def lazy_type?

data/lib/sober_swag/type.rb

@@ -0,0 +1,7 @@
+module SoberSwag
+  ##
+  # Namespace for type-definition-related utilities
+  module Type
+    autoload(:Named, 'sober_swag/type/named')
+  end
+end

data/lib/sober_swag/type/named.rb

@@ -0,0 +1,35 @@
+module SoberSwag
+  module Type
+    ##
+    # Mixin module used to identify types that should be considered
+    # standalone, named types from SoberSwag's perspective.
+    module Named
+      ##
+      # Class Methods Module.
+      # Modules that include {SoberSwag::Type::Named}
+      # will automatically extend this module.
+      module ClassMethods
+        def alias?
+          false
+        end
+
+        def alias_of
+          nil
+        end
+
+        def root_alias
+          alias_of || self
+        end
+
+        def description(arg = nil)
+          @description = arg if arg
+          @description
+        end
+      end
+
+      def self.included(mod)
+        mod.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/sober_swag/types.rb

@@ -4,5 +4,7 @@ module SoberSwag
   # You can use constants like SoberSwag::Types::Integer and things as a result of this module existing.
   class Types
     include ::Dry::Types()
+
+    autoload(:CommaArray, 'sober_swag/types/comma_array')
   end
 end

data/lib/sober_swag/types/comma_array.rb

@@ -0,0 +1,17 @@
+module SoberSwag
+  class Types
+    ##
+    # An array that will be parsed from comma-separated values in a string, if given a string.
+    module CommaArray
+      def self.of(other)
+        SoberSwag::Types::Array.of(other).constructor { |val|
+          if val.is_a?(::String)
+            val.split(',').map(&:strip)
+          else
+            val
+          end
+        }.meta(style: :form, explode: false)
+      end
+    end
+  end
+end

data/lib/sober_swag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoberSwag
-  VERSION = '0.11.0'
+  VERSION = '0.16.0'
 end

data/sober_swag.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
   spec.add_development_dependency 'simplecov'
 end