oas_contrib 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b2dd9f63fca90af7dfadb2acb5bbcf3298bcbe8124f058228ef2e039702e519
-  data.tar.gz: 4077394dfc935cf038f283147840a9bb95600774bec1f0ccb2c21254edc1500a
+  metadata.gz: 87c1e2320567fdd04877c5764842ce980a18ff540aa809129133383ff2096373
+  data.tar.gz: 1f9d67c5afde0abc2895834e855c1f869511ea99a0d54d43688671dc2c8bc335
 SHA512:
-  metadata.gz: 63164dd1c20142588d8453c87c4a9043107ae3ba7f9a6d9072dd4639b5d6886a4333d7de0acc9a39b85cc20870c27db9df623aebf318aee8d95464afd7c04b67
-  data.tar.gz: 396ae10edea63c1a1198ae20054d631e2c4ade37d2e073965f6d6714014755a6bfb3e6c6ee57114b214aa1782cbdc83ca6a91a26382dee9751d7bcbb804d7823
+  metadata.gz: ba9d73d6cf2ea45aecba1a4fd31b36edcc6dd7a55dc4c77af2bff88afdf70a6a8686c0e683dc55790ef3f2a26d65acf2af04ef4e082bbb05ea34a81ab34b16ba
+  data.tar.gz: 8cd80655e4ebc7afe1208dde4957ced17ea8f5857a95819efb41f0653eb25c2c7ba523aac0bdb609198272a453aadfe128adf6ac4150b5cfa0dc279490d6f257

data/.rspec_status

@@ -1,12 +1,12 @@
 example_id                           | status | run_time        |
 ------------------------------------ | ------ | --------------- |
-./spec/divide_command_spec.rb[1:1:1] | passed | 0.31599 seconds |
-./spec/divide_command_spec.rb[1:2:1] | passed | 0.31835 seconds |
-./spec/divide_command_spec.rb[1:3:1] | passed | 0.32395 seconds |
-./spec/divide_command_spec.rb[1:4:1] | passed | 0.33436 seconds |
-./spec/divide_command_spec.rb[1:5:1] | passed | 0.30711 seconds |
-./spec/merge_command_spec.rb[1:1:1]  | passed | 0.32602 seconds |
-./spec/merge_command_spec.rb[1:2:1]  | passed | 0.31555 seconds |
-./spec/merge_command_spec.rb[1:3:1]  | passed | 0.30952 seconds |
-./spec/merge_command_spec.rb[1:4:1]  | passed | 0.31631 seconds |
-./spec/merge_command_spec.rb[1:5:1]  | passed | 0.31812 seconds |
+./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 |

data/lib/oas_contrib/command.rb

@@ -6,33 +6,40 @@ require 'oas_contrib/resolver/preview'
 module OasContrib
   # Commands
   class Command < Thor
-    option :out_type, type: :string, aliases: '-ot', default: 'yaml', desc: 'output file type (yaml or json)'
+    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] in_file input file path
-    # @param [String] out_dir output directory path
+    # @param [String] infile input file path
+    # @param [String] outdir output directory path
     # @return [Integer]
-    def divide(in_file, out_dir)
-      Resolver::Divide.new(in_file, out_dir, options['out_type']).run
+    def divide(infile, outdir)
+      OasContrib::Resolver::Divide.new(infile, outdir, options).run
     end
 
-    option :in_type, type: :string, aliases: '-it', default: 'yaml', desc: 'input file type (yaml or json)'
+    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] in_dir input directory path
-    # @param [String] out_file output file path
+    # @param [String] indir input directory path
+    # @param [String] outfile output file path
     # @return [Integer]
-    def merge(in_dir, out_file)
-      Resolver::Merge.new(in_dir, out_file, options['in_type']).run
+    def merge(indir, outfile)
+      OasContrib::Resolver::Merge.new(indir, outfile, options).run
     end
 
-    option :port, type: :string, aliases: '-p', default: '50010', desc: 'Swagger UI listen port'
+    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] in_file input file path
+    # @param [String] infile input file path
     # @return [Integer]
-    def preview(in_file)
-      Resolver::Preview.new(in_file, options['port']).run
+    def preview(infile)
+      OasContrib::Resolver::Preview.new(infile, options).run
     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
   end
 end

data/lib/oas_contrib/interface/resolver.rb

@@ -0,0 +1,41 @@
+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
+    end
+  end
+end

data/lib/oas_contrib/interface/spec.rb

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

data/lib/oas_contrib/openapi/base.rb

@@ -0,0 +1,21 @@
+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
+    end
+  end
+end

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

@@ -1,18 +1,35 @@
+require 'oas_contrib/openapi/base'
+
 module OasContrib
   # OpenAPI module
   module OpenAPI
     # Version 2 module
     module V2
       # Spec
-      class Spec
-        attr_accessor :data, :meta, :path, :model
+      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
+
         # Initialize
         # @param [Hash] data mapping data
         def initialize(data)
-          @data  = data
+          super
+        end
+
+        # Mapping
+        # @return [OpenAPI::V2::Spec]
+        def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'definitions' } || nil
           @path  = data['paths'] || nil
           @model = data['definitions'] || nil
+          self
         end
       end
     end

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

@@ -1,19 +1,35 @@
+require 'oas_contrib/openapi/base'
+
 module OasContrib
   # OpenAPI
   module OpenAPI
     # Version 3 module
     module V3
       # Spec class
-      class Spec
-        attr_accessor :data, :meta, :path, :model
+      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
 
         # Initialize
         # @param [Hash] data mapping data
         def initialize(data)
-          @data  = data
+          super
+        end
+
+        # Mapping
+        # @return [OpenAPI::V3::Spec]
+        def mapping
           @meta  = data.select { |v| v != 'paths' && v != 'components' } || nil
           @path  = data['paths'] || nil
           @model = data.dig('components', 'schemas') || nil
+          self
         end
       end
     end

data/lib/oas_contrib/resolver/base.rb

@@ -1,3 +1,4 @@
+require 'oas_contrib/interface/resolver'
 require 'oas_contrib/openapi/v2/spec'
 require 'oas_contrib/openapi/v3/spec'
 require 'yaml'
@@ -7,85 +8,43 @@ module OasContrib
   module Resolver
     # CommandResolver Base
     class Base
-      # Initialze
-      # @param [String] path input or output directory path
-      def initialize(path)
-        @meta_dir  = path + '/meta'
-        @path_dir  = path + '/path'
-        @model_dir = path + '/model'
-      end
-
-      # Run
-      # @raise [NotImplementedError]
-      # @return [nil]
-      def run
-        raise NotImplementedError, 'This class must be implemented "run" method.'
-      end
+      # @!attribute [r] data
+      #   @return [<Type>] <description>
+      attr_reader :data
 
-      # Load
-      # @raise [NotImplementedError]
-      # @return [nil]
-      def load
-        raise NotImplementedError, 'This class must be implemented "load" method.'
-      end
-
-      # Distribute
-      # @raise [NotImplementedError]
-      # @return [nil]
-      def dist
-        raise NotImplementedError, 'This class must be implemented "dist" method.'
-      end
+      # @!attribute [r] spec
+      #   @return [<Type>] <description>
+      attr_reader :spec
 
-      # Determine which type of definition data.
-      # @raise [StandardError]
-      # @return [OasContrib::Swagger::V2::Spec|OasContrib::OpenAPI::V3::Spec] spec
-      def resolve
-        return @spec = OasContrib::OpenAPI::V2::Spec.new(@load_data) if has_v2_meta?
-        return @spec = OasContrib::OpenAPI::V3::Spec.new(@load_data) if has_v3_meta?
-        raise 'Undefined OAS file.'
-      end
+      include OasContrib::Interface::Resolver
 
       # <Description>
       # @return [<Type>] <description>
-      def has_v3_meta?
-        @load_data['openapi'] =~ /^3/
+      def v3?
+        @data['openapi'] =~ /^3/
       end
 
       # <Description>
       # @return [<Type>] <description>
-      def has_v2_meta?
-        @load_data['swagger'] =~ /^2/
-      end
-
-      # Check the type of OpenAPI v3 definition or not
-      # @return [Boolean]
-      def v3_spec?
-        @spec.is_a?(OasContrib::OpenAPI::V3::Spec)
+      def v2?
+        @data['swagger'] =~ /^2/
       end
 
-      # Check the type of OpenAPI v2 definition or not
-      # @return [Boolean]
-      def v2_spec?
-        @spec.is_a?(OasContrib::OpenAPI::V2::Spec)
-      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 file_type_to_ext(type)
-        case type
-        when 'yaml' then '.yml'
-        when 'json' then '.json'
-        else raise ArgumentError, 'Undefined file type'
-        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?
+        raise 'Undefined OAS file.' unless @spec
+        @spec.mapping
       end
 
       # Load a file
       # @param [String] path input file path
       # @return [Hash]
       def input(path)
-        @load_data = input_call(path)
+        @data = _input(path)
       end
 
       # Output a file
@@ -93,68 +52,48 @@ module OasContrib
       # @param [String] path output file path
       # @return [File]
       def output(hash, path)
-        File.open(path, 'w') { |f| output_call(hash, f) }
-      end
-
-      # Load directory files
-      # @param [String] path input directory
-      # @return [Hash] merged input files data
-      def input_dir(path)
-        Dir.glob(path).sort.each_with_object({}, &input_call_lambda)
+        File.open(path, 'w') { |f| _output(hash, f) }
       end
 
-      # Proc of input a yaml or json file
-      # @return [Proc]
-      def input_call_lambda
-        lambda do |file, result|
-          hash = input_call(file)
-          key = hash.keys[0]
-          result[key] = hash[key]
+      # 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'
+        when 'json' then '.json'
+        else raise ArgumentError, 'Undefined file type'
         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_call(path)
+      def _input(path)
         puts "Load: #{path}"
-        case @input_file_ext
+        case @infile_ext
         when '.yml'  then YAML.load_file(path)
         when '.json' then JSON.parse(File.read(path))
-        else raise ArgumentError, 'Undefined file type'
+        else raise ArgumentError, 'Undefined input file type'
         end
       end
 
-      # Output a file depending on file extension
-      # @param [String] path file path
+      # <Description>
+      # @param [Hash] hash data
+      # @param [File] file output file object
       # @raise [ArgumentError] invalid file type string
       # @return [IO]
-      def output_call(hash, file)
+      def _output(hash, file)
         puts "Dist: #{file.path}"
-        case @output_file_ext
+        case @outfile_ext
         when '.yml'  then YAML.dump(hash, file)
         when '.json' then JSON.dump(hash, file)
-        else raise ArgumentError, 'Undefined file type'
-        end
-      end
-
-      # 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)
-
-        i = 1
-        hash.each do |k, _v|
-          key = k.tr('/', '_').gsub(/^_/, '')
-          val = hash.select { |hash_key, _| hash_key == k }
-          output(val, "#{path}/#{i.to_s.rjust(3, '0')}_#{key}#{@output_file_ext}")
-          i += 1
+        else raise ArgumentError, 'Undefined output file type'
         end
-        nil
       end
     end
   end

data/lib/oas_contrib/resolver/divide.rb

@@ -4,30 +4,39 @@ module OasContrib
   # Command Resolvers
   module Resolver
     # Divide command resolver
-    class Divide < Resolver::Base
+    class Divide < OasContrib::Resolver::Base
       # Initialize
-      # @param [String] input_file_path input file path
-      # @param [String] output_dir_path output directory path
-      # @param [String] output_file_type output file type (json or yaml)
-      def initialize(input_file_path, output_dir_path, output_file_type)
-        @input_file_path = input_file_path
-        @input_file_ext  = File.extname(input_file_path)
-        @output_file_ext = file_type_to_ext(output_file_type)
-        super(output_dir_path)
+      # @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'
+        @model_dir    = outdir + '/model'
+        @infile       = infile
+        @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(@input_file_path)
+        input(@infile)
       end
 
       # Output divided files
@@ -37,6 +46,42 @@ module OasContrib
         output_dir(@spec.path,  @path_dir)
         output_dir(@spec.model, @model_dir)
       end
+
+      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)
+        hash.each.with_index(1) do |(k, _v), i|
+          outfile_path = _output_dir_file_path_modify(path, k, i)
+          outfile_data = _output_dir_file_data_filter(hash, k)
+          output(outfile_data, outfile_path)
+        end
+        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
     end
   end
 end

data/lib/oas_contrib/resolver/merge.rb

@@ -4,26 +4,35 @@ module OasContrib
   # Command Resolvers
   module Resolver
     # Merge command resolver
-    class Merge < Resolver::Base
+    class Merge < OasContrib::Resolver::Base
       # Initialize
-      # @param [String] input_dir_path input directory path
-      # @param [String] output_file_path output file path
-      # @param [String] input_file_type input file type (json or yaml)
-      def initialize(input_dir_path, output_file_path, input_file_type)
-        @input_file_ext = file_type_to_ext(input_file_type)
-        @output_file_path = output_file_path
-        @output_file_ext = File.extname(output_file_path)
-        super(input_dir_path)
+      # @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'
+        @model_dir   = indir + '/model'
+        @outfile     = outfile
+        @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
@@ -36,7 +45,7 @@ module OasContrib
       # Output the OAS file
       # @return [nil]
       def dist
-        output(@load_data, @output_file_path)
+        output(@data, @outfile)
       end
 
       private
@@ -44,24 +53,37 @@ module OasContrib
       # Load meta part files
       # @return [Hash] loaded data
       def load_meta
-        @load_data = input_dir(@meta_dir + '/**/*' + @input_file_ext)
+        @data = input_dir(@meta_dir)
       end
 
       # Load path part files
       # @return [Hash] load and merged data
       def load_path
-        @load_data['paths'] = input_dir(@path_dir + '/**/*' + @input_file_ext)
+        @data['paths'] = input_dir(@path_dir)
       end
 
       # Load model part files
       # @return [Hash] load and merged data
       def load_model
-        path = @model_dir + '/**/*' + @input_file_ext
-        if v3_spec?
-          @load_data['components'] = {}
-          @load_data['components']['schemas'] = input_dir(path)
-        elsif v2_spec?
-          @load_data['definitions'] = input_dir(path)
+        @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
       end
     end

data/lib/oas_contrib/resolver/preview.rb

@@ -4,27 +4,32 @@ module OasContrib
   # Command Resolvers
   module Resolver
     # Preview command resolver
-    class Preview < Resolver::Base
+    class Preview < OasContrib::Resolver::Base
       # Initialize
-      # @param [String] input_file_path input file path
-      # @param [String] input_file_type input file type (json or yaml)
-      def initialize(input_file_path, port)
-        @input_file_path = input_file_path
-        @port = port
+      # @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
-        load
+        setup
+        # load
+        # resolve
         dist
       end
 
+      def setup
+        @expand_path = File.expand_path(@infile)
+        @basename    = File.basename(@expand_path)
+      end
+
       # Load
       # @return [nil]
       def load
-        @expand_path = File.expand_path(@input_file_path)
-        @basename = File.basename(@expand_path)
         nil
       end
 

data/lib/oas_contrib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Michinao Shimizu
@@ -109,6 +109,9 @@ files:
 - exe/oas_contrib
 - lib/oas_contrib.rb
 - lib/oas_contrib/command.rb
+- lib/oas_contrib/interface/resolver.rb
+- lib/oas_contrib/interface/spec.rb
+- lib/oas_contrib/openapi/base.rb
 - lib/oas_contrib/openapi/v2/spec.rb
 - lib/oas_contrib/openapi/v3/spec.rb
 - lib/oas_contrib/resolver/base.rb