r2-oas 0.1.2 → 0.3.2

data/.github/ISSUE_TEMPLATE.md

@@ -1,12 +0,0 @@
-### Steps to reproduce
-
-### Expected behavior
-Tell us what should happen
-
-### Actual behavior
-Tell us what happens instead
-
-### System configuration
-**r2-oas version**:
-
-**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +0,0 @@
-### Summary
-
-### Other Information
-
-If there's anything else that's important and relevant to your pull
-request, mention that information here. This could include
-benchmarks, or other information.
-
-If you are updating any of the CHANGELOG files or are asked to update the
-CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
-
-Thanks for contributing to r2-oas!

data/Gemfile.lock

@@ -1,222 +0,0 @@
-PATH
-  remote: .
-  specs:
-    r2-oas (0.1.2)
-      docker-api (~> 1.34.2)
-      easy_diff (~> 1.0.0)
-      eventmachine (~> 1.2.0)
-      paint
-      rails (>= 4.2.5)
-      terminal-table (~> 1.6.0)
-      watir (~> 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      mail (>= 2.7.1)
-    actionmailer (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      nokogiri (>= 1.8.5)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.2)
-      activesupport (= 6.0.2.2)
-      globalid (>= 0.3.6)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activestorage (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      marcel (~> 0.3.1)
-    activesupport (6.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
-    builder (3.2.4)
-    childprocess (3.0.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
-    crass (1.0.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    docker-api (1.34.2)
-      excon (>= 0.47.0)
-      multi_json
-    easy_diff (1.0.0)
-    erubi (1.9.0)
-    eventmachine (1.2.7)
-    excon (0.73.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    loofah (2.5.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.4)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    multi_json (1.14.1)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    paint (2.2.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.2.2)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.0.2.2)
-      actioncable (= 6.0.2.2)
-      actionmailbox (= 6.0.2.2)
-      actionmailer (= 6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actiontext (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      bundler (>= 1.3.0)
-      railties (= 6.0.2.2)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    rubyzip (2.3.0)
-    selenium-webdriver (3.142.7)
-      childprocess (>= 0.5, < 4.0)
-      rubyzip (>= 1.2.2)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sprockets (4.0.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.4.1)
-    term-ansicolor (1.7.1)
-      tins (~> 1.0)
-    terminal-table (1.6.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tins (1.21.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    watir (6.16.5)
-      regexp_parser (~> 1.2)
-      selenium-webdriver (~> 3.6)
-    websocket-driver (0.7.1)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  coveralls
-  pry
-  r2-oas!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop
-  sqlite3
-
-BUNDLED WITH
-   1.17.3

data/bin/console

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'r2-oas'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docs/README.md

@@ -1,326 +0,0 @@
-# R2-OAS
-
-[![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
-[![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
-
-Generate api docment(OpenAPI) side only from `Rails` routing.
-
-Provides a rake command to help `generate` , `view` , and `edit` OpenAPI documents.
-
-```bash
-bundle exec rake routes:oas:docs    # generate
-bundle exec rake routes:oas:ui      # view
-bundle exec rake routes:oas:editor  # edit
-bundle exec rake routes:oas:monitor # monitor
-bundle exec rake routes:oas:dist    # distribute
-bundle exec rake routes:oas:clean   # clean
-bundle exec rake routes:oas:analyze # analyze
-bundle exec rake routes:oas:deploy  # deploy
-```
-
-## 💎 Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-group :development do
-  gem 'r2-oas'
-end
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install r2-oas
-
-## 🔦 Requirements
-
-If you want to view with `Swagger UI` or edit with `Swagger Editor`, This gem needs the following:
-
-- [`swaggerapi/swagger-ui:latest` docker image](https://hub.docker.com/r/swaggerapi/swagger-ui/)
-- [`swaggerapi/swagger-editor:latest` docker image](https://hub.docker.com/r/swaggerapi/swagger-editor/)
-- [`chromedriver`](http://chromedriver.chromium.org/downloads)
-
-If you do not have it download as below.
-
-```
-$ docker pull swaggerapi/swagger-editor:latest
-$ docker pull swaggerapi/swagger-ui:latest
-$ brew cask install chromedriver
-```
-
-## 🚀 Tutorial
-
-After requiring a gem,
-
-```bash
-bundle exec routes:oas:docs
-bundle exec routes:oas:editor
-```
-
-## 📖 Usage
-
-All settings are optional. The initial value is as follows.
-
-In your rails project, Write `config/environments/development.rb` like that:
-
-```ruby
-# default setting
-R2OAS.configure do |config|
-  config.version                            = :v3
-  config.root_dir_path                      = "./oas_docs"
-  config.schema_save_dir_name               = "src"
-  config.doc_save_file_name                 = "oas_doc.yml"
-  config.force_update_schema                = false
-  config.use_tag_namespace                  = true
-  config.use_schema_namespace               = false
-  config.interval_to_save_edited_tmp_schema = 15
-  # :dot or :underbar
-  config.namespace_type                     = :underbar
-  config.deploy_dir_path                    = "./deploy_docs"
-
-  config.server.data = [
-    {
-      url: "http://localhost:3000",
-      description: "localhost"
-    }
-  ]
-
-  config.swagger.configure do |swagger|
-    swagger.ui.image            = "swaggerapi/swagger-ui"
-    swagger.ui.port             = "8080"
-    swagger.ui.exposed_port     = "8080/tcp"
-    swagger.ui.volume           = "/app/swagger.json"
-    swagger.editor.image        = "swaggerapi/swagger-editor"
-    swagger.editor.port         = "81"
-    swagger.editor.exposed_port = "8080/tcp" 
-  end
-
-  config.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
-  }
-
-  config.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)
-    }
-  }
-
-  config.http_methods_when_generate_request_body = %w[post patch put]
-  config.ignored_http_statuses_when_generate_component_schema = %w[204 404]
-
-  config.tool.paths_stats.configure do |paths_stats|
-    paths_stats.month_to_turn_to_warning_color = 3
-    paths_stats.warning_color                  = :red
-    paths_stats.table_title_color              = :yellow
-    paths_stats.heading_color                  = :yellow
-    paths_stats.highlight_color                = :magenta
-  end
-end
-```
-
-You can execute the following command in the root directory of rails.
-
-```bash
-$ # Generate docs
-$ bundle exec rake routes:oas:docs                                                                        # Generate docs
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs    # Generate docs by specify unit paths
-
-$ # Start swagger editor
-$ bundle exec rake routes:oas:editor                                                                      # Start swagger editor
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor  # Start swagger editor by specify unit paths
-$ # Start swagger ui
-$ bundle exec rake routes:oas:ui                                                                          # Start swagger ui
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui      # Start swagger ui by specify unit paths
-$ # Monitor swagger document
-$ bundle exec rake routes:oas:monitor                                                                     # Monitor swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:monitor # Monitor swagger by specify unit paths
-
-$ # Analyze docs
-$ OAS_FILE="~/Desktop/swagger.yml" bundle exec rake routes:oas:analyze
-$ # Clean docs
-$ bundle exec rake routes:oas:clean
-$ # Deploy docs
-$ bundle exec rake routes:oas:deploy
-$ # Distribute swagger document
-$ bundle exec rake routes:oas:dist
-$ # Distribute swagger document
-$ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:dist # Distribute swagger document by specify unit paths
- 
-# Display paths list
-$ bundle exec rake routes:oas:paths_ls
-# Display paths stats
-$ bundle exec rake routes:oas:paths_stats
-```
-
-## ❤️ Support Rails Version
-
-- Rails (>= 4.2.5.1)
-
-## ❤️ Support Ruby Version
-
-- Ruby (>= 2.3.3p222 (2016-11-21 revision 56859) [x86_64-darwin18])
-
-## ❤️ Support Rouging
-
-- Rails Engine Routing
-- Rails Normal Routing
-
-## ❗️ Convention over Configuration (CoC)
-
-- `tag name` represents `controller name` and determine `paths file name`.
-  - For example, If `controller name` is `Api::V1::UsersController`, `tag_name` is `api/v1/user`. and `paths file name` is `api/v1/user.yml`
-
-- `_` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `Api_V1_User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `_` is supposed to be used to express `namespace`.
-  - format is `Namespace1_Namespace2_Model`.
-
-- `.` of `components/{schemas,requestBodies, ...} name` convert `/` when save file.
-  - For example, If `components/schemas name` is `api.v1.User`, `components/schemas file name` is `api/v1/user.yml`.
-  - `.` is supposed to be used to express `namespace`.
-  - format is `namespace1.namespace2.Model`.
-
-## ⚙ Configure
-
-we explain the options that can be set.
-
-#### basic
-
-|option|description|default|
-|------|-----------|---|
-|version|OpenAPI schema version| `:v3` |
-|root_dir_path|Root directory for storing products.| `"./oas_docs"` |
-|schema_save_dir_name|Directory name for storing swagger schemas|`"src"`|
-|doc_save_file_name|File name for storing swagger doc|`"oas_doc.yml"`|
-|force_update_schema|Force update schema from routes data|`false`|
-|use_tag_namespace|Use namespace for tag name|`true`|
-|use_schema_namespace|Use namespace for schema name|`true`|
-|interval_to_save_edited_tmp_schema|Interval(sec) to save edited tmp schema|`15`|
-|http_statuses_when_http_method|Determine the response to support for each HTTP method|omission...|
-|http_methods_when_generate_request_body|HTTP methods when generate requestBody|`[post put patch]`|
-|ignored_http_statuses_when_generate_component_schema|Ignore HTTP statuses when generate component schema|`[204 404]`|
-|namespace_type|namespace for components(schemas/requestBodies) name| `underbar` |
-|deploy_dir_path|deploy directory.|`"./deploy_docs"`|
-
-#### server
-
-|option|children option|description|default|
-|------|---------------|-----------|-------|
-|server|data|Server data (url, description) |[{ url: `http://localhost:3000`, description: `localhost` }] |
-
-#### swagger
-
-|option|children option|grandchild option|description|default|
-|------|---------------|-----------------|-----------|-------|
-|swagger|ui|image|Swagger UI Docker Image|`"swaggerapi/swagger-ui"`|
-|swagger|ui|port|Swagger UI Port|`"8080"`|
-|swagger|ui|exposed_port|Swagger UI Exposed Port|`"8080/tcp"`|
-|swagger|ui|volume|Swagger UI Volume|`"/app/swagger.json"`|
-|swagger|editor|image|Swagger Editor Docker Image|`"swaggerapi/swagger-editor"`|
-|swagger|editor|port|Swagger Editor Port|`"8080"`|
-|swagger|editor|exposed_port|Swagger Editor Exposed Port|`"8080/tcp"`|
-
-#### hook
-
-|option|description|default|
-|------|-----------|-------|
-|use_object_classes|Object class(hook class) to generate Openapi document|{ info_object: `R2OAS::Schema::V3::InfoObject`,<br>paths_object: `R2OAS::Schema::V3::PathsObject`,<br>path_item_object: `R2OAS::Schema::V3::PathItemObject`, external_document_object: `R2OAS::Schema::V3::ExternalDocumentObject`,<br> components_object: `R2OAS::Schema::V3::ComponentsObject`,<br> components_schema_object: `R2OAS::Schema::V3::Components::SchemaObject`, <br> components_request_body_object:`R2OAS::Schema::V3::Components::RequestBodyObject` }|
-
-#### tool
-
-|option|children option|grandchild option|description|default|
-|------|---------------|-----------------|-----------|-------|
-|tool|paths_stats|month_to_turn_to_warning_color|Elapsed month to issue a warning|`3`|
-|tool|paths_stats|warning_color|Warning Color|`:red`|
-|tool|paths_stats|table_title_color|Table Title Color|`:yellow`|
-|tool|paths_stats|heading_color|Heading Color|`:yellow`|
-|tool|paths_stats|highlight_color|Highlight Color|`:magenta`|
-
-Please refer to [here](https://github.com/janlelis/paint) for the color.
-
-## Environment variables
-
-We explain the environment variables that can be set.
-
-|variable|description|default|
-|--------|-----------|-------|
-|PATHS_FILE|Specify one paths file path|`""`|
-|OAS_FILE|Specify swagger file path to analyze|`""`|
-
-
-## .paths
-
-Writing file paths in .paths will only read them.
-You can comment out with `#`
-
-`oas_docs/.paths`
-
-```
-#account_user_role.yml    # ignore
-account.yml
-account.yml               # ignore
-account.yml               # ignore
-```
-
-## 🔩 CORS
-
-Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.
-
-```ruby
-require 'rack/cors'
-use Rack::Cors do
-  allow do
-    origins '*'
-    resource '*', headers: :any, methods: [ :get, :post, :put, :delete, :options ]
-  end
-end
-```
-
-Alternatively you can set CORS headers in a `before` block.
-
-```ruby
-before do
-  header['Access-Control-Allow-Origin'] = '*'
-  header['Access-Control-Request-Method'] = '*'
-end
-```
-
-## 📝 License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## 🤝 Contributing
-
-1. Fork it ( http://github.com/yukihirop/r2-oas/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request