r2-oas 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eec703f732ad44e2cd37ad10c80bc2a2335a139d2d1e49fb16a8e5a2f74c768
-  data.tar.gz: 18757357c5b9958d68e5cbba48e098788f5182d5942b532eb56554204c2df66a
+  metadata.gz: 517376839248a5dd6de6e70b753490e02a23ac70c967129fc7a578ec89da596c
+  data.tar.gz: 7eedf1ebcd319c0b93ee1ac58556ce0e4788658e62b64eecbad825862770245f
 SHA512:
-  metadata.gz: ed60f8a51749c1989332104c4282fb95e1c85cd842893335437d29666ac17217035dd8fcd7db6fbfd7406b3da5e24aa2fc1110e0dd86a6c59fb167163dd23b6b
-  data.tar.gz: c2e023025e03f76944a3a9b8459acfd2a18d1c8ca89cbc4a3753d60bc5cc713afabd1a7087e2dddea6ca01fe8b28c644ff1dcf8f477d553332931b7861111a89
+  metadata.gz: 20b7b68bbf6c4e8ec2d963301855d7bd078b78c31a98e8a01d421197a9e080682e459fb2a2b5541ca07580b995003f3fe17f88b97b1ab5295bdcda793d255c81
+  data.tar.gz: 140b4b5c71b4e34ed9f7ef7796414699db821ac078d6ad0101530145d0e3084cfd3f4e7b0c85e6a6091a2213b91ce6f976d4a2ee44d20434ce75f4f848595bf1

data/.gitignore

@@ -10,3 +10,7 @@
 # rspec failure tracking
 .rspec_status
 /example*
+Gemfile.lock
+**/vendor/bundle
+gemfiles/*.lock
+gemfiles/.bundle/*

data/.rubocop.yml

@@ -1,7 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   Exclude:
-    - 'example*/**/*'
-    - 'vendor/**/*'
+    - "example*/**/*"
+    - "vendor/**/*"
+    - "r2-oas.gemspec"
+    - "gemfiles/**/*"
+    - "Appraisals"

data/.rubocop_todo.yml

@@ -10,7 +10,7 @@
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 2088
 
 Metrics/AbcSize:
@@ -26,6 +26,7 @@ Metrics/AbcSize:
     - "lib/r2-oas/routing/components/request_component.rb"
     - "spec/r2-oas/schema/v3/object/components/schema_object_spec.rb"
     - "spec/support/helpers/config_helper.rb"
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
 
 Style/Documentation:
   Enabled: false
@@ -55,6 +56,7 @@ Metrics/BlockLength:
     - "spec/r2-oas/tasks/tool_spec.rb"
     - "spec/r2-oas/configuration_spec.rb"
     - "spec/r2-oas/schema/v3/generator_spec.rb"
+    - "spec/r2-oas/schema/v3/builder_spec.rb"
     - "spec/r2-oas/schema/v3/analyzer_spec.rb"
     - "spec/support/helpers/config_helper.rb"
     - "spec/r2-oas/schema/v3/object/components_object_spec.rb"
@@ -62,6 +64,7 @@ Metrics/BlockLength:
     - "spec/r2-oas/schema/v3/manager/diff/base_array_diff_manager_spec.rb"
     - "spec/r2-oas/schema/v3/manager/file/include_ref_base_file_manager_spec.rb"
     - "spec/r2-oas/schema/v3/generator/base_generator_spec.rb"
+    - "spec/r2-oas/schema/v3/builder/base_builder_spec.rb"
     - "spec/r2-oas/schema/v3/object/openapi_object_spec.rb"
     - "spec/r2-oas/schema/v3/object/info_object_spec.rb"
 
@@ -112,17 +115,20 @@ Metrics/MethodLength:
     - "lib/r2-oas/schema/v3/generator/schema_generator.rb"
     - "lib/r2-oas/schema/v3/generator/components/schema_generator.rb"
     - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/doc_builder.rb"
     - "lib/r2-oas/schema/v3/object/components/request_body_object.rb"
     - "lib/r2-oas/schema/v3/squeezer/path_squeezer.rb"
     - "lib/r2-oas/schema/v3/generator/components/object_generator.rb"
     - "lib/r2-oas/routing/components/request_component.rb"
     - "spec/support/helpers/config_helper.rb"
     - "lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb"
+    - "lib/r2-oas/store.rb"
 
 Metrics/CyclomaticComplexity:
   Exclude:
     - "lib/r2-oas/logger/stdout_logger.rb"
     - "lib/r2-oas/schema/v3/manager/pathname_manager.rb"
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
 
 Naming/ConstantName:
   Exclude:
@@ -180,6 +186,7 @@ Style/AccessModifierDeclarations:
 Style/NumericPredicate:
   Exclude:
     - "lib/r2-oas/schema/v3/generator/base_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/base_builder.rb"
 
 Metrics/ClassLength:
   Exclude:
@@ -195,6 +202,7 @@ Layout/EndAlignment:
   Exclude:
     - "lib/r2-oas/shared/sortable.rb"
     - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+    - "lib/r2-oas/schema/v3/builder/doc_builder.rb"
 
 Security/YAMLLoad:
   Exclude:
@@ -222,3 +230,62 @@ Style/ClassAndModuleChildren:
 Lint/RequireParentheses:
   Exclude:
     - "spec/r2-oas/schema/v3/object/components/schema_object_spec.rb"
+
+Style/IfUnlessModifier:
+  Exclude:
+    - "lib/r2-oas/schema/editor.rb"
+
+Security/MarshalLoad:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/r2-oas/schema/v3/generator/doc_generator.rb"
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: false
+
+Style/RedundantRegexpEscape:
+  Enabled: false

data/.travis.yml

@@ -7,8 +7,12 @@ cache: bundler
 
 rvm:
   - 2.3.3
+  - 2.4.2
+  - 2.5.7
+  - 2.6.5
+  - 2.7.1
 
-before_install: gem install bundler -v 1.17.3
+before_install: gem install bundler
 
 gemfile:
   - Gemfile
@@ -18,5 +22,5 @@ install:
   - bundle install
 
 script:
-  - bundle exec rubocop --fail-level=W
+  - 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

@@ -0,0 +1,13 @@
+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/CHANGELOG.md

@@ -1,5 +1,56 @@
 # 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
+
+- [`Breaking`] Remove unnecessary runtime dependencies ([384ea1a](https://github.com/yukihirop/r2-oas/pull/132))
+
+## v0.3.0
+
+2020-05-30
+
+- [`Feature/Breaking`] Support Ruby 2.7 🎉 ([931ec4b](https://github.com/yukihirop/r2-oas/pull/122))
+
+  - Remove `Gemfile.lock`
+
+- [`Developer`] Create script to test all support ruby in development ([8d0df98](https://github.com/yukihirop/r2-oas/pull/124))
+- [`Docs`] Add docs about Trableshouting ([f4a782f](https://github.com/yukihirop/r2-oas/pull/125))
+
+## v0.2.0
+
+2020-05-02
+
+- [`Feature/Breaking`] Upgrade `routes:oas:docs` cmd ([37ccddf](https://github.com/yukihirop/r2-oas/pull/117))
+  
+  - `.docs` is needed to continue using r2-oas. `If you are using previous version`,you need to run the following command to generate `.docs`.
+
+    ```bash
+    CACHE_DOCS=true bundle exec rake routes:oas:docs
+    ```
+
+- [`Breaking`] Divide into `Generator` and `Builder` ([00fea7d](https://github.com/yukihirop/r2-oas/pull/116))
+  - `routes:oas:docs` cmd do not generate `oas_docs/oas_doc.yml`
+
+## v0.1.3
+
+2020-04-27
+
+- [`FixBugs`] Fix clash when edit ([906d068](https://github.com/yukihirop/r2-oas/pull/109))
+- [`Feature`] Change log display to relative path ([c735d22](https://github.com/yukihirop/r2-oas/pull/111))
+
+## v0.1.2
+
+2020-04-22
+
+- No Change
+
 ## v0.1.1
 
 2020-04-22

data/GEMSPEC.md

@@ -0,0 +1,20 @@
+Configureless and no DSL. 👍 But you can also configure.  
+Manage with yaml file instead of Ruby code.  
+Loosely coupled to your Rails project. 👍  
+So if you want to use another tool, you can port it right away. 😢  
+Generate api docment(OpenAPI) side only from `Rails` routing.  
+  
+Provide rake tasks to management API Docment (OpenAPI) 🎉  
+  
+
+    $ bundle exec rake routes:oas:docs
+    $ bundle exec rake routes:oas:ui
+    $ bundle exec rake routes:oas:editor
+    $ bundle exec rake routes:oas:monitor
+    $ bundle exec rake routes:oas:dist
+    $ bundle exec rake routes:oas:clean
+    $ bundle exec rake routes:oas:analyze
+    $ bundle exec rake routes:oas:deploy
+
+  
+Happy Coding ❗️

data/README.ja.md

@@ -1,5 +1,6 @@
 # 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)
@@ -52,6 +53,15 @@ 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)
+
 ## 📚 Documents
 
 公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas
@@ -147,6 +157,67 @@ OpenAPIの3.0.0をサポートしてます。
 
 公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
 
+
+## Bundle and Rspec with multiple ruby ​​versions
+
+#### Bundle
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle 2.6.6 2.7.1
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+#### Rspec
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
+rubyのバージョンを `2.6.6` と `2.7.1`　に指定する場合
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec 2.6.6 2.7.1
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
 ## 🔩 CORS
 
 [rack-cors](https://github.com/cyu/rack-cors)を使用する事でCORSを可能にします。

data/README.md

@@ -1,5 +1,6 @@
 # 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)
@@ -62,6 +63,15 @@ 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.
@@ -146,6 +156,66 @@ Supported hook(life cycle methods) is like this:
 
 Full docs are available at https://yukihirop.github.io/r2-oas/#/usage/use_hook_methods
 
+## Bundle and Rspec with multiple ruby ​​versions
+
+#### Bundle
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+If specify ruby version `2.6.6` and `2.7.1`
+
+```bash
+/bin/bash devscript/all_support_ruby.sh bundle 2.6.6 2.7.1
+.
+.
+.
+===== Bundle install for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+======================================================
+```
+
+#### Rspec
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.3.3: 0
+ruby-2.4.2: 0
+ruby-2.5.8: 0
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
+If specify ruby version `2.6.6` and `2.7.1`
+
+```bash
+/bin/bash devscript/all_support_ruby.sh rspec 2.6.6 2.7.1
+.
+.
+.
+===== Rspec for All Support Ruby Result =====
+ruby-2.6.6: 0
+ruby-2.7.1: 0
+=============================================
+```
+
 ## 🔩 CORS
 
 Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.