tests_doc 0.0.4 → 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (155) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/lib/tests_doc/version.rb +1 -1
  4. data/tests_doc.gemspec +2 -2
  5. metadata +9 -152
  6. data/examples/rails-4.2.5/.gitignore +0 -21
  7. data/examples/rails-4.2.5/.rspec +0 -3
  8. data/examples/rails-4.2.5/Gemfile +0 -34
  9. data/examples/rails-4.2.5/Gemfile.lock +0 -143
  10. data/examples/rails-4.2.5/README.md +0 -3
  11. data/examples/rails-4.2.5/Rakefile +0 -6
  12. data/examples/rails-4.2.5/app/assets/images/.keep +0 -0
  13. data/examples/rails-4.2.5/app/controllers/application_controller.rb +0 -2
  14. data/examples/rails-4.2.5/app/controllers/concerns/.keep +0 -0
  15. data/examples/rails-4.2.5/app/controllers/posts_controller.rb +0 -61
  16. data/examples/rails-4.2.5/app/controllers/users_controller.rb +0 -59
  17. data/examples/rails-4.2.5/app/mailers/.keep +0 -0
  18. data/examples/rails-4.2.5/app/models/.keep +0 -0
  19. data/examples/rails-4.2.5/app/models/concerns/.keep +0 -0
  20. data/examples/rails-4.2.5/app/models/post.rb +0 -3
  21. data/examples/rails-4.2.5/app/models/user.rb +0 -2
  22. data/examples/rails-4.2.5/bin/bundle +0 -3
  23. data/examples/rails-4.2.5/bin/rails +0 -9
  24. data/examples/rails-4.2.5/bin/rake +0 -9
  25. data/examples/rails-4.2.5/bin/setup +0 -29
  26. data/examples/rails-4.2.5/bin/spring +0 -15
  27. data/examples/rails-4.2.5/config.ru +0 -4
  28. data/examples/rails-4.2.5/config/application.rb +0 -26
  29. data/examples/rails-4.2.5/config/boot.rb +0 -3
  30. data/examples/rails-4.2.5/config/database.yml +0 -25
  31. data/examples/rails-4.2.5/config/environment.rb +0 -5
  32. data/examples/rails-4.2.5/config/environments/development.rb +0 -41
  33. data/examples/rails-4.2.5/config/environments/production.rb +0 -79
  34. data/examples/rails-4.2.5/config/environments/test.rb +0 -42
  35. data/examples/rails-4.2.5/config/initializers/filter_parameter_logging.rb +0 -4
  36. data/examples/rails-4.2.5/config/initializers/secret_token.rb +0 -19
  37. data/examples/rails-4.2.5/config/initializers/wrap_parameters.rb +0 -13
  38. data/examples/rails-4.2.5/config/locales/en.yml +0 -23
  39. data/examples/rails-4.2.5/config/routes.rb +0 -60
  40. data/examples/rails-4.2.5/config/secrets.yml +0 -22
  41. data/examples/rails-4.2.5/db/migrate/20151119010359_create_users.rb +0 -11
  42. data/examples/rails-4.2.5/db/migrate/20151119010415_create_posts.rb +0 -11
  43. data/examples/rails-4.2.5/db/schema.rb +0 -34
  44. data/examples/rails-4.2.5/db/seeds.rb +0 -7
  45. data/examples/rails-4.2.5/lib/assets/.keep +0 -0
  46. data/examples/rails-4.2.5/lib/tasks/.keep +0 -0
  47. data/examples/rails-4.2.5/log/.keep +0 -0
  48. data/examples/rails-4.2.5/public/404.html +0 -67
  49. data/examples/rails-4.2.5/public/422.html +0 -67
  50. data/examples/rails-4.2.5/public/500.html +0 -66
  51. data/examples/rails-4.2.5/public/favicon.ico +0 -0
  52. data/examples/rails-4.2.5/public/robots.txt +0 -5
  53. data/examples/rails-4.2.5/spec/rails_helper.rb +0 -62
  54. data/examples/rails-4.2.5/spec/requests/posts_spec.rb +0 -33
  55. data/examples/rails-4.2.5/spec/requests/users_spec.rb +0 -24
  56. data/examples/rails-4.2.5/spec/spec_helper.rb +0 -89
  57. data/examples/rails-4.2.5/tests-doc/README.md +0 -32
  58. data/examples/rails-4.2.5/tests-doc/api/posts.md +0 -24
  59. data/examples/rails-4.2.5/tests-doc/api/posts/@id.md +0 -29
  60. data/examples/rails-4.2.5/tests-doc/api/posts@with-filter.md +0 -25
  61. data/examples/rails-4.2.5/tests-doc/api/users.md +0 -24
  62. data/examples/rails-4.2.5/tests-doc/api/users/@id/posts.md +0 -24
  63. data/examples/rails-5.2.3/.gitignore +0 -31
  64. data/examples/rails-5.2.3/.ruby-version +0 -1
  65. data/examples/rails-5.2.3/Gemfile +0 -49
  66. data/examples/rails-5.2.3/Gemfile.lock +0 -235
  67. data/examples/rails-5.2.3/README.md +0 -24
  68. data/examples/rails-5.2.3/Rakefile +0 -6
  69. data/examples/rails-5.2.3/app/assets/config/manifest.js +0 -3
  70. data/examples/rails-5.2.3/app/assets/images/.keep +0 -0
  71. data/examples/rails-5.2.3/app/assets/javascripts/application.js +0 -16
  72. data/examples/rails-5.2.3/app/assets/javascripts/cable.js +0 -13
  73. data/examples/rails-5.2.3/app/assets/javascripts/channels/.keep +0 -0
  74. data/examples/rails-5.2.3/app/assets/javascripts/posts.js +0 -2
  75. data/examples/rails-5.2.3/app/assets/javascripts/users.js +0 -2
  76. data/examples/rails-5.2.3/app/assets/stylesheets/application.css +0 -15
  77. data/examples/rails-5.2.3/app/assets/stylesheets/posts.scss +0 -3
  78. data/examples/rails-5.2.3/app/assets/stylesheets/users.scss +0 -3
  79. data/examples/rails-5.2.3/app/channels/application_cable/channel.rb +0 -4
  80. data/examples/rails-5.2.3/app/channels/application_cable/connection.rb +0 -4
  81. data/examples/rails-5.2.3/app/controllers/application_controller.rb +0 -2
  82. data/examples/rails-5.2.3/app/controllers/concerns/.keep +0 -0
  83. data/examples/rails-5.2.3/app/controllers/posts_controller.rb +0 -61
  84. data/examples/rails-5.2.3/app/controllers/users_controller.rb +0 -59
  85. data/examples/rails-5.2.3/app/helpers/application_helper.rb +0 -2
  86. data/examples/rails-5.2.3/app/helpers/posts_helper.rb +0 -2
  87. data/examples/rails-5.2.3/app/helpers/users_helper.rb +0 -2
  88. data/examples/rails-5.2.3/app/jobs/application_job.rb +0 -2
  89. data/examples/rails-5.2.3/app/mailers/application_mailer.rb +0 -4
  90. data/examples/rails-5.2.3/app/models/application_record.rb +0 -3
  91. data/examples/rails-5.2.3/app/models/concerns/.keep +0 -0
  92. data/examples/rails-5.2.3/app/models/post.rb +0 -3
  93. data/examples/rails-5.2.3/app/models/user.rb +0 -2
  94. data/examples/rails-5.2.3/app/views/layouts/application.html.erb +0 -15
  95. data/examples/rails-5.2.3/app/views/layouts/mailer.html.erb +0 -13
  96. data/examples/rails-5.2.3/app/views/layouts/mailer.text.erb +0 -1
  97. data/examples/rails-5.2.3/bin/bundle +0 -3
  98. data/examples/rails-5.2.3/bin/rails +0 -9
  99. data/examples/rails-5.2.3/bin/rake +0 -9
  100. data/examples/rails-5.2.3/bin/setup +0 -36
  101. data/examples/rails-5.2.3/bin/spring +0 -17
  102. data/examples/rails-5.2.3/bin/update +0 -31
  103. data/examples/rails-5.2.3/bin/yarn +0 -11
  104. data/examples/rails-5.2.3/config.ru +0 -5
  105. data/examples/rails-5.2.3/config/application.rb +0 -19
  106. data/examples/rails-5.2.3/config/boot.rb +0 -4
  107. data/examples/rails-5.2.3/config/cable.yml +0 -10
  108. data/examples/rails-5.2.3/config/credentials.yml.enc +0 -1
  109. data/examples/rails-5.2.3/config/database.yml +0 -25
  110. data/examples/rails-5.2.3/config/environment.rb +0 -5
  111. data/examples/rails-5.2.3/config/environments/development.rb +0 -61
  112. data/examples/rails-5.2.3/config/environments/production.rb +0 -94
  113. data/examples/rails-5.2.3/config/environments/test.rb +0 -46
  114. data/examples/rails-5.2.3/config/initializers/application_controller_renderer.rb +0 -8
  115. data/examples/rails-5.2.3/config/initializers/assets.rb +0 -14
  116. data/examples/rails-5.2.3/config/initializers/backtrace_silencers.rb +0 -7
  117. data/examples/rails-5.2.3/config/initializers/content_security_policy.rb +0 -25
  118. data/examples/rails-5.2.3/config/initializers/cookies_serializer.rb +0 -5
  119. data/examples/rails-5.2.3/config/initializers/filter_parameter_logging.rb +0 -4
  120. data/examples/rails-5.2.3/config/initializers/inflections.rb +0 -16
  121. data/examples/rails-5.2.3/config/initializers/mime_types.rb +0 -4
  122. data/examples/rails-5.2.3/config/initializers/wrap_parameters.rb +0 -14
  123. data/examples/rails-5.2.3/config/locales/en.yml +0 -33
  124. data/examples/rails-5.2.3/config/puma.rb +0 -34
  125. data/examples/rails-5.2.3/config/routes.rb +0 -6
  126. data/examples/rails-5.2.3/config/spring.rb +0 -6
  127. data/examples/rails-5.2.3/config/storage.yml +0 -34
  128. data/examples/rails-5.2.3/db/migrate/20190618211257_create_users.rb +0 -11
  129. data/examples/rails-5.2.3/db/migrate/20190618211325_create_posts.rb +0 -11
  130. data/examples/rails-5.2.3/db/schema.rb +0 -32
  131. data/examples/rails-5.2.3/db/seeds.rb +0 -7
  132. data/examples/rails-5.2.3/lib/assets/.keep +0 -0
  133. data/examples/rails-5.2.3/lib/tasks/.keep +0 -0
  134. data/examples/rails-5.2.3/log/.keep +0 -0
  135. data/examples/rails-5.2.3/package.json +0 -5
  136. data/examples/rails-5.2.3/public/404.html +0 -67
  137. data/examples/rails-5.2.3/public/422.html +0 -67
  138. data/examples/rails-5.2.3/public/500.html +0 -66
  139. data/examples/rails-5.2.3/public/apple-touch-icon-precomposed.png +0 -0
  140. data/examples/rails-5.2.3/public/apple-touch-icon.png +0 -0
  141. data/examples/rails-5.2.3/public/favicon.ico +0 -0
  142. data/examples/rails-5.2.3/public/robots.txt +0 -1
  143. data/examples/rails-5.2.3/spec/rails_helper.rb +0 -62
  144. data/examples/rails-5.2.3/spec/requests/posts_spec.rb +0 -33
  145. data/examples/rails-5.2.3/spec/requests/users_spec.rb +0 -24
  146. data/examples/rails-5.2.3/spec/spec_helper.rb +0 -89
  147. data/examples/rails-5.2.3/storage/.keep +0 -0
  148. data/examples/rails-5.2.3/tests-doc/README.md +0 -32
  149. data/examples/rails-5.2.3/tests-doc/api/posts.md +0 -24
  150. data/examples/rails-5.2.3/tests-doc/api/posts/@id.md +0 -29
  151. data/examples/rails-5.2.3/tests-doc/api/posts@with-filter.md +0 -25
  152. data/examples/rails-5.2.3/tests-doc/api/users.md +0 -24
  153. data/examples/rails-5.2.3/tests-doc/api/users/@id/posts.md +0 -24
  154. data/examples/rails-5.2.3/tmp/.keep +0 -0
  155. data/examples/rails-5.2.3/vendor/.keep +0 -0
@@ -1,89 +0,0 @@
1
- # This file was generated by the `rails generate rspec:install` command. Conventionally, all
2
- # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
3
- # The generated `.rspec` file contains `--require spec_helper` which will cause this
4
- # file to always be loaded, without a need to explicitly require it in any files.
5
- #
6
- # Given that it is always loaded, you are encouraged to keep this file as
7
- # light-weight as possible. Requiring heavyweight dependencies from this file
8
- # will add to the boot time of your test suite on EVERY test run, even for an
9
- # individual file that may not need all of that loaded. Instead, make a
10
- # separate helper file that requires this one and then use it only in the specs
11
- # that actually need it.
12
- #
13
- # The `.rspec` file also contains a few flags that are not defaults but that
14
- # users commonly want.
15
- #
16
- # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
17
- RSpec.configure do |config|
18
- # The settings below are suggested to provide a good initial experience
19
- # with RSpec, but feel free to customize to your heart's content.
20
- =begin
21
- # These two settings work together to allow you to limit a spec run
22
- # to individual examples or groups you care about by tagging them with
23
- # `:focus` metadata. When nothing is tagged with `:focus`, all examples
24
- # get run.
25
- config.filter_run :focus
26
- config.run_all_when_everything_filtered = true
27
-
28
- # Many RSpec users commonly either run the entire suite or an individual
29
- # file, and it's useful to allow more verbose output when running an
30
- # individual spec file.
31
- if config.files_to_run.one?
32
- # Use the documentation formatter for detailed output,
33
- # unless a formatter has already been configured
34
- # (e.g. via a command-line flag).
35
- config.default_formatter = 'doc'
36
- end
37
-
38
- # Print the 10 slowest examples and example groups at the
39
- # end of the spec run, to help surface which specs are running
40
- # particularly slow.
41
- config.profile_examples = 10
42
-
43
- # Run specs in random order to surface order dependencies. If you find an
44
- # order dependency and want to debug it, you can fix the order by providing
45
- # the seed, which is printed after each run.
46
- # --seed 1234
47
- config.order = :random
48
-
49
- # Seed global randomization in this process using the `--seed` CLI option.
50
- # Setting this allows you to use `--seed` to deterministically reproduce
51
- # test failures related to randomization by passing the same `--seed` value
52
- # as the one that triggered the failure.
53
- Kernel.srand config.seed
54
-
55
- # rspec-expectations config goes here. You can use an alternate
56
- # assertion/expectation library such as wrong or the stdlib/minitest
57
- # assertions if you prefer.
58
- config.expect_with :rspec do |expectations|
59
- # Enable only the newer, non-monkey-patching expect syntax.
60
- # For more details, see:
61
- # - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
62
- expectations.syntax = :expect
63
- end
64
-
65
- # rspec-mocks config goes here. You can use an alternate test double
66
- # library (such as bogus or mocha) by changing the `mock_with` option here.
67
- config.mock_with :rspec do |mocks|
68
- # Enable only the newer, non-monkey-patching expect syntax.
69
- # For more details, see:
70
- # - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
71
- mocks.syntax = :expect
72
-
73
- # Prevents you from mocking or stubbing a method that does not exist on
74
- # a real object. This is generally recommended.
75
- mocks.verify_partial_doubles = true
76
- end
77
- =end
78
-
79
- config.after :suite do |test|
80
- # block executed when there is any api interactions were recorded during the rspec
81
- TestsDoc.with_api_interaction do
82
- require 'rake'
83
- require 'tests_doc/tasks'
84
-
85
- Rake::Task["tests_doc:index:build"].invoke(TestsDoc.configuration.root_folder)
86
- end
87
- end
88
-
89
- end
File without changes
@@ -1,32 +0,0 @@
1
- # Api Interactions
2
-
3
- This document contains a list of api endpoints tested.
4
- If one of the api endpoint is modified during the test suite if its a deletion,
5
- make sure this wont affect any of code consuming the api endpoint.
6
-
7
- Last modified at: 06/18/2019 11:27PM
8
-
9
-
10
- # Endpoints
11
-
12
- ## Api Interactions
13
-
14
- [/README.md](README.md)
15
-
16
- ## GET posts
17
-
18
- [/api/posts.md](api/posts.md)
19
-
20
- [/api/posts@with-filter.md](api/posts@with-filter.md)
21
-
22
- ## GET posts/@id
23
-
24
- [/api/posts/@id.md](api/posts/@id.md)
25
-
26
- ## GET users
27
-
28
- [/api/users.md](api/users.md)
29
-
30
- ## GET users/@id/posts
31
-
32
- [/api/users/@id/posts.md](api/users/@id/posts.md)
@@ -1,24 +0,0 @@
1
- # GET posts
2
-
3
- Rspec description: Posts GET /posts renders posts
4
-
5
- [spec/requests/posts_spec.rb:5](/spec/requests/posts_spec.rb#L5)
6
-
7
- # Parameters
8
-
9
- ```json
10
- {
11
- }
12
- ```
13
-
14
- # Response
15
-
16
- ```
17
- HTTP CODE = 200
18
- ```
19
-
20
- ```json
21
- [
22
-
23
- ]
24
- ```
@@ -1,29 +0,0 @@
1
- # GET posts/@id
2
-
3
- Rspec description: Posts GET /posts/:id renders posts with id
4
-
5
- [spec/requests/posts_spec.rb:22](/spec/requests/posts_spec.rb#L22)
6
-
7
- # Parameters
8
-
9
- ```json
10
- {
11
- }
12
- ```
13
-
14
- # Response
15
-
16
- ```
17
- HTTP CODE = 200
18
- ```
19
-
20
- ```json
21
- {
22
- "id": 1,
23
- "title": null,
24
- "body": null,
25
- "user_id": 1,
26
- "created_at": "2019-06-18T21:27:26.839Z",
27
- "updated_at": "2019-06-18T21:27:26.839Z"
28
- }
29
- ```
@@ -1,25 +0,0 @@
1
- # GET posts
2
-
3
- Rspec description: Posts GET /posts renders posts with filter
4
-
5
- [spec/requests/posts_spec.rb:12](/spec/requests/posts_spec.rb#L12)
6
-
7
- # Parameters
8
-
9
- ```json
10
- {
11
- "published": "true"
12
- }
13
- ```
14
-
15
- # Response
16
-
17
- ```
18
- HTTP CODE = 200
19
- ```
20
-
21
- ```json
22
- [
23
-
24
- ]
25
- ```
@@ -1,24 +0,0 @@
1
- # GET users
2
-
3
- Rspec description: Users GET /users renders users
4
-
5
- [spec/requests/users_spec.rb:5](/spec/requests/users_spec.rb#L5)
6
-
7
- # Parameters
8
-
9
- ```json
10
- {
11
- }
12
- ```
13
-
14
- # Response
15
-
16
- ```
17
- HTTP CODE = 200
18
- ```
19
-
20
- ```json
21
- [
22
-
23
- ]
24
- ```
@@ -1,24 +0,0 @@
1
- # GET users/@id/posts
2
-
3
- Rspec description: Users GET /users/:user_id/posts renders posts
4
-
5
- [spec/requests/users_spec.rb:14](/spec/requests/users_spec.rb#L14)
6
-
7
- # Parameters
8
-
9
- ```json
10
- {
11
- }
12
- ```
13
-
14
- # Response
15
-
16
- ```
17
- HTTP CODE = 200
18
- ```
19
-
20
- ```json
21
- [
22
-
23
- ]
24
- ```
File without changes
File without changes