oas_contrib 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b1a48c2b71fbc69225a8d565450bd2478ce8e5f2710196a06c05a3d60c93e68
-  data.tar.gz: 4bb4aea54a90ebdd8edc03252da09122625e411c17a31076fdd93c8457df76ba
+  metadata.gz: b0a7cb442ad80a5069290a8ee4452c08aa454b9db4fe0e4c6a4a9e759754269f
+  data.tar.gz: 41ee8a0a9d722e5ec0e14cc2db1eb177d646538b4e1c4bd52a12816d8325c089
 SHA512:
-  metadata.gz: 723585fa66b02f6ff7201026234ea318f9f26e798a2ddf6fdc232c6b32505a7a3d9a6653c07820cd12f32fb38f74009727a34a8425073b9692e9ba14ed13d03a
-  data.tar.gz: a7d852a298beafaf2fbefec3c84278610d680f438ca3d21d9a02d36fd005e73e707709e165593fea66920696be8ccbbd5132512edaa4a1a3ec4313adf2bc561b
+  metadata.gz: 30b549fe4d53f3281f3b498d898251a131fd20fd4d8f5e6b70fed504bcb6935a29de10237952895287cbf5d1f7f4fce294233541cb48ce798f4caa75ceec8a92
+  data.tar.gz: 92fbd5c8820a6b30dde1e7b7ff431d7fac8b56cc14c1392ea36cfb836b364e1f6e7fb6919ff14022ffa6639a22a16680e7164b9005c4f250fced5a165955c706

data/.rspec_status

@@ -1,12 +1,12 @@
 example_id                           | status | run_time        |
 ------------------------------------ | ------ | --------------- |
-./spec/divide_command_spec.rb[1:1:1] | passed | 0.34731 seconds |
-./spec/divide_command_spec.rb[1:2:1] | passed | 0.35834 seconds |
-./spec/divide_command_spec.rb[1:3:1] | passed | 0.50581 seconds |
-./spec/divide_command_spec.rb[1:4:1] | passed | 0.41085 seconds |
-./spec/divide_command_spec.rb[1:5:1] | passed | 0.52116 seconds |
-./spec/merge_command_spec.rb[1:1:1]  | passed | 0.80512 seconds |
-./spec/merge_command_spec.rb[1:2:1]  | passed | 0.54957 seconds |
-./spec/merge_command_spec.rb[1:3:1]  | passed | 0.45048 seconds |
-./spec/merge_command_spec.rb[1:4:1]  | passed | 0.53336 seconds |
-./spec/merge_command_spec.rb[1:5:1]  | passed | 0.60615 seconds |
+./spec/divide_command_spec.rb[1:1:1] | passed | 0.51656 seconds |
+./spec/divide_command_spec.rb[1:2:1] | passed | 0.42067 seconds |
+./spec/divide_command_spec.rb[1:3:1] | passed | 0.45216 seconds |
+./spec/divide_command_spec.rb[1:4:1] | passed | 0.35493 seconds |
+./spec/divide_command_spec.rb[1:5:1] | passed | 0.31474 seconds |
+./spec/merge_command_spec.rb[1:1:1]  | passed | 0.34898 seconds |
+./spec/merge_command_spec.rb[1:2:1]  | passed | 0.3249 seconds  |
+./spec/merge_command_spec.rb[1:3:1]  | passed | 0.3212 seconds  |
+./spec/merge_command_spec.rb[1:4:1]  | passed | 0.41895 seconds |
+./spec/merge_command_spec.rb[1:5:1]  | passed | 0.75778 seconds |

data/README.md

@@ -22,132 +22,37 @@ Or install it yourself as:
 
 ## Usage
 
-### Divide command
+### Common rule
 
-Divide the OAS file into path units and schema units.
+* The file extension of `<OpenAPI Specification file>` must be `.json` or `.yml`.
+* `<OpenAPI Specification file>` must be has the section of `swagger: 2.0.X` or `openapi: 3.0.X`.
 
-```bash
-$ oas_contrib divide <OAS file> <output_dir> (<options>...)
-```
-
-`<OAS file>` must be `.json` or `.yml`
-
-#### Options
-
-| option     | description      | value type                | default  |
-|------------|------------------|---------------------------|----------|
-|`--out_type`| output file type | String (`yaml` or `json`) | `yaml`   |
-
-#### Example
-
-##### Open API 3.0
-
-[BEFORE](https://github.com/MichinaoShimizu/oas_contrib/blob/master/example/v3.yml) -> [AFTER](https://github.com/MichinaoShimizu/oas_contrib/tree/master/example/dist/v3)
-
-```
-$ oas_contrib divide example/v3.yml example/dist/v3
-Load: example/v3.yml
-Dist: example/dist/v3/meta
-Dist: example/dist/v3/meta/001_openapi.yml
-Dist: example/dist/v3/meta/002_info.yml
-Dist: example/dist/v3/meta/003_servers.yml
-Dist: example/dist/v3/path
-Dist: example/dist/v3/path/001_pets.yml
-Dist: example/dist/v3/path/002_pets_{petId}.yml
-Dist: example/dist/v3/model
-Dist: example/dist/v3/model/001_Pet.yml
-Dist: example/dist/v3/model/002_Error.yml
-
-$ tree example/dist/v3/
-example/dist/v3/
-├── meta
-│   ├── 001_openapi.yml
-│   ├── 002_info.yml
-│   └── 003_servers.yml
-├── model
-│   ├── 001_Pet.yml
-│   ├── 002_Error.yml
-│   └── 003_Pets.yml
-└── path
-    ├── 001_pets.yml
-    └── 002_pets_{petId}.yml
-```
+### Divide the OpenAPI Specification file
 
-##### Open API 2.0
-
-[BEFORE](https://github.com/MichinaoShimizu/oas_contrib/blob/master/example/v2.yml) -> [AFTER](https://github.com/MichinaoShimizu/oas_contrib/tree/master/example/dist/v2)
-
-```
-$ oas_contrib divide example/v2.yml example/dist/v2
-Load: example/v2.yml
-Dist: example/dist/v2/meta
-Dist: example/dist/v2/meta/001_swagger.yml
-Dist: example/dist/v2/meta/002_info.yml
-Dist: example/dist/v2/meta/003_host.yml
-Dist: example/dist/v2/meta/004_basePath.yml
-Dist: example/dist/v2/meta/005_schemes.yml
-Dist: example/dist/v2/meta/006_consumes.yml
-Dist: example/dist/v2/meta/007_produces.yml
-Dist: example/dist/v2/meta/008_components.yml
-Dist: example/dist/v2/path
-Dist: example/dist/v2/path/001_pets.yml
-Dist: example/dist/v2/path/002_pets_{petId}.yml
-Dist: example/dist/v2/model
-Dist: example/dist/v2/model/001_Pet.yml
-Dist: example/dist/v2/model/002_Error.yml
-Dist: example/dist/v2/model/003_Pets.yml
-
-$ tree example/dist/
-example/dist/
-└── v2
-    ├── meta
-    │   ├── 001_swagger.yml
-    │   ├── 002_info.yml
-    │   ├── 003_host.yml
-    │   ├── 004_basePath.yml
-    │   ├── 005_schemes.yml
-    │   ├── 006_consumes.yml
-    │   ├── 007_produces.yml
-    │   └── 008_components.yml
-    ├── model
-    │   ├── 001_Pet.yml
-    │   ├── 002_Error.yml
-    │   └── 003_Pets.yml
-    └── path
-        ├── 001_pets.yml
-        └── 002_pets_{petId}.yml
+```bash
+$ oas_contrib divide <OpenAPI Specification file> <output_dir> (<options>...)
 ```
 
-### Merge command
+| option     | description                  | value type                 | default  |
+|------------|------------------------------|----------------------------|----------|
+|`--out_ext` | the extension of output file | String (`.json` or `.yml`) | `.yml`   |
 
-Merge multiple divided files into an OAS file.
+### Merge from divided files to an OpenAPI Specification file
 
 ```bash
-$ oas_contrib merge <input_dir> <OAS file> (<options>...)
+$ oas_contrib merge <input_dir> <OpenAPI Specification file> (<options>...)
 ```
 
-`<OAS file>` must be `.json` or `.yml`
-
-#### Options
+| option     | description                  | value type                 | default  |
+|------------|------------------------------|----------------------------|----------|
+|`--in_ext`  | the extension of input  file | String (`.json` or `.yml`) | `.yml`   |
 
-| option     | description      | value type               | default  |
-|------------|------------------|------------------------- |----------|
-|`--in_type` | input file type  | String (`yaml` or `json`)| `yaml`   |
-
-### Preview command
-
-Preview OAS file using Swagger-UI official Docker image.
-
-The preview command needs docker.
+### Preview the OpenAPI Specification file using Swagger-UI docker image
 
 ```bash
-$ oas_contrib preview <input_file> (<options>...)
+$ oas_contrib preview <OpenAPI Specification file> (<options>...)
 ```
 
-`<input_file>` must be `.json` or `.yml`
-
-#### Options
-
 | option     | description             | value type      | default  |
 |------------|-------------------------|-----------------|----------|
 |`--port`    | Swagger UI listen port  | Integer         | `50010`  |

data/lib/oas_contrib/command.rb

@@ -7,8 +7,8 @@ module OasContrib
   class Command < Thor
     include Thor::Actions
 
-    option :out_type, type: :string, default: 'yaml', desc: 'output file type (yaml or json)'
     desc 'divide <spec_file> <output_dir> (<options>)', 'Divide the spec_file into path units and schema units.'
+    option :out_ext, type: :string, default: '.yml', desc: 'output file ext (.yml or .json)'
 
     def divide(spec_file, outdir)
       resolver = OasContrib::Resolver::Divide.new(spec_file, outdir, options)
@@ -19,8 +19,8 @@ module OasContrib
       say 'complete!', :green
     end
 
-    option :in_type, type: :string, default: 'yaml', desc: 'input file type (yaml or json)'
     desc 'merge <input_dir> <spec_file> (<options>)', 'Merge multiple divided files into an spec_file.'
+    option :in_ext, type: :string, default: '.yml', desc: 'input file ext (.yml or .json)'
 
     def merge(indir, spec_file)
       resolver = OasContrib::Resolver::Merge.new(indir, spec_file, options)
@@ -31,8 +31,8 @@ module OasContrib
       say 'complete!', :green
     end
 
-    option :port, type: :numeric, default: 50010, desc: 'Swagger UI listen port'
     desc 'preview <spec_file> (<options>)', 'Preview the spec_file using Swagger-UI official Docker image.'
+    option :port, type: :numeric, default: 50_010, desc: 'Swagger UI listen port'
 
     def preview(spec_file)
       resolver = OasContrib::Resolver::Preview.new(spec_file, options)

data/lib/oas_contrib/interface/spec.rb

@@ -2,7 +2,7 @@ module OasContrib
   module Interface
     module Spec
       def mapping
-        raise NotImplementedError, 'You must be implement "mangppi" method.'
+        raise NotImplementedError, 'You must be implement "mapping" method.'
       end
     end
   end

data/lib/oas_contrib/resolver/base.rb

@@ -11,6 +11,18 @@ module OasContrib
 
       include OasContrib::Interface::Resolver
 
+      DEFINED_FILE_EXT = ['.json', '.yml'].freeze
+
+      def file_ext_check
+        if @infile_ext && !DEFINED_FILE_EXT.include?(@infile_ext)
+          raise "Undefined input file extension. #{@infile_ext}"
+        end
+
+        if @outfile_ext && !DEFINED_FILE_EXT.include?(@outfile_ext)
+          raise "Undefined output file extension. #{@outfile_ext}"
+        end
+      end
+
       def v3?
         @data['openapi'] =~ /^3/
       end
@@ -34,14 +46,6 @@ module OasContrib
         File.open(path, 'w') { |f| _output(hash, f) }
       end
 
-      def str2ext(type)
-        case type
-        when 'yaml' then '.yml'
-        when 'json' then '.json'
-        else raise ArgumentError, 'Undefined file type'
-        end
-      end
-
       def input_dir(dir)
         path = dir + '/**/*' + @infile_ext
         Dir.glob(path).sort.each_with_object({}, &input_lambda)

data/lib/oas_contrib/resolver/divide.rb

@@ -8,12 +8,12 @@ module OasContrib
         @path_dir     = outdir + '/path'
         @model_dir    = outdir + '/model'
         @infile       = infile
-        @outfile_type = options['out_type']
+        @outfile_ext  = options['out_ext']
       end
 
       def setup
-        @infile_ext  = File.extname(@infile)
-        @outfile_ext = str2ext(@outfile_type)
+        @infile_ext = File.extname(@infile)
+        file_ext_check
       end
 
       def load

data/lib/oas_contrib/resolver/merge.rb

@@ -4,16 +4,16 @@ module OasContrib
   module Resolver
     class Merge < OasContrib::Resolver::Base
       def initialize(indir, outfile, options)
-        @meta_dir    = indir + '/meta'
-        @path_dir    = indir + '/path'
-        @model_dir   = indir + '/model'
-        @outfile     = outfile
-        @infile_type = options['in_type']
+        @meta_dir   = indir + '/meta'
+        @path_dir   = indir + '/path'
+        @model_dir  = indir + '/model'
+        @outfile    = outfile
+        @infile_ext = options['in_ext']
       end
 
       def setup
-        @infile_ext  = str2ext(@infile_type)
         @outfile_ext = File.extname(@outfile)
+        file_ext_check
       end
 
       def load

data/lib/oas_contrib/resolver/preview.rb

@@ -10,7 +10,9 @@ module OasContrib
 
       def setup
         @expand_path = File.expand_path(@infile)
-        @basename = File.basename(@expand_path)
+        @basename    = File.basename(@expand_path)
+        @infile_ext  = File.extname(@infile)
+        file_ext_check
       end
 
       def distribute

data/lib/oas_contrib/version.rb

@@ -1,3 +1,3 @@
 module OasContrib
-  VERSION = '0.2.4'.freeze
+  VERSION = '0.2.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Michinao Shimizu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-07 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor