r2-oas 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202a93f6e116bb378c723a0810746749dea8059e91d2c199727739850ca528e7
-  data.tar.gz: 8061d7a71e56c7656065b20ac85f39755df665dd0d22031e01374e82a773114c
+  metadata.gz: 517376839248a5dd6de6e70b753490e02a23ac70c967129fc7a578ec89da596c
+  data.tar.gz: 7eedf1ebcd319c0b93ee1ac58556ce0e4788658e62b64eecbad825862770245f
 SHA512:
-  metadata.gz: 0700ad89a7147febd6b7fabb6c2343403a0f0fc4fa2e244996e3a2fa24a9e951e6e5899335f4fb4e26858796c87b04e4af4984992ce06d3a0d6864fdd6f2659f
-  data.tar.gz: 2bab390d140d5eeef3b12b7563ffe20e3b2179e129f38bf4c3c4483777d80f4b91e5f73f8d74ad7a8f7c9db81ff258915a6a57cda90b4b2edcf199eb26b2ec49
+  metadata.gz: 20b7b68bbf6c4e8ec2d963301855d7bd078b78c31a98e8a01d421197a9e080682e459fb2a2b5541ca07580b995003f3fe17f88b97b1ab5295bdcda793d255c81
+  data.tar.gz: 140b4b5c71b4e34ed9f7ef7796414699db821ac078d6ad0101530145d0e3084cfd3f4e7b0c85e6a6091a2213b91ce6f976d4a2ee44d20434ce75f4f848595bf1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## v0.3.2
+
+2020-07-05
+
+- [`Feature`] The file size at the time of gem install was reduced by about 10MB. ([dbdbce9 ](https://github.com/yukihirop/r2-oas/pull/138))
+
 ## v0.3.1
 
 2020-06-07

data/lib/r2-oas/deploy/client.rb

@@ -6,22 +6,33 @@ require 'fileutils'
 module R2OAS
   module Deploy
     class Client < Schema::Base
+      SWAGGER_UI_DIST_URL = 'https://github.com/swagger-api/swagger-ui/trunk/dist'
+
+      def initialize(options = {})
+        super(options)
+        @download_dir = "#{SecureRandom.uuid[0..7]}/dist"
+        @dist_path = File.expand_path(Rails.root.join(@download_dir), __FILE__)
+      end
+
+      def download_swagger_ui_dist
+        system("svn export #{SWAGGER_UI_DIST_URL} #{@dist_path}")
+      end
+
       def deploy
         copy_swagger_ui_dist
         copy_swagger_ui_index
         copy_oas_doc_file
+      ensure
+        remove_download_dist
       end
 
       private
 
       def copy_swagger_ui_dist
         docs_path = File.expand_path(Rails.root.join(deploy_dir_path), __FILE__)
-        return if FileTest.exists?(docs_path)
-
         FileUtils.mkdir_p(docs_path) unless FileTest.exists?(docs_path)
-
-        dist_path = File.expand_path('swagger-ui/dist', __dir__)
-        FileUtils.cp_r(dist_path, docs_path)
+        FileUtils.mkdir_p(@dist_path) unless FileTest.exists?(@dist_path)
+        FileUtils.cp_r(@dist_path, docs_path)
       end
 
       def copy_swagger_ui_index
@@ -39,6 +50,10 @@ module R2OAS
         FileUtils.cp_r(oas_doc_file_path, swagger_file_path)
       end
 
+      def remove_download_dist
+        FileUtils.rm_rf(File.expand_path('..', @dist_path))
+      end
+
       # [ref]
       # https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint/ErbNewArguments
       def make_index(template)

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

@@ -11,12 +11,19 @@ namespace :routes 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
 
-        client_options = {}
-        client = R2OAS::Deploy::Client.new(client_options)
+        download_dist_th.join
         client.deploy
       end
     end

data/lib/r2-oas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module R2OAS
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/r2-oas.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin|.github|devscript|docs|gemfiles)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r2-oas
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - yukihirop
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -251,8 +251,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -267,39 +265,6 @@ files:
 - README.ja.md
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- devscript/all_support_ruby.sh
-- devscript/bundle_for_all_support_ruby.sh
-- devscript/rspec_for_all_support_ruby.sh
-- docs/.nojekyll
-- docs/README.md
-- docs/_sidebar.md
-- docs/attention/if_clash.md
-- docs/index.html
-- docs/schema/3.0.0.md
-- docs/setting/COC.md
-- docs/setting/CORS.md
-- docs/setting/configure.md
-- docs/trableshouting/runtime_error.md
-- docs/usage/analyze_docs.md
-- docs/usage/clean_docs.md
-- docs/usage/deploy_docs.md
-- docs/usage/display_paths_list.md
-- docs/usage/display_paths_stats.md
-- docs/usage/edit_docs.md
-- docs/usage/generate_docs.md
-- docs/usage/monitor_docs.md
-- docs/usage/use_hook_methods.md
-- docs/usage/use_hook_to_generate_docs.md
-- docs/usage/use_schema_namespace.md
-- docs/usage/use_tag_namespace.md
-- docs/usage/view_docs.md
-- gemfiles/ruby_2.3.3.gemfile
-- gemfiles/ruby_2.4.2.gemfile
-- gemfiles/ruby_2.5.8.gemfile
-- gemfiles/ruby_2.6.6.gemfile
-- gemfiles/ruby_2.7.1.gemfile
 - lib/r2-oas.rb
 - lib/r2-oas/app_configuration.rb
 - lib/r2-oas/app_configuration/server.rb
@@ -312,17 +277,6 @@ files:
 - lib/r2-oas/configuration.rb
 - lib/r2-oas/configuration/paths_config.rb
 - lib/r2-oas/deploy/client.rb
-- lib/r2-oas/deploy/swagger-ui/dist/favicon-16x16.png
-- lib/r2-oas/deploy/swagger-ui/dist/favicon-32x32.png
-- lib/r2-oas/deploy/swagger-ui/dist/oauth2-redirect.html
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css.map
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js
-- lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js.map
 - lib/r2-oas/deploy/swagger-ui/index.html.erb
 - lib/r2-oas/errors.rb
 - lib/r2-oas/hooks/global_hook.rb
@@ -418,9 +372,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/yukihirop/r2-oas/issues
-  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.3.1/CHANGELOG.md
+  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.3.2/CHANGELOG.md
   documentation_uri: https://yukihirop.github.io/r2-oas
-  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.3.1
+  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.3.2
 post_install_message: 
 rdoc_options: []
 require_paths:

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/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