r2-oas 0.3.1 → 0.4.1

data/lib/r2-oas/shared/all.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'sortable'
+require_relative 'callable'

data/lib/r2-oas/shared/callable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Callable
+    def deep_call(data, target, callback)
+      return data unless data.is_a?(Hash)
+
+      data.each do |key, value|
+        if key.eql? target
+          data[key] = callback.call(value)
+        else
+          data[key] = deep_call(value, target, callback)
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/store.rb

@@ -9,29 +9,32 @@ module R2OAS
   class Store
     attr_accessor :data
 
-    def initialize(data = {})
+    def initialize(type, data = {})
       if data.empty?
         @data = {}
-        @data['type'] = :schema
+        @type = type
+        @data['type'] = type
         @data['data'] = {}
       else
+        @type = type
         @data = data
       end
     end
 
-    def add(key, value, type = :schema)
-      sha1 = calc_sha1(key, value)
+    def add(key, value)
+      case @type
+      when :schema
+        sha1 = calc_sha1(key, value)
 
-      @data['data'][sha1] ||= {}
-      @data['type'] = type
-      @data['data'][sha1]['key'] = key
-      @data['data'][sha1]['value'] = Zlib::Deflate.deflate(value)
+        @data['data'][sha1] ||= {}
+        @data['data'][sha1]['key'] = key
+        @data['data'][sha1]['value'] = Zlib::Deflate.deflate(value)
+      end
     end
 
     def save
-      type = @data['type']
       @data['data'].values.each do |value|
-        case type
+        case @type
         when :schema
           save_path = value['key']
           save_data = Zlib::Inflate.inflate(value['value'])
@@ -43,7 +46,7 @@ module R2OAS
     end
 
     def dup_slice(*sha1s)
-      dup_store = Store.new(@data.dup)
+      dup_store = Store.new(@type, @data.dup)
       dup_data = dup_store.data['data']
       dup_store.data['data'] = sha1s.each_with_object({}) { |sha1, data| data[sha1] = dup_data[sha1] if dup_store.key?(sha1) }
       dup_store
@@ -102,16 +105,17 @@ module R2OAS
     class << self
       extend Forwardable
 
-      def_delegators :instance, :add
+      def_delegators :instance, :add, :save, :dup_slice, :checksum?, :key?, :exists?, :diff_from
 
-      def create
-        instance
+      def create(type = :schema)
+        instance(type)
       end
 
       private
 
-      def instance
-        @instance ||= new
+      def instance(type)
+        @instance ||= {}
+        @instance[type] ||= new(type)
       end
     end
   end

data/lib/r2-oas/support/deprecation.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+require_relative 'deprecation/instance_delegator'
+require_relative 'deprecation/reporting'
+require_relative 'deprecation/behavior'
+
+module R2OAS
+  class Deprecation
+    include Singleton
+    # Be sure to follow the Singleton module
+    include InstanceDelegator
+    include Behavior
+    include Reporting
+
+    # The version number in which the deprecated behavior will be removed, by default.
+    attr_accessor :deprecation_horizon
+
+    def initialize(deprecation_horizon = '0.4.2', gem_name = 'r2-oas')
+      self.gem_name = gem_name
+      self.deprecation_horizon = deprecation_horizon
+      self.silenced = false
+    end
+  end
+end

data/lib/r2-oas/support/deprecation/behavior.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# MEMO:
+# copy from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/deprecation/behaviors.rb
+module R2OAS
+  class Deprecation
+    class DeprecationError < StandardError; end
+
+    DEFAULT_BEHAVIORS = {
+      stderr: lambda { |message, _callstack, _deprecation_horizon, _gem_name|
+        $stderr.puts(message)
+      }
+    }.freeze
+
+    module Behavior
+      def behavior
+        @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
+      end
+    end
+  end
+end

data/lib/r2-oas/support/deprecation/instance_delegator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+# copy from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/deprecation/instance_delegator.rb
+module R2OAS
+  class Deprecation
+    module InstanceDelegator
+      # MEMO:
+      # base must be singleton class
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.singleton_class.extend(Forwardable)
+        base.singleton_class.prepend(OverrideDelegators)
+        base.public_class_method :new
+      end
+
+      module ClassMethods
+        # override Module#include
+        def include(included_module)
+          included_module.instance_methods.each { |m| method_added(m) }
+          super
+        end
+
+        def method_added(method_name)
+          singleton_class.def_delegators(:instance, method_name)
+        end
+      end
+
+      module OverrideDelegators
+        def warn(message = nil, callstack = nil)
+          # MEMO:
+          # Why update callstack
+          # https://github.com/rails/rails/pull/26686
+          callstack ||= caller_locations(2)
+          super
+        end
+        alias will_remove warn
+      end
+    end
+  end
+end

data/lib/r2-oas/support/deprecation/reporting.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# MEMO:
+# copy from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/deprecation/reporting.rb
+module R2OAS
+  class Deprecation
+    module Reporting
+      attr_accessor :silenced, :gem_name
+
+      FILE_LINE_METHOD_REGEXP = /^(?<file>.+?):(?<line>\d+)(?::in `(?<method>.*?)')?/.freeze
+      R2OAS_GEM_ROOT = File.expand_path('../../../../', __dir__) + '/lib'
+
+      def warn(message = nil, callstack = nil)
+        return if silenced
+
+        callstack ||= caller_locations(2)
+        deprecation_message(callstack, message).tap do |msg|
+          behavior.each { |b| b.call(msg, callstack, deprecation_horizon, gem_name) }
+        end
+      end
+      alias will_remove warn
+
+      def silence
+        old_silenced = silenced
+        self.silenced = true
+        yield if block_given?
+        self.silenced = old_silenced
+      end
+
+      private
+
+      def deprecation_message(callstack, message = nil)
+        message ||= 'You are using deprecated behavior which will be removed from the next major or minor release.'
+        "DEPRECATION WARNING: #{message} #{deprecation_caller_message(callstack)}"
+      end
+
+      def deprecation_caller_message(callstack)
+        file, line, method = extract_callstack(callstack)
+        if file
+          if line && method
+            "(called from #{method} at #{file}:#{line})"
+          else
+            "(called from #{file}:#{line})"
+          end
+        end
+      end
+
+      def extract_callstack(callstack)
+        return _extract_callback(callstack) if callstack.first.is_a? String
+
+        offending_line = callstack.find do |frame|
+          frame.absolute_path && !ignored_callstack(frame.absolute_path)
+        end || callstack.first
+
+        [offending_line.path, offending_line.lineno, offending_line.label]
+      end
+
+      # e.g.)
+      # callback = /path/to/file.rb:274:in `require'
+      #
+      # file = /path/to/file.rb
+      # line = 274
+      # method = require
+      def _extract_callstack(_callback)
+        warn 'Please pass `caller_options` to the deprecation API' if $VERBOSE
+        offending_line = callstack.find { |line| !ignored_callstack(line) || callstack.first }
+
+        if offendihng_line
+          md = offending_line.match(FILE_LINE_METHOD_REGEXP)
+
+          if md.present?
+            md.captures
+          else
+            offending_line
+          end
+        end
+      end
+
+      # MEMO:
+      # see https://docs.ruby-lang.org/ja/latest/class/RbConfig.html#C_-C-O-N-F-I-G
+      def ignored_callstack(path)
+        # MEMO:
+        #
+        # e.g.)
+        # R2OAS_GEM_ROOT = "/Users/yukihirop/RubyProjects/r2-oas/lib"
+        # rubylibprefix = "/Users/yukihirop/.rbenv/versions/2.7.1/lib/ruby"
+        path.start_with?(R2OAS_GEM_ROOT) || path.start_with?(RbConfig::CONFIG['rubylibprefix'])
+      end
+    end
+  end
+end

data/lib/r2-oas/task.rb

@@ -4,8 +4,7 @@ module R2OAS
   class Task < ::Rails::Railtie
     rake_tasks do
       main_task_path = File.join(File.dirname(__FILE__), './tasks/main.rake')
-      tool_task_path = File.join(File.dirname(__FILE__), './tasks/tool.rake')
-      Dir[main_task_path, tool_task_path].each { |f| load f }
+      Dir[main_task_path].each { |f| load f }
     end
   end
 end

data/lib/r2-oas/task_logging.rb

@@ -20,20 +20,16 @@ module R2OAS
 
     private
 
-    def start
-      logger.info '[R2-OAS] start'
+    def start(initial = '[R2-OAS]')
+      logger.info "#{initial} start"
       yield
-      logger.info '[R2-OAS] end'
+      logger.info "#{initial} end"
     end
 
     def logger
       R2OAS.logger
     end
 
-    def set_info_level
-      R2OAS.logger.level = StdoutLogger::INFO
-    end
-
     def set_debug_level
       R2OAS.logger.level = StdoutLogger::DEBUG
     end

data/lib/r2-oas/tasks/common.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../task_logging'
+require 'r2-oas/task_logging'
 
 namespace :routes do
   namespace :oas do
@@ -10,7 +10,6 @@ namespace :routes do
     # desc "Setup a common setting for every tasks"
     task common: [:environment] do
       create_dot_paths
-      set_info_level
     end
 
     # private

data/lib/r2-oas/tasks/main.rake

@@ -3,12 +3,19 @@
 require 'r2-oas/schema/editor'
 require 'r2-oas/schema/ui'
 require 'r2-oas/schema/monitor'
+require 'r2-oas/deploy/client'
 require 'r2-oas/task_logging'
 load File.expand_path('common.rake', __dir__)
 
 namespace :routes do
   namespace :oas do
-    desc 'Generate OAS documentation files'
+    desc '[R2-OAS] Initialize'
+    task init: [:common] do
+      R2OAS.init
+      puts '[R2-OAS] Initialized!'
+    end
+
+    desc '[R2-OAS] Generate OAS documentation files'
     task docs: [:common] do
       start do
         is_create_cache = cache_docs.eql? 'true'
@@ -18,7 +25,7 @@ namespace :routes do
       end
     end
 
-    desc 'Analyze OAS documentation'
+    desc '[R2-OAS] Analyze OAS documentation'
     task analyze: [:common] do
       start do
         analyzer_options = { type: :existing, existing_schema_file_path: existing_schema_file_path }
@@ -31,16 +38,29 @@ namespace :routes do
       end
     end
 
-    desc 'Distribute OAS documentation'
-    task dist: [:common] do
+    desc '[R2-OAS] Build OAS documentation'
+    task build: [:common] do
       start do
-        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        output_dir_path = File.expand_path(R2OAS.output_dir_path)
+        FileUtils.mkdir_p(output_dir_path) unless FileTest.exists?(output_dir_path)
+
+        is_overrirde_src = override_src.eql? 'true'
+        use_plugin = skip_plugin.eql? 'false'
+        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: use_plugin, output: true }
         builder = R2OAS::Schema::Builder.new(builder_options)
         builder.build_docs
+
+        if is_overrirde_src
+          before_schama_data = builder.pure_oas_doc
+          after_schema_data = builder.oas_doc
+          analyzer_options = { type: :edited }
+          analyzer = R2OAS::Schema::Analyzer.new(before_schama_data, after_schema_data, analyzer_options)
+          analyzer.analyze_docs
+        end
       end
     end
 
-    desc 'Open Swagger Editor'
+    desc '[R2-OAS] Open Swagger Editor'
     task editor: [:common] do
       start do
         builder_options = { unit_paths_file_path: unit_paths_file_path }
@@ -54,7 +74,7 @@ namespace :routes do
       end
     end
 
-    desc 'Open Swagger UI'
+    desc '[R2-OAS] Open Swagger UI'
     task ui: [:common] do
       start do
         builder_options = { unit_paths_file_path: unit_paths_file_path }
@@ -67,7 +87,7 @@ namespace :routes do
       end
     end
 
-    desc 'Monitor OAS Document'
+    desc '[R2-OAS] Monitor OAS Document'
     task monitor: [:common] do
       start do
         builder_options = { unit_paths_file_path: unit_paths_file_path }
@@ -81,7 +101,7 @@ namespace :routes do
       end
     end
 
-    desc 'Clean OAS Document'
+    desc '[R2-OAS] Clean OAS Document'
     task clean: [:common] do
       start do
         builder_options = { skip_load_dot_paths: true }
@@ -93,6 +113,29 @@ namespace :routes do
       end
     end
 
+    desc '[R2-OAS] Deploy OAS Document'
+    task deploy: [:common] do
+      start do
+        client_options = {}
+        client = R2OAS::Deploy::Client.new(client_options)
+
+        download_dist_th = Thread.new do
+          puts 'Download swagger-api/swagger-ui/dist ... (async)'
+          client.download_swagger_ui_dist
+        end
+
+        output_dir_path = File.expand_path(R2OAS.output_dir_path)
+        FileUtils.mkdir_p(output_dir_path) unless FileTest.exists?(output_dir_path)
+
+        builder_options = { unit_paths_file_path: unit_paths_file_path, use_plugin: true, output: true }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        download_dist_th.join
+        client.deploy
+      end
+    end
+
     private
 
     def unit_paths_file_path
@@ -106,5 +149,13 @@ namespace :routes do
     def cache_docs
       ENV.fetch('CACHE_DOCS', 'false')
     end
+
+    def override_src
+      ENV.fetch('OVERRIDE_SRC', 'false')
+    end
+
+    def skip_plugin
+      ENV.fetch('SKIP_PLUGIN', 'false')
+    end
   end
 end