tests_doc 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 36daab5dc76caf8d5e40caefec0aeef2eeac048e
-  data.tar.gz: 1c6fb21fab993de63a0055ba00b481140ff85a82
+SHA256:
+  metadata.gz: 0dbb038887cab8e4719329176f3e14fb2e941efc3d586f6ff69aa0408d082123
+  data.tar.gz: ad511d78cf585ab8378016390d44ab018ea8af396a1a66ef73cee28e9de74fdb
 SHA512:
-  metadata.gz: 68071ad2d90621ad152762c4fccbd65f0059c908a3d2b483ebc400401b6958ab4e2ab8aa3db4104abec560ac577102a18466d842e8a79fe8c5922847cbf84f50
-  data.tar.gz: 4d5b57030f580f889ce36e72b155ae1919fae743fdeb98197e3d515060cb6c435d27f517d04bced3a5b41c7566d47a5f0d5293181fe80d8e93ef72f96bb1671b
+  metadata.gz: 8b859ea0e46fd530e8b01c005ade4bf631c9f6f42b6f6fa9b0ce6ab5c51dd78c78d223500c37a2012895dd799134e971e64308d7ff54417ac20a66003b063bce
+  data.tar.gz: 2b395d17f5f002da43cae6a15e09b4d86794a801c7460aecb8c71e98c8436842230c20fce116f4931a3e6fa3b012336c8db41ba7352864e1543af68a2585de88

data/.ruby-version

@@ -1 +1 @@
-2.1.6
+2.7.5

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.6] - 2022-03-16
+### Changed
+
+ - Changed upper bound for Rails versions to 7. Added examples for Rails 6.1
+ - Updated Gemfile.lock in examples for Rails 4 and 5
+
+## [0.0.5] - 2019-06-21
+### Changed
+
+ - Sets the bounds for rails to versions 4 and 5. Of which there are examples.
+ - Excludes the examples from the gem.

data/lib/tests_doc/version.rb

@@ -1,3 +1,3 @@
 module TestsDoc
-  VERSION = "0.0.3"
+  VERSION = "0.0.6"
 end

data/tests_doc.gemspec

@@ -13,12 +13,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/taskrabbit/tests_doc"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/).reject { |f| f =~ /^examples/ }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", '~> 4.0'
+  spec.add_dependency "rails", '>= 4', '< 7.0'
   spec.add_dependency "rspec", '>= 2.0'
   spec.add_dependency "rspec-rails", '>= 2.0'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: tests_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Jean-Richard Lai
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,64 +68,8 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - README.md
-- examples/rails-4.2.5/.gitignore
-- examples/rails-4.2.5/.rspec
-- examples/rails-4.2.5/Gemfile
-- examples/rails-4.2.5/Gemfile.lock
-- examples/rails-4.2.5/README.md
-- examples/rails-4.2.5/Rakefile
-- examples/rails-4.2.5/app/assets/images/.keep
-- examples/rails-4.2.5/app/controllers/application_controller.rb
-- examples/rails-4.2.5/app/controllers/concerns/.keep
-- examples/rails-4.2.5/app/controllers/posts_controller.rb
-- examples/rails-4.2.5/app/controllers/users_controller.rb
-- examples/rails-4.2.5/app/mailers/.keep
-- examples/rails-4.2.5/app/models/.keep
-- examples/rails-4.2.5/app/models/concerns/.keep
-- examples/rails-4.2.5/app/models/post.rb
-- examples/rails-4.2.5/app/models/user.rb
-- examples/rails-4.2.5/bin/bundle
-- examples/rails-4.2.5/bin/rails
-- examples/rails-4.2.5/bin/rake
-- examples/rails-4.2.5/bin/setup
-- examples/rails-4.2.5/bin/spring
-- examples/rails-4.2.5/config.ru
-- examples/rails-4.2.5/config/application.rb
-- examples/rails-4.2.5/config/boot.rb
-- examples/rails-4.2.5/config/database.yml
-- examples/rails-4.2.5/config/environment.rb
-- examples/rails-4.2.5/config/environments/development.rb
-- examples/rails-4.2.5/config/environments/production.rb
-- examples/rails-4.2.5/config/environments/test.rb
-- examples/rails-4.2.5/config/initializers/filter_parameter_logging.rb
-- examples/rails-4.2.5/config/initializers/secret_token.rb
-- examples/rails-4.2.5/config/initializers/wrap_parameters.rb
-- examples/rails-4.2.5/config/locales/en.yml
-- examples/rails-4.2.5/config/routes.rb
-- examples/rails-4.2.5/config/secrets.yml
-- examples/rails-4.2.5/db/migrate/20151119010359_create_users.rb
-- examples/rails-4.2.5/db/migrate/20151119010415_create_posts.rb
-- examples/rails-4.2.5/db/schema.rb
-- examples/rails-4.2.5/db/seeds.rb
-- examples/rails-4.2.5/lib/assets/.keep
-- examples/rails-4.2.5/lib/tasks/.keep
-- examples/rails-4.2.5/log/.keep
-- examples/rails-4.2.5/public/404.html
-- examples/rails-4.2.5/public/422.html
-- examples/rails-4.2.5/public/500.html
-- examples/rails-4.2.5/public/favicon.ico
-- examples/rails-4.2.5/public/robots.txt
-- examples/rails-4.2.5/spec/rails_helper.rb
-- examples/rails-4.2.5/spec/requests/posts_spec.rb
-- examples/rails-4.2.5/spec/requests/users_spec.rb
-- examples/rails-4.2.5/spec/spec_helper.rb
-- examples/rails-4.2.5/tests-doc/README.md
-- examples/rails-4.2.5/tests-doc/api/posts.md
-- examples/rails-4.2.5/tests-doc/api/posts/@id.md
-- examples/rails-4.2.5/tests-doc/api/posts@with-filter.md
-- examples/rails-4.2.5/tests-doc/api/users.md
-- examples/rails-4.2.5/tests-doc/api/users/@id/posts.md
 - lib/tests_doc.rb
 - lib/tests_doc/configuration.rb
 - lib/tests_doc/disabled_record_spec_helper.rb
@@ -136,7 +86,7 @@ homepage: https://github.com/taskrabbit/tests_doc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,9 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Rspec requests file to markdown
 test_files: []

data/examples/rails-4.2.5/.gitignore

@@ -1,21 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-journal
-
-# Ignore all logfiles and tempfiles.
-/log/*
-!/log/.keep
-/tmp
-
-/vendor
-
-.byebug_history

data/examples/rails-4.2.5/.rspec

@@ -1,3 +0,0 @@
---color
---warnings
---require spec_helper

data/examples/rails-4.2.5/Gemfile

@@ -1,35 +0,0 @@
-source 'https://rubygems.org'
-
-
-gem 'rails', '4.2.5'
-
-gem 'rails-api'
-
-gem 'spring', :group => :development
-
-
-gem 'sqlite3'
-
-# gem 'minitest', :group => :test
-
-gem 'tests_doc', path: '../../../tests_doc', :group => :test
-
-group :test, :development do
-  gem 'byebug'
-  gem 'rspec-rails', '~> 3.4'
-end
-
-# To use ActiveModel has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
-
-# To use Jbuilder templates for JSON
-# gem 'jbuilder'
-
-# Use unicorn as the app server
-# gem 'unicorn'
-
-# Deploy with Capistrano
-# gem 'capistrano', :group => :development
-
-# To use debugger
-# gem 'ruby-debug19', :require => 'ruby-debug'

data/examples/rails-4.2.5/Gemfile.lock

@@ -1,143 +0,0 @@
-PATH
-  remote: ../../../tests_doc
-  specs:
-    tests_doc (0.0.3)
-      rails (~> 4.0)
-      rspec (>= 2.0)
-      rspec-rails (>= 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.5)
-      actionview (= 4.2.5)
-      activesupport (= 4.2.5)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.5)
-      activesupport (= 4.2.5)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.5)
-      activesupport (= 4.2.5)
-      globalid (>= 0.3.0)
-    activemodel (4.2.5)
-      activesupport (= 4.2.5)
-      builder (~> 3.1)
-    activerecord (4.2.5)
-      activemodel (= 4.2.5)
-      activesupport (= 4.2.5)
-      arel (~> 6.0)
-    activesupport (4.2.5)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.3)
-    builder (3.2.2)
-    byebug (8.2.0)
-    diff-lcs (1.2.5)
-    erubis (2.7.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
-    mime-types (2.6.2)
-    mini_portile2 (2.0.0)
-    minitest (5.8.3)
-    nokogiri (1.6.7)
-      mini_portile2 (~> 2.0.0.rc2)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.5)
-      actionmailer (= 4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
-      activemodel (= 4.2.5)
-      activerecord (= 4.2.5)
-      activesupport (= 4.2.5)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.5)
-      sprockets-rails
-    rails-api (0.4.0)
-      actionpack (>= 3.2.11)
-      railties (>= 3.2.11)
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.2)
-      loofah (~> 2.0)
-    railties (4.2.5)
-      actionpack (= 4.2.5)
-      activesupport (= 4.2.5)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.4.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-rails (3.4.0)
-      actionpack (>= 3.0, < 4.3)
-      activesupport (>= 3.0, < 4.3)
-      railties (>= 3.0, < 4.3)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    spring (1.4.4)
-    sprockets (3.4.0)
-      rack (> 1, < 3)
-    sprockets-rails (2.3.3)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  rails (= 4.2.5)
-  rails-api
-  rspec-rails (~> 3.4)
-  spring
-  sqlite3
-  tests_doc!
-
-BUNDLED WITH
-   1.10.6

data/examples/rails-4.2.5/README.md

@@ -1,3 +0,0 @@
-# Example App
-
-This is a sample Rails 4 app using `tests_doc` you can see the recorded tests doc inside the [tests-doc folder](tests-doc)

data/examples/rails-4.2.5/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/examples/rails-4.2.5/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::API
-end

data/examples/rails-4.2.5/app/controllers/posts_controller.rb

@@ -1,61 +0,0 @@
-class PostsController < ApplicationController
-  before_action :set_post, only: [:show, :update, :destroy]
-
-  # GET /posts
-  # GET /posts.json
-  def index
-    @posts = Post
-    @posts = @posts.where(user_id: params[:user_id]) if params[:user_id]
-    @posts = @posts.all
-
-    render json: @posts
-  end
-
-  # GET /posts/1
-  # GET /posts/1.json
-  def show
-    render json: @post
-  end
-
-  # POST /posts
-  # POST /posts.json
-  def create
-    @post = Post.new(post_params)
-
-    if @post.save
-      render json: @post, status: :created, location: @post
-    else
-      render json: @post.errors, status: :unprocessable_entity
-    end
-  end
-
-  # PATCH/PUT /posts/1
-  # PATCH/PUT /posts/1.json
-  def update
-    @post = Post.find(params[:id])
-
-    if @post.update(post_params)
-      head :no_content
-    else
-      render json: @post.errors, status: :unprocessable_entity
-    end
-  end
-
-  # DELETE /posts/1
-  # DELETE /posts/1.json
-  def destroy
-    @post.destroy
-
-    head :no_content
-  end
-
-  private
-
-    def set_post
-      @post = Post.find(params[:id])
-    end
-
-    def post_params
-      params.require(:post).permit(:title, :body, :user_id)
-    end
-end

data/examples/rails-4.2.5/app/controllers/users_controller.rb

@@ -1,59 +0,0 @@
-class UsersController < ApplicationController
-  before_action :set_user, only: [:show, :update, :destroy]
-
-  # GET /users
-  # GET /users.json
-  def index
-    @users = User.all
-
-    render json: @users
-  end
-
-  # GET /users/1
-  # GET /users/1.json
-  def show
-    render json: @user
-  end
-
-  # POST /users
-  # POST /users.json
-  def create
-    @user = User.new(user_params)
-
-    if @user.save
-      render json: @user, status: :created, location: @user
-    else
-      render json: @user.errors, status: :unprocessable_entity
-    end
-  end
-
-  # PATCH/PUT /users/1
-  # PATCH/PUT /users/1.json
-  def update
-    @user = User.find(params[:id])
-
-    if @user.update(user_params)
-      head :no_content
-    else
-      render json: @user.errors, status: :unprocessable_entity
-    end
-  end
-
-  # DELETE /users/1
-  # DELETE /users/1.json
-  def destroy
-    @user.destroy
-
-    head :no_content
-  end
-
-  private
-
-    def set_user
-      @user = User.find(params[:id])
-    end
-
-    def user_params
-      params.require(:user).permit(:email, :first_name, :last_name)
-    end
-end

data/examples/rails-4.2.5/app/models/post.rb

@@ -1,3 +0,0 @@
-class Post < ActiveRecord::Base
-  belongs_to :user
-end

data/examples/rails-4.2.5/app/models/user.rb

@@ -1,2 +0,0 @@
-class User < ActiveRecord::Base
-end

data/examples/rails-4.2.5/bin/bundle

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')

data/examples/rails-4.2.5/bin/rails

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-begin
-  load File.expand_path('../spring', __FILE__)
-rescue LoadError => e
-  raise unless e.message.include?('spring')
-end
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'

data/examples/rails-4.2.5/bin/rake

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-begin
-  load File.expand_path('../spring', __FILE__)
-rescue LoadError => e
-  raise unless e.message.include?('spring')
-end
-require_relative '../config/boot'
-require 'rake'
-Rake.application.run

data/examples/rails-4.2.5/bin/setup

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-require 'pathname'
-
-# path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
-
-Dir.chdir APP_ROOT do
-  # This script is a starting point to setup your application.
-  # Add necessary setup steps to this file:
-
-  puts "== Installing dependencies =="
-  system "gem install bundler --conservative"
-  system "bundle check || bundle install"
-
-  # puts "\n== Copying sample files =="
-  # unless File.exist?("config/database.yml")
-  #   system "cp config/database.yml.sample config/database.yml"
-  # end
-
-  puts "\n== Preparing database =="
-  system "bin/rake db:setup"
-
-  puts "\n== Removing old logs and tempfiles =="
-  system "rm -f log/*"
-  system "rm -rf tmp/cache"
-
-  puts "\n== Restarting application server =="
-  system "touch tmp/restart.txt"
-end

data/examples/rails-4.2.5/bin/spring

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-# This file loads spring without using Bundler, in order to be fast.
-# It gets overwritten when you run the `spring binstub` command.
-
-unless defined?(Spring)
-  require 'rubygems'
-  require 'bundler'
-
-  if (match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m))
-    Gem.paths = { 'GEM_PATH' => [Bundler.bundle_path.to_s, *Gem.path].uniq }
-    gem 'spring', match[1]
-    require 'spring/binstub'
-  end
-end

data/examples/rails-4.2.5/config/application.rb

@@ -1,26 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'rails/all'
-
-# Require the gems listed in Gemfile, including any gems
-# you've limited to :test, :development, or :production.
-Bundler.require(*Rails.groups)
-
-module Rails425
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
-  end
-end

data/examples/rails-4.2.5/config/boot.rb

@@ -1,3 +0,0 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
-require 'bundler/setup' # Set up gems listed in the Gemfile.