autodoc 0.7.1 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f949109553f40d0648ce7db3c7ad1dc34e3c825e
-  data.tar.gz: aba98fa5384f3800fc492fec28c9154e488a7207
+SHA256:
+  metadata.gz: 47721414a1cf3631034dbe786a133d21922de3a4ca0689dd5d37112c9267d638
+  data.tar.gz: 6b398807f034927b9c8ec8749f028c0da00a254afb6a91e09fdd03f9a188602d
 SHA512:
-  metadata.gz: 857a1f3de052570c6dae4fb30169ce642366eee3f8162ed3e4d4f6ba588b957d8522683782391bcf114434215693060f409714663f1802da930cccc3847d73a5
-  data.tar.gz: ae882bf23025dd57506e4403b83cf2ee63f11e84c1a3264514b9c3c637e2dfe2331b91ed786b0dcf61cc4afe1c82d380f5f231b6b2bc122bd454e2105e9e0710
+  metadata.gz: 9602be06ef5819e7edc380dd0ae990ec844cc0e38e4244144ca336de0522f213acffce64cf3df75eab269cce3a4a03bd276352fbfe518e2e9257194fa1ec6074
+  data.tar.gz: 45030c275296700cd24e69ac95c0ade9f7bbb6e37a4cb23f9056d9037eb97e87f38a302f29164317381bf2da383f968246198890de8a50547fcfa4a158d76cf9

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+jobs:
+  rspec:
+    docker:
+      - image: ruby:2.5.3
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            - v1-dependencies-
+      - run:
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+          name: bundle install
+      - save_cache:
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          paths:
+            - ./vendor/bundle
+      - run:
+          command: cd spec/dummy && RAILS_ENV=test bundle exec rails db:setup
+          name: rails db:setup
+      - run:
+          command: bundle exec rspec
+          name: rspec
+version: 2
+workflows:
+  version: 2
+  test:
+    jobs:
+      - rspec

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle/
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -7,12 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## 0.7.1 - 2018-12-18
+## 0.7.6
+
+### Fixed
+
+- Replace `URI.unescape` with `URI.decode_www_form_component` for Ruby 3 support.
+
+## 0.7.5
+
+### Fixed
+
+- Convert header key to string.
+
+## 0.7.4 - 2020-04-14
+
+### Fixed
+
+- Improve error message on no request case.
+
+## 0.7.3 - 2019-06-18
+
+### Fixed
+
+- Fix indent in toc template.
+
+## 0.7.2 - 2019-01-09
 
 ### Fixed
 
 - Fixed broken symlink on spec/dummy/spec.
 
+## 0.7.1 - 2018-12-18
+
 ## 0.7.0 - 2018-08-30
 
 ### Changed

data/Gemfile

@@ -12,7 +12,6 @@ group :test do
     gem "rspec-rails"
   end
   gem "weak_parameters"
-  gem "protected_attributes"
   gem "rack-test"
   gem "redcarpet"
   gem "responders"

data/Gemfile.lock

@@ -0,0 +1,176 @@
+PATH
+  remote: .
+  specs:
+    autodoc (0.7.5)
+      actionpack
+      activesupport (>= 3.0.0)
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.2)
+      actionpack (= 5.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.2)
+      activesupport (= 5.2.2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activestorage (5.2.2)
+      actionpack (= 5.2.2)
+      activerecord (= 5.2.2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    coderay (1.1.1)
+    concurrent-ruby (1.1.4)
+    crass (1.0.5)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.3.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.8.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.5.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.6)
+      pry (>= 0.10.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.2)
+      actioncable (= 5.2.2)
+      actionmailer (= 5.2.2)
+      actionpack (= 5.2.2)
+      actionview (= 5.2.2)
+      activejob (= 5.2.2)
+      activemodel (= 5.2.2)
+      activerecord (= 5.2.2)
+      activestorage (= 5.2.2)
+      activesupport (= 5.2.2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.1)
+    redcarpet (3.5.1)
+    responders (2.4.0)
+      actionpack (>= 4.2.0, < 5.3)
+      railties (>= 4.2.0, < 5.3)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    slop (3.6.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    weak_parameters (0.4.2)
+      rails (>= 4.0.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autodoc!
+  bundler (~> 1.3)
+  pry-rails
+  rack-test
+  rails (= 5.2.2)
+  rake
+  redcarpet
+  responders
+  rspec-rails
+  sqlite3
+  weak_parameters
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,4 +1,8 @@
 # Autodoc
+
+[![CircleCI](https://circleci.com/gh/r7kamura/autodoc.svg?style=svg)](https://circleci.com/gh/r7kamura/autodoc)
+[![Gem Version](https://badge.fury.io/rb/autodoc.svg)](https://rubygems.org/gems/autodoc)
+
 Generate documentation from your rack application & request-spec.
 
 ## Installation

data/autodoc.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack"
   spec.add_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rails", "4.2.0"
+  spec.add_development_dependency "rails", "5.2.2"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "sqlite3"
 end

data/lib/autodoc/document.rb

@@ -73,7 +73,7 @@ module Autodoc
     end
 
     def method
-      request.method
+      request.request_method
     end
 
     def request_header
@@ -87,8 +87,8 @@ module Autodoc
 
     def request_header_from_http_prefix
       request.headers.inject({}) do |table, (key, value)|
-        if key.start_with?("HTTP_")
-          table.merge(key.gsub(/^HTTP_/, "") => value)
+        if key.to_s.start_with?("HTTP_")
+          table.merge(key.to_s.gsub(/^HTTP_/, "") => value)
         else
           table
         end
@@ -106,7 +106,7 @@ module Autodoc
     end
 
     def request_query
-      "?#{URI.unescape(request.query_string.force_encoding(Encoding::UTF_8))}" unless request.query_string.empty?
+      "?#{URI.decode_www_form_component(request.query_string.force_encoding(Encoding::UTF_8))}" unless request.query_string.empty?
     end
 
     def request_body_section

data/lib/autodoc/templates/toc.md.erb

@@ -6,7 +6,7 @@
 <% documents.group_by(&:title).each do |title, docs| -%>
 <% docs.each_with_index do |document, index| -%>
 <% suffix = index == 0 ? "" : "-#{index}" -%>
- * [<%= title %>](<%= "#{relative_path}##{document.identifier}#{suffix}" %>)
+  * [<%= title %>](<%= "#{relative_path}##{document.identifier}#{suffix}" %>)
 <% end -%>
 <% end -%>
 <% end -%>

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.7.1"
+  VERSION = "0.7.6"
 end

data/spec/autodoc/documents_spec.rb

@@ -45,7 +45,7 @@ describe Autodoc::Documents do
     end
 
     let(:request) do
-      double(method: method)
+      double(request_method: method)
     end
 
     let(:method) do

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -9,6 +9,6 @@ class RecipesController < ApplicationController
   end
 
   def create
-    respond_with Recipe.create(params.slice(:name, :type))
+    respond_with Recipe.create(params.permit(:name, :type))
   end
 end

data/spec/dummy/app/models/recipe.rb

@@ -1,4 +1,3 @@
 class Recipe < ActiveRecord::Base
-  attr_accessible :name, :type
   self.inheritance_column = :_type
 end

data/spec/dummy/config/application.rb

@@ -44,7 +44,6 @@ module Dummy
     # like if you have constraints or database-specific column types
     # config.active_record.schema_format = :sql
 
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
+    config.active_record.sqlite3.represent_boolean_as_integer = true
   end
 end

data/spec/dummy/config/initializers/secret_token.rb

@@ -4,5 +4,5 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Dummy::Application.config.secret_token = '2da8e59639e7c92b0da46798ed97a45be5834c72cdd9a4ad141dadc5b1175f991b05ef02dde00f9c27cadb3790311e642010b89ed1dad598539980a1ae88be61'
+Dummy::Application.config.secret_key_base = '2da8e59639e7c92b0da46798ed97a45be5834c72cdd9a4ad141dadc5b1175f991b05ef02dde00f9c27cadb3790311e642010b89ed1dad598539980a1ae88be61'
 Dummy::Application.config.secret_key_base = '7bea42a7812ad8da2fa753be701ed39a8b35f014c0cfcc876ad08180f2b25504e67ed24fc4470c51b229bbbc4731454c912e4609902e1c0bba65fb86037f7f1a'

data/spec/requests/recipes_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "Recipes", type: :request do
-  let(:env_hash) do
+  let(:headers) do
     { "ACCEPT" => "application/json", "CONTENT_TYPE" => "application/json" }
   end
 
@@ -16,13 +16,13 @@ describe "Recipes", type: :request do
 
     context "with valid condition (using Rack::Test)", autodoc: true do
       before do
-        env_hash["Content-Type"] = "application/json"
+        headers["Content-Type"] = "application/json"
       end
 
       include Rack::Test::Methods
 
       it "returns the recipe" do
-        get "/recipes/#{recipe.id}", params, env_hash
+        get "/recipes/#{recipe.id}", headers: headers, params: params.to_json
         expect(last_response.status).to eq(200)
       end
     end
@@ -40,7 +40,7 @@ describe "Recipes", type: :request do
       end
 
       it "returns 400" do
-        post "/recipes", params.to_json, env_hash
+        post "/recipes", headers: headers, params: params.to_json
         expect(response.status).to eq(400)
       end
     end
@@ -51,7 +51,7 @@ describe "Recipes", type: :request do
       end
 
       it "returns 400" do
-        post "/recipes", params.to_json, env_hash
+        post "/recipes", headers: headers, params: params.to_json
         expect(response.status).to eq(400)
       end
     end
@@ -62,7 +62,7 @@ describe "Recipes", type: :request do
       end
 
       it "creates a new recipe" do
-        post "/recipes", params.to_json, env_hash
+        post "/recipes", headers: headers, params: params.to_json
         expect(response.status).to eq(201)
       end
     end
@@ -78,7 +78,7 @@ describe "Recipes", type: :request do
       end
 
       it "creates a new recipe" do
-        post "/recipes", params.to_json, env_hash
+        post "/recipes", headers: headers, params: params.to_json
         expect(response.status).to eq(201)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.6
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,9 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -175,7 +177,6 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/dummy/spec
 - spec/requests/admin/entries_spec.rb
 - spec/requests/entries_spec.rb
 - spec/requests/pending_spec.rb
@@ -200,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Auto-generate JSON API documents from your request-specs.
@@ -250,7 +250,6 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
-- spec/dummy/spec
 - spec/requests/admin/entries_spec.rb
 - spec/requests/entries_spec.rb
 - spec/requests/pending_spec.rb

data/spec/dummy/spec

@@ -1 +0,0 @@
-spec/dummy/../../spec