oas_contrib 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c1e2320567fdd04877c5764842ce980a18ff540aa809129133383ff2096373
-  data.tar.gz: 1f9d67c5afde0abc2895834e855c1f869511ea99a0d54d43688671dc2c8bc335
+  metadata.gz: 0b1a48c2b71fbc69225a8d565450bd2478ce8e5f2710196a06c05a3d60c93e68
+  data.tar.gz: 4bb4aea54a90ebdd8edc03252da09122625e411c17a31076fdd93c8457df76ba
 SHA512:
-  metadata.gz: ba9d73d6cf2ea45aecba1a4fd31b36edcc6dd7a55dc4c77af2bff88afdf70a6a8686c0e683dc55790ef3f2a26d65acf2af04ef4e082bbb05ea34a81ab34b16ba
-  data.tar.gz: 8cd80655e4ebc7afe1208dde4957ced17ea8f5857a95819efb41f0653eb25c2c7ba523aac0bdb609198272a453aadfe128adf6ac4150b5cfa0dc279490d6f257
+  metadata.gz: 723585fa66b02f6ff7201026234ea318f9f26e798a2ddf6fdc232c6b32505a7a3d9a6653c07820cd12f32fb38f74009727a34a8425073b9692e9ba14ed13d03a
+  data.tar.gz: a7d852a298beafaf2fbefec3c84278610d680f438ca3d21d9a02d36fd005e73e707709e165593fea66920696be8ccbbd5132512edaa4a1a3ec4313adf2bc561b

data/.rspec_status

@@ -1,12 +1,12 @@
 example_id                           | status | run_time        |
 ------------------------------------ | ------ | --------------- |
-./spec/divide_command_spec.rb[1:1:1] | passed | 0.36528 seconds |
-./spec/divide_command_spec.rb[1:2:1] | passed | 0.46455 seconds |
-./spec/divide_command_spec.rb[1:3:1] | passed | 0.34273 seconds |
-./spec/divide_command_spec.rb[1:4:1] | passed | 0.34539 seconds |
-./spec/divide_command_spec.rb[1:5:1] | passed | 0.32332 seconds |
-./spec/merge_command_spec.rb[1:1:1]  | passed | 0.33312 seconds |
-./spec/merge_command_spec.rb[1:2:1]  | passed | 0.31424 seconds |
-./spec/merge_command_spec.rb[1:3:1]  | passed | 0.31142 seconds |
-./spec/merge_command_spec.rb[1:4:1]  | passed | 0.31345 seconds |
-./spec/merge_command_spec.rb[1:5:1]  | passed | 0.31093 seconds |
+./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 |

data/lib/oas_contrib/command.rb

@@ -4,42 +4,41 @@ require 'oas_contrib/resolver/merge'
 require 'oas_contrib/resolver/preview'
 
 module OasContrib
-  # Commands
   class Command < Thor
+    include Thor::Actions
+
     option :out_type, type: :string, default: 'yaml', desc: 'output file type (yaml or json)'
-    desc 'divide <input_file> <output_dir>', 'Divide the OAS file into path units and schema units.'
-    # Command (Divide the OAS file into path units and schema units)
-    # @param [String] infile input file path
-    # @param [String] outdir output directory path
-    # @return [Integer]
-    def divide(infile, outdir)
-      OasContrib::Resolver::Divide.new(infile, outdir, options).run
+    desc 'divide <spec_file> <output_dir> (<options>)', 'Divide the spec_file into path units and schema units.'
+
+    def divide(spec_file, outdir)
+      resolver = OasContrib::Resolver::Divide.new(spec_file, outdir, options)
+      resolver.setup
+      resolver.load
+      resolver.resolve
+      resolver.distribute
+      say 'complete!', :green
     end
 
     option :in_type, type: :string, default: 'yaml', desc: 'input file type (yaml or json)'
-    desc 'merge <input_dir> <output_file>', 'Merge multiple divided files into an OAS file.'
-    # Command (Merge multiple divided files into an OAS file)
-    # @param [String] indir input directory path
-    # @param [String] outfile output file path
-    # @return [Integer]
-    def merge(indir, outfile)
-      OasContrib::Resolver::Merge.new(indir, outfile, options).run
-    end
+    desc 'merge <input_dir> <spec_file> (<options>)', 'Merge multiple divided files into an spec_file.'
 
-    option :port, type: :string,default: '50010', desc: 'Swagger UI listen port'
-    desc 'preview <input_file>', 'Preview OAS file using Swagger-UI official Docker image.'
-    # Preview OAS file using Swagger-UI official Docker image.
-    # @param [String] infile input file path
-    # @return [Integer]
-    def preview(infile)
-      OasContrib::Resolver::Preview.new(infile, options).run
+    def merge(indir, spec_file)
+      resolver = OasContrib::Resolver::Merge.new(indir, spec_file, options)
+      resolver.setup
+      resolver.load
+      resolver.resolve
+      resolver.distribute
+      say 'complete!', :green
     end
 
-    # Preview OAS file using Swagger-UI official Docker image.
-    # @param [String] infile input file path
-    # @return [Integer]
-    # def preview(infile)
-    #   OasContrib::Resolver::Generate.new(infile).run
-    # 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.'
+
+    def preview(spec_file)
+      resolver = OasContrib::Resolver::Preview.new(spec_file, options)
+      resolver.setup
+      resolver.distribute
+      say 'complete!', :green
+    end
   end
 end

data/lib/oas_contrib/interface/resolver.rb

@@ -1,41 +1,21 @@
 module OasContrib
   module Interface
-    # Resolver Interface
     module Resolver
-      # Run
-      # @raise [NotImplementedError]
-      # @return [nil]
-      def run
-        raise NotImplementedError, 'You must be implement "run" method.'
-      end
-
-      # Run
-      # @raise [NotImplementedError]
-      # @return [nil]
       def setup
         raise NotImplementedError, 'You must be implement "setup" method.'
       end
 
-      # Load
-      # @raise [NotImplementedError]
-      # @return [nil]
       def load
         raise NotImplementedError, 'You must be implement "load" method.'
       end
 
-      # Distribute
-      # @raise [NotImplementedError]
-      # @return [nil]
-      def dist
-        raise NotImplementedError, 'You must be implement"dist" method.'
-      end
-
-      # Resolve
-      # @raise [NotImplementedError]
-      # @return [nil]
       def resolve
         raise NotImplementedError, 'You must be implement "resolve" method.'
       end
+
+      def distribute
+        raise NotImplementedError, 'You must be implement"dist" method.'
+      end
     end
   end
 end

data/lib/oas_contrib/interface/spec.rb

@@ -1,10 +1,6 @@
 module OasContrib
   module Interface
-    # Spec Interface
     module Spec
-      # Run
-      # @raise [NotImplementedError]
-      # @return [nil]
       def mapping
         raise NotImplementedError, 'You must be implement "mangppi" method.'
       end

data/lib/oas_contrib/openapi/base.rb

@@ -1,18 +1,12 @@
 require 'oas_contrib/interface/spec'
 
 module OasContrib
-  # OpenAPI module
   module OpenAPI
-    # Spec Base
     class Base
-      # @!attribute data
-      #   @return [<Type>] <description>
       attr_reader :data
 
       include OasContrib::Interface::Spec
 
-      # Initialize
-      # @param [Hash] data mapping data
       def initialize(data)
         @data = data
       end

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

@@ -1,30 +1,15 @@
 require 'oas_contrib/openapi/base'
 
 module OasContrib
-  # OpenAPI module
   module OpenAPI
-    # Version 2 module
     module V2
-      # Spec
       class Spec < OasContrib::OpenAPI::Base
-        # @!attribute [r] meta
-        #   @return [<Type>] <description>
-        attr_reader :meta
-        # @!attribute [r] path
-        #   @return [<Type>] <description>
-        attr_reader :path
-        # @!attribute [r] model
-        #   @return [<Type>] <description>
-        attr_reader :model
+        attr_reader :meta, :path, :model
 
-        # Initialize
-        # @param [Hash] data mapping data
         def initialize(data)
           super
         end
 
-        # Mapping
-        # @return [OpenAPI::V2::Spec]
         def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'definitions' } || nil
           @path  = data['paths'] || nil

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

@@ -1,30 +1,15 @@
 require 'oas_contrib/openapi/base'
 
 module OasContrib
-  # OpenAPI
   module OpenAPI
-    # Version 3 module
     module V3
-      # Spec class
       class Spec < OasContrib::OpenAPI::Base
-        # @!attribute [r] meta
-        #   @return [<Type>] <description>
-        attr_reader :meta
-        # @!attribute [r] path
-        #   @return [<Type>] <description>
-        attr_reader :path
-        # @!attribute [r] model
-        #   @return [<Type>] <description>
-        attr_reader :model
+        attr_reader :meta ,:path, :model
 
-        # Initialize
-        # @param [Hash] data mapping data
         def initialize(data)
           super
         end
 
-        # Mapping
-        # @return [OpenAPI::V3::Spec]
         def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'components' } || nil
           @path  = data['paths'] || nil

data/lib/oas_contrib/resolver/base.rb

@@ -6,33 +6,19 @@ require 'json'
 
 module OasContrib
   module Resolver
-    # CommandResolver Base
     class Base
-      # @!attribute [r] data
-      #   @return [<Type>] <description>
-      attr_reader :data
-
-      # @!attribute [r] spec
-      #   @return [<Type>] <description>
-      attr_reader :spec
+      attr_reader :data, :spec
 
       include OasContrib::Interface::Resolver
 
-      # <Description>
-      # @return [<Type>] <description>
       def v3?
         @data['openapi'] =~ /^3/
       end
 
-      # <Description>
-      # @return [<Type>] <description>
       def v2?
         @data['swagger'] =~ /^2/
       end
 
-      # Resolver spec object
-      # @raise [StandardError]
-      # @return [OasContrib::Swagger::V2::Spec|OasContrib::OpenAPI::V3::Spec] spec
       def resolve
         @spec = OasContrib::OpenAPI::V2::Spec.new(@data) if v2?
         @spec = OasContrib::OpenAPI::V3::Spec.new(@data) if v3?
@@ -40,25 +26,14 @@ module OasContrib
         @spec.mapping
       end
 
-      # Load a file
-      # @param [String] path input file path
-      # @return [Hash]
       def input(path)
         @data = _input(path)
       end
 
-      # Output a file
-      # @param [Hash] hash data
-      # @param [String] path output file path
-      # @return [File]
       def output(hash, path)
         File.open(path, 'w') { |f| _output(hash, f) }
       end
 
-      # Convert file type string to file extention string.
-      # @param [String] type file type string (yaml or json)
-      # @raise [ArgumentError] invalid file type string
-      # @return [String] file extension string (.yml or .json)
       def str2ext(type)
         case type
         when 'yaml' then '.yml'
@@ -67,12 +42,21 @@ module OasContrib
         end
       end
 
+      def input_dir(dir)
+        path = dir + '/**/*' + @infile_ext
+        Dir.glob(path).sort.each_with_object({}, &input_lambda)
+      end
+
+      def input_lambda
+        lambda do |file, result|
+          hash = _input(file)
+          key = hash.keys[0]
+          result[key] = hash[key]
+        end
+      end
+
       private
 
-      # Load a file depending on file extension
-      # @param [String] path file path
-      # @raise [ArgumentError] invalid file type string
-      # @return [Hash]
       def _input(path)
         puts "Load: #{path}"
         case @infile_ext
@@ -82,11 +66,6 @@ module OasContrib
         end
       end
 
-      # <Description>
-      # @param [Hash] hash data
-      # @param [File] file output file object
-      # @raise [ArgumentError] invalid file type string
-      # @return [IO]
       def _output(hash, file)
         puts "Dist: #{file.path}"
         case @outfile_ext

data/lib/oas_contrib/resolver/divide.rb

@@ -1,14 +1,8 @@
 require 'oas_contrib/resolver/base'
 
 module OasContrib
-  # Command Resolvers
   module Resolver
-    # Divide command resolver
     class Divide < OasContrib::Resolver::Base
-      # Initialize
-      # @param [String] infile input file path
-      # @param [String] outdir output directory path
-      # @param [Array] options options
       def initialize(infile, outdir, options)
         @meta_dir     = outdir + '/meta'
         @path_dir     = outdir + '/path'
@@ -17,31 +11,16 @@ module OasContrib
         @outfile_type = options['out_type']
       end
 
-      # Run
-      # @return [nil]
-      def run
-        setup
-        load
-        resolve
-        dist
-      end
-
-      # <Description>
-      # @return [<Type>] <description>
       def setup
         @infile_ext  = File.extname(@infile)
         @outfile_ext = str2ext(@outfile_type)
       end
 
-      # Load the OAS file
-      # @return [Hash] loaded data
       def load
         input(@infile)
       end
 
-      # Output divided files
-      # @return [nil]
-      def dist
+      def distribute
         output_dir(@spec.meta,  @meta_dir)
         output_dir(@spec.path,  @path_dir)
         output_dir(@spec.model, @model_dir)
@@ -49,10 +28,6 @@ module OasContrib
 
       private
 
-      # Output directory and files
-      # @param [Hash] hash data
-      # @param [String] path directory path
-      # @return [nil]
       def output_dir(hash, path)
         puts "Dist: #{path}"
         FileUtils.mkdir_p(path)
@@ -64,21 +39,12 @@ module OasContrib
         nil
       end
 
-      # <Description>
-      # @param [<Type>] dir <description>
-      # @param [<Type>] hash_key <description>
-      # @param [<Type>] num <description>
-      # @return [<Type>] <description>
       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
 
-      # <Description>
-      # @param [<Type>] hash <description>
-      # @param [<Type>] filter_key <description>
-      # @return [<Type>] <description>
       def _output_dir_file_data_filter(hash, filter_key)
         hash.select { |key, _| key == filter_key }
       end

data/lib/oas_contrib/resolver/merge.rb

@@ -1,14 +1,8 @@
 require 'oas_contrib/resolver/base'
 
 module OasContrib
-  # Command Resolvers
   module Resolver
-    # Merge command resolver
     class Merge < OasContrib::Resolver::Base
-      # Initialize
-      # @param [String] indir input directory path
-      # @param [String] outfile output file path
-      # @param [Array] options options
       def initialize(indir, outfile, options)
         @meta_dir    = indir + '/meta'
         @path_dir    = indir + '/path'
@@ -17,74 +11,21 @@ module OasContrib
         @infile_type = options['in_type']
       end
 
-      # Run
-      # @return [nil]
-      def run
-        setup
-        load
-        resolve
-        dist
-      end
-
-      # <Description>
-      # @return [<Type>] <description>
       def setup
         @infile_ext  = str2ext(@infile_type)
         @outfile_ext = File.extname(@outfile)
       end
 
-      # Load divided files
-      # @return [Hash] load and merged data
       def load
-        load_meta
-        resolve
-        load_path
-        load_model
-      end
-
-      # Output the OAS file
-      # @return [nil]
-      def dist
-        output(@data, @outfile)
-      end
-
-      private
-
-      # Load meta part files
-      # @return [Hash] loaded data
-      def load_meta
         @data = input_dir(@meta_dir)
-      end
-
-      # Load path part files
-      # @return [Hash] load and merged data
-      def load_path
+        resolve
         @data['paths'] = input_dir(@path_dir)
-      end
-
-      # Load model part files
-      # @return [Hash] load and merged data
-      def load_model
         @data['definitions'] = input_dir(@model_dir) if v2?
         @data['components'] = { 'schemas' => input_dir(@model_dir) } if v3?
       end
 
-      # Load directory files
-      # @param [String] path input directory
-      # @return [Hash] merged input files data
-      def input_dir(dir)
-        path = dir + '/**/*' + @infile_ext
-        Dir.glob(path).sort.each_with_object({}, &input_lambda)
-      end
-
-      # Proc of input a yaml or json file
-      # @return [Proc]
-      def input_lambda
-        lambda do |file, result|
-          hash = _input(file)
-          key = hash.keys[0]
-          result[key] = hash[key]
-        end
+      def distribute
+        output(@data, @outfile)
       end
     end
   end

data/lib/oas_contrib/resolver/preview.rb

@@ -1,41 +1,19 @@
 require 'oas_contrib/resolver/base'
 
 module OasContrib
-  # Command Resolvers
   module Resolver
-    # Preview command resolver
     class Preview < OasContrib::Resolver::Base
-      # Initialize
-      # @param [String] infile input file path
-      # @param [Integer] port listen port
       def initialize(infile, options)
         @infile = infile
-        @port   = options['port']
-      end
-
-      # Run
-      # @return [nil]
-      def run
-        setup
-        # load
-        # resolve
-        dist
+        @port = options['port']
       end
 
       def setup
         @expand_path = File.expand_path(@infile)
-        @basename    = File.basename(@expand_path)
-      end
-
-      # Load
-      # @return [nil]
-      def load
-        nil
+        @basename = File.basename(@expand_path)
       end
 
-      # Distribute
-      # @return [nil]
-      def dist
+      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} \

data/lib/oas_contrib/version.rb

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

data/lib/oas_contrib.rb

@@ -1,6 +1,4 @@
 require 'oas_contrib/version'
 
-# OAS Contribute module
-# @author Michinao Shimizu
 module OasContrib
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Michinao Shimizu