r2-oas 0.1.0

data/lib/r2-oas/schema/v3/squeezer/base_squeezer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Schema
+    module V3
+      class BaseSqueezer < Base
+        def initialize(schema_data, options = {})
+          super(options)
+          @schema_data = schema_data
+          @tag_names = create_tag_names
+        end
+
+        def squeeze_docs
+          raise NoImplementError, 'Please implement in inherited class.'
+        end
+
+        private
+
+        attr_accessor :many_paths_file_paths
+
+        def create_tag_names
+          many_paths_file_paths.each_with_object([]) do |unit_paths_path, result|
+            paths_from_local = YAML.load_file(unit_paths_path)
+
+            tag_name_from_path = if paths_from_local['paths'].values[0].values[0].is_a?(Array)
+                                   'unknown'
+                                 else
+                                   paths_from_local['paths'].values[0].values[0]['tags'][0]
+                                 end
+
+            result.push(tag_name_from_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/squeezer/path_squeezer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'base_squeezer'
+
+module R2OAS
+  module Schema
+    module V3
+      class PathSqueezer < BaseSqueezer
+        VERB = %w[get put post delete options head patch trace].freeze
+        NOT_VERB = %w[$ref summary description servers parameters].freeze
+
+        def squeeze_docs
+          slice_paths_schema = @schema_data['paths'].each_with_object({}) do |(path, data_when_path), result|
+            data_when_path.each do |verb_or_not, data_when_verb_or_not|
+              if VERB.include?(verb_or_not)
+                include_tag_name = data_when_verb_or_not['tags'].first.in? @tag_names
+                result.deep_merge!(path.to_s => data_when_path) if include_tag_name
+              elsif NOT_VERB.include?(verb_or_not)
+                result.deep_merge!(path.to_s => data_when_path)
+              end
+            end
+          end
+          { 'paths' => slice_paths_schema }
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/schema/v3/squeezer/tag_squeezer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'base_squeezer'
+
+module R2OAS
+  module Schema
+    module V3
+      class TagSqueezer < BaseSqueezer
+        def squeeze_docs
+          slice_tags_schema = @schema_data['tags'].each_with_object([]) do |tag, result|
+            eql_tag_name = tag['name'].in? @tag_names
+            result.push(tag) if eql_tag_name
+          end
+          { 'tags' => slice_tags_schema }
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module Sortable
+    def deep_sort(data, target)
+      if data.is_a?(Hash)
+        data.each_with_object({}) do |(key, value), result|
+          result[key] = if key.eql? target
+                          if value.is_a?(Hash)
+                            Hash[value.sort]
+                          else
+                            value
+                                        end
+                        else
+                          deep_sort(value, target)
+                        end
+        end
+      else
+        data
+      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,39 @@
+# 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 logger
+      R2OAS.logger
+    end
+
+    def set_info_level
+      R2OAS.logger.level = StdoutLogger::INFO
+    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,26 @@
+# frozen_string_literal: true
+
+require_relative '../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
+      set_info_level
+    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,117 @@
+# 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 'Generate Swagger documentation files'
+    task docs: [:common] do
+      logger.info '[R2-OAS] start'
+      options = { unit_paths_file_path: unit_paths_file_path, skip_load_dot_paths: true }
+      generator = R2OAS::Schema::Generator.new(options)
+      generator.generate_docs
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Analyze Swagger documentation'
+    task analyze: [:common] do
+      logger.info '[R2-OAS] start'
+
+      analyzer_options = { type: :existing, existing_schema_file_path: existing_schema_file_path }
+      analyzer = R2OAS::Schema::Analyzer.new({}, {}, analyzer_options)
+      analyzer.analyze_docs
+
+      generator_options = { skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Distribute Swagger documentation'
+    task dist: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Open Swagger Editor'
+    task editor: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      before_schema_data = generator.oas_doc
+      editor_options = { unit_paths_file_path: unit_paths_file_path }
+      editor = R2OAS::Schema::Editor.new(before_schema_data, editor_options)
+      editor.start
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Open Swagger UI'
+    task ui: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      ui_options = { unit_paths_file_path: unit_paths_file_path }
+      ui = R2OAS::Schema::UI.new(ui_options)
+      ui.start
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Monitor Swagger Document'
+    task monitor: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      before_schema_data = generator.oas_doc
+      monitor_options = { unit_paths_file_path: unit_paths_file_path }
+      monitor = R2OAS::Schema::Monitor.new(before_schema_data, monitor_options)
+      monitor.start
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Clean Swagger Document'
+    task clean: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { skip_generate_docs: true, skip_load_dot_paths: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      cleaner = R2OAS::Schema::Cleaner.new
+      cleaner.clean_docs
+
+      logger.info '[R2-OAS] end'
+    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/tasks/tool.rake

@@ -0,0 +1,79 @@
+# 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 'Deploy Swagger UI'
+    task deploy: [:common] do
+      logger.info '[R2-OAS] start'
+
+      generator_options = { unit_paths_file_path: unit_paths_file_path, skip_generate_docs: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      client_options = {}
+      client = R2OAS::Deploy::Client.new(client_options)
+      client.deploy
+
+      logger.info '[R2-OAS] end'
+    end
+
+    desc 'Display paths list'
+    task paths_ls: [:common] do
+      fd = IO.sysopen('/dev/null', 'w+')
+      $stdout = IO.new(fd)
+      logger.level = :null
+      logger.info '[R2-OAS] start'
+      $stdout = StringIO.new
+
+      paths_ls_options = {}
+      paths_ls = R2OAS::Tool::Paths::Ls.new(paths_ls_options)
+      paths_ls.print
+
+      logger.info '[R2-OAS] end'
+
+      result = $stdout.string
+      $stdout = STDOUT
+      puts result
+    end
+
+    desc 'Display paths stats'
+    task paths_stats: [:common] do
+      fd = IO.sysopen('/dev/null', 'w+')
+      $stdout = IO.new(fd)
+      logger.level = :null
+
+      logger.info '[R2-OAS] start'
+      generator_options = { skip_generate_docs: true, skip_load_dot_paths: true }
+      generator = R2OAS::Schema::Generator.new(generator_options)
+      generator.generate_docs
+
+      $stdout = StringIO.new
+
+      paths_log_options = {}
+      paths_log = R2OAS::Tool::Paths::Stats.new(paths_log_options)
+      paths_log.print
+
+      logger.info '[R2-OAS] 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+require 'paint'
+require 'forwardable'
+
+module R2OAS
+  module Tool
+    module Paths
+      class Stats < Base
+        extend Forwardable
+
+        TIMESTAMPS = ['Created At', 'Updated At'].freeze
+        TABLE_TITLE = 'Paths Stats'
+
+        def initialize(options = {})
+          super
+          @paths_list = Dir.glob("#{schema_save_dir_path}/paths/**/**.yml")
+          @path_from = Pathname(File.dirname(File.expand_path(root_dir_path)))
+          @paths_stats = tool.paths_stats
+        end
+
+        def print
+          table.title = Paint[TABLE_TITLE, table_title_color]
+          puts table
+          puts "\n#{Paint['Red', warning_color]}: over #{month_to_turn_to_warning_color} months since the last update."
+        end
+
+        private
+
+        def_delegators :@paths_stats, :month_to_turn_to_warning_color, :warning_color, :table_title_color, :heading_color, :highlight_color
+
+        def table
+          @table ||= Terminal::Table.new do |t|
+            @paths_list.each_with_index do |file_path, index|
+              t.headings = ['No', 'File Path', *TIMESTAMPS].map { |head| Paint[head, heading_color] }
+              t << table_content(index, file_path)
+              t.style = { all_separators: true }
+            end
+          end
+        end
+
+        def table_content(index, file_path)
+          content = [(index + 1).to_s, relative_file_path(file_path), *timestamps(file_path)]
+          if file_path.in? paths_config.many_paths_file_paths
+            content.map { |c| Paint[c, highlight_color] }
+          else
+            content
+          end
+        end
+
+        def relative_file_path(file_path)
+          path_to = Pathname(file_path)
+          path_to.relative_path_from(@path_from).to_s
+        end
+
+        def timestamps(file_path)
+          timestamps_data(file_path) do |result, stat|
+            mtime = stat.mtime
+            result.deep_merge!(
+              mtime: expired?(mtime) ? Paint[mtime, warning_color] : mtime
+            )
+          end.values
+        end
+
+        def timestamps_data(file_path)
+          stat = File::Stat.new(file_path)
+          result = {
+            birthtime: stat.birthtime,
+            mtime: stat.mtime
+          }
+          yield result, stat if block_given?
+          result
+        end
+
+        def expired?(mtime)
+          month = month_to_turn_to_warning_color.send(:month)
+          expired_at = Time.current.ago(month)
+          mtime < expired_at
+        end
+      end
+    end
+  end
+end