sober_swag 0.22.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1c1c2df36ccecf700e4d3ecf104c1324f9fa35b4588b4a040238f2513bf4b8
-  data.tar.gz: 3d22562035e1d8e93b11876fc82f6a23b1d26e95952d988423559d555adf680a
+  metadata.gz: 85928715576aecc38e7a63176e14595a22531501e36ef9a4ef6202e03e08d8ea
+  data.tar.gz: 12940b348760152cef2e20c96adb15fc9ebf59e9aaacfd13741da83841c45bdf
 SHA512:
-  metadata.gz: 3a486a7b09b631d567f509c94b3b161350de61971f148ba24f707e117fa6915e6d7be99c6782ff07662da44edc3edb56ebb1691ac0fe8e819fc138dca4513ac9
-  data.tar.gz: e4447e3a951d0867c76a6bbd30a49da136d9406d00dfe0c5e0632574746a59fa72b936eb736c573de33bfe01e1d36d36771561fed7b9a6b00be43dcaa0c82653
+  metadata.gz: 88722e20a08f2b80b64501756474bcbd06758c2b7bcb498b0f0d316f5d335f43e5d937579f1888b8a5332eb536c0172618c75485a52bf6096c6ebe823e8e3f3e
+  data.tar.gz: 3f98c37fb29945196ce348f48886d9f27b9c913c83aca5520d96318d9711b5d5fc97347566e73c93538e931ad7d70c2ad725a006197504d2197a9e55432158c4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v0.24.1] 2022-05-26
+
+- Added a better `#message` to `SoberSwag::Reporting::Report::Error`
+
 ## [v0.22.0] 2021-12-21
 
 - Added `SoberSwag::Reporting`, which is basically a v2 of the gem!

data/example/Gemfile

@@ -8,7 +8,7 @@ gem 'actionpack', '>= 6.0.3.2'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3', '~> 1.4'
 # Use Puma as the app server
-gem 'puma', '~> 5.4'
+gem 'puma', '~> 5.6'
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 # gem 'jbuilder', '~> 2.7'
 # Use Active Model has_secure_password

data/example/Gemfile.lock

@@ -64,14 +64,14 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    bootsnap (1.9.3)
-      msgpack (~> 1.0)
+    bootsnap (1.11.1)
+      msgpack (~> 1.2)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.6)
@@ -98,16 +98,16 @@ GEM
       dry-types (>= 0.8.1)
       rails (>= 3)
     erubi (1.10.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    listen (3.7.0)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.12.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -115,17 +115,17 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    msgpack (1.4.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    msgpack (1.5.1)
     nio4r (2.5.8)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    puma (5.5.2)
+    puma (5.6.4)
       nio4r (~> 2.0)
     racc (1.6.0)
     rack (2.2.3)
@@ -158,18 +158,18 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (13.0.6)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-rails (5.0.2)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -177,7 +177,7 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.10.3)
+    rspec-support (3.11.0)
     spring (2.1.1)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
@@ -190,14 +190,14 @@ GEM
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    thor (1.1.0)
+    thor (1.2.1)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.1)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -209,7 +209,7 @@ DEPENDENCIES
   dry-types-rails
   listen (>= 3.0.5, < 3.8)
   pry
-  puma (~> 5.4)
+  puma (~> 5.6)
   rails (~> 6.0.2, >= 6.0.2.2)
   rspec-rails
   sober_swag!

data/lib/sober_swag/input_object.rb

@@ -42,6 +42,7 @@ module SoberSwag
       #   @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)
+        raise ArgumentError, "cannot mix reporting and non-reporting types at attribute #{key}" if parent.is_a?(SoberSwag::Reporting::Input::Interface)
 
         super(key, parent, &block)
       end

data/lib/sober_swag/output_object/field_syntax.rb

@@ -11,6 +11,8 @@ module SoberSwag
       # @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)
+        raise ArgumentError, "do not mix reporting and non-reporting outputs (at key #{name})" if serializer.is_a?(SoberSwag::Reporting::Output::Interface)
+
         add_field!(Field.new(name, serializer, from: from, &block))
       end
 

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

@@ -0,0 +1,61 @@
+module SoberSwag
+  module Reporting
+    module Input
+      ##
+      # Specify that an item must be within a given range in ruby.
+      # This gets translated to `minimum` and `maximum` keys in swagger.
+      #
+      # This works with endless ranges (Ruby 2.6+) and beginless ranges (Ruby 2.7+)
+      class InRange < Base
+        def initialize(input, range)
+          @input = input
+          @range = range
+        end
+
+        ##
+        # @return [Interface]
+        attr_reader :input
+
+        ##
+        # @return [Range]
+        attr_reader :range
+
+        ##
+        # @return [Range]
+        def call(value)
+          res = input.call(value)
+
+          return res if res.is_a?(Report::Base)
+          return Report::Value.new(['was not in minimum/maximum range']) unless range.member?(res)
+
+          res
+        end
+
+        def swagger_schema
+          schema, found = input.swagger_schema
+
+          merged =
+            if schema.key?(:$ref)
+              { allOf: [schema] }
+            else
+              schema
+            end.merge(maximum_portion).merge(minimum_portion)
+
+          [merged, found]
+        end
+
+        def maximum_portion
+          return {} unless range.end
+
+          { maximum: range.end, exclusiveMaximum: range.exclude_end? }
+        end
+
+        def minimum_portion
+          return {} unless range.begin
+
+          { minimum: range.begin, exclusiveMinimum: false }
+        end
+      end
+    end
+  end
+end

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

@@ -35,6 +35,21 @@ module SoberSwag
           List.new(self)
         end
 
+        ##
+        # Constrained values: must be in range.
+        # @return [InRange]
+        def in_range(range)
+          raise ArgumentError, "need a range, not a #{range.class}" unless range.is_a?(Range)
+
+          InRange.new(self, range)
+        end
+
+        ##
+        # Constrained values: must be a multiple of the given number
+        def multiple_of(number)
+          MultipleOf.new(self, number)
+        end
+
         def referenced(name)
           Referenced.new(self, name)
         end
@@ -74,6 +89,17 @@ module SoberSwag
           raise InvalidSchemaError::InvalidForQueryError.new(self) # rubocop:disable Style/RaiseArgs
         end
 
+        def modify_schema(base, addition)
+          schema, found = base.swagger_schema
+          merged =
+            if schema.key?(:$ref)
+              { allOf: [schema] }
+            else
+              schema
+            end.merge(addition)
+          [merged, found]
+        end
+
         def add_schema_key(base, addition)
           if base.key?(:$ref)
             { allOf: [base] }.merge(addition)

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

@@ -0,0 +1,36 @@
+module SoberSwag
+  module Reporting
+    module Input
+      ##
+      # Adds the multipleOf constraint to input types.
+      # Will use the '%' operator to calculate this, which may behave oddly for floats.
+      class MultipleOf < Base
+        def initialize(input, mult)
+          @input = input
+          @mult = mult
+        end
+
+        ##
+        # @return [Interface]
+        attr_reader :input
+
+        ##
+        # @return [Numeric]
+        attr_reader :mult
+
+        def call(value)
+          parsed = input.call(value)
+
+          return parsed if parsed.is_a?(Report::Base)
+          return Report::Value.new(["was not a multiple of #{mult}"]) unless (parsed % mult).zero?
+
+          parsed
+        end
+
+        def swagger_schema
+          modify_schema(input, { multipleOf: mult })
+        end
+      end
+    end
+  end
+end

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

@@ -65,7 +65,7 @@ module SoberSwag
         end
 
         def field_schemas
-          fields.reduce([{}, Set.new]) do |(field_schemas, found), (k, v)|
+          fields.reduce([{}, {}]) do |(field_schemas, found), (k, v)|
             key_schema, key_found = v.property_schema
             [
               field_schemas.merge(k => key_schema),

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

@@ -76,6 +76,7 @@ module SoberSwag
           #
           def add_attribute!(name, input, required:, description: nil)
             raise ArgumentError, 'name must be a symbol' unless name.is_a?(Symbol)
+            raise ArgumentError, 'input type must be a SoberSwag::Reporting::Input::Interface' unless input.is_a?(Interface)
 
             define_attribute(name) # defines an instance method to access this attribute
 

data/lib/sober_swag/reporting/input.rb

@@ -14,7 +14,9 @@ module SoberSwag
       autoload :Format, 'sober_swag/reporting/input/format'
       autoload :Number, 'sober_swag/reporting/input/number'
       autoload :Interface, 'sober_swag/reporting/input/interface'
+      autoload :InRange, 'sober_swag/reporting/input/in_range'
       autoload :List, 'sober_swag/reporting/input/list'
+      autoload :MultipleOf, 'sober_swag/reporting/input/multiple_of'
       autoload :Mapped, 'sober_swag/reporting/input/mapped'
       autoload :MergeObjects, 'sober_swag/reporting/input/merge_objects'
       autoload :Null, 'sober_swag/reporting/input/null'

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

@@ -0,0 +1,47 @@
+module SoberSwag
+  module Reporting
+    module Output
+      ##
+      # Models outputting an enum.
+      class Enum < Base
+        def initialize(output, values)
+          @output = output
+          @values = values
+        end
+
+        ##
+        # @return [Interface]
+        attr_reader :output
+
+        ##
+        # @return [Array]
+        attr_reader :values
+
+        def call(value)
+          output.call(value)
+        end
+
+        def serialize_report(value)
+          rep = output.serialize_report(value)
+
+          return rep if rep.is_a?(Report::Base)
+
+          return Report::Value.new(['was not an acceptable enum member']) unless values.include?(rep)
+
+          rep
+        end
+
+        def swagger_schema
+          schema, found = output.swagger_schema
+          merged =
+            if schema.key?(:$ref)
+              { allOf: [schema] }
+            else
+              schema
+            end.merge(enum: values)
+          [merged, found]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module SoberSwag
+  module Reporting
+    module Output
+      ##
+      # Specify that an output will be within a certain range.
+      # This gets translated to `minimum` and `maximum` keys in swagger.
+      class InRange < Base
+        def initialize(output, range)
+          @output = output
+          @range = range
+        end
+
+        ##
+        # @return [Interface]
+        attr_reader :output
+
+        ##
+        # @return [Range]
+        attr_reader :range
+
+        def call(value)
+          output.call(value)
+        end
+
+        def serialize_report(value)
+          rep = output.serialize_report(value)
+
+          return rep if rep.is_a?(Report::Base)
+
+          return Report::Value.new(['was not in minimum/maximum range']) unless range.member?(rep)
+
+          rep
+        end
+
+        def swagger_schema
+          schema, found = output.swagger_schema
+
+          merged =
+            if schema.key?(:$ref)
+              { allOf: [schema] }
+            else
+              schema
+            end.merge(maximum_portion).merge(minimum_portion)
+
+          [merged, found]
+        end
+
+        def maximum_portion
+          return {} unless range.end
+
+          res = { maximum: range.end }
+          res[:exclusiveMaximum] = true if range.exclude_end?
+          res
+        end
+
+        def minimum_portion
+          return {} unless range.begin
+
+          { minimum: range.begin }
+        end
+      end
+    end
+  end
+end

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

@@ -30,10 +30,25 @@ module SoberSwag
           ViaMap.new(self, block)
         end
 
+        ##
+        # @return [SoberSwag::Reporting::Output::Enum]
+        def enum(*cases)
+          Enum.new(self, cases)
+        end
+
         def referenced(name)
           Referenced.new(self, name)
         end
 
+        ##
+        # @return [SoberSwag::Reporting::Output::InRange]
+        # Constrained values: must be within the given range.
+        def in_range(range)
+          raise ArgumentError, 'need a range' unless range.is_a?(Range)
+
+          InRange.new(self, range)
+        end
+
         def list
           List.new(self)
         end

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

@@ -20,6 +20,8 @@ module SoberSwag
           #
           #   You can access other methods from this method.
           def field(name, output, description: nil, &extract)
+            raise ArgumentError, "output of field #{name} is not a SoberSwag::Reporting::Output::Interface" unless output.is_a?(Interface)
+
             define_field(name, extract)
 
             object_fields[name] = Object::Property.new(
@@ -158,22 +160,20 @@ module SoberSwag
           # @param name [Symbol] name of this view.
           # @yieldself [self] a block in which you can add more fields to the view.
           # @return [Class]
-          def define_view(name, &block) # rubocop:disable Metrics/MethodLength
-            raise ArgumentError, "duplicate view #{name}" if name == :base || views.include?(name)
-
-            classy_name = name.to_s.classify
+          def define_view(name, &block)
+            define_view_with_parent(name, self, block)
+          end
 
-            Class.new(self).tap do |c|
-              c.instance_eval(&block)
-              c.define_singleton_method(:define_view) do |*|
-                raise ArgumentError, 'no nesting views'
-              end
-              c.define_singleton_method(:identifier) do
-                [parent_struct.identifier, classy_name.gsub('::', '.')].join('.')
-              end
-              const_set(classy_name, c)
-              view_map[name] = c
-            end
+          ##
+          # Defines a view for this object, which "inherits" another view.
+          # @see #define_view for how views behave.
+          #
+          # @param name [Symbol] name of this view
+          # @param inherits [Symbol] name of the view this view inherits
+          # @yieldself [self] a block in which you can add more fields to this view
+          # @return [Class]
+          def define_inherited_view(name, inherits:, &block)
+            define_view_with_parent(name, view_class(inherits), block)
           end
 
           ##
@@ -199,6 +199,16 @@ module SoberSwag
             view_map.fetch(name).view(:base)
           end
 
+          ##
+          # Equivalent to .view, but returns the raw view class.
+          #
+          # @return [Class]
+          def view_class(name)
+            return self if name == :base
+
+            view_map.fetch(name)
+          end
+
           attr_accessor :parent_struct
 
           ##
@@ -226,6 +236,21 @@ module SoberSwag
 
           private
 
+          def define_view_with_parent(name, parent, block)
+            raise ArgumentError, "duplicate view #{name}" if name == :base || views.include?(name)
+
+            classy_name = name.to_s.classify
+            us = self # grab this so its identifier doesn't get nested under whatever parent it inherits from, since its our view
+
+            Class.new(parent).tap do |c|
+              c.instance_eval(&block)
+              c.define_singleton_method(:define_view) { |*| raise ArgumentError, 'no nesting views' }
+              c.define_singleton_method(:identifier) { [us.identifier, classy_name.gsub('::', '.')].join('.') }
+              const_set(classy_name, c)
+              view_map[name] = c
+            end
+          end
+
           def identified_view_map
             view_map.transform_values(&:identified_without_base).merge(base: inherited_output)
           end

data/lib/sober_swag/reporting/output.rb

@@ -10,11 +10,13 @@ module SoberSwag
       autoload(:Defer, 'sober_swag/reporting/output/defer')
       autoload(:Described, 'sober_swag/reporting/output/described')
       autoload(:Dictionary, 'sober_swag/reporting/output/dictionary')
+      autoload(:InRange, 'sober_swag/reporting/output/in_range')
       autoload(:Interface, 'sober_swag/reporting/output/interface')
       autoload(:List, 'sober_swag/reporting/output/list')
       autoload(:MergeObjects, 'sober_swag/reporting/output/merge_objects')
       autoload(:Null, 'sober_swag/reporting/output/null')
       autoload(:Number, 'sober_swag/reporting/output/number')
+      autoload(:Enum, 'sober_swag/reporting/output/enum')
       autoload(:Object, 'sober_swag/reporting/output/object')
       autoload(:Partitioned, 'sober_swag/reporting/output/partitioned')
       autoload(:Pattern, 'sober_swag/reporting/output/pattern')

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

@@ -8,6 +8,10 @@ module SoberSwag
           @report = report
         end
 
+        def message
+          "Reported errors: #{report.full_errors.join(', ')}"
+        end
+
         attr_reader :report
       end
     end

data/lib/sober_swag/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.1
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -304,10 +304,12 @@ files:
 - 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/in_range.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/multiple_of.rb
 - lib/sober_swag/reporting/input/null.rb
 - lib/sober_swag/reporting/input/number.rb
 - lib/sober_swag/reporting/input/object.rb
@@ -323,6 +325,8 @@ files:
 - 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/enum.rb
+- lib/sober_swag/reporting/output/in_range.rb
 - lib/sober_swag/reporting/output/interface.rb
 - lib/sober_swag/reporting/output/list.rb
 - lib/sober_swag/reporting/output/merge_objects.rb