oas_contrib 0.2.5 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a7cb442ad80a5069290a8ee4452c08aa454b9db4fe0e4c6a4a9e759754269f
-  data.tar.gz: 41ee8a0a9d722e5ec0e14cc2db1eb177d646538b4e1c4bd52a12816d8325c089
+  metadata.gz: 7fa1d5623f4d09450ed267bb56e209700143a0aa1d80259164ace19ea0a2d6d9
+  data.tar.gz: 29b486addbd6c5ca256d668b489b258ada6b8a36e0c52d9265659f322c748684
 SHA512:
-  metadata.gz: 30b549fe4d53f3281f3b498d898251a131fd20fd4d8f5e6b70fed504bcb6935a29de10237952895287cbf5d1f7f4fce294233541cb48ce798f4caa75ceec8a92
-  data.tar.gz: 92fbd5c8820a6b30dde1e7b7ff431d7fac8b56cc14c1392ea36cfb836b364e1f6e7fb6919ff14022ffa6639a22a16680e7164b9005c4f250fced5a165955c706
+  metadata.gz: c925b3c0c21f3d9e0178a5ebb9deda4cc2b6b1c20b3a14a4d6cdb655aab0a3dd93c3f4e07ebaad6fe7e4a1ca2451a5268d0497cfaa2520c4247a4016fa6b83c6
+  data.tar.gz: 42aaac1a8b4aab20067d4e70bedc78b2080114610807d687f5d0949c62a4c264f6ce41d7996a18cfae2739286a0bb6d90ac54be3baf99fb444e4f4735ade761a

data/.rspec_status

@@ -1,12 +1,14 @@
 example_id                           | status | run_time        |
 ------------------------------------ | ------ | --------------- |
-./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 |
+./spec/divide_command_spec.rb[1:1:1] | passed | 0.38062 seconds |
+./spec/divide_command_spec.rb[1:2:1] | passed | 0.37096 seconds |
+./spec/divide_command_spec.rb[1:3:1] | passed | 0.37719 seconds |
+./spec/divide_command_spec.rb[1:4:1] | passed | 0.36952 seconds |
+./spec/divide_command_spec.rb[1:5:1] | passed | 0.37552 seconds |
+./spec/divide_command_spec.rb[1:6:1] | passed | 0.3675 seconds  |
+./spec/merge_command_spec.rb[1:1:1]  | passed | 0.36627 seconds |
+./spec/merge_command_spec.rb[1:2:1]  | passed | 0.35855 seconds |
+./spec/merge_command_spec.rb[1:3:1]  | failed | 0.4193 seconds  |
+./spec/merge_command_spec.rb[1:4:1]  | passed | 0.36323 seconds |
+./spec/merge_command_spec.rb[1:5:1]  | passed | 0.3595 seconds  |
+./spec/merge_command_spec.rb[1:6:1]  | failed | 0.35928 seconds |

data/README.md

@@ -4,6 +4,12 @@
 
 Libraries and Commands for Open API (2.0, 3.0) Specification.
 
+* Divide OAS file.
+* Merge OAS divided files.
+* Preview OAS file with SwaggerUI.
+
+![divide](/divide.jpg)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,48 +20,103 @@ gem 'oas_contrib'
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install oas_contrib
+    gem install oas_contrib
 
 ## Usage
 
-### Common rule
+### sub commands
+```bash
+$ oas_contrib
+Commands:
+  oas_contrib divide <spec_file> <output_dir> (<options>)  # Divide the spec_file into path units and schema units.
+  oas_contrib help [COMMAND]                               # Describe available commands or one specific command
+  oas_contrib merge <input_dir> <spec_file> (<options>)    # Merge multiple divided files into an spec_file.
+  oas_contrib preview <spec_file> (<options>)              # Preview the spec_file using Swagger-UI official Docker image.
+```
 
-* 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`.
+### divide command
+```bash
+$ oas_contrib help divide
+Usage:
+  oas_contrib divide <spec_file> <output_dir> (<options>)
 
-### Divide the OpenAPI Specification file
+Options:
+  [--out-ext=OUT_EXT]  # output file ext (.yml or .yaml or .json)
+                       # Default: .yml
 
-```bash
-$ oas_contrib divide <OpenAPI Specification file> <output_dir> (<options>...)
+Divide the spec_file into path units and schema units.
 ```
 
-| option     | description                  | value type                 | default  |
-|------------|------------------------------|----------------------------|----------|
-|`--out_ext` | the extension of output file | String (`.json` or `.yml`) | `.yml`   |
+#### example
 
-### Merge from divided files to an OpenAPI Specification file
+##### input
+[v3.yml](/example/v3.yml)
 
-```bash
-$ oas_contrib merge <input_dir> <OpenAPI Specification file> (<options>...)
+##### execution
+```
+$ oas_contrib divide v3.yml sample
+Load: v3.yml
+Dist: sample/meta
+Dist: sample/meta/001_openapi.yml
+Dist: sample/meta/002_info.yml
+Dist: sample/meta/003_servers.yml
+Dist: sample/path
+Dist: sample/path/001_pets.yml
+Dist: sample/path/002_pets_{petId}.yml
+Dist: sample/model
+Dist: sample/model/001_Pet.yml
+Dist: sample/model/002_Error.yml
+Dist: sample/model/003_Pets.yml
+complete!
 ```
 
-| option     | description                  | value type                 | default  |
-|------------|------------------------------|----------------------------|----------|
-|`--in_ext`  | the extension of input  file | String (`.json` or `.yml`) | `.yml`   |
-
-### Preview the OpenAPI Specification file using Swagger-UI docker image
+##### output
+```
+$ tree sample/
+sample/
+├── 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
+```
+[output sample dir](/example/dist/v3)
 
+### merge command
 ```bash
-$ oas_contrib preview <OpenAPI Specification file> (<options>...)
+$ oas_contrib help merge
+Usage:
+  oas_contrib merge <input_dir> <spec_file> (<options>)
+
+Options:
+  [--in-ext=IN_EXT]  # input file ext (.yml or .yaml or .json)
+                     # Default: .yml
+
+Merge multiple divided files into an spec_file.
 ```
 
-| option     | description             | value type      | default  |
-|------------|-------------------------|-----------------|----------|
-|`--port`    | Swagger UI listen port  | Integer         | `50010`  |
+### preview command
+```bash
+$ oas_contrib help preview
+Usage:
+  oas_contrib preview <spec_file> (<options>)
+
+Options:
+  [--port=N]  # Swagger UI listen port
+              # Default: 50010
+
+Preview the spec_file using Swagger-UI official Docker image.
+```
 
 ## Contributing
 

data/example/v2.yaml

@@ -0,0 +1,103 @@
+---
+swagger: '2.0'
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+host: petstore.swagger.io
+basePath: "/v1"
+schemes:
+- http
+consumes:
+- application/json
+produces:
+- application/json
+components: {}
+paths:
+  "/pets":
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+      - pets
+      parameters:
+      - name: limit
+        in: query
+        description: How many items to return at one time (max 100)
+        required: false
+        type: integer
+        format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              type: string
+              description: A link to the next page of responses
+          schema:
+            "$ref": "#/definitions/Pets"
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+      - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+  "/pets/{petId}":
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+      - pets
+      parameters:
+      - name: petId
+        in: path
+        required: true
+        description: The id of the pet to retrieve
+        type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          schema:
+            "$ref": "#/definitions/Pets"
+        default:
+          description: unexpected error
+          schema:
+            "$ref": "#/definitions/Error"
+definitions:
+  Pet:
+    required:
+    - id
+    - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string
+  Error:
+    required:
+    - code
+    - message
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string
+  Pets:
+    type: array
+    items:
+      "$ref": "#/definitions/Pet"

data/example/v3.yaml

@@ -0,0 +1,110 @@
+---
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+- url: http://petstore.swagger.io/v1
+components:
+  schemas:
+    Pet:
+      required:
+      - id
+      - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Error:
+      required:
+      - code
+      - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string
+    Pets:
+      type: array
+      items:
+        "$ref": "#/components/schemas/Pet"
+paths:
+  "/pets":
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+      - pets
+      parameters:
+      - name: limit
+        in: query
+        description: How many items to return at one time (max 100)
+        required: false
+        schema:
+          type: integer
+          format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+      - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+  "/pets/{petId}":
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+      - pets
+      parameters:
+      - name: petId
+        in: path
+        required: true
+        description: The id of the pet to retrieve
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"

data/lib/oas_contrib/command.rb

@@ -4,12 +4,17 @@ require 'oas_contrib/resolver/merge'
 require 'oas_contrib/resolver/preview'
 
 module OasContrib
+  # Command class
   class Command < Thor
     include Thor::Actions
 
     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)'
+    option :out_ext, type: :string, default: '.yml', desc: 'output file ext (.yml or .yaml or .json)'
 
+    # Divide the spec file command
+    # @param [String] spec_file spec file path
+    # @param [String] outdir output directory path
+    # @return [Integer] return code
     def divide(spec_file, outdir)
       resolver = OasContrib::Resolver::Divide.new(spec_file, outdir, options)
       resolver.setup
@@ -17,11 +22,16 @@ module OasContrib
       resolver.resolve
       resolver.distribute
       say 'complete!', :green
+      exit(0)
     end
 
     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)'
+    option :in_ext, type: :string, default: '.yml', desc: 'input file ext (.yml or .yaml or .json)'
 
+    # Merge divided files to spec file command
+    # @param [String] indir input directory path
+    # @param [String] spec_file spec file path
+    # @return [Integer] return code
     def merge(indir, spec_file)
       resolver = OasContrib::Resolver::Merge.new(indir, spec_file, options)
       resolver.setup
@@ -29,16 +39,21 @@ module OasContrib
       resolver.resolve
       resolver.distribute
       say 'complete!', :green
+      exit(0)
     end
 
     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'
 
+    # Preview the spec file with Swagger UI
+    # @param [String] spec_file spec file path
+    # @return [Integer] return code
     def preview(spec_file)
       resolver = OasContrib::Resolver::Preview.new(spec_file, options)
       resolver.setup
       resolver.distribute
       say 'complete!', :green
+      exit(0)
     end
   end
 end

data/lib/oas_contrib/interface/resolver.rb

@@ -1,18 +1,27 @@
 module OasContrib
   module Interface
+    # Interface of Resolver class
     module Resolver
+      # Setup the resolver object.
+      # @return [nil]
       def setup
         raise NotImplementedError, 'You must be implement "setup" method.'
       end
 
+      # Load and parse the input file.
+      # @return [nil]
       def load
         raise NotImplementedError, 'You must be implement "load" method.'
       end
 
+      # Judge and generate OpenAPI specification object.
+      # @return [nil]
       def resolve
         raise NotImplementedError, 'You must be implement "resolve" method.'
       end
 
+      # Distribute the command artifacts.
+      # @return [nil]
       def distribute
         raise NotImplementedError, 'You must be implement"dist" method.'
       end

data/lib/oas_contrib/interface/spec.rb

@@ -1,6 +1,9 @@
 module OasContrib
   module Interface
+    # Interface of Spec class
     module Spec
+      # Mapping the hash to the spec object.
+      # @return [nil]
       def mapping
         raise NotImplementedError, 'You must be implement "mapping" method.'
       end

data/lib/oas_contrib/openapi/base.rb

@@ -2,11 +2,16 @@ require 'oas_contrib/interface/spec'
 
 module OasContrib
   module OpenAPI
+    # Basical spec class
     class Base
+      # @!attribute [r] data
+      #   @return [Hash] mapped spec data hash
       attr_reader :data
 
       include OasContrib::Interface::Spec
 
+      # Initialize
+      # @param [Hash] data spec data hash
       def initialize(data)
         @data = data
       end

data/lib/oas_contrib/openapi/v2/spec.rb

@@ -2,14 +2,30 @@ require 'oas_contrib/openapi/base'
 
 module OasContrib
   module OpenAPI
+    # OpenAPI V2 module
     module V2
+      # Spec class
       class Spec < OasContrib::OpenAPI::Base
-        attr_reader :meta, :path, :model
+        # @!attribute [r] meta
+        #   @return [Hash] meta part
+        attr_reader :meta
 
+        # @!attribute [r] path
+        #   @return [Hash] path part
+        attr_reader :path
+
+        # @!attribute [r] model
+        #   @return [Hash] model part
+        attr_reader :model
+
+        # Initialize
+        # @param [Hash] data spec data hash
         def initialize(data)
           super
         end
 
+        # Mapping the hash to the spec object.
+        # @return [OpenAPI::V2::Spec] mapped spec data object
         def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'definitions' } || nil
           @path  = data['paths'] || nil

data/lib/oas_contrib/openapi/v3/spec.rb

@@ -2,14 +2,30 @@ require 'oas_contrib/openapi/base'
 
 module OasContrib
   module OpenAPI
+    # OpenAPI V3 module
     module V3
+      # Spec class
       class Spec < OasContrib::OpenAPI::Base
-        attr_reader :meta ,:path, :model
+        # @!attribute [r] meta
+        #   @return [Hash] meta part
+        attr_reader :meta
 
+        # @!attribute [r] path
+        #   @return [Hash] path part
+        attr_reader :path
+
+        # @!attribute [r] model
+        #   @return [Hash] model part
+        attr_reader :model
+
+        # Initialize
+        # @param [Hash] data spec data hash
         def initialize(data)
           super
         end
 
+        # Mapping the hash to the spec object.
+        # @return [OpenAPI::V3::Spec] mapped spec data object
         def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'components' } || nil
           @path  = data['paths'] || nil

data/lib/oas_contrib/resolver/base.rb

@@ -6,13 +6,32 @@ require 'json'
 
 module OasContrib
   module Resolver
+    # Basical command resolver class
     class Base
-      attr_reader :data, :spec
+      # @!attribute [r] data
+      #   @return [Hash] parsed input data hash
+      attr_reader :data
+
+      # @!attribute [r] spec
+      #   @return [OpenAPI::V3::Spec|OpenAPI::V2::Spec] mapped spec data object
+      attr_reader :spec
 
       include OasContrib::Interface::Resolver
 
-      DEFINED_FILE_EXT = ['.json', '.yml'].freeze
+      # @return [Array] approval file extensions
+      DEFINED_FILE_EXT = ['.json', '.yml', '.yaml'].freeze
+
+      # @return [String] the directory name of meta part files
+      DIR_NAME_META = 'meta'.freeze
+
+      # @return [String] the directory name of path part files
+      DIR_NAME_PATH = 'path'.freeze
+
+      # @return [String] the directory name of model part files
+      DIR_NAME_MODEL = 'model'.freeze
 
+      # Check the file extensions is approved or not.
+      # @return [Boolean]
       def file_ext_check
         if @infile_ext && !DEFINED_FILE_EXT.include?(@infile_ext)
           raise "Undefined input file extension. #{@infile_ext}"
@@ -21,16 +40,23 @@ module OasContrib
         if @outfile_ext && !DEFINED_FILE_EXT.include?(@outfile_ext)
           raise "Undefined output file extension. #{@outfile_ext}"
         end
+        true
       end
 
+      # Check the format of input file is OpenAPI v3 specificaion or not.
+      # @return [Boolean]
       def v3?
         @data['openapi'] =~ /^3/
       end
 
+      # Check the format of input file is OpenAPI v2 specificaion or not.
+      # @return [Boolean]
       def v2?
         @data['swagger'] =~ /^2/
       end
 
+      # Judge and generate OpenAPI specification object.
+      # @return [OpenAPI::V3::Spec|OpenAPI::V2::Spec] mapped spec data object
       def resolve
         @spec = OasContrib::OpenAPI::V2::Spec.new(@data) if v2?
         @spec = OasContrib::OpenAPI::V3::Spec.new(@data) if v3?
@@ -38,19 +64,31 @@ module OasContrib
         @spec.mapping
       end
 
+      # Load and parse the input file.
+      # @param [String] path input file path
+      # @return [Hash] parsed input data hash
       def input(path)
         @data = _input(path)
       end
 
+      # Output a new file with mapped spec data hash.
+      # @param [Hash] hash mapped spec data hash
+      # @param [String] path output file path
+      # @return [IO]
       def output(hash, path)
         File.open(path, 'w') { |f| _output(hash, f) }
       end
 
+      # Load and parse the files in target directory recursive.
+      # @param [String] dir input directory path
+      # @return [Hash] parsed input data hash
       def input_dir(dir)
         path = dir + '/**/*' + @infile_ext
         Dir.glob(path).sort.each_with_object({}, &input_lambda)
       end
 
+      # Load and parse the file proc.
+      # @return [Proc]
       def input_lambda
         lambda do |file, result|
           hash = _input(file)
@@ -61,20 +99,30 @@ module OasContrib
 
       private
 
+      # Load and prase the file depending on the file extension.
+      # @param [String] path input file path
+      # @return [Hash] parsed input data hash
       def _input(path)
         puts "Load: #{path}"
         case @infile_ext
-        when '.yml'  then YAML.load_file(path)
-        when '.json' then JSON.parse(File.read(path))
+        when DEFINED_FILE_EXT[0] then JSON.parse(File.read(path))
+        when DEFINED_FILE_EXT[1] then YAML.load_file(path)
+        when DEFINED_FILE_EXT[2] then YAML.load_file(path)
         else raise ArgumentError, 'Undefined input file type'
         end
       end
 
+      # Write the spec data hash depending on the file extension.
+      # @param [Hash] hash mapped spec data hash
+      # @param [String] file output file path
+      # @return [IO]
       def _output(hash, file)
         puts "Dist: #{file.path}"
+        p @outfile_ext
         case @outfile_ext
-        when '.yml'  then YAML.dump(hash, file)
-        when '.json' then JSON.dump(hash, file)
+        when DEFINED_FILE_EXT[0] then JSON.dump(hash, file)
+        when DEFINED_FILE_EXT[1] then YAML.dump(hash, file)
+        when DEFINED_FILE_EXT[2] then YAML.dump(hash, file)
         else raise ArgumentError, 'Undefined output file type'
         end
       end

data/lib/oas_contrib/resolver/divide.rb

@@ -2,32 +2,50 @@ require 'oas_contrib/resolver/base'
 
 module OasContrib
   module Resolver
+    # Divide command resolver class
     class Divide < OasContrib::Resolver::Base
+      # Initialize
+      # @param [String] infile spec file path
+      # @param [String] outdir output directory path
+      # @param [Array] options command options
       def initialize(infile, outdir, options)
-        @meta_dir     = outdir + '/meta'
-        @path_dir     = outdir + '/path'
-        @model_dir    = outdir + '/model'
+        @meta_dir     = outdir + '/' + DIR_NAME_META
+        @path_dir     = outdir + '/' + DIR_NAME_PATH
+        @model_dir    = outdir + '/' + DIR_NAME_MODEL
         @infile       = infile
         @outfile_ext  = options['out_ext']
       end
 
+      # Setup the resolver object.
+      # @return [Boolean]
       def setup
         @infile_ext = File.extname(@infile)
         file_ext_check
+        true
       end
 
+      # Load and parse the input file.
+      # @return [Boolean]
       def load
         input(@infile)
+        true
       end
 
+      # Distribute the command artifacts.
+      # @return [Boolean]
       def distribute
         output_dir(@spec.meta,  @meta_dir)
         output_dir(@spec.path,  @path_dir)
         output_dir(@spec.model, @model_dir)
+        true
       end
 
       private
 
+      # Generate directory and output files.
+      # @param [Hash] hash mapped spec data hash
+      # @param [String] path output directory path
+      # @return [Boolean]
       def output_dir(hash, path)
         puts "Dist: #{path}"
         FileUtils.mkdir_p(path)
@@ -36,15 +54,24 @@ module OasContrib
           outfile_data = _output_dir_file_data_filter(hash, k)
           output(outfile_data, outfile_path)
         end
-        nil
+        true
       end
 
+      # Modify the output file path.
+      # @param [String] dir output directory path
+      # @param [String] hash_key hash key
+      # @param [Integer] num count of file
+      # @return [String] modified file path
       def _output_dir_file_path_modify(dir, hash_key, num)
         prefix    = num.to_s.rjust(3, '0')
         file_name = hash_key.tr('/', '_').gsub(/^_/, '')
         dir + '/' + prefix + '_' + file_name + @outfile_ext
       end
 
+      # Filter the output file data.
+      # @param [Hash] hash mapped spec data hash
+      # @param [String] filter_key filtering hash key
+      # @return [Hash] filterd hash
       def _output_dir_file_data_filter(hash, filter_key)
         hash.select { |key, _| key == filter_key }
       end

data/lib/oas_contrib/resolver/merge.rb

@@ -2,30 +2,44 @@ require 'oas_contrib/resolver/base'
 
 module OasContrib
   module Resolver
+    # Merge command resolver class
     class Merge < OasContrib::Resolver::Base
+      # Initialize
+      # @param [String] indir input directory path
+      # @param [String] outfile output spec file path
+      # @param [Array] options command options
       def initialize(indir, outfile, options)
-        @meta_dir   = indir + '/meta'
-        @path_dir   = indir + '/path'
-        @model_dir  = indir + '/model'
+        @meta_dir   = indir + '/' + DIR_NAME_META
+        @path_dir   = indir + '/' + DIR_NAME_PATH
+        @model_dir  = indir + '/' + DIR_NAME_MODEL
         @outfile    = outfile
         @infile_ext = options['in_ext']
       end
 
+      # Setup the resolver object.
+      # @return [Boolean]
       def setup
         @outfile_ext = File.extname(@outfile)
         file_ext_check
+        true
       end
 
+      # Load and parse the input files.
+      # @return [Boolean]
       def load
         @data = input_dir(@meta_dir)
         resolve
         @data['paths'] = input_dir(@path_dir)
         @data['definitions'] = input_dir(@model_dir) if v2?
         @data['components'] = { 'schemas' => input_dir(@model_dir) } if v3?
+        true
       end
 
+      # Distribute the command artifacts.
+      # @return [Boolean]
       def distribute
         output(@data, @outfile)
+        true
       end
     end
   end

data/lib/oas_contrib/resolver/preview.rb

@@ -2,25 +2,35 @@ require 'oas_contrib/resolver/base'
 
 module OasContrib
   module Resolver
+    # Preview command resolver class
     class Preview < OasContrib::Resolver::Base
+      # Initialize
+      # @param [String] infile spec file path
+      # @param [Array] options command options
       def initialize(infile, options)
         @infile = infile
         @port = options['port']
       end
 
+      # Setup the resolver object.
+      # @return [Boolean]
       def setup
         @expand_path = File.expand_path(@infile)
         @basename    = File.basename(@expand_path)
         @infile_ext  = File.extname(@infile)
         file_ext_check
+        true
       end
 
+      # Distribute the command artifacts.
+      # @return [Boolean]
       def distribute
         puts "SwaggerUI listen: http://localhost:#{@port} with: #{@expand_path}"
         `docker run --rm --name oas_contrib_preview_swagger_ui \
         -p #{@port}:8080 -e API_URL=#{@basename} \
         -v #{@expand_path}:/usr/share/nginx/html/#{@basename} swaggerapi/swagger-ui`
         raise 'Preview command needs docker.' unless $?.exitstatus.zero?
+        true
       end
     end
   end

data/lib/oas_contrib/version.rb

@@ -1,3 +1,4 @@
 module OasContrib
-  VERSION = '0.2.5'.freeze
+  # @return [String] semantic version
+  VERSION = '0.2.8'.freeze
 end

data/lib/oas_contrib.rb

@@ -1,4 +1,5 @@
 require 'oas_contrib/version'
 
+# Main module
 module OasContrib
 end

data/oas_contrib.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = OasContrib::VERSION
   spec.authors       = ['Michinao Shimizu']
   spec.email         = ['shimizu.michinao@gmail.com']
-  spec.summary       = 'Libraries and Commands for Open API (2.0, 3.0) Specification.'
-  spec.description   = 'Libraries and Commands for Open API (2.0, 3.0) Specification.'
+  spec.summary       = 'Libraries and Commands for Open API (2.X, 3.X) Specification.'
+  spec.description   = 'Divide OAS file (2.X, 3.X). Merge divided files to a OAS file. Preview OAS file with SwaggerUI Docker Container.'
   spec.homepage      = 'https://github.com/MichinaoShimizu/oas_contrib'
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency 'thor', '~> 0.20'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'thor', '> 0.20'
+  spec.add_development_dependency 'bundler', '> 2.0.1'
+  spec.add_development_dependency 'rake', '> 10.0'
+  spec.add_development_dependency 'rspec', '> 3.0'
 end

metadata

@@ -1,72 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.8
 platform: ruby
 authors:
 - Michinao Shimizu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Libraries and Commands for Open API (2.0, 3.0) Specification.
+description: Divide OAS file (2.X, 3.X). Merge divided files to a OAS file. Preview
+  OAS file with SwaggerUI Docker Container.
 email:
 - shimizu.michinao@gmail.com
 executables:
@@ -83,6 +84,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- divide.jpg
 - example/dist/v2/meta/001_swagger.yml
 - example/dist/v2/meta/002_info.yml
 - example/dist/v2/meta/003_host.yml
@@ -104,7 +106,9 @@ files:
 - example/dist/v3/model/003_Pets.yml
 - example/dist/v3/path/001_pets.yml
 - example/dist/v3/path/002_pets_{petId}.yml
+- example/v2.yaml
 - example/v2.yml
+- example/v3.yaml
 - example/v3.yml
 - exe/oas_contrib
 - lib/oas_contrib.rb
@@ -139,9 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Libraries and Commands for Open API (2.0, 3.0) Specification.
+summary: Libraries and Commands for Open API (2.X, 3.X) Specification.
 test_files: []