oas_contrib 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a7cb442ad80a5069290a8ee4452c08aa454b9db4fe0e4c6a4a9e759754269f
-  data.tar.gz: 41ee8a0a9d722e5ec0e14cc2db1eb177d646538b4e1c4bd52a12816d8325c089
+  metadata.gz: 0435eddeadb5b43491f1df9287f23fa12049571c24e710031046f9536b5d9450
+  data.tar.gz: aca0d184bd5c17d8b34d11078e78cd8cd60f62e5403985eb864d38300092eb67
 SHA512:
-  metadata.gz: 30b549fe4d53f3281f3b498d898251a131fd20fd4d8f5e6b70fed504bcb6935a29de10237952895287cbf5d1f7f4fce294233541cb48ce798f4caa75ceec8a92
-  data.tar.gz: 92fbd5c8820a6b30dde1e7b7ff431d7fac8b56cc14c1392ea36cfb836b364e1f6e7fb6919ff14022ffa6639a22a16680e7164b9005c4f250fced5a165955c706
+  metadata.gz: 8067d5c55797756b8f4978306b907b7fa24e9960a8f05d2e6e140affaa41fa006eac5996d2084d0885acf737de2392db297ff134063ed8d28e7e727ffd2c0fdb
+  data.tar.gz: 6e39a195a3f0ef8e4eab7bf1ab11051c61e9d4150af76a9c2a2ad0dc7713a87747c5e54786c7cd4b8a7eb13a578fc5e97f06198c4b26c180e257157346425309

data/.rspec_status

@@ -1,12 +1,12 @@
 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.37097 seconds |
+./spec/divide_command_spec.rb[1:2:1] | passed | 0.34114 seconds |
+./spec/divide_command_spec.rb[1:3:1] | passed | 0.33399 seconds |
+./spec/divide_command_spec.rb[1:4:1] | passed | 0.33446 seconds |
+./spec/divide_command_spec.rb[1:5:1] | passed | 0.39866 seconds |
+./spec/merge_command_spec.rb[1:1:1]  | passed | 0.34996 seconds |
+./spec/merge_command_spec.rb[1:2:1]  | passed | 0.33477 seconds |
+./spec/merge_command_spec.rb[1:3:1]  | passed | 0.39575 seconds |
+./spec/merge_command_spec.rb[1:4:1]  | passed | 0.46906 seconds |
+./spec/merge_command_spec.rb[1:5:1]  | passed | 0.42331 seconds |

data/README.md

@@ -14,11 +14,11 @@ gem 'oas_contrib'
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install oas_contrib
+    gem install oas_contrib
 
 ## Usage
 
@@ -30,7 +30,7 @@ Or install it yourself as:
 ### Divide the OpenAPI Specification file
 
 ```bash
-$ oas_contrib divide <OpenAPI Specification file> <output_dir> (<options>...)
+oas_contrib divide <OpenAPI Specification file> <output_dir> (<options>...)
 ```
 
 | option     | description                  | value type                 | default  |
@@ -40,7 +40,7 @@ $ oas_contrib divide <OpenAPI Specification file> <output_dir> (<options>...)
 ### Merge from divided files to an OpenAPI Specification file
 
 ```bash
-$ oas_contrib merge <input_dir> <OpenAPI Specification file> (<options>...)
+oas_contrib merge <input_dir> <OpenAPI Specification file> (<options>...)
 ```
 
 | option     | description                  | value type                 | default  |
@@ -50,7 +50,7 @@ $ oas_contrib merge <input_dir> <OpenAPI Specification file> (<options>...)
 ### Preview the OpenAPI Specification file using Swagger-UI docker image
 
 ```bash
-$ oas_contrib preview <OpenAPI Specification file> (<options>...)
+oas_contrib preview <OpenAPI Specification file> (<options>...)
 ```
 
 | option     | description             | value type      | default  |

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)'
 
+    # 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)'
 
+    # 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
 
+      # @return [Array] approval file extensions
       DEFINED_FILE_EXT = ['.json', '.yml'].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,27 @@ 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)
         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}"
         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)
         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.6'.freeze
 end

data/lib/oas_contrib.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Michinao Shimizu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Libraries and Commands for Open API (2.0, 3.0) Specification.