r2-oas 0.4.0

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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 }
+    end
+  end
+end

data/lib/r2-oas/task_logging.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Scope Rails
+module R2OAS
+  module TaskLogging
+    def task(*args, &block)
+      Rake::Task.define_task(*args) do |task|
+        if block_given?
+          debug_log task, "[#{task.name}] started"
+          begin
+            block.call(task)
+            debug_log task, "[#{task.name}] finished"
+          rescue StandardError => e
+            debug_log task, "[#{task.name}] failed"
+            raise e
+          end
+        end
+      end
+    end
+
+    private
+
+    def start(initial = '[R2-OAS]')
+      logger.info "#{initial} start"
+      yield
+      logger.info "#{initial} end"
+    end
+
+    def logger
+      R2OAS.logger
+    end
+
+    def set_debug_level
+      R2OAS.logger.level = StdoutLogger::DEBUG
+    end
+
+    def debug_log(task, message)
+      R2OAS.logger.debug message.to_s unless task.name == 'routes:oas:debug'
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'r2-oas/task_logging'
+
+namespace :routes do
+  namespace :oas do
+    extend R2OAS::TaskLogging
+
+    # private
+    # desc "Setup a common setting for every tasks"
+    task common: [:environment] do
+      create_dot_paths
+    end
+
+    # private
+    # desc "Switch the level of a logger to DEBUG"
+    task debug: [:common] do
+      set_debug_level
+    end
+
+    def create_dot_paths
+      R2OAS.paths_config.create_dot_paths
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'r2-oas/schema/editor'
+require 'r2-oas/schema/ui'
+require 'r2-oas/schema/monitor'
+require 'r2-oas/task_logging'
+load File.expand_path('common.rake', __dir__)
+
+namespace :routes do
+  namespace :oas do
+    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'
+        options = { unit_paths_file_path: unit_paths_file_path, skip_load_dot_paths: true, is_create_cache: is_create_cache }
+        generator = R2OAS::Schema::Generator.new(options)
+        generator.generate_docs
+      end
+    end
+
+    desc '[R2-OAS] Analyze OAS documentation'
+    task analyze: [:common] do
+      start do
+        analyzer_options = { type: :existing, existing_schema_file_path: existing_schema_file_path }
+        analyzer = R2OAS::Schema::Analyzer.new({}, {}, analyzer_options)
+        analyzer.analyze_docs
+
+        builder_options = {}
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+      end
+    end
+
+    desc '[R2-OAS] Build OAS documentation'
+    task build: [:common] do
+      start do
+        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'
+        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
+
+        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 '[R2-OAS] Open Swagger Editor'
+    task editor: [:common] do
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        before_schema_data = builder.oas_doc
+        editor_options = { unit_paths_file_path: unit_paths_file_path }
+        editor = R2OAS::Schema::Editor.new(before_schema_data, editor_options)
+        editor.start
+      end
+    end
+
+    desc '[R2-OAS] Open Swagger UI'
+    task ui: [:common] do
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        ui_options = { unit_paths_file_path: unit_paths_file_path }
+        ui = R2OAS::Schema::UI.new(ui_options)
+        ui.start
+      end
+    end
+
+    desc '[R2-OAS] Monitor OAS Document'
+    task monitor: [:common] do
+      start do
+        builder_options = { unit_paths_file_path: unit_paths_file_path }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        before_schema_data = builder.oas_doc
+        monitor_options = { unit_paths_file_path: unit_paths_file_path }
+        monitor = R2OAS::Schema::Monitor.new(before_schema_data, monitor_options)
+        monitor.start
+      end
+    end
+
+    desc '[R2-OAS] Clean OAS Document'
+    task clean: [:common] do
+      start do
+        builder_options = { skip_load_dot_paths: true }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        cleaner = R2OAS::Schema::Cleaner.new
+        cleaner.clean_docs
+      end
+    end
+
+    private
+
+    def unit_paths_file_path
+      ENV.fetch('PATHS_FILE', '')
+    end
+
+    def existing_schema_file_path
+      ENV.fetch('OAS_FILE', '')
+    end
+
+    def cache_docs
+      ENV.fetch('CACHE_DOCS', 'false')
+    end
+
+    def override_src
+      ENV.fetch('OVERRIDE_SRC', 'false')
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'r2-oas/deploy/client'
+require 'r2-oas/tool/paths/ls'
+require 'r2-oas/tool/paths/stats'
+require 'r2-oas/task_logging'
+load File.expand_path('common.rake', __dir__)
+
+namespace :routes do
+  namespace :oas do
+    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
+
+    desc '[R2-OAS] Display paths list'
+    task paths_ls: [:common] do
+      fd = IO.sysopen('/dev/null', 'w+')
+      $stdout = IO.new(fd)
+      logger.level = :null
+
+      start do
+        $stdout = StringIO.new
+
+        paths_ls_options = {}
+        paths_ls = R2OAS::Tool::Paths::Ls.new(paths_ls_options)
+        paths_ls.print
+      end
+
+      result = $stdout.string
+      $stdout = STDOUT
+      puts result
+    end
+
+    desc '[R2-OAS] Display paths stats'
+    task paths_stats: [:common] do
+      fd = IO.sysopen('/dev/null', 'w+')
+      $stdout = IO.new(fd)
+      logger.level = :null
+
+      start do
+        builder_options = { skip_load_dot_paths: true }
+        builder = R2OAS::Schema::Builder.new(builder_options)
+        builder.build_docs
+
+        $stdout = StringIO.new
+
+        paths_log_options = {}
+        paths_log = R2OAS::Tool::Paths::Stats.new(paths_log_options)
+        paths_log.print
+      end
+
+      result = $stdout.string
+      $stdout = STDOUT
+      puts result
+    end
+
+    private
+
+    def unit_paths_file_path
+      ENV.fetch('PATHS_FILE', '')
+    end
+
+    def existing_schema_file_path
+      ENV.fetch('OAS_FILE', '')
+    end
+  end
+end

data/lib/r2-oas/tool/paths/ls.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Tool
+    module Paths
+      class Ls < Base
+        def print
+          Dir.glob("#{schema_save_dir_path}/paths/**/**.yml").each do |path|
+            puts path.sub(%r{^#{Dir.getwd}/?}, '')
+          end
+        end
+      end
+    end
+  end
+end