sober_swag 0.21.0 → 0.22.0

data/lib/sober_swag/reporting/report/object.rb

@@ -0,0 +1,29 @@
+module SoberSwag
+  module Reporting
+    module Report
+      ##
+      # Report on problems with an object.
+      class Object < Base
+        ##
+        # @param problems [Hash<Symbol, Report::Base>] the problems with each value.
+        def initialize(problems)
+          @problems = problems
+        end
+
+        ##
+        # @return [Hash] the hash being reported on
+        attr_reader :problems
+
+        def each_error
+          return enum_for(:each_error) unless block_given?
+
+          problems.each do |k, v|
+            v.each_error do |nested, err|
+              yield [".#{k}", nested].reject(&:nil?).join(''), err
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sober_swag/reporting/report/output.rb

@@ -0,0 +1,14 @@
+module SoberSwag
+  module Reporting
+    module Report
+      ##
+      # Output suitable to serialize an instance of {SoberSwag::Reporting::Report::Base} to
+      # a nice key-value thing.
+      Output = SoberSwag::Reporting::Output::Dictionary.of(
+        SoberSwag::Reporting::Output::List.new(
+          SoberSwag::Reporting::Output.text
+        )
+      ).via_map(&:path_hash)
+    end
+  end
+end

data/lib/sober_swag/reporting/report/value.rb

@@ -0,0 +1,28 @@
+module SoberSwag
+  module Reporting
+    module Report
+      ##
+      # Report for a single value.
+      # Basically a wrapper around an array of strings.
+      class Value < Base
+        ##
+        # @param problems [Array<String>] problems with it
+        def initialize(problems)
+          @problems = problems
+        end
+
+        ##
+        # @return [Array<String>] the problems the value had
+        attr_reader :problems
+
+        def each_error
+          return enum_for(:each_error) unless block_given?
+
+          problems.each do |problem|
+            yield nil, problem
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sober_swag/reporting/report.rb

@@ -0,0 +1,16 @@
+module SoberSwag
+  module Reporting
+    ##
+    # Namespace modules for the various "reporters," or things that provide error handling.
+    module Report
+      autoload :Base, 'sober_swag/reporting/report/base'
+      autoload :Either, 'sober_swag/reporting/report/either'
+      autoload :Error, 'sober_swag/reporting/report/error'
+      autoload :Object, 'sober_swag/reporting/report/object'
+      autoload :Output, 'sober_swag/reporting/report/output'
+      autoload :MergedObject, 'sober_swag/reporting/report/merged_object'
+      autoload :Value, 'sober_swag/reporting/report/value'
+      autoload :List, 'sober_swag/reporting/report/list'
+    end
+  end
+end

data/lib/sober_swag/reporting.rb

@@ -0,0 +1,11 @@
+module SoberSwag
+  ##
+  # A new module for parsers with better error reporting.
+  module Reporting
+    autoload :Input, 'sober_swag/reporting/input'
+    autoload :Report, 'sober_swag/reporting/report'
+    autoload :Output, 'sober_swag/reporting/output'
+    autoload :Compiler, 'sober_swag/reporting/compiler'
+    autoload :InvalidSchemaError, 'sober_swag/reporting/invalid_schema_error'
+  end
+end

data/lib/sober_swag/version.rb

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

data/lib/sober_swag.rb

@@ -24,6 +24,7 @@ module SoberSwag
   autoload :InputObject, 'sober_swag/input_object'
   autoload :Server, 'sober_swag/server'
   autoload :Type, 'sober_swag/type'
+  autoload :Reporting, 'sober_swag/reporting'
 
   ##
   # Define a struct of something.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -193,6 +193,7 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
+- docs/reporting.md
 - docs/serializers.md
 - example/.gitignore
 - example/.rspec
@@ -210,12 +211,15 @@ files:
 - example/app/models/concerns/.keep
 - example/app/models/person.rb
 - example/app/models/post.rb
+- example/app/output_objects/identified_output.rb
 - example/app/output_objects/person_errors_output_object.rb
 - example/app/output_objects/person_output_object.rb
 - example/app/output_objects/post_output_object.rb
+- example/app/output_objects/reporting_post_output.rb
 - example/bin/bundle
 - example/bin/rails
 - example/bin/rake
+- example/bin/rspec
 - example/bin/setup
 - example/bin/spring
 - example/config.ru
@@ -283,6 +287,65 @@ files:
 - lib/sober_swag/output_object/field_syntax.rb
 - lib/sober_swag/output_object/view.rb
 - lib/sober_swag/parser.rb
+- lib/sober_swag/reporting.rb
+- lib/sober_swag/reporting/compiler.rb
+- lib/sober_swag/reporting/input.rb
+- lib/sober_swag/reporting/input/base.rb
+- lib/sober_swag/reporting/input/bool.rb
+- lib/sober_swag/reporting/input/converting.rb
+- lib/sober_swag/reporting/input/converting/bool.rb
+- lib/sober_swag/reporting/input/converting/date.rb
+- lib/sober_swag/reporting/input/converting/date_time.rb
+- lib/sober_swag/reporting/input/converting/decimal.rb
+- lib/sober_swag/reporting/input/converting/integer.rb
+- lib/sober_swag/reporting/input/defer.rb
+- lib/sober_swag/reporting/input/described.rb
+- lib/sober_swag/reporting/input/dictionary.rb
+- lib/sober_swag/reporting/input/either.rb
+- lib/sober_swag/reporting/input/enum.rb
+- lib/sober_swag/reporting/input/format.rb
+- lib/sober_swag/reporting/input/interface.rb
+- lib/sober_swag/reporting/input/list.rb
+- lib/sober_swag/reporting/input/mapped.rb
+- lib/sober_swag/reporting/input/merge_objects.rb
+- lib/sober_swag/reporting/input/null.rb
+- lib/sober_swag/reporting/input/number.rb
+- lib/sober_swag/reporting/input/object.rb
+- lib/sober_swag/reporting/input/object/property.rb
+- lib/sober_swag/reporting/input/pattern.rb
+- lib/sober_swag/reporting/input/referenced.rb
+- lib/sober_swag/reporting/input/struct.rb
+- lib/sober_swag/reporting/input/text.rb
+- lib/sober_swag/reporting/invalid_schema_error.rb
+- lib/sober_swag/reporting/output.rb
+- lib/sober_swag/reporting/output/base.rb
+- lib/sober_swag/reporting/output/bool.rb
+- lib/sober_swag/reporting/output/defer.rb
+- lib/sober_swag/reporting/output/described.rb
+- lib/sober_swag/reporting/output/dictionary.rb
+- lib/sober_swag/reporting/output/interface.rb
+- lib/sober_swag/reporting/output/list.rb
+- lib/sober_swag/reporting/output/merge_objects.rb
+- lib/sober_swag/reporting/output/null.rb
+- lib/sober_swag/reporting/output/number.rb
+- lib/sober_swag/reporting/output/object.rb
+- lib/sober_swag/reporting/output/object/property.rb
+- lib/sober_swag/reporting/output/partitioned.rb
+- lib/sober_swag/reporting/output/pattern.rb
+- lib/sober_swag/reporting/output/referenced.rb
+- lib/sober_swag/reporting/output/struct.rb
+- lib/sober_swag/reporting/output/text.rb
+- lib/sober_swag/reporting/output/via_map.rb
+- lib/sober_swag/reporting/output/viewed.rb
+- lib/sober_swag/reporting/report.rb
+- lib/sober_swag/reporting/report/base.rb
+- lib/sober_swag/reporting/report/either.rb
+- lib/sober_swag/reporting/report/error.rb
+- lib/sober_swag/reporting/report/list.rb
+- lib/sober_swag/reporting/report/merged_object.rb
+- lib/sober_swag/reporting/report/object.rb
+- lib/sober_swag/reporting/report/output.rb
+- lib/sober_swag/reporting/report/value.rb
 - lib/sober_swag/serializer.rb
 - lib/sober_swag/serializer/array.rb
 - lib/sober_swag/serializer/base.rb