swagger-dsl 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a014577228f6444f0b6f6d4b3766d8231e280b4a8d099e1676f1d3711a832bab
-  data.tar.gz: a8495609f16a93e3af4dfacacafc400a3f14235836dc7b49e6907afafaa287c1
+  metadata.gz: 4ec890325cd8a13a5777720b3351c4c041d91e393fba975379795bace2860d95
+  data.tar.gz: 8082c1127a67be4060d2dbb32e1f89955b5b12642861198bdf1d0b627be750db
 SHA512:
-  metadata.gz: d86adb4e85d2162ea20b5cee7f6bb99c3447a7e00a3d6ceb6d427c104e20d0819cb372664ebfcc7677c3d2854c445d5feb059ca8e56bca288e29b1f854b6ee62
-  data.tar.gz: b1235bc9d31acb7c2828c6e45bf3123f9f2a907079e4dee1c6008c4ebdb276d0f00ed724469dfde91f33eb2e9fc4bf030e809e14c712c255d15d99de55a91e7a
+  metadata.gz: ef51b9cdb97ec79798999e4b4d5414e8bdd9b79e696d5492e11a3ec2f16fbb63be0222fd81a03bbe9fd57532b1b4a7e87c074c2c6fc0e855814c8ba8075c0e87
+  data.tar.gz: cce2fd4ff859619d69ab8fedf7668f7f70f83c60ab825ec31a60f40608f3fe30de2de82177815d68008c3d87530642860882f672b3488b9278da3483232f8f67

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.4.0
+
+- add: lazy_define_paths for Rails eager_load
+
 ## 1.3.0
 
 - mod: put / patch both define

data/README.md

@@ -90,6 +90,23 @@ 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/config.rb

@@ -1,14 +1,22 @@
 module Swagger
   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/operation.rb

@@ -29,9 +29,7 @@ module Swagger
 
       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 +44,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

@@ -6,6 +6,7 @@ module Swagger
       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

@@ -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

@@ -8,6 +8,15 @@ module Swagger
       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,14 +29,12 @@ module Swagger
         if method.include?("|")
           raise NotExactMatch, "route matched but verb can be #{verb}! specify :method key like 'get'."
         end
-        method = ["put", "patch"] if ["put", "patch"].include?(method)
+        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] ||= {}
-        Array(method).each do |single_method|
-          Swagger::DSL.current["paths"][path][single_method] = operation
-        end
+        Array(method).each { |single_method| Swagger::DSL.current["paths"][path][single_method] = operation }
       end
 
       alias_method :oas3, :swagger

data/lib/swagger/dsl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-dsl
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Narazaka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jimmy
@@ -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.3.0
+  documentation_uri: https://www.rubydoc.info/gems/swagger-dsl/1.4.0
 post_install_message: 
 rdoc_options: []
 require_paths: