r2-oas 0.4.0

data/lib/r2-oas.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'r2-oas/version'
+require 'r2-oas/public'
+
+module R2OAS
+  if !defined?(::Rails)
+    raise NoImplementError, 'Can not load Rails'
+  # support Rails version
+  elsif ::Rails::VERSION::STRING >= '4.2.5.1'
+    extend Configuration
+    require 'r2-oas/task'
+    require 'r2-oas/plugin/public'
+    require 'r2-oas/lib/core_ext/hash/deep_merge'
+    require 'r2-oas/lib/core_ext/object/blank'
+
+    autoload :Base, 'r2-oas/base'
+    autoload :NoImplementError, 'r2-oas/errors'
+    autoload :NoFileExistsError, 'r2-oas/errors'
+    autoload :NoSupportError, 'r2-oas/errors'
+    autoload :Sortable, 'r2-oas/shared/all'
+    autoload :Deprecation, 'r2-oas/support/deprecation'
+
+    module Schema
+      autoload :Base, 'r2-oas/schema/base'
+      autoload :Generator, 'r2-oas/schema/generator'
+      autoload :Builder, 'r2-oas/schema/builder'
+      autoload :Analyzer, 'r2-oas/schema/analyzer'
+      autoload :Squeezer, 'r2-oas/schema/squeezer'
+      autoload :Cleaner, 'r2-oas/schema/cleaner'
+    end
+  else
+    raise NoImplementError, "Do not support Rails Version: #{::Rails::VERSION::STRING}"
+  end
+end

data/lib/r2-oas/app_configuration.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative 'app_configuration/server'
+require_relative 'app_configuration/swagger'
+require_relative 'app_configuration/tool'
+require_relative 'app_configuration/deprecation'
+
+module R2OAS
+  module AppConfiguration
+    DEFAULT_VERSION = :v3
+    DEFAULT_ROOT_DIR_PATH = './oas_docs'
+    DEFAULT_SCHEMA_SAVE_DIR_NAME = 'src'
+    DEFAULT_DOC_SAVE_FILE_NAME = 'oas_doc.yml'
+    DEFAULT_FORCE_UPDATE_SCHEMA = false
+    DEFAULT_USE_TAG_NAMESPACE = true
+    DEFAULT_USE_SCHEMA_NAMESPACE = true
+    DEFAULT_SERVER = Server.new
+    DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA = 15
+    DEFAULT_SWAGGER = Swagger.new
+    # rubocop:disable Style/MutableConstant
+    DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD = {
+      get: {
+        default: %w[200 422],
+        path_parameter: %w[200 404 422]
+      },
+      post: {
+        default: %w[201 422],
+        path_parameter: %w[201 404 422]
+      },
+      patch: {
+        default: %w[204 422],
+        path_parameter: %w[204 404 422]
+      },
+      put: {
+        default: %w[204 422],
+        path_parameter: %w[204 404 422]
+      },
+      delete: {
+        default: %w[200 422],
+        path_parameter: %w[200 404 422]
+      }
+    }
+    DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY = %w[post patch put]
+    DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA = %w[204 404]
+    # rubocop:enable Style/MutableConstant
+    DEFAULT_TOOL = Tool.new
+    # :dot or :underbar
+    DEFAULT_NAMESPACE_TYPE = :dot
+    DEFAULT_DEPLOY_DIR_PATH = './deploy_docs'
+    EDFAULT_PLUGINS = [].freeze
+    DEFAULT_LOCAL_PLUGINS_DIR_NAME = 'plugins'
+    DEFAULT_LOCAL_TASKS_DIR_NAME = 'tasks'
+    DEFAULT_OUTPUT_PATH = './oas_docs/dist/oas_doc.yml'
+    DEFAULT_DEPRECATION = Deprecation.new
+
+    PUBLIC_VALID_OPTIONS_KEYS = %i[
+      version
+      root_dir_path
+      schema_save_dir_name
+      doc_save_file_name
+      force_update_schema
+      use_tag_namespace
+      use_schema_namespace
+      server
+      interval_to_save_edited_tmp_schema
+      swagger
+      http_statuses_when_http_method
+      http_methods_when_generate_request_body
+      ignored_http_statuses_when_generate_component_schema
+      tool
+      namespace_type
+      deploy_dir_path
+      plugins
+      local_plugins_dir_name
+      local_tasks_dir_name
+      output_path
+      deprecation
+    ].freeze
+
+    UNPUBLIC_VALID_OPTIONS_KEYS = %i[
+      paths_config
+      logger
+    ].freeze
+
+    VALID_OPTIONS_KEYS = PUBLIC_VALID_OPTIONS_KEYS + UNPUBLIC_VALID_OPTIONS_KEYS
+
+    attr_accessor *PUBLIC_VALID_OPTIONS_KEYS
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    private
+
+    module_function def set_default(target)
+      target.version                                              = DEFAULT_VERSION
+      target.root_dir_path                                        = DEFAULT_ROOT_DIR_PATH
+      target.schema_save_dir_name                                 = DEFAULT_SCHEMA_SAVE_DIR_NAME
+      target.doc_save_file_name                                   = DEFAULT_DOC_SAVE_FILE_NAME
+      target.force_update_schema                                  = DEFAULT_FORCE_UPDATE_SCHEMA
+      target.use_tag_namespace                                    = DEFAULT_USE_TAG_NAMESPACE
+      target.use_schema_namespace                                 = DEFAULT_USE_SCHEMA_NAMESPACE
+      target.server                                               = DEFAULT_SERVER
+      target.interval_to_save_edited_tmp_schema                   = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
+      target.swagger                                              = DEFAULT_SWAGGER
+      target.http_statuses_when_http_method                       = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
+      target.tool                                                 = DEFAULT_TOOL
+      target.http_methods_when_generate_request_body              = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
+      target.ignored_http_statuses_when_generate_component_schema = DEFAULT_IGNORED_HTTP_STATUSES_WHEN_GENERATE_COMPONENT_SCHEMA
+      target.namespace_type                                       = DEFAULT_NAMESPACE_TYPE
+      target.deploy_dir_path                                      = DEFAULT_DEPLOY_DIR_PATH
+      target.plugins                                              = EDFAULT_PLUGINS
+      target.local_plugins_dir_name                               = DEFAULT_LOCAL_PLUGINS_DIR_NAME
+      target.local_tasks_dir_name                                 = DEFAULT_LOCAL_TASKS_DIR_NAME
+      target.output_path                                          = DEFAULT_OUTPUT_PATH
+      target.deprecation                                          = DEFAULT_DEPRECATION
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'r2-oas/support/deprecation'
+
+module R2OAS
+  module AppConfiguration
+    class Deprecation
+      DEFAULT_SILENCED = ::R2OAS::Deprecation.silenced
+
+      attr_reader :silenced
+
+      def silenced=(value)
+        @silenced = !!value
+        ::R2OAS::Deprecation.silenced = !!value
+      end
+
+      def initialize
+        set_default
+      end
+
+      private
+
+      def set_default
+        self.silenced = DEFAULT_SILENCED
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Server
+      DEFAULT_URL = 'http://localhost:3000'
+      DEFAULT_DESCRIPTION = 'localhost'
+
+      VALID_OPTIONS_KEYS = [
+        :data
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def initialize
+        set_default
+      end
+
+      def configure
+        yield self
+      end
+
+      private
+
+      def set_default
+        self.data = [
+          {
+            url: DEFAULT_URL,
+            description: DEFAULT_DESCRIPTION
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'swagger/ui'
+require_relative 'swagger/editor'
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      DEFAULT_EDITOR = Editor.new
+      DEFAULT_UI     = UI.new
+
+      VALID_OPTIONS_KEYS = %i[
+        editor
+        ui
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def initialize
+        set_default
+      end
+
+      def configure
+        yield self
+      end
+
+      private
+
+      def set_default
+        self.editor = DEFAULT_EDITOR
+        self.ui     = DEFAULT_UI
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger/editor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      class Editor
+        DEFAULT_IMAGE         = 'swaggerapi/swagger-editor'
+        DEFAULT_PORT          = '81'
+        DEFAULT_EXPOSED_PORT  = '8080/tcp'
+        DEFAULT_STORAGE_KEY   = 'swagger-editor-content' # Fixed
+        DEFAULT_HOST          = 'http://localhost'       # Fixed
+
+        VALID_OPTIONS_KEYS = %i[
+          image
+          port
+          exposed_port
+        ].freeze
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def initialize
+          set_default
+        end
+
+        def configure
+          yield self
+        end
+
+        def url
+          "#{DEFAULT_HOST}:#{port}"
+        end
+
+        def storage_key
+          DEFAULT_STORAGE_KEY
+        end
+
+        private
+
+        def set_default
+          self.image         = DEFAULT_IMAGE
+          self.port          = DEFAULT_PORT
+          self.exposed_port  = DEFAULT_EXPOSED_PORT
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger/ui.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      class UI
+        DEFAULT_IMAGE        = 'swaggerapi/swagger-ui'
+        DEFAULT_PORT         = '8080'
+        DEFAULT_EXPOSED_PORT = '8080/tcp'
+        DEFAULT_VOLUME       = '/app/swagger.json'
+        DEFAULT_HOST         = 'http://localhost' # Fixed
+
+        VALID_OPTIONS_KEYS = %i[
+          image
+          port
+          exposed_port
+          volume
+        ].freeze
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def initialize
+          set_default
+        end
+
+        def configure
+          yield self
+        end
+
+        def url
+          "#{DEFAULT_HOST}:#{port}"
+        end
+
+        private
+
+        def set_default
+          self.image        = DEFAULT_IMAGE
+          self.port         = DEFAULT_PORT
+          self.exposed_port = DEFAULT_EXPOSED_PORT
+          self.volume       = DEFAULT_VOLUME
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/tool.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'tool/paths/stats'
+
+module R2OAS
+  module AppConfiguration
+    class Tool
+      DEFAULT_PATHS_STATS = PathsStats.new
+
+      VALID_OPTIONS_KEYS = [
+        :paths_stats
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def initialize
+        set_default
+      end
+
+      def configure
+        yield self
+      end
+
+      private
+
+      def set_default
+        self.paths_stats = DEFAULT_PATHS_STATS
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Tool
+      class PathsStats
+        DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR = 3
+        DEFAULT_WARNING_COLOR = :red
+        DEFAULT_TABLE_TITLE_COLOR = :yellow
+        DEFAULT_HEADING_COLOR = :yellow
+        DEFAULT_HIGHLIGHT_COLOR = :magenta
+
+        VALID_OPTIONS_KEYS = %i[
+          month_to_turn_to_warning_color
+          warning_color
+          table_title_color
+          heading_color
+          highlight_color
+        ].freeze
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def initialize
+          set_default
+        end
+
+        def configure
+          yield self
+        end
+
+        private
+
+        def set_default
+          self.month_to_turn_to_warning_color = DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR
+          self.warning_color                  = DEFAULT_WARNING_COLOR
+          self.table_title_color              = DEFAULT_TABLE_TITLE_COLOR
+          self.heading_color                  = DEFAULT_HEADING_COLOR
+          self.highlight_color                = DEFAULT_HIGHLIGHT_COLOR
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module R2OAS
+  class Base
+    def initialize(options = {})
+      @options = options
+
+      (AppConfiguration::VALID_OPTIONS_KEYS + options.keys).each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    private
+
+    attr_accessor *AppConfiguration::VALID_OPTIONS_KEYS
+
+    def merged_options
+      if @options.present?
+        R2OAS.options.merge(@options)
+      else
+        R2OAS.options
+      end
+    end
+
+    def logger
+      R2OAS.logger
+    end
+
+    def schema_save_dir_path
+      File.expand_path("#{root_dir_path}/#{schema_save_dir_name}")
+    end
+
+    def doc_save_file_path
+      File.expand_path("#{root_dir_path}/#{doc_save_file_name}")
+    end
+
+    def ns_div
+      case namespace_type
+      when :dot
+        '.'
+      when :underbar
+        '_'
+      else
+        raise "Do not support #{namespace_type}"
+      end
+    end
+  end
+end