r2-oas 0.3.1 → 0.4.1

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/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/devscript/all_support_ruby.sh

@@ -1,43 +0,0 @@
-#!/usr/local/bin/bash
-
-if [ $# -eq 0 ]; then
-  echo "Please specify 'rspec' or 'bundle', 'list'"
-  exit 1
-fi
-
-# Check if rbenv is installed
-which rbenv > /dev/null 2>&1 && if [ $? -ne 0 ]; then echo -e 'rbenv is need\nPlease install rbenv: https://github.com/rbenv/rbenv'; exit 1; fi
-
-declare -a all_support_ruby=(
-  '2.3.3'
-  '2.4.2'
-  '2.5.8'
-  '2.6.6'
-  '2.7.1'
-)
-
-declare -a target_ruby
-declare -a versions=${@:2:$#}
-if [[ $# > 1 ]]; then
-  target_ruby=("${versions[@]}")
-else
-  target_ruby=("${all_support_ruby[@]}")
-fi
-
-command=$1
-case $command in
-  "bundle")
-    source "$(pwd)/devscript/bundle_for_all_support_ruby.sh" "${target_ruby[@]}";;
-  "rspec")
-    source "$(pwd)/devscript/rspec_for_all_support_ruby.sh" "${target_ruby[@]}";;
-  "list")
-    echo "===== Display All Support Ruby Version ====="
-    for version in "${target_ruby[@]}"; do
-      echo "${version}"
-    done
-    echo "============================================";;
-  *)
-    echo -n "Do not support command: ${command}\nPlease specify 'bundle' or 'rspec', 'list'"
-    exit 1;;
-esac
-

data/devscript/bundle_for_all_support_ruby.sh

@@ -1,31 +0,0 @@
-#!/usr/local/bin/bash
-
-# Bundle install each All Support Ruby
-declare -a report
-for version in $@; do
-  echo "== Bundle install for Ruby Version: ${version} =="
-  
-  # Remove gemfile.lock
-  lockfile="./gemfiles/ruby_${version}.gemfile.lock"
-  if [[ -f $lockfile ]]; then rm $lockfile; fi
-  
-  # Change Ruby Version
-  echo ${version} > ./.ruby-version && rbenv rehash
-  
-  # Bundle install
-  if [[ $version == "2.3.3" ]]; then
-    BUNDLE_GEMFILE=./gemfiles/ruby_${version}.gemfile bundle _1.17.3_ install --path vendor/bundle && report+=("ruby-${version}: $?")
-  else
-    BUNDLE_GEMFILE=./gemfiles/ruby_${version}.gemfile bundle install --path vendor/bundle && report+=("ruby-${version}: $?")
-  fi 
-  if [ $? -ne 0 ]; then report+=("ruby-${version}: 1 (failed)");fi
-
-  echo "== End for Ruby Version: ${version} =="
-done
-
-#  Display report
-echo "===== Bundle install for All Support Ruby Result ====="
-for result in "${report[@]}"; do
-  echo $result
-done
-echo "======================================================"

data/devscript/rspec_for_all_support_ruby.sh

@@ -1,27 +0,0 @@
-#!/usr/local/bin/bash
-
-# Rspec each All Support Ruby
-declare -a report
-for version in $@; do
-  echo "== Rspec for Ruby Version: ${version} =="
-  
-  # Change Ruby Version
-  echo ${version} > ./.ruby-version && rbenv rehash
-
-  # Rspec
-  if [[ $version == "2.3.3" ]];then
-    BUNDLE_GEMFILE=./gemfiles/ruby_${version}.gemfile bundle _1.17.3_ exec rspec --format progress && report+=("ruby-${version}: $?")
-  else
-    BUNDLE_GEMFILE=./gemfiles/ruby_${version}.gemfile bundle exec rspec --format progress && report+=("ruby-${version}: $?")
-  fi
-  if [ $? -ne 0 ]; then report+=("ruby-${version}: 1 (failed)");fi
-
-  echo "== End for Ruby Version: ${version} =="
-done
-
-#  Display report
-echo "===== Rspec for All Support Ruby Result ====="
-for result in "${report[@]}"; do
-  echo $result
-done
-echo "============================================="

data/docs/README.md

@@ -1,173 +0,0 @@
-# R2-OAS
-
-[![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/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
-```
-
-#### Generate docs
-
-![oas_docs](https://user-images.githubusercontent.com/11146767/80856236-0b839a80-8c83-11ea-888f-d0e659e0c251.gif)
-
-
-#### Edit docs
-
-![oas_editor](https://user-images.githubusercontent.com/11146767/80856240-15a59900-8c83-11ea-9dbd-4382528944f2.gif)
-
-## 📖 Usage
-
-
-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`.
-
-## 🔩 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

data/docs/_sidebar.md

@@ -1,25 +0,0 @@
-<!-- docs/_sidebar.md -->
-* **Attention**
- * [If Clash](/attention/if_clash)
-* **Trableshouting**
- * [RuntimeError](/trableshouting/runtime_error)
-* **Usage**
- * [Generate Docs](/usage/generate_docs)
- * [Edit docs](/usage/edit_docs)
- * [View docs](/usage/view_docs)
- * [Monitor Docs](/usage/monitor_docs)
- * [Analyze Docs](/usage/analyze_docs)
- * [Use Hook to Generate Docs](/usage/use_hook_to_generate_docs)
- * [Use schema namespace](/usage/use_schema_namespace)
- * [Use tag namespace](/usage/use_tag_namespace)
- * [Use hook methods](/usage/use_hook_methods)
- * [Deploy docs](/usage/deploy_docs)
- * [Clean Docs](/usage/clean_docs)
- * [Display Paths Lists](/usage/display_paths_list)
- * [Display Paths Stats](/usage/display_paths_stats)
-* **Configure**
- * [COC](/setting/COC)
- * [Configure](/setting/configure)
- * [CORS](/setting/CORS)
-* **Support Schema**
- * [3.0.0](/schema/3.0.0)