r2-oas 0.3.2 → 0.5.0

data/.travis.yml

@@ -1,26 +0,0 @@
----
-sudo: false
-
-language: ruby
-
-cache: bundler
-
-rvm:
-  - 2.3.3
-  - 2.4.2
-  - 2.5.7
-  - 2.6.5
-  - 2.7.1
-
-before_install: gem install bundler
-
-gemfile:
-  - Gemfile
-bundler_args: "--without development --deployment"
-
-install:
-  - bundle install
-
-script:
-  - ruby -e "if RUBY_VERSION >= '2.7'; system('bundle exec rubocop --fail-level=W'); end"
-  - bundle exec rspec spec --exclude-pattern "spec/r2-oas/tasks/tool_spec.rb,spec/r2-oas/tool/paths/stats_spec.rb"

data/Appraisals

@@ -1,13 +0,0 @@
-appraise 'ruby-2.3.3' do
-end
-appraise 'ruby-2.4.2' do
-end
-# stable
-appraise 'ruby-2.5.8' do
-end
-# stable
-appraise 'ruby-2.6.6' do
-end
-# stable
-appraise 'ruby-2.7.1' do
-end

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at te108186@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in r2-oas.gemspec
-gemspec
-
-group :test do
-  gem 'sqlite3'
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

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

@@ -1,31 +0,0 @@
-# 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

@@ -1,43 +0,0 @@
-# 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/pluggable_configuration.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'schema/v3/object/public'
-
-module R2OAS
-  module PluggableConfiguration
-    # rubocop:disable Style/MutableConstant
-    DEFAULT_USE_OBJECT_CLASSES = {
-      info_object: R2OAS::Schema::V3::InfoObject,
-      paths_object: R2OAS::Schema::V3::PathsObject,
-      path_item_object: R2OAS::Schema::V3::PathItemObject,
-      external_document_object: R2OAS::Schema::V3::ExternalDocumentObject,
-      components_object: R2OAS::Schema::V3::ComponentsObject,
-      components_schema_object: R2OAS::Schema::V3::Components::SchemaObject,
-      components_request_body_object: R2OAS::Schema::V3::Components::RequestBodyObject
-    }
-    # rubocop:enable Style/MutableConstant
-
-    VALID_OPTIONS_KEYS = [
-      :use_object_classes
-    ].freeze
-
-    attr_accessor *VALID_OPTIONS_KEYS
-
-    private
-
-    module_function
-
-    def set_default(target)
-      target.use_object_classes = DEFAULT_USE_OBJECT_CLASSES
-    end
-  end
-end

data/lib/r2-oas/plugins/schema/v3/object/hookable_base_object.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require 'r2-oas/schema/v3/object/base_object'
-require 'r2-oas/hooks/hook'
-
-module R2OAS
-  module Plugins
-    module Schema
-      module V3
-        class HookableBaseObject < R2OAS::Schema::V3::BaseObject
-          module ClassMethods
-            def before_create(&block)
-              proc = (block_given? ? block : proc {})
-              on(:before_create, proc)
-            end
-
-            def after_create(&block)
-              proc = (block_given? ? block : proc {})
-              on(:after_create, proc)
-            end
-          end
-
-          def self.inherited(base)
-            base.extend ClassMethods
-            self.hook = Hooks::Hook.register(base)
-          end
-
-          def self.hooks
-            superclass.hook.repository[self].global_hooks_data
-          end
-
-          def self.hook=(value)
-            @@hook = value
-          end
-
-          def self.hook
-            @@hook
-          end
-
-          class << self
-            def on(on, callback, once = false)
-              hook.on(on, callback, self, once)
-            end
-
-            # MEMO: Do not Use
-            def off(on, callback, once = false)
-              hook.off(on, callback, self, once)
-            end
-
-            def execute_hook(on, *data)
-              hook.execute_hook(on, *data, self)
-            end
-
-            def has_hook?(name)
-              hook.has_hook?(name, self)
-            end
-          end
-
-          attr_accessor :doc
-
-          def initialize
-            super
-            self.doc = {}
-          end
-
-          # MEMO: Please overwrite when passing arguments other than `doc`
-          def to_doc
-            execute_before_create
-            create_doc
-            execute_after_create
-            doc
-          end
-
-          def use_superclass_hook
-            self.class.hook.repository[self.class] = self.class.hook.repository[self.class.superclass]
-          end
-
-          private
-
-          def create_doc
-            raise NoImplementError
-          end
-
-          def execute_before_create(*data)
-            execute_hook_method(:before_create, *data)
-          end
-
-          def execute_after_create(*data)
-            execute_hook_method(:after_create, *data)
-          end
-
-          def execute_hook_method(method_name, *data)
-            args = [doc].push(*data)
-            self.class.execute_hook(method_name.to_sym, *args) if self.class.has_hook?(method_name.to_sym)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/r2-oas/schema/v3/object/base_object.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module R2OAS
-  module Schema
-    module V3
-      class BaseObject
-        def initialize(*_args)
-          AppConfiguration::VALID_OPTIONS_KEYS.each do |key|
-            send("#{key}=", app_configuration_options[key])
-          end
-
-          PluggableConfiguration::VALID_OPTIONS_KEYS.each do |key|
-            instance_variable_set(:"@#{key}", pluggable_configuration_options[key])
-          end
-        end
-
-        def info_object_class
-          @use_object_classes[:info_object]
-        end
-
-        def paths_object_class
-          @use_object_classes[:paths_object]
-        end
-
-        def path_item_object_class
-          @use_object_classes[:path_item_object]
-        end
-
-        def external_document_object_class
-          @use_object_classes[:external_document_object]
-        end
-
-        def components_object_class
-          @use_object_classes[:components_object]
-        end
-
-        def components_schema_object_class
-          @use_object_classes[:components_schema_object]
-        end
-
-        def components_request_body_object_class
-          @use_object_classes[:components_request_body_object]
-        end
-
-        private
-
-        def app_configuration_options
-          R2OAS.app_configuration_options
-        end
-
-        def pluggable_configuration_options
-          R2OAS.pluggable_configuration_options
-        end
-
-        # Can not define attr_accessor for PluggableConfiguration::VALID_OPTIONS_KEYS.
-        # Because, PuggableConfiguration module is not loaded when this class is loaded.
-        attr_accessor *AppConfiguration::VALID_OPTIONS_KEYS
-
-        def to_doc
-          raise 'Implement Inherit Class'
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# 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 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
-
-        builder_options = { unit_paths_file_path: unit_paths_file_path }
-        builder = R2OAS::Schema::Builder.new(builder_options)
-        builder.build_docs
-
-        download_dist_th.join
-        client.deploy
-      end
-    end
-
-    desc '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 '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