tests_doc 0.0.3 → 0.0.4

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 (107) hide show
  1. checksums.yaml +4 -4
  2. data/.ruby-version +1 -1
  3. data/examples/rails-4.2.5/Gemfile +0 -1
  4. data/examples/rails-4.2.5/Gemfile.lock +4 -4
  5. data/examples/rails-4.2.5/spec/requests/posts_spec.rb +4 -1
  6. data/examples/rails-4.2.5/spec/requests/users_spec.rb +3 -1
  7. data/examples/rails-4.2.5/tests-doc/README.md +1 -1
  8. data/examples/rails-4.2.5/tests-doc/api/posts.md +1 -16
  9. data/examples/rails-4.2.5/tests-doc/api/posts/@id.md +6 -6
  10. data/examples/rails-4.2.5/tests-doc/api/posts@with-filter.md +1 -16
  11. data/examples/rails-4.2.5/tests-doc/api/users.md +1 -16
  12. data/examples/rails-5.2.3/.gitignore +31 -0
  13. data/examples/rails-5.2.3/.ruby-version +1 -0
  14. data/examples/rails-5.2.3/Gemfile +49 -0
  15. data/examples/rails-5.2.3/Gemfile.lock +235 -0
  16. data/examples/rails-5.2.3/README.md +24 -0
  17. data/examples/rails-5.2.3/Rakefile +6 -0
  18. data/examples/rails-5.2.3/app/assets/config/manifest.js +3 -0
  19. data/examples/rails-5.2.3/app/assets/images/.keep +0 -0
  20. data/examples/rails-5.2.3/app/assets/javascripts/application.js +16 -0
  21. data/examples/rails-5.2.3/app/assets/javascripts/cable.js +13 -0
  22. data/examples/rails-5.2.3/app/assets/javascripts/channels/.keep +0 -0
  23. data/examples/rails-5.2.3/app/assets/javascripts/posts.js +2 -0
  24. data/examples/rails-5.2.3/app/assets/javascripts/users.js +2 -0
  25. data/examples/rails-5.2.3/app/assets/stylesheets/application.css +15 -0
  26. data/examples/rails-5.2.3/app/assets/stylesheets/posts.scss +3 -0
  27. data/examples/rails-5.2.3/app/assets/stylesheets/users.scss +3 -0
  28. data/examples/rails-5.2.3/app/channels/application_cable/channel.rb +4 -0
  29. data/examples/rails-5.2.3/app/channels/application_cable/connection.rb +4 -0
  30. data/examples/rails-5.2.3/app/controllers/application_controller.rb +2 -0
  31. data/examples/rails-5.2.3/app/controllers/concerns/.keep +0 -0
  32. data/examples/rails-5.2.3/app/controllers/posts_controller.rb +61 -0
  33. data/examples/rails-5.2.3/app/controllers/users_controller.rb +59 -0
  34. data/examples/rails-5.2.3/app/helpers/application_helper.rb +2 -0
  35. data/examples/rails-5.2.3/app/helpers/posts_helper.rb +2 -0
  36. data/examples/rails-5.2.3/app/helpers/users_helper.rb +2 -0
  37. data/examples/rails-5.2.3/app/jobs/application_job.rb +2 -0
  38. data/examples/rails-5.2.3/app/mailers/application_mailer.rb +4 -0
  39. data/examples/rails-5.2.3/app/models/application_record.rb +3 -0
  40. data/examples/rails-5.2.3/app/models/concerns/.keep +0 -0
  41. data/examples/rails-5.2.3/app/models/post.rb +3 -0
  42. data/examples/rails-5.2.3/app/models/user.rb +2 -0
  43. data/examples/rails-5.2.3/app/views/layouts/application.html.erb +15 -0
  44. data/examples/rails-5.2.3/app/views/layouts/mailer.html.erb +13 -0
  45. data/examples/rails-5.2.3/app/views/layouts/mailer.text.erb +1 -0
  46. data/examples/rails-5.2.3/bin/bundle +3 -0
  47. data/examples/rails-5.2.3/bin/rails +9 -0
  48. data/examples/rails-5.2.3/bin/rake +9 -0
  49. data/examples/rails-5.2.3/bin/setup +36 -0
  50. data/examples/rails-5.2.3/bin/spring +17 -0
  51. data/examples/rails-5.2.3/bin/update +31 -0
  52. data/examples/rails-5.2.3/bin/yarn +11 -0
  53. data/examples/rails-5.2.3/config.ru +5 -0
  54. data/examples/rails-5.2.3/config/application.rb +19 -0
  55. data/examples/rails-5.2.3/config/boot.rb +4 -0
  56. data/examples/rails-5.2.3/config/cable.yml +10 -0
  57. data/examples/rails-5.2.3/config/credentials.yml.enc +1 -0
  58. data/examples/rails-5.2.3/config/database.yml +25 -0
  59. data/examples/rails-5.2.3/config/environment.rb +5 -0
  60. data/examples/rails-5.2.3/config/environments/development.rb +61 -0
  61. data/examples/rails-5.2.3/config/environments/production.rb +94 -0
  62. data/examples/rails-5.2.3/config/environments/test.rb +46 -0
  63. data/examples/rails-5.2.3/config/initializers/application_controller_renderer.rb +8 -0
  64. data/examples/rails-5.2.3/config/initializers/assets.rb +14 -0
  65. data/examples/rails-5.2.3/config/initializers/backtrace_silencers.rb +7 -0
  66. data/examples/rails-5.2.3/config/initializers/content_security_policy.rb +25 -0
  67. data/examples/rails-5.2.3/config/initializers/cookies_serializer.rb +5 -0
  68. data/examples/rails-5.2.3/config/initializers/filter_parameter_logging.rb +4 -0
  69. data/examples/rails-5.2.3/config/initializers/inflections.rb +16 -0
  70. data/examples/rails-5.2.3/config/initializers/mime_types.rb +4 -0
  71. data/examples/rails-5.2.3/config/initializers/wrap_parameters.rb +14 -0
  72. data/examples/rails-5.2.3/config/locales/en.yml +33 -0
  73. data/examples/rails-5.2.3/config/puma.rb +34 -0
  74. data/examples/rails-5.2.3/config/routes.rb +6 -0
  75. data/examples/rails-5.2.3/config/spring.rb +6 -0
  76. data/examples/rails-5.2.3/config/storage.yml +34 -0
  77. data/examples/rails-5.2.3/db/migrate/20190618211257_create_users.rb +11 -0
  78. data/examples/rails-5.2.3/db/migrate/20190618211325_create_posts.rb +11 -0
  79. data/examples/rails-5.2.3/db/schema.rb +32 -0
  80. data/examples/rails-5.2.3/db/seeds.rb +7 -0
  81. data/examples/rails-5.2.3/lib/assets/.keep +0 -0
  82. data/examples/rails-5.2.3/lib/tasks/.keep +0 -0
  83. data/examples/rails-5.2.3/log/.keep +0 -0
  84. data/examples/rails-5.2.3/package.json +5 -0
  85. data/examples/rails-5.2.3/public/404.html +67 -0
  86. data/examples/rails-5.2.3/public/422.html +67 -0
  87. data/examples/rails-5.2.3/public/500.html +66 -0
  88. data/examples/rails-5.2.3/public/apple-touch-icon-precomposed.png +0 -0
  89. data/examples/rails-5.2.3/public/apple-touch-icon.png +0 -0
  90. data/examples/rails-5.2.3/public/favicon.ico +0 -0
  91. data/examples/rails-5.2.3/public/robots.txt +1 -0
  92. data/examples/rails-5.2.3/spec/rails_helper.rb +62 -0
  93. data/examples/rails-5.2.3/spec/requests/posts_spec.rb +33 -0
  94. data/examples/rails-5.2.3/spec/requests/users_spec.rb +24 -0
  95. data/examples/rails-5.2.3/spec/spec_helper.rb +89 -0
  96. data/examples/rails-5.2.3/storage/.keep +0 -0
  97. data/examples/rails-5.2.3/tests-doc/README.md +32 -0
  98. data/examples/rails-5.2.3/tests-doc/api/posts.md +24 -0
  99. data/examples/rails-5.2.3/tests-doc/api/posts/@id.md +29 -0
  100. data/examples/rails-5.2.3/tests-doc/api/posts@with-filter.md +25 -0
  101. data/examples/rails-5.2.3/tests-doc/api/users.md +24 -0
  102. data/examples/rails-5.2.3/tests-doc/api/users/@id/posts.md +24 -0
  103. data/examples/rails-5.2.3/tmp/.keep +0 -0
  104. data/examples/rails-5.2.3/vendor/.keep +0 -0
  105. data/lib/tests_doc/version.rb +1 -1
  106. data/tests_doc.gemspec +1 -1
  107. metadata +100 -7
@@ -0,0 +1,24 @@
1
+ # README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require_relative 'config/application'
5
+
6
+ Rails.application.load_tasks
@@ -0,0 +1,3 @@
1
+ //= link_tree ../images
2
+ //= link_directory ../javascripts .js
3
+ //= link_directory ../stylesheets .css
@@ -0,0 +1,16 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
5
+ // vendor/assets/javascripts directory can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file. JavaScript code in this file should be added after the last require_* statement.
9
+ //
10
+ // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require rails-ujs
14
+ //= require activestorage
15
+ //= require turbolinks
16
+ //= require_tree .
@@ -0,0 +1,13 @@
1
+ // Action Cable provides the framework to deal with WebSockets in Rails.
2
+ // You can generate new channels where WebSocket features live using the `rails generate channel` command.
3
+ //
4
+ //= require action_cable
5
+ //= require_self
6
+ //= require_tree ./channels
7
+
8
+ (function() {
9
+ this.App || (this.App = {});
10
+
11
+ App.cable = ActionCable.createConsumer();
12
+
13
+ }).call(this);
@@ -0,0 +1,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -0,0 +1,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -0,0 +1,15 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
6
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
10
+ * files in this directory. Styles in this file should be added after the last require_* statement.
11
+ * It is generally better to create a new file per style scope.
12
+ *
13
+ *= require_tree .
14
+ *= require_self
15
+ */
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the posts controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the users controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,4 @@
1
+ module ApplicationCable
2
+ class Channel < ActionCable::Channel::Base
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module ApplicationCable
2
+ class Connection < ActionCable::Connection::Base
3
+ end
4
+ end
@@ -0,0 +1,2 @@
1
+ class ApplicationController < ActionController::Base
2
+ end
@@ -0,0 +1,61 @@
1
+ class PostsController < ApplicationController
2
+ before_action :set_post, only: [:show, :update, :destroy]
3
+
4
+ # GET /posts
5
+ # GET /posts.json
6
+ def index
7
+ @posts = Post
8
+ @posts = @posts.where(user_id: params[:user_id]) if params[:user_id]
9
+ @posts = @posts.all
10
+
11
+ render json: @posts
12
+ end
13
+
14
+ # GET /posts/1
15
+ # GET /posts/1.json
16
+ def show
17
+ render json: @post
18
+ end
19
+
20
+ # POST /posts
21
+ # POST /posts.json
22
+ def create
23
+ @post = Post.new(post_params)
24
+
25
+ if @post.save
26
+ render json: @post, status: :created, location: @post
27
+ else
28
+ render json: @post.errors, status: :unprocessable_entity
29
+ end
30
+ end
31
+
32
+ # PATCH/PUT /posts/1
33
+ # PATCH/PUT /posts/1.json
34
+ def update
35
+ @post = Post.find(params[:id])
36
+
37
+ if @post.update(post_params)
38
+ head :no_content
39
+ else
40
+ render json: @post.errors, status: :unprocessable_entity
41
+ end
42
+ end
43
+
44
+ # DELETE /posts/1
45
+ # DELETE /posts/1.json
46
+ def destroy
47
+ @post.destroy
48
+
49
+ head :no_content
50
+ end
51
+
52
+ private
53
+
54
+ def set_post
55
+ @post = Post.find(params[:id])
56
+ end
57
+
58
+ def post_params
59
+ params.require(:post).permit(:title, :body, :user_id)
60
+ end
61
+ end
@@ -0,0 +1,59 @@
1
+ class UsersController < ApplicationController
2
+ before_action :set_user, only: [:show, :update, :destroy]
3
+
4
+ # GET /users
5
+ # GET /users.json
6
+ def index
7
+ @users = User.all
8
+
9
+ render json: @users
10
+ end
11
+
12
+ # GET /users/1
13
+ # GET /users/1.json
14
+ def show
15
+ render json: @user
16
+ end
17
+
18
+ # POST /users
19
+ # POST /users.json
20
+ def create
21
+ @user = User.new(user_params)
22
+
23
+ if @user.save
24
+ render json: @user, status: :created, location: @user
25
+ else
26
+ render json: @user.errors, status: :unprocessable_entity
27
+ end
28
+ end
29
+
30
+ # PATCH/PUT /users/1
31
+ # PATCH/PUT /users/1.json
32
+ def update
33
+ @user = User.find(params[:id])
34
+
35
+ if @user.update(user_params)
36
+ head :no_content
37
+ else
38
+ render json: @user.errors, status: :unprocessable_entity
39
+ end
40
+ end
41
+
42
+ # DELETE /users/1
43
+ # DELETE /users/1.json
44
+ def destroy
45
+ @user.destroy
46
+
47
+ head :no_content
48
+ end
49
+
50
+ private
51
+
52
+ def set_user
53
+ @user = User.find(params[:id])
54
+ end
55
+
56
+ def user_params
57
+ params.require(:user).permit(:email, :first_name, :last_name)
58
+ end
59
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ module PostsHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ module UsersHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ class ApplicationJob < ActiveJob::Base
2
+ end
@@ -0,0 +1,4 @@
1
+ class ApplicationMailer < ActionMailer::Base
2
+ default from: 'from@example.com'
3
+ layout 'mailer'
4
+ end
@@ -0,0 +1,3 @@
1
+ class ApplicationRecord < ActiveRecord::Base
2
+ self.abstract_class = true
3
+ end
@@ -0,0 +1,3 @@
1
+ class Post < ApplicationRecord
2
+ belongs_to :user
3
+ end
@@ -0,0 +1,2 @@
1
+ class User < ApplicationRecord
2
+ end
@@ -0,0 +1,15 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Rails523</title>
5
+ <%= csrf_meta_tags %>
6
+ <%= csp_meta_tag %>
7
+
8
+ <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
9
+ <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
10
+ </head>
11
+
12
+ <body>
13
+ <%= yield %>
14
+ </body>
15
+ </html>
@@ -0,0 +1,13 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5
+ <style>
6
+ /* Email styles need to be inline */
7
+ </style>
8
+ </head>
9
+
10
+ <body>
11
+ <%= yield %>
12
+ </body>
13
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env ruby
2
+ begin
3
+ load File.expand_path('../spring', __FILE__)
4
+ rescue LoadError => e
5
+ raise unless e.message.include?('spring')
6
+ end
7
+ APP_PATH = File.expand_path('../config/application', __dir__)
8
+ require_relative '../config/boot'
9
+ require 'rails/commands'
@@ -0,0 +1,9 @@
1
+ #!/usr/bin/env ruby
2
+ begin
3
+ load File.expand_path('../spring', __FILE__)
4
+ rescue LoadError => e
5
+ raise unless e.message.include?('spring')
6
+ end
7
+ require_relative '../config/boot'
8
+ require 'rake'
9
+ Rake.application.run
@@ -0,0 +1,36 @@
1
+ #!/usr/bin/env ruby
2
+ require 'fileutils'
3
+ include FileUtils
4
+
5
+ # path to your application root.
6
+ APP_ROOT = File.expand_path('..', __dir__)
7
+
8
+ def system!(*args)
9
+ system(*args) || abort("\n== Command #{args} failed ==")
10
+ end
11
+
12
+ chdir APP_ROOT do
13
+ # This script is a starting point to setup your application.
14
+ # Add necessary setup steps to this file.
15
+
16
+ puts '== Installing dependencies =='
17
+ system! 'gem install bundler --conservative'
18
+ system('bundle check') || system!('bundle install')
19
+
20
+ # Install JavaScript dependencies if using Yarn
21
+ # system('bin/yarn')
22
+
23
+ # puts "\n== Copying sample files =="
24
+ # unless File.exist?('config/database.yml')
25
+ # cp 'config/database.yml.sample', 'config/database.yml'
26
+ # end
27
+
28
+ puts "\n== Preparing database =="
29
+ system! 'bin/rails db:setup'
30
+
31
+ puts "\n== Removing old logs and tempfiles =="
32
+ system! 'bin/rails log:clear tmp:clear'
33
+
34
+ puts "\n== Restarting application server =="
35
+ system! 'bin/rails restart'
36
+ end
@@ -0,0 +1,17 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ # This file loads spring without using Bundler, in order to be fast.
4
+ # It gets overwritten when you run the `spring binstub` command.
5
+
6
+ unless defined?(Spring)
7
+ require 'rubygems'
8
+ require 'bundler'
9
+
10
+ lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
11
+ spring = lockfile.specs.detect { |spec| spec.name == "spring" }
12
+ if spring
13
+ Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
14
+ gem 'spring', spring.version
15
+ require 'spring/binstub'
16
+ end
17
+ end
@@ -0,0 +1,31 @@
1
+ #!/usr/bin/env ruby
2
+ require 'fileutils'
3
+ include FileUtils
4
+
5
+ # path to your application root.
6
+ APP_ROOT = File.expand_path('..', __dir__)
7
+
8
+ def system!(*args)
9
+ system(*args) || abort("\n== Command #{args} failed ==")
10
+ end
11
+
12
+ chdir APP_ROOT do
13
+ # This script is a way to update your development environment automatically.
14
+ # Add necessary update steps to this file.
15
+
16
+ puts '== Installing dependencies =='
17
+ system! 'gem install bundler --conservative'
18
+ system('bundle check') || system!('bundle install')
19
+
20
+ # Install JavaScript dependencies if using Yarn
21
+ # system('bin/yarn')
22
+
23
+ puts "\n== Updating database =="
24
+ system! 'bin/rails db:migrate'
25
+
26
+ puts "\n== Removing old logs and tempfiles =="
27
+ system! 'bin/rails log:clear tmp:clear'
28
+
29
+ puts "\n== Restarting application server =="
30
+ system! 'bin/rails restart'
31
+ end
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env ruby
2
+ APP_ROOT = File.expand_path('..', __dir__)
3
+ Dir.chdir(APP_ROOT) do
4
+ begin
5
+ exec "yarnpkg", *ARGV
6
+ rescue Errno::ENOENT
7
+ $stderr.puts "Yarn executable was not detected in the system."
8
+ $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
9
+ exit 1
10
+ end
11
+ end