autodoc 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47721414a1cf3631034dbe786a133d21922de3a4ca0689dd5d37112c9267d638
-  data.tar.gz: 6b398807f034927b9c8ec8749f028c0da00a254afb6a91e09fdd03f9a188602d
+  metadata.gz: 50536334ac5d6f900f9fced708be9ad367e3fe1eddaa00bac5293da40e431e54
+  data.tar.gz: 13466a0fcf42bc05cb62f58db8f25da29cad54b4542b8f119fcd16834e326532
 SHA512:
-  metadata.gz: 9602be06ef5819e7edc380dd0ae990ec844cc0e38e4244144ca336de0522f213acffce64cf3df75eab269cce3a4a03bd276352fbfe518e2e9257194fa1ec6074
-  data.tar.gz: 45030c275296700cd24e69ac95c0ade9f7bbb6e37a4cb23f9056d9037eb97e87f38a302f29164317381bf2da383f968246198890de8a50547fcfa4a158d76cf9
+  metadata.gz: 1d06e79f180dee1d1f52618b867b575a689efbc8f01b950f3dbdbeee5dabb3ada471f0a1d61faf26b4853d8777be2f874592b7a1792a7125ec1e6a32866dba2b
+  data.tar.gz: 281b298e0ae036992b5b36718c2f9bf71bbe3ca47de3edb744c67cc8c1d33856630a041dd7165faf3094ab9e49abd159c6bf0ebd9d899b49395460a379be63ae

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.7.2
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: rails db:setup
+      run: |
+        cd spec/dummy
+        RAILS_ENV=test bundle exec rails db:setup
+    - name: Run the default task
+      run: bundle exec rake

data/CHANGELOG.md

@@ -7,13 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## 0.7.6
+## 0.8.0 - 2022-12-23
+
+### Fixed
+
+- Change the order of documents to match the order of tests.
+
+## 0.7.7 - 2022-05-17
+
+### Fixed
+
+- Prefer `#media_type` to `#content_type` (for Rails 7's change).
+- Fix `ERB.new` arguments style.
+
+## 0.7.6 - 2021-04-22
 
 ### Fixed
 
 - Replace `URI.unescape` with `URI.decode_www_form_component` for Ruby 3 support.
 
-## 0.7.5
+## 0.7.5 - 2021-02-16
 
 ### Fixed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    autodoc (0.7.5)
+    autodoc (0.7.7)
       actionpack
       activesupport (>= 3.0.0)
       rspec
@@ -51,40 +51,41 @@ GEM
       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)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.3.1)
+    loofah (2.19.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)
+    method_source (1.0.0)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.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.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-rails (0.3.9)
       pry (>= 0.10.4)
-    racc (1.5.2)
-    rack (2.2.3)
+    racc (1.6.1)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (5.2.2)
@@ -103,56 +104,55 @@ GEM
     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)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
     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)
+    rake (13.0.6)
     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)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       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)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.11.0)
+    sprockets (4.0.3)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.13)
-    thor (0.20.3)
+    thor (1.2.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
-    weak_parameters (0.4.2)
+    weak_parameters (0.5.0)
       rails (>= 4.0.0)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
 
@@ -169,7 +169,7 @@ DEPENDENCIES
   redcarpet
   responders
   rspec-rails
-  sqlite3
+  sqlite3 (~> 1.3.13)
   weak_parameters
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,6 @@
 # Autodoc
 
-[![CircleCI](https://circleci.com/gh/r7kamura/autodoc.svg?style=svg)](https://circleci.com/gh/r7kamura/autodoc)
+[![test](https://github.com/r7kamura/autodoc/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/autodoc/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/autodoc.svg)](https://rubygems.org/gems/autodoc)
 
 Generate documentation from your rack application & request-spec.
@@ -17,7 +17,7 @@ gem "redcarpet", group: :test
 ```
 
 ## Usage
-Run rspec with AUTODOC=1 to generate documents for your request-specs tagged with `:autodoc`.  
+Run rspec with AUTODOC=1 to generate documents for your request-specs tagged with `:autodoc`.
 example: Autodoc generates [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/recipes.md) and [doc/toc.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/toc.md) from [spec/requests/recipes_spec.rb](https://github.com/r7kamura/autodoc/blob/master/spec/requests/recipes_spec.rb).
 
 ```sh

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/autodoc.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rails", "5.2.2"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "~> 1.3.13"
 end

data/lib/autodoc/document.rb

@@ -20,6 +20,10 @@ module Autodoc
       @example = example
     end
 
+    def line_number
+      @context.inspect[/:([\d]+)\)>$/, 1].to_i
+    end
+
     def pathname
       @pathname ||= begin
         Autodoc.configuration.pathname + document_path_from_example.call(example)
@@ -27,7 +31,7 @@ module Autodoc
     end
 
     def render
-      ERB.new(Autodoc.configuration.template, nil, "-").result(binding)
+      ERB.new(Autodoc.configuration.template, trim_mode: "-").result(binding)
     end
 
     def title
@@ -119,7 +123,7 @@ module Autodoc
       else
         @request_body = begin
           case
-          when request.try(:content_type) == "multipart/form-data"
+          when request.try(:media_type) == "multipart/form-data"
             "multipart/form-data"
           when request.headers["Content-Type"].try(:include?, "application/json")
             request_body_parsed_as_json

data/lib/autodoc/documents.rb

@@ -23,7 +23,7 @@ module Autodoc
     def write_documents
       @table.each do |pathname, documents|
         pathname.parent.mkpath
-        pathname.open("w") {|file| file << documents.map(&:render).join("\n").rstrip + "\n" }
+        pathname.open("w") {|file| file << documents.sort_by(&:line_number).map(&:render).join("\n").rstrip + "\n" }
       end
     end
 
@@ -33,7 +33,7 @@ module Autodoc
     end
 
     def render_toc
-      ERB.new(Autodoc.configuration.toc_template, nil, "-").result(binding)
+      ERB.new(Autodoc.configuration.toc_template, trim_mode: "-").result(binding)
     end
 
     def write_toc_html
@@ -42,7 +42,7 @@ module Autodoc
     end
 
     def render_toc_html
-      ERB.new(Autodoc.configuration.toc_html_template, nil, "-").result(binding)
+      ERB.new(Autodoc.configuration.toc_html_template, trim_mode: "-").result(binding)
     end
 
     def toc_path

data/lib/autodoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,24 +98,24 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.3.13
+description:
 email:
 - r7kamura@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -186,7 +186,7 @@ homepage: https://github.com/r7kamura/autodoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,8 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Auto-generate JSON API documents from your request-specs.
 test_files:

data/.circleci/config.yml

@@ -1,29 +0,0 @@
-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