swaggard 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -0
  3. data/config/initializers/assets.rb +8 -5
  4. data/lib/swaggard/engine.rb +5 -6
  5. data/lib/swaggard/version.rb +1 -1
  6. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7a8b23d0506bee9f1348d9d9226395143d49fddafdfedd0b738e6fa46e037034
4
- data.tar.gz: d217e3ea082ecb262f8a298d8c3418835441a0d6c3e67737cf2affb14d7a90f2
3
+ metadata.gz: 3dd5439e8bfa3577b6585d2f5bc85eca2de86b7f41df02425f7d3083f97db6c4
4
+ data.tar.gz: 472f444aa3a5f99f0d6f867d55a80141a81848a24af6ca29366f979dfc8c4656
5
5
  SHA512:
6
- metadata.gz: c27ee9ce529d840cf54f0e9c3fa3849c9cac9c6a42f99d2b46ff7330865e48a3a7890473455b8925f5c907f569f0c36d4bb904ae501a586207ed670a9fbca934
7
- data.tar.gz: f1fd82efe8b1106596a48470dcb7bc2a528e7e27340c1f046c986b281ab615cd92a779362f620a54ed5af429bd3b6957df8bbfd7f82d6ece3bb8de9c2d8ecfb7
6
+ metadata.gz: d7ccfd568ffde678cafae6be6b2551823d24ba2e3f2d5ecaf8f04231c14d271b25223c9dcaab12ab4dd97ac1b93d1490045f6b6812af662def8d3faf628443c0
7
+ data.tar.gz: 7c08c85b64918c6fe0806af1e224e0e3daeec20704f1617f65b21f8908bc79881d1a9ae01f4b25afe14efd7d7070bb97603a0523bbaf685724679f15b866998f
data/README.md CHANGED
@@ -11,6 +11,8 @@ the supported rails version.
11
11
 
12
12
  Swaggard Version | Swagger UI Version | Supported Rails Versions
13
13
  ---------------- | ------------------- | ------------------------
14
+ 1.1.x | 2.2.8 | 4 - 6
15
+ 1.0.x | 2.2.8 | 4 - 5
14
16
  0.5.x | 2.2.8 | 4 - 5
15
17
  0.4.x | 2.2.8 | 4
16
18
  0.3.x | 2.1.3 | 4
@@ -43,6 +45,13 @@ Mount your engine
43
45
 
44
46
  mount Swaggard::Engine, at: '/api_docs/swagger/'
45
47
 
48
+ Make sure the asset pipeline is enabled by either requiring all railties
49
+ or just the sprockets one:
50
+
51
+ # config/application.rb
52
+
53
+ require 'sprockets/railtie'
54
+
46
55
  Access your service documentation
47
56
 
48
57
  open http://localhost:3000/api_docs/swagger/
data/config/initializers/assets.rb CHANGED
@@ -1,5 +1,8 @@
1
- Rails.application.config.assets.precompile += %w[swaggard/application_print.css
2
- swaggard/favicon-32x32.png
3
- swaggard/favicon-16x16.png
4
- swaggard/lang/*.js
5
- swaggard/logo_small.png]
1
+ if Rails::Application.instance_methods.include?(:assets_manifest)
2
+ Rails.application.config.assets.precompile += %w[swaggard/application_print.css
3
+ swaggard/favicon-32x32.png
4
+ swaggard/favicon-16x16.png
5
+ swaggard/lang/*.js
6
+ swaggard/logo_small.png]
7
+
8
+ end
data/lib/swaggard/engine.rb CHANGED
@@ -1,11 +1,10 @@
1
1
  unless Rails::Application.instance_methods.include?(:assets_manifest)
2
- warn <<-END
3
- [Swaggard] It seems you are using an api only rails setup, but swaggard
4
- [Swaggard] neeeds sprockets in order to work so its going to require it.
5
- [Swaggard] This might have undesired side effects, if thats not the case
6
- [Swaggard] you can ignore this warning.
2
+ warn <<~END
3
+ [Swaggard] It seems you are using an api only rails setup, but swaggard
4
+ [Swaggard] web app needs sprockets in order to work. Make sure to add
5
+ [Swaggard] require 'sprockets/railtie'.
6
+ [Swaggard] If you plan to use it
7
7
  END
8
- require 'sprockets/railtie'
9
8
  end
10
9
 
11
10
  module Swaggard
data/lib/swaggard/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Swaggard
2
- VERSION = '1.0.2'
2
+ VERSION = '1.1.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: swaggard
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Adrian Gomez
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-08-01 00:00:00.000000000 Z
11
+ date: 2020-01-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '4.0'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
- version: '6.0'
22
+ version: '7.0'
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '4.0'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
- version: '6.0'
32
+ version: '7.0'
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: sass-rails
35
35
  requirement: !ruby/object:Gem::Requirement