swagger-dsl 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df246a1f449c1cb5be1e6d1353bd3a5f04863471ebc6e742d1474bb8f320729d
-  data.tar.gz: e7b9841234c25d9c0c44171cadfcdc2768cae499c1969e74569d7b8f25fd5369
+  metadata.gz: b131abdb9e40b72e5958ab7c2a7e34b42cf21e162ef01726feab2585b1e6e450
+  data.tar.gz: dec48a00848fc65cf08fa11ebb4369cfa9793491ea10884bc472eb848ddeee06
 SHA512:
-  metadata.gz: 33920f490f0899e4ec4a2fd1b5d25a53ead73b1e20712b7cbaf3ed9998d2af84abb9c77fa89f669ae858a0b9487a0c8335bdd81556f6edabb7f9b113704a9b01
-  data.tar.gz: 71319ffb954af6404a9eac5618f89a81d3d00c5d7b7c45959891bfa3560aa7d0b8d505fcdf96937d19f9cf10c0eeeb186b1c6cd908a359e69d8ce8cf877c6f15
+  metadata.gz: 5ab34c7b9ca4de4d1dd3eb8bcabfdfb06a6090d6c3cace125abe1d67511bc00c876303bce1f2825a70e5573b737477f8c849e8d4539478c3bcfe5187e0f34a10
+  data.tar.gz: da64cb44e3c4bee8ee6f4249be6393c86b181729fc2cf48e245279f94c883df775a9234f90ede60c35862e3051296b86ffdf8d376084aab398c68a8e85156f23

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # CHANGELOG
 
+## 1.2.0
+
+- mod(brake): params default required
+
 ## 1.1.0
 
-- add: multiple format accept in params
-- add: form shortcut in params format
+- add: multiple format accept
+- add: form shortcut in format
 
 ## 1.0.0
 

data/lib/swagger/dsl/config.rb

@@ -1,13 +1,14 @@
 module Swagger
   class DSL
     class Config
-      attr_accessor :inject_key, :default_dsl, :dsl_options, :eager
+      attr_accessor :inject_key, :default_dsl, :dsl_options, :eager, :default_required
 
-      def initialize(inject_key: "title", default_dsl: nil, dsl_options: nil, eager: false)
+      def initialize(inject_key: "title", default_dsl: nil, dsl_options: nil, eager: false, default_required: true)
         @inject_key = inject_key
         @default_dsl = default_dsl
         @dsl_options ||= { reference_name: ->(name) { name.sub(/Serializer$/, "") } }
         @eager = eager
+        @default_required = default_required
       end
     end
   end

data/lib/swagger/dsl/operation.rb

@@ -1,5 +1,6 @@
 require_relative "./json_schema"
 require_relative "./parameters"
+require_relative "../dsl"
 
 module Swagger
   class DSL
@@ -22,8 +23,8 @@ module Swagger
         instance_eval(&block)
       end
 
-      def params(&block)
-        self["parameters"] = Parameters.new(&block)
+      def params(default_required: Swagger::DSL.current.config.default_required, &block)
+        self["parameters"] = Parameters.new(default_required: default_required, &block)
       end
 
       def body(format: @format, dsl: nil, &block)

data/lib/swagger/dsl/parameter.rb

@@ -3,11 +3,14 @@ require_relative "./json_schema"
 module Swagger
   class DSL
     class Parameter < Hash
-      def initialize(*args, &block)
+      def initialize(options, *args, &block)
+        @default_required = options[:default_required]
+        self["required"] = true if @default_required
         unless args.empty?
           self["name"] = args.first
           args[1..-1].each { |arg| merge!(arg.map { |k, v| [k.to_s, v] }.to_h) }
           canonical_schema!
+          delete("required") unless self["required"]
         end
         instance_eval(&block) if block_given?
       end
@@ -17,10 +20,18 @@ module Swagger
         canonical_schema!
       end
 
-      %w[description required deprecated allowEmptyValue style explode allowReserved example examples].each do |name|
+      %w[description deprecated allowEmptyValue style explode allowReserved example examples].each do |name|
         define_method(name) { |value| self[name] = value }
       end
 
+      def required(value)
+        if value
+          self["required"] = true
+        else
+          delete("required")
+        end
+      end
+
       private
 
       def canonical_schema!

data/lib/swagger/dsl/parameters.rb

@@ -3,14 +3,14 @@ require_relative "./parameters_in_type"
 module Swagger
   class DSL
     class Parameters < Array
-      def initialize(format: :json, &block)
-        @format = format
+      def initialize(default_required:, &block)
+        @default_required = default_required
         instance_eval(&block)
       end
 
       %i[path query header cookie].each do |in_type|
         define_method(in_type) do |*args, &block|
-          args.empty? ? ParametersInType.new(self, in_type, &block) : self << Parameter.new(*args, in: in_type, &block)
+          args.empty? ? ParametersInType.new(self, in_type, { default_required: @default_required }, &block) : self << Parameter.new({ default_required: @default_required }, *args, in: in_type, &block)
         end
       end
     end

data/lib/swagger/dsl/parameters_in_type.rb

@@ -3,9 +3,10 @@ require_relative "./parameter"
 module Swagger
   class DSL < Hash
     class ParametersInType
-      def initialize(parent, type, &block)
+      def initialize(parent, type, parameter_options, &block)
         @parent = parent
         @type = type
+        @parameter_options = parameter_options
         instance_eval(&block)
       end
 
@@ -14,7 +15,7 @@ module Swagger
       end
 
       def method_missing(name, *args, &block)
-        @parent << Parameter.new(name, *args, in: @type, &block)
+        @parent << Parameter.new(@parameter_options, name, *args, in: @type, &block)
       end
     end
   end

data/lib/swagger/dsl/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   class DSL < Hash
-    VERSION = "1.1.0".freeze
+    VERSION = "1.2.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Narazaka
@@ -264,7 +264,7 @@ metadata:
   homepage_uri: https://github.com/Narazaka/swagger-dsl
   source_code_uri: https://github.com/Narazaka/swagger-dsl.git
   changelog_uri: https://github.com/Narazaka/swagger-dsl/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.1.0
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: