sober_swag 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1c1c2df36ccecf700e4d3ecf104c1324f9fa35b4588b4a040238f2513bf4b8
-  data.tar.gz: 3d22562035e1d8e93b11876fc82f6a23b1d26e95952d988423559d555adf680a
+  metadata.gz: 13d3f48bc3d3d8fb42984b13e7b260f0c5e52331cbc6b641b600511b67aed323
+  data.tar.gz: 32437d0fc96f42c5c05120946154108d0ffa2a6d9ad3fce648c8c49884addbce
 SHA512:
-  metadata.gz: 3a486a7b09b631d567f509c94b3b161350de61971f148ba24f707e117fa6915e6d7be99c6782ff07662da44edc3edb56ebb1691ac0fe8e819fc138dca4513ac9
-  data.tar.gz: e4447e3a951d0867c76a6bbd30a49da136d9406d00dfe0c5e0632574746a59fa72b936eb736c573de33bfe01e1d36d36771561fed7b9a6b00be43dcaa0c82653
+  metadata.gz: 2e643f5d730c20eac9671c6e306f63c8c0b679dd26eab69a5eea91aa456c094f240399c7058d59300e7c333c3747980a814a7db43f979f2e800cdc9ef940f577
+  data.tar.gz: 4454eee231879d67313f1d9c1d1b094faf1131d3487f68d96fa1e529055ce48954ad8fa74eeef78b675baf7a4404afb778d607ce701b27a3e40bbeb513aaab15

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.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/interface.rb

@@ -30,6 +30,12 @@ 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

data/lib/sober_swag/reporting/output.rb

@@ -15,6 +15,7 @@ module SoberSwag
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-03 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,7 @@ 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/interface.rb
 - lib/sober_swag/reporting/output/list.rb
 - lib/sober_swag/reporting/output/merge_objects.rb