swagger-dsl 1.2.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b131abdb9e40b72e5958ab7c2a7e34b42cf21e162ef01726feab2585b1e6e450
-  data.tar.gz: dec48a00848fc65cf08fa11ebb4369cfa9793491ea10884bc472eb848ddeee06
+  metadata.gz: 786aa5eea8ae2c2ce700f8c9bf9777da355f5647788d0fd7a1756316017bc182
+  data.tar.gz: 879edc53b7549aa2d194428cdc66f94080adc7c1e306c9aa6d67612606d4639c
 SHA512:
-  metadata.gz: 5ab34c7b9ca4de4d1dd3eb8bcabfdfb06a6090d6c3cace125abe1d67511bc00c876303bce1f2825a70e5573b737477f8c849e8d4539478c3bcfe5187e0f34a10
-  data.tar.gz: da64cb44e3c4bee8ee6f4249be6393c86b181729fc2cf48e245279f94c883df775a9234f90ede60c35862e3051296b86ffdf8d376084aab398c68a8e85156f23
+  metadata.gz: f3462fb293dfb7f055d80ec3d027a2b33c9d5a973c84a0aaa2b84c566e7587bbfaa456a0e17e24321e1d525e22356314e9aa203d58f5c33ffac6d47d90d0f0e3
+  data.tar.gz: eb112da3508f85283177a6bdfb375f487880b5f32a2c18f301d21f4f221981fe7cf3e42c84f868e933032254fa944d790618be327ceba1648d1b183be79d2df0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.4.0
+
+- add: lazy_define_paths for Rails eager_load
+
+## 1.3.0
+
+- mod: put / patch both define
+
 ## 1.2.0
 
 - mod(brake): params default required

data/README.md

@@ -42,11 +42,10 @@ end
 class UsersController < ApplicationController
   swagger :update do
     params do
-      path :id, schema: :integer, required: true
+      path :id, schema: :integer
       query do
-        safe schema: :boolean
+        safe schema: :boolean, required: false
         redirect do
-          required true
           schema do
             string!
             format! "url"
@@ -83,6 +82,31 @@ Swagger::DSL.current["info"] = {
 JSON.dump(Swagger::DSL.current)
 ```
 
+### required default
+
+Body and response parameters are "required" default in default DSL.
+
+So `params` are also default "required".
+
+If you do not want it, `Swagger::DSL.current.config.default_required = false`.
+
+### If Rails eager_load = true
+
+Rails controllers will be loaded before loading the routes when eager_load is enabled.
+
+So set `Swagger::DSL.current.config.lazy_define_paths = true`, `reload_routes!` and `Swagger::DSL.current.define_paths!`
+
+```ruby
+if Rails.application.config.eager_load
+  Swagger::DSL.current.config.lazy_define_paths = true
+  Rails.application.config.after_initialize do
+    Rails.application.reload_routes!
+    Swagger::DSL.current.define_paths!
+    JSON.dump(Swagger::DSL.current)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/swagger/dsl.rb

@@ -15,7 +15,7 @@ module Swagger
       end
     end
 
-    attr_reader :config
+    attr_reader :config, :define_paths_procs
 
     def initialize(schema = nil, config: Config.new)
       merge!(schema || {})
@@ -24,6 +24,11 @@ module Swagger
       self["paths"] ||= {}
       self["components"] = Components[self["components"] || {}]
       @config = config
+      @define_paths_procs = []
+    end
+
+    def define_paths!
+      define_paths_procs.each(&:call)
     end
   end
 end

data/lib/swagger/dsl/components.rb

@@ -3,7 +3,7 @@ require_relative "./parameters"
 require_relative "../dsl"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class Components < Hash
       STRING = "".freeze
 

data/lib/swagger/dsl/config.rb

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

data/lib/swagger/dsl/json_schema.rb

@@ -3,7 +3,7 @@ require_relative "./json_schema/jimmy"
 require_relative "../dsl"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class JsonSchema
       def self.by(dsl_type = nil)
         dsl_type ||= Swagger::DSL.current.config.default_dsl

data/lib/swagger/dsl/json_schema/jimmy.rb

@@ -2,7 +2,7 @@ require "jimmy"
 require_relative "./jimmy_patch"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class JsonSchema
       class Jimmy
         DOMAIN = ::Jimmy::Domain.new("")

data/lib/swagger/dsl/json_schema/subset_dsl.rb

@@ -2,7 +2,7 @@ require "json/schema/subset/dsl"
 require_relative "../../dsl"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class JsonSchema
       class SubsetDSL
         def self.dsl(&block)

data/lib/swagger/dsl/operation.rb

@@ -3,7 +3,7 @@ require_relative "./parameters"
 require_relative "../dsl"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class Operation < Hash
       FORMAT_TYPE = {
         json: "application/json",
@@ -19,19 +19,30 @@ module Swagger
         self["requestBody"] = { "content" => {}, "required" => true }
         self["responses"] = {}
         self["parameters"] = []
+        self["tags"] = []
         @format = format
         instance_eval(&block)
       end
 
+      def summary(text)
+        self["summary"] = text
+      end
+
+      def description(text)
+        self["description"] = text
+      end
+
+      def tags(*tags)
+        self["tags"].concat(tags.flatten(1))
+      end
+
       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)
         formats(format).each do |f|
-          self["requestBody"]["content"][f] = {
-            "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
-          }
+          self["requestBody"]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end
       end
 
@@ -46,9 +57,7 @@ module Swagger
       def render(code = 200, format: @format, dsl: nil, &block)
         self["responses"][code] ||= { "content" => {} }
         formats(format).each do |f|
-          self["responses"][code]["content"][f] = {
-            "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block)
-          }
+          self["responses"][code]["content"][f] = { "schema" => Swagger::DSL::JsonSchema.by(dsl).dsl(&block) }
         end
       end
 

data/lib/swagger/dsl/parameter.rb

@@ -1,11 +1,12 @@
 require_relative "./json_schema"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class Parameter < Hash
       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) }

data/lib/swagger/dsl/parameters.rb

@@ -1,7 +1,7 @@
 require_relative "./parameters_in_type"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     class Parameters < Array
       def initialize(default_required:, &block)
         @default_required = default_required
@@ -10,7 +10,11 @@ module Swagger
 
       %i[path query header cookie].each do |in_type|
         define_method(in_type) do |*args, &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)
+          if args.empty?
+            ParametersInType.new(self, in_type, { default_required: @default_required }, &block)
+          else
+            self << Parameter.new({ default_required: @default_required }, *args, in: in_type, &block)
+          end
         end
       end
     end

data/lib/swagger/dsl/rails_controller.rb

@@ -2,12 +2,21 @@ require_relative "../dsl"
 require_relative "./operation"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     module RailsController
       class NotMatch < StandardError; end
       class NotExactMatch < StandardError; end
 
       def swagger(action, format = :json, path: nil, method: nil, &block)
+        if Swagger::DSL.current.config.lazy_define_paths
+          Swagger::DSL.current.define_paths_procs <<
+            -> { swagger_define_path(action, format, path: path, method: method, &block) }
+        else
+          swagger_define_path(action, format, path: path, method: method, &block)
+        end
+      end
+
+      def swagger_define_path(action, format = :json, path: nil, method: nil, &block)
         operation_id = "#{name}##{action}"
 
         defaults = { action: action.to_s, controller: name.underscore.sub(/_controller$/, "") }
@@ -20,11 +29,12 @@ module Swagger
         if method.include?("|")
           raise NotExactMatch, "route matched but verb can be #{verb}! specify :method key like 'get'."
         end
+        method = %w[put patch] if %w[put patch].include?(method)
         path ||= route.path.spec.to_s.sub("(.:format)", "").gsub(/:(\w+)/, "{\\1}")
 
         operation = Swagger::DSL::Operation.new(operation_id, format: format, &block)
         Swagger::DSL.current["paths"][path] ||= {}
-        Swagger::DSL.current["paths"][path][method] = operation
+        Array(method).each { |single_method| Swagger::DSL.current["paths"][path][single_method] = operation }
       end
 
       alias_method :oas3, :swagger

data/lib/swagger/dsl/resolve_module.rb

@@ -3,7 +3,7 @@ require "hana"
 require "active_support/core_ext/object/deep_dup"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     module ResolveModule
       def resolved
         JsonRefs.call(deep_dup)

data/lib/swagger/dsl/serializer.rb

@@ -2,7 +2,7 @@ require_relative "../dsl"
 require_relative "./json_schema"
 
 module Swagger
-  class DSL
+  class DSL < Hash
     module Serializer
       def swagger(dsl: nil, &block)
         name = self.name.sub(/Serializer$/, "")

data/lib/swagger/dsl/version.rb

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

data/swagger-dsl.gemspec

@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json-schema-subset-dsl", "~> 1.2"
   spec.add_dependency "hana", "~> 1.3"
   spec.add_dependency "json_refs", "~> 0.1"
-  spec.add_dependency "activesupport", "~> 6.0"
+  spec.add_dependency "activesupport", ">= 4.0.2"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rspec-power_assert", "~> 1.1"
   spec.add_development_dependency "rubocop", "~> 0.76"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-01 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jimmy
@@ -70,16 +70,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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.2.0
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.5.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Swagger (OpenAPI 3) DSL