zero-rails_openapi 1.5.7 → 1.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed64dbbb343efdc64e8ea606b49e5363f6fcc04a
-  data.tar.gz: f6914e5543de926f5672710f9247ccb3b1c1bdbc
+SHA256:
+  metadata.gz: 39f35108e381101fa164cda95f406a2317dac0fd7527fd1a05860301a41633f0
+  data.tar.gz: 949cdb1266842f65c92b8f1822f0c4fe1c2cc6c566bf5164c2b6bee168e29fb1
 SHA512:
-  metadata.gz: 6308ca2b74eee6cd14d2a828eaed6c4591ffd2496e115c1e2c1d0807f7c70b457965f7146738efdb430740eb7a3f95d7fe0991060b4ca2531e18037c14547d5f
-  data.tar.gz: 290fcb45ceb1f876ea4b3f20ccdfd4f056be1a5e18a6e534bef63e8d7a7d217e513872ec3bbed827748d2bd258bae69af455102f6dda5a870797a87981c4286c
+  metadata.gz: ed98743a9c8709cbeca382a61c343b4a93d2f62342a2f35cdf16fba131fa1129906d015b875dd1eca23bacfdcfc306806c5b05a2089a6fc3e016e625dc49e906
+  data.tar.gz: 8a88b1ff4011352b2f5875fbce9615c33cd3da3be6e1b068aacf2e902f36ccac5048862b54c701c79d7bbb5c1199bf2216bae66f091a126afcb78982996b3697

data/CHANGELOG.md

@@ -6,11 +6,11 @@
 
 ## Changed
 
-1. issue [#16](#https://github.com/zhandao/zero-rails_openapi/issues/16) DSL in `base_doc_class` can not be generated.
+1. issue [#16](https://github.com/zhandao/zero-rails_openapi/issues/16) DSL in `base_doc_class` can not be generated.
 
 ## Fixed
 
-1. issue [#15](#https://github.com/zhandao/zero-rails_openapi/issues/15) colorize was not required.
+1. issue [#15](https://github.com/zhandao/zero-rails_openapi/issues/15) colorize was not required.
 2. securitySchemes defined by config DSL was not be generated.
 
 ## [1.5.6] - 2018/3/23 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.5...v1.5.6)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.5.7)
+    zero-rails_openapi (1.5.8)
       activesupport (>= 3)
       colorize
       rails (>= 3)
@@ -9,54 +9,54 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.5)
-      actionpack (= 5.1.5)
+    actioncable (5.1.6)
+      actionpack (= 5.1.6)
       nio4r (~> 2.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.1.5)
-      actionpack (= 5.1.5)
-      actionview (= 5.1.5)
-      activejob (= 5.1.5)
+    actionmailer (5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.5)
-      actionview (= 5.1.5)
-      activesupport (= 5.1.5)
+    actionpack (5.1.6)
+      actionview (= 5.1.6)
+      activesupport (= 5.1.6)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.5)
-      activesupport (= 5.1.5)
+    actionview (5.1.6)
+      activesupport (= 5.1.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.5)
-      activesupport (= 5.1.5)
+    activejob (5.1.6)
+      activesupport (= 5.1.6)
       globalid (>= 0.3.6)
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activerecord (5.1.5)
-      activemodel (= 5.1.5)
-      activesupport (= 5.1.5)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
       arel (~> 8.0)
-    activesupport (5.1.5)
+    activesupport (5.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (8.0.0)
     builder (3.2.3)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
-    crass (1.0.3)
+    crass (1.0.4)
     diff-lcs (1.3)
     docile (1.3.0)
     erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (0.9.5)
+    i18n (1.0.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     loofah (2.2.2)
@@ -72,28 +72,28 @@ GEM
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     rack (2.0.4)
-    rack-test (0.8.3)
+    rack-test (1.0.0)
       rack (>= 1.0, < 3)
-    rails (5.1.5)
-      actioncable (= 5.1.5)
-      actionmailer (= 5.1.5)
-      actionpack (= 5.1.5)
-      actionview (= 5.1.5)
-      activejob (= 5.1.5)
-      activemodel (= 5.1.5)
-      activerecord (= 5.1.5)
-      activesupport (= 5.1.5)
+    rails (5.1.6)
+      actioncable (= 5.1.6)
+      actionmailer (= 5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
+      activemodel (= 5.1.6)
+      activerecord (= 5.1.6)
+      activesupport (= 5.1.6)
       bundler (>= 1.3.0)
-      railties (= 5.1.5)
+      railties (= 5.1.6)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.1.5)
-      actionpack (= 5.1.5)
-      activesupport (= 5.1.5)
+    railties (5.1.6)
+      actionpack (= 5.1.6)
+      activesupport (= 5.1.6)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)

data/documentation/parameter.md

@@ -66,3 +66,4 @@ You can set the schema by following keys (all are optional), the words in parent
   Regexp or Time Format
   - **default (dft, default_value)**
   - **as** # TODO
+  - **example & examples** # TODO

data/lib/oas_objs/example_obj.rb

@@ -7,14 +7,16 @@ module OpenApi
     class ExampleObj < Hash
       include Helpers
 
-      attr_accessor :processed, :examples_hash, :keys_of_value
+      attr_accessor :processed, :examples_hash, :example_value, :keys_of_value
 
-      def initialize(examples_hash, keys_of_value = nil)
-        self.examples_hash = examples_hash
+      def initialize(exp, keys_of_value = nil, multiple: false)
+        multiple ? self.examples_hash = exp : self.example_value = exp
         self.keys_of_value = keys_of_value
       end
 
       def process
+        return self.processed = example_value if example_value
+
         self.processed =
           examples_hash.map do |(name, value)|
             value =

data/lib/oas_objs/media_type_obj.rb

@@ -13,7 +13,7 @@ module OpenApi
         schema_type   = hash.values_at(:type, :data).compact.first
         exp_by        = schema_type.keys if exp_by == :all
 
-        self.examples   = ExampleObj.new(examples_hash, exp_by) if examples_hash.present?
+        self.examples   = ExampleObj.new(examples_hash, exp_by, multiple: true) if examples_hash.present?
         self.media_type = media_type_mapping media_type
         self.schema     = SchemaObj.new(schema_type, hash)
       end

data/lib/oas_objs/schema_obj.rb

@@ -91,9 +91,10 @@ module OpenApi
 
       def pattern_default_and_other
         {
-            pattern:    _pattern.is_a?(String) ? _pattern : _pattern&.inspect&.delete('/'),
-            default:    _default,
-            examples:   self[:examples].present? ? ExampleObj.new(self[:examples], self[:exp_by]).process : nil,
+            pattern:  _pattern.is_a?(String) ? _pattern : _pattern&.inspect&.delete('/'),
+            default:  _default,
+            example:  _exp.present? ? ExampleObj.new(_exp).process : nil,
+            examples: _exps.present? ? ExampleObj.new(_exps, self[:exp_by], multiple: true).process : nil,
             as: _as, permit: _permit, not_permit: _npermit, req_if: _req_if, opt_if: _opt_if, blankable: _blank
         }
       end
@@ -104,18 +105,20 @@ module OpenApi
           _value:   %i[ must_be  value   allowable_value  ],
           _range:   %i[ range    number_range             ],
           _length:  %i[ length   lth     size             ],
-          _is:      %i[ is_a     is                       ], # NOT OAS Spec, see documentation/parameter.md
           _format:  %i[ format   fmt                      ],
           _pattern: %i[ pattern  regexp  pt   reg         ],
           _default: %i[ default  dft     default_value    ],
           _desc:    %i[ desc     description  d           ],
           __desc:   %i[ desc!    description! d!          ],
+          _exp:     %i[ example                           ],
+          _exps:    %i[ examples                          ],
+          _is:      %i[ is_a     is                       ], # NOT OAS Spec, see documentation/parameter.md
           _as:      %i[ as   to  for     map  mapping     ], # NOT OAS Spec, it's for zero-params_processor
-          _permit:  %i[ permit   pmt                      ], # NOT OAS Spec, it's for zero-params_processor
-          _npermit: %i[ npmt     not_permit   unpermit    ], # NOT OAS Spec, it's for zero-params_processor
-          _req_if:  %i[ req_if   req_when                 ], # NOT OAS Spec, it's for zero-params_processor
-          _opt_if:  %i[ opt_if   opt_when                 ], # NOT OAS Spec, it's for zero-params_processor
-          _blank:   %i[ blank    blankable                ], # NOT OAS Spec, it's for zero-params_processor
+          _permit:  %i[ permit   pmt                      ], # ditto
+          _npermit: %i[ npmt     not_permit   unpermit    ], # ditto
+          _req_if:  %i[ req_if   req_when                 ], # ditto
+          _opt_if:  %i[ opt_if   opt_when                 ], # ditto
+          _blank:   %i[ blank    blankable                ], # ditto
       }.each do |key, aliases|
         define_method key do
           return self[key] unless self[key].nil?

data/lib/open_api/dsl.rb

@@ -27,9 +27,11 @@ module OpenApi
       def components &block
         doc_tag if @doc_info.nil?
         structure = %i[ schemas responses	parameters examples requestBodies securitySchemes ].map { |k| [k, { }] }.to_h
-        current_doc = @doc_info[:components] = Components.new.merge!(structure)
+        current_doc = Components.new.merge!(structure)
         current_doc.instance_exec(&block)
         current_doc.process_objs
+
+        (@doc_info[:components] ||= { }).deep_merge!(current_doc)
       end
 
       def api action, summary = '', http: http_method = nil, skip: [ ], use: [ ], &block
@@ -37,7 +39,7 @@ module OpenApi
         # select the routing info (corresponding to the current method) from routing list.
         action_path = "#{@route_base ||= controller_path}##{action}"
         routes = ctrl_routes_list&.select { |api| api[:action_path].match?(/^#{action_path}$/) }
-        return puts '    ZRO'.red + " Route mapping failed: #{@route_base}##{action}" if routes.blank?
+        return puts '    ZRO'.red + " Route mapping failed: #{action_path}" if routes.blank?
 
         api = Api.new(action_path, skip: Array(skip), use: Array(use))
                  .merge! description: '', summary: summary, operationId: action, tags: [@doc_tag],

data/lib/open_api/dsl/api.rb

@@ -132,7 +132,7 @@ module OpenApi
 
       def param_examples exp_by = :all, examples_hash
         exp_by = self[:parameters].map(&:name) if exp_by == :all
-        self[:examples] = ExampleObj.new(examples_hash, exp_by).process
+        self[:examples] = ExampleObj.new(examples_hash, exp_by, multiple: true).process
       end
 
       alias examples param_examples

data/lib/open_api/dsl/components.rb

@@ -15,7 +15,7 @@ module OpenApi
       arrow_enable :schema
 
       def example component_key, examples_hash
-        self[:examples][component_key] = ExampleObj.new(examples_hash).process
+        self[:examples][component_key] = ExampleObj.new(examples_hash, multiple: true).process
       end
 
       arrow_enable :example

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.5.7'
+  VERSION = '1.5.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.5.7
+  version: 1.5.8
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Concise DSL for generating OpenAPI3 documentation.