sober_swag 0.21.0 → 0.22.0

data/example/app/controllers/people_controller.rb

@@ -5,35 +5,40 @@ class PeopleController < ApplicationController
 
   before_action :load_person, only: %i[show update]
 
-  PersonBodyParams = SoberSwag.input_object do
-    identifier 'PersonBodyParams'
+  ##
+  # Parameters to create or update a person.
+  class ReportingPersonParams < SoberSwag::Reporting::Input::Struct
+    identifier 'PersonReportingParams'
 
-    attribute :first_name, SoberSwag::Types::String
-    attribute :last_name, SoberSwag::Types::String
-    attribute? :date_of_birth, SoberSwag::Types::Params::DateTime.optional
+    attribute :first_name, SoberSwag::Reporting::Input::Text.new.with_pattern(/.+/)
+    attribute :last_name, SoberSwag::Reporting::Input::Text.new.with_pattern(/.+/)
+    attribute? :date_of_birth, SoberSwag::Reporting::Input::Converting::DateTime.optional
   end
 
-  PersonBodyPatchParams = SoberSwag.input_object(PersonBodyParams) do
-    identifier 'PersonBodyPatchParams'
+  ##
+  # Parameters to create a person.
+  class ReportingPersonCreate < SoberSwag::Reporting::Input::Struct
+    identifier 'ReportingPersonCreate'
 
-    attribute? :first_name, SoberSwag::Types::String
-    attribute? :last_name, SoberSwag::Types::String
-    attribute? :date_of_birth, SoberSwag::Types::Params::DateTime.optional
+    attribute :person, ReportingPersonParams
   end
 
-  PersonParams = SoberSwag.input_object do
-    identifier 'PersonParams'
-    attribute :person, PersonBodyParams
-  end
+  ##
+  # Patch body for a person.
+  class ReportingPersonPatchParams < SoberSwag::Reporting::Input::Struct
+    identifier 'PersonReportingPatchParams'
 
-  PersonPatchParams = SoberSwag.input_object do
-    identifier 'PersonPatchParams'
-    attribute :person, PersonBodyPatchParams
+    attribute? :first_name, SoberSwag::Reporting::Input.text.with_pattern(/.+/)
+    attribute? :last_name, SoberSwag::Reporting::Input.text.with_pattern(/.+/)
+    attribute? :date_of_birth, SoberSwag::Reporting::Input::Converting::DateTime.optional
   end
 
   define :post, :create, '/people/' do
-    request_body(PersonParams)
+    summary 'Create a person'
+
+    request_body(ReportingPersonCreate)
     response(:ok, 'the person created', PersonOutputObject)
+    response(:bad_request, 'the parse errors', SoberSwag::Reporting::Report::Output)
     response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
     tags 'people', 'create'
   end
@@ -47,9 +52,14 @@ class PeopleController < ApplicationController
   end
 
   define :patch, :update, '/people/{id}' do
-    request_body(PersonPatchParams)
-    path_params { attribute :id, Types::Params::Integer }
+    summary 'Update a person'
+
+    request_body(reporting: true) do
+      attribute :person, ReportingPersonPatchParams
+    end
+    path_params(reporting: true) { attribute :id, SoberSwag::Reporting::Input::Converting::Integer }
     response(:ok, 'the person updated', PersonOutputObject)
+    response(:bad_request, 'the parse errors', SoberSwag::Reporting::Report::Output)
     response(:unprocessable_entity, 'the validation errors', PersonErrorsOutputObject)
     tags 'people', 'update'
   end
@@ -62,28 +72,34 @@ class PeopleController < ApplicationController
   end
 
   define :get, :index, '/people/' do
-    query_params do
+    summary 'List persons'
+
+    query_params(reporting: true) do
       attribute? :filters do
-        attribute? :first_name, Types::String
-        attribute? :last_name, Types::String
+        attribute? :first_name, SoberSwag::Reporting::Input.text
+        attribute? :last_name, SoberSwag::Reporting::Input.text
       end
-      attribute :view, Types::String.default('base'.freeze).enum('base', 'detail')
+      attribute? :view, SoberSwag::Reporting::Input.text.enum('base', 'detail')
     end
-    response(:ok, 'all the people', PersonOutputObject.array)
+    response(:ok, 'all the people', PersonOutputObject.list)
+    response(:bad_request, 'the parse errors', SoberSwag::Reporting::Report::Output)
     tags 'people', 'list'
   end
   def index
     @people = Person.all
     @people = @people.where('UPPER(first_name) LIKE UPPER(?)', "%#{parsed_query.filters.first_name}%") if parsed_query.filters&.first_name
     @people = @people.where('UPPER(last_name) LIKE UPPER(?)', "%#{parsed_query.filters.last_name}%") if parsed_query.filters&.last_name
-    respond!(:ok, @people.includes(:posts), serializer_opts: { view: parsed_query.view })
+    respond!(:ok, @people.includes(:posts), serializer_opts: { view: parsed_query.view || :base })
   end
 
   define :get, :show, '/people/{id}' do
-    path_params do
-      attribute :id, Types::Params::Integer
+    summary 'Get a single person by id'
+
+    path_params(reporting: true) do
+      attribute :id, SoberSwag::Reporting::Input::Converting::Integer
     end
     response(:ok, 'the person requested', PersonOutputObject)
+    response(:bad_request, 'the parse errors', SoberSwag::Reporting::Report::Output)
     tags 'people', 'show'
   end
   def show

data/example/app/output_objects/identified_output.rb

@@ -0,0 +1,7 @@
+##
+# Base serializer for objects with a global id of some variety.
+class IdentifiedOutput < SoberSwag::Reporting::Output::Struct
+  field :global_id, SoberSwag::Reporting::Output.text.nilable do
+    object_to_serialize.try(:to_global_id).try(:to_s)
+  end
+end

data/example/app/output_objects/person_output_object.rb

@@ -1,15 +1,41 @@
-PersonOutputObject = SoberSwag::OutputObject.define do
-  identifier 'Person'
-  field :id, primitive(:Integer).meta(description: 'Unique ID')
-  field :first_name, primitive(:String).meta(description: <<~MARKDOWN)
-    This is the first name of a person.
-    Note that you can't use this as a unique identifier, and you really should understand how names work before using this.
-    [Falsehoods programmers believe about names](https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/)
-    is a good thing to read!
+##
+# Output object that serializes a person.
+class PersonOutputObject < IdentifiedOutput
+  identifier 'PersonOutput'
+
+  description <<~MARKDOWN
+    Basic as hell serializer for a person.
   MARKDOWN
-  field :last_name, primitive(:String)
 
-  view :detail do
-    field :posts, -> { PostOutputObject.array }
+  field :id, SoberSwag::Reporting::Output::Text.new.via_map(&:to_s)
+  field(
+    :first_name,
+    SoberSwag::Reporting::Output::Text.new,
+    description: <<~MARKDOWN
+      This is the first name of a person.
+      Note that you can't use this as a unique identifier, and you really should understand how names work before using this.
+      [Falsehoods programmers believe about names](https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/)
+      is a good thing to read!
+    MARKDOWN
+  )
+  field(
+    :last_name, SoberSwag::Reporting::Output::Text.new
+  )
+
+  define_view :detail do
+    field(
+      :initials,
+      SoberSwag::Reporting::Output::Text.new
+    ) do |person|
+      [person.first_name[0..0], person.last_name[0..0]].compact.map { |x| "#{x}." }.join(' ')
+    end
+
+    field(
+      :posts,
+      SoberSwag::Reporting::Output::Defer.defer do
+        ReportingPostOutput.view(:base).array
+      end,
+      description: 'all posts this user has made'
+    )
   end
 end

data/example/app/output_objects/post_output_object.rb

@@ -3,8 +3,4 @@ PostOutputObject = SoberSwag::OutputObject.define do
   field :id, primitive(:Integer)
   field :title, primitive(:String)
   field :body, primitive(:String)
-
-  view :detail do
-    field :person, -> { PersonOutputObject.view(:base) }
-  end
 end

data/example/app/output_objects/reporting_post_output.rb

@@ -0,0 +1,18 @@
+##
+# A reporting output object for a post.
+class ReportingPostOutput < SoberSwag::Reporting::Output::Struct
+  identifier 'ReportingPostOutput'
+
+  field :id, SoberSwag::Reporting::Output::Text.new.via_map(&:to_s)
+  field :title, SoberSwag::Reporting::Output::Text.new
+  field :body, SoberSwag::Reporting::Output::Text.new
+
+  define_view :detail do
+    field(
+      :person,
+      SoberSwag::Reporting::Output::Defer.defer do
+        PersonOutputObject.view(:base)
+      end
+    )
+  end
+end

data/example/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/example/spec/requests/people/create_spec.rb

@@ -34,7 +34,8 @@ RSpec.describe 'people controller create', type: :request do
 
       it { should_not be_successful }
       it { should_not be_server_error }
-      it { should be_unprocessable }
+      it { should be_bad_request }
+      it { should have_attributes(status: 400) }
     end
 
     describe 'the act of requesting' do
@@ -46,7 +47,7 @@ RSpec.describe 'people controller create', type: :request do
     describe 'the response body' do
       subject { request && response && JSON.parse(response.body) }
 
-      it { should have_key('first_name') }
+      it { should have_key('$.person.first_name') }
     end
   end
 end

data/example/spec/requests/people/index_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe 'Index action for people' do
       end
 
       it 'has the right person' do
-        expect(parsed_body).to include(include('id' => person.id))
+        expect(parsed_body).to include(include('id' => person.id.to_s))
       end
     end
 

data/lib/sober_swag/compiler/path.rb

@@ -51,7 +51,9 @@ module SoberSwag
               description: route.response_descriptions[status],
               content: {
                 'application/json': {
-                  schema: compiler.response_for(serializer.type)
+                  schema: compiler.response_for(
+                    serializer.respond_to?(:swagger_schema) ? serializer : serializer.type
+                  )
                 }
               }
             }

data/lib/sober_swag/compiler.rb

@@ -13,6 +13,7 @@ module SoberSwag
     def initialize
       @types = Set.new
       @paths = Paths.new
+      @reporting_types = SoberSwag::Reporting::Compiler::Schema.new
     end
 
     ##
@@ -28,6 +29,10 @@ module SoberSwag
       }
     end
 
+    ##
+    # @return [SoberSwag::Reporting::Compiler::Schema]
+    attr_reader :reporting_types
+
     ##
     # Add a path to be compiled.
     # @param route [SoberSwag::Controller::Route] the route to add.
@@ -41,7 +46,9 @@ module SoberSwag
     #
     # @return [Hash]
     def object_schemas
-      @types.map { |v| [v.ref_name, v.object_schema] }.to_h
+      @types.map { |v| [v.ref_name, v.object_schema] }.to_h.merge(
+        reporting_types.references
+      )
     end
 
     ##
@@ -59,7 +66,13 @@ module SoberSwag
     # @param type [Class] the type to get a path_params definition for
     # @return [Hash]
     def path_params_for(type)
-      with_types_discovered(type).path_schema
+      compiler = with_types_discovered(type)
+
+      if compiler.respond_to?(:swagger_path_schema)
+        compiler.swagger_path_schema
+      else
+        compiler.path_schema
+      end
     end
 
     ##
@@ -69,7 +82,13 @@ module SoberSwag
     # @param type [Class] the type to get the query_params definitions for
     # @return [Hash]
     def query_params_for(type)
-      with_types_discovered(type).query_schema
+      compiler = with_types_discovered(type)
+
+      if compiler.respond_to?(:swagger_query_schema)
+        compiler.swagger_query_schema
+      else
+        compiler.query_schema
+      end
     end
 
     ##
@@ -80,6 +99,9 @@ module SoberSwag
     # @return [Hash]
     def body_for(type)
       add_type(type)
+
+      return reporting_types.compile(type) if type.respond_to?(:swagger_schema)
+
       Type.new(type).schema_stub
     end
 
@@ -109,23 +131,47 @@ module SoberSwag
       # use tap here to avoid an explicit self at the end of this
       # which makes this method chainable
       tap do
-        type_compiler = Type.new(type)
+        if type.is_a?(SoberSwag::Reporting::Input::Interface) || type.is_a?(SoberSwag::Reporting::Output::Interface)
+          add_reporting_type(type)
+        else
+          add_dry_type(type)
+        end
+      end
+    end
 
-        ##
-        # Do nothing if we already have a type
-        return self if @types.include?(type_compiler)
+    private
 
-        @types.add(type_compiler) if type_compiler.standalone?
+    def add_dry_type(type)
+      type_compiler = Type.new(type)
 
-        type_compiler.found_types.each do |ft|
-          add_type(ft)
-        end
+      ##
+      # Do nothing if we already have a type
+      return self if @types.include?(type_compiler)
+
+      @types.add(type_compiler) if type_compiler.standalone?
+
+      type_compiler.found_types.each do |ft|
+        add_type(ft)
       end
     end
 
-    private
+    def add_reporting_type(type)
+      reporting_types.compile(type)
+    end
 
     def with_types_discovered(type)
+      if type.respond_to?(:swagger_schema)
+        with_reporting_types_discovered(type)
+      else
+        with_dry_types_discovered(type)
+      end
+    end
+
+    def with_reporting_types_discovered(type)
+      type.tap { |t| reporting_types.compile(t) }
+    end
+
+    def with_dry_types_discovered(type)
       Type.new(type).tap do |type_compiler|
         type_compiler.found_types.each { |ft| add_type(ft) }
       end

data/lib/sober_swag/controller/route.rb

@@ -2,7 +2,7 @@ module SoberSwag
   module Controller
     ##
     # Describe a single controller endpoint.
-    class Route
+    class Route # rubocop:disable Metrics/ClassLength
       ##
       # @param method [Symbol] the HTTP method to get
       # @param action_name [Symbol] the name of the rails action
@@ -83,8 +83,11 @@ module SoberSwag
       # @overload request_body(base = SoberSwag::InputObject, &block)
       #   Define a Swagger-able type inline to use to parse the request body.
       #   @see SoberSwag.input_object
-      def request_body(base = SoberSwag::InputObject, &block)
-        @request_body_class = make_input_object!(base, &block)
+      # @overload request_body(base = SoberSwag::Reporting::Input::Struct, reporting: true, &block)
+      #   Define a swagger-able type inline, using the new reporting system.
+      #   @see SoberSwag::Reporting::Input::Struct
+      def request_body(base = SoberSwag::InputObject, reporting: false, &block)
+        @request_body_class = make_input_object!(base, reporting: reporting, &block)
         action_module.const_set('RequestBody', @request_body_class)
       end
 
@@ -101,8 +104,11 @@ module SoberSwag
       # @overload query_params(base = SoberSwag::InputObject, &block)
       #   Define a Swagger-able type inline to use to parse the query params.
       #   @see SoberSwag.input_object
-      def query_params(base = SoberSwag::InputObject, &block)
-        @query_params_class = make_input_object!(base, &block)
+      # @overload query_params(base = SoberSwag::Reporting::Input::Struct, reporting: true, &block)
+      #   Define a swagger-able type inline, using the new reporting system.
+      #   @see SoberSwag::Reporting::Input::Struct
+      def query_params(base = SoberSwag::InputObject, reporting: false, &block)
+        @query_params_class = make_input_object!(base, reporting: reporting, &block)
         action_module.const_set('QueryParams', @query_params_class)
       end
 
@@ -119,8 +125,11 @@ module SoberSwag
       # @overload path_params(base = SoberSwag::InputObject, &block)
       #   Define a Swagger-able type inline to use to parse the path params.
       #   @see SoberSwag.input_object
-      def path_params(base = SoberSwag::InputObject, &block)
-        @path_params_class = make_input_object!(base, &block)
+      # @overload path_params(base = SoberSwag::Reporting::Input::Struct, reporting: true, &block)
+      #   Define a swagger-able type inline, using the new reporting system.
+      #   @see SoberSwag::Reporting::Input::Struct
+      def path_params(base = SoberSwag::InputObject, reporting: false, &block)
+        @path_params_class = make_input_object!(base, reporting: reporting, &block)
         action_module.const_set('PathParams', @path_params_class)
       end
 
@@ -214,7 +223,34 @@ module SoberSwag
         @response_module ||= Module.new.tap { |m| action_module.const_set(:Response, m) }
       end
 
-      def make_input_object!(base, &block)
+      def make_input_object!(base, reporting:, &block)
+        if reporting
+          make_reporting_input!(
+            base == SoberSwag::InputObject ? SoberSwag::Reporting::Input::Struct : base,
+            &block
+          )
+        else
+          make_non_reporting_input!(base, &block)
+        end
+      end
+
+      def make_reporting_input!(base, &block)
+        if block
+          raise ArgumentError, 'non-class passed along with block' unless base.is_a?(Class)
+
+          make_reporting_input_struct!(base, &block)
+        else
+          base
+        end
+      end
+
+      def make_reporting_input_struct!(base, &block)
+        raise ArgumentError, 'base class must be a soberswag reporting class!' unless base <= SoberSwag::Reporting::Input::Struct
+
+        Class.new(base, &block)
+      end
+
+      def make_non_reporting_input!(base, &block)
         if base.is_a?(Class)
           make_input_class(base, block)
         elsif block

data/lib/sober_swag/controller.rb

@@ -114,7 +114,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedPathError unless r&.path_params_class
 
-          r.path_params_class.call(request.path_parameters)
+          build_parsed_sober_swag(r.path_params_class, request.path_parameters)
         end
     end
 
@@ -128,7 +128,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedBodyError unless r&.request_body_class
 
-          r.request_body_class.call(body_params)
+          build_parsed_sober_swag(r.request_body_class, body_params)
         end
     end
 
@@ -142,7 +142,7 @@ module SoberSwag
           r = current_action_def
           raise UndefinedQueryError unless r&.query_params_class
 
-          r.query_params_class.call(request.query_parameters)
+          build_parsed_sober_swag(r.query_params_class, request.query_parameters)
         end
     end
 
@@ -154,8 +154,13 @@ module SoberSwag
     def respond!(status, entity, serializer_opts: {}, rails_opts: {})
       r = current_action_def
       serializer = r.response_serializers[Rack::Utils.status_code(status)]
-      serializer ||= serializer.new if serializer.respond_to?(:new)
-      render json: serializer.serialize(entity, serializer_opts), status: status, **rails_opts
+      if serializer.respond_to?(:reporting?) && serializer.reporting?
+        serializer = serializer.view(serializer_opts[:view].to_sym) if serializer_opts.key?(:view)
+        render json: serializer.call(entity), status: status, **rails_opts
+      else
+        serializer ||= serializer.new if serializer.respond_to?(:new)
+        render json: serializer.serialize(entity, serializer_opts), status: status, **rails_opts
+      end
     end
 
     ##
@@ -177,6 +182,14 @@ module SoberSwag
     def current_action_def
       self.class.find_route(params[:action])
     end
+
+    def build_parsed_sober_swag(parser, params)
+      if parser.respond_to?(:call!)
+        parser.call!(params)
+      else
+        parser.call(params)
+      end
+    end
   end
 end
 

data/lib/sober_swag/reporting/compiler.rb

@@ -0,0 +1,39 @@
+module SoberSwag
+  module Reporting
+    module Compiler
+      ##
+      # Compile component schemas.
+      class Schema
+        def initialize
+          @references = {}
+          @referenced_schemas = Set.new
+        end
+
+        ##
+        # Hash of references to type definitions.
+        # Suitable for us as the components hash.
+        attr_reader :references
+
+        def compile(value)
+          compile_inner(value.swagger_schema)
+        end
+
+        def compile_inner(value)
+          initial, found = value
+
+          merge_found(found)
+
+          initial
+        end
+
+        def merge_found(found)
+          found.each do |k, v|
+            next unless @referenced_schemas.add?(k)
+
+            @references[k] = compile_inner(v.call)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sober_swag/reporting/input/base.rb

@@ -0,0 +1,11 @@
+module SoberSwag
+  module Reporting
+    module Input
+      ##
+      # Base class for all inputs in the cool new schema style.
+      class Base
+        include Interface
+      end
+    end
+  end
+end

data/lib/sober_swag/reporting/input/bool.rb

@@ -0,0 +1,19 @@
+module SoberSwag
+  module Reporting
+    module Input
+      ##
+      # Convert booleans.
+      class Bool < Base
+        def call(val)
+          return Report::Value.new(['was not a bool']) unless [true, false].include?(val)
+
+          val
+        end
+
+        def swagger_schema
+          [{ type: 'boolean' }, {}]
+        end
+      end
+    end
+  end
+end

data/lib/sober_swag/reporting/input/converting/bool.rb

@@ -0,0 +1,24 @@
+module SoberSwag
+  module Reporting
+    module Input
+      module Converting
+        ##
+        # Try to convert a boolean-like value to an actual boolean.
+        Bool = # rubocop:disable Naming/ConstantName
+          (SoberSwag::Reporting::Input::Bool.new |
+           (
+             SoberSwag::Reporting::Input::Text
+              .new
+              .enum(*(%w[y yes true t].flat_map { |x| [x, x.upcase] } + ['1'])) |
+              SoberSwag::Reporting::Input::Number.new.enum(1)).mapped { |_| true } |
+            (
+              SoberSwag::Reporting::Input::Text
+                .new
+                .enum(*(%w[false no n f].flat_map { |x| [x, x.upcase] } + ['0'])) |
+              SoberSwag::Reporting::Input::Number.new.enum(0)
+            ).mapped { |_| false }
+          )
+      end
+    end
+  end
+end