autodoc 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937c3ab0cd4c58a348027ba6b9a05d2c87d45e6b
-  data.tar.gz: ee87c40f918c645971f3f14cdb7a26756557371f
+  metadata.gz: d93952ec85969ac234dbeb59363103d1587a06dd
+  data.tar.gz: 2f69882edbd84d12d0cd5c257858fa50a45d4a66
 SHA512:
-  metadata.gz: 6da626b43eab6022fb1d434cd7800ecba703113be0246c6f5230618ee031a6168d8bf43d6250d23964ff19ba03d50321f6e0e1ebc7172e530ad108e3ff63b202
-  data.tar.gz: c5c7e82c7915f3efcedda12a4d88365eeaceacd6c2d8cf8584780fae8808ec0b800fecc3d6b3d8804c2ec1a0bc80ad8e93c4deff51e99f0edb4978b4990fb93e
+  metadata.gz: 5ba609ac4bed6ac01df05fcaa3b1c6dcf1101e150d106016d4bcecc4850dc334a7074f785ce342df9cf6101e297e6673348b39c5cb9e985d6b325777b99b8b6e
+  data.tar.gz: 8af2b92831a033e1b9d189911b92ac379e4651d02f752a11d70e691b8d26d2b21565f8b7edaf6b1b1831082ca0395ff9e6e8d4b70264a5f8bf7400be111786bd

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.3
+* Fix ToC template for specs in sub-directory
+
 ## 0.3.2
 * Fix template & document bug
 

data/lib/autodoc/configuration.rb

@@ -37,5 +37,9 @@ module Autodoc
     property :toc do
       false
     end
+
+    def pathname
+      Pathname.new(path)
+    end
   end
 end

data/lib/autodoc/document.rb

@@ -18,7 +18,7 @@ module Autodoc
     def pathname
       @path ||= begin
         payload = @context.example.file_path.gsub(%r<\./spec/requests/(.+)_spec\.rb>, '\1.md')
-        Pathname.new(Autodoc.configuration.path) + payload
+        Autodoc.configuration.pathname + payload
       end
     end
 

data/lib/autodoc/documents.rb

@@ -35,7 +35,7 @@ module Autodoc
     end
 
     def toc_path
-      Pathname.new(Autodoc.configuration.path) + "toc.md"
+      Autodoc.configuration.pathname + "toc.md"
     end
   end
 end

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

@@ -1,11 +1,12 @@
 <%# coding: UTF-8 -%>
 ## Table of Contents
 <% @table.sort.each do |pathname, documents| -%>
-* [<%= pathname.basename %>](<%= pathname.basename %>)
+<% relative_path = pathname.relative_path_from(Autodoc.configuration.pathname) -%>
+* [<%= relative_path %>](<%= relative_path %>)
 <% documents.group_by(&:title).each do |title, documents| -%>
 <% documents.each_with_index do |document, index| -%>
 <% suffix = index == 0 ? "" : "-#{index}" -%>
- * [<%= title %>](<%= "#{pathname.basename}##{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.3.2"
+  VERSION = "0.3.3"
 end

data/spec/autodoc/documents_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe Autodoc::Documents do
+  describe "#render_toc" do
+    before do
+      documents.append(context)
+    end
+
+    let(:documents) do
+      Autodoc::Documents.new
+    end
+
+    let(:context) do
+      mock = double(example: example, request: request)
+      mock.stub(clone: mock)
+      mock
+    end
+
+    let(:example) do
+      double(file_path: file_path, full_description: full_description)
+    end
+
+    let(:file_path) do
+      "spec/requests/recipes.md"
+    end
+
+    let(:request) do
+      double(method: method)
+    end
+
+    let(:method) do
+      "GET"
+    end
+
+    context "with GET /recipes spec" do
+      let(:full_description) do
+        "Recipe #{method} /recipes returns recipes"
+      end
+
+      let(:file_path) do
+        "./spec/requests/recipes_spec.rb"
+      end
+
+      it "includes links to recipes.md" do
+        toc = documents.send(:render_toc)
+        toc.should include("[recipes.md](recipes.md)")
+        toc.should include("[GET /recipes](recipes.md#get-recipes)")
+      end
+    end
+
+    context "with GET /admin/recipes spec" do
+      let(:full_description) do
+        "Admin::Recipe #{method} /admin/recipes returns recipes for administrator"
+      end
+
+      let(:file_path) do
+        "./spec/requests/admin/recipes_spec.rb"
+      end
+
+      it "includes links to admin/recipes.md" do
+        toc = documents.send(:render_toc)
+        toc.should include("[admin/recipes.md](admin/recipes.md)")
+        toc.should include("[GET /admin/recipes](admin/recipes.md#get-adminrecipes)")
+      end
+    end
+  end
+end

data/spec/dummy/doc/admin/entries.md

@@ -0,0 +1,23 @@
+## GET /admin/entries
+Returns entries.
+
+### Example
+```
+GET /admin/entries HTTP/1.1
+Accept: application/json
+Content-Length: 0
+Host: example.org
+```
+
+```
+HTTP/1.1 200
+Content-Length: 45
+Content-Type: application/json
+
+[
+  {
+    "title": "Test Title",
+    "body": "Lorem Ipsum"
+  }
+]
+```

data/spec/dummy/doc/recipes.md

@@ -14,11 +14,11 @@ HTTP/1.1 200
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "817f9446a34cdb5179ee09b555b507f8"
+ETag: "d2bb4f3624c215dcc71b683ec7d58ebd"
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: a1723cc5-c4f7-4779-8382-5dbf879687e5
-X-Runtime: 0.017503
+X-Request-Id: 5f84d51d-9709-4a8f-a02c-77732902252b
+X-Runtime: 0.013851
 X-UA-Compatible: chrome=1
 X-XSS-Protection: 1; mode=block
 
@@ -26,8 +26,8 @@ X-XSS-Protection: 1; mode=block
   "id": 1,
   "name": "test",
   "type": 2,
-  "created_at": "2013-12-18T06:33:23.129Z",
-  "updated_at": "2013-12-18T06:33:23.129Z"
+  "created_at": "2013-12-29T14:22:59.625Z",
+  "updated_at": "2013-12-29T14:22:59.625Z"
 }
 ```
 
@@ -61,12 +61,12 @@ HTTP/1.1 201
 Cache-Control: max-age=0, private, must-revalidate
 Content-Length: 111
 Content-Type: application/json; charset=utf-8
-ETag: "9a32ff7207d60c4e3eca833ed83320f9"
+ETag: "0d698f869368039f2145c92927b36720"
 Location: http://www.example.com/recipes/1
 X-Content-Type-Options: nosniff
 X-Frame-Options: SAMEORIGIN
-X-Request-Id: 06f2dfe3-3085-419a-b2a8-db3abd1d3156
-X-Runtime: 0.006099
+X-Request-Id: 84349101-dc40-4416-83a0-a767242881f9
+X-Runtime: 0.003861
 X-UA-Compatible: chrome=1
 X-XSS-Protection: 1; mode=block
 
@@ -74,7 +74,7 @@ X-XSS-Protection: 1; mode=block
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-12-18T06:33:23.195Z",
-  "updated_at": "2013-12-18T06:33:23.195Z"
+  "created_at": "2013-12-29T14:22:59.676Z",
+  "updated_at": "2013-12-29T14:22:59.676Z"
 }
 ```

data/spec/dummy/doc/toc.md

@@ -1,4 +1,6 @@
 ## Table of Contents
+* [admin/entries.md](admin/entries.md)
+ * [GET /admin/entries](admin/entries.md#get-adminentries)
 * [entries.md](entries.md)
  * [GET /entries](entries.md#get-entries)
 * [recipes.md](recipes.md)

data/spec/requests/admin/entries_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "Admin::Entries" do
+  include Rack::Test::Methods
+
+  let(:env) do
+    { "HTTP_ACCEPT" => "application/json" }
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:app) do
+    lambda do |env|
+      [
+        200,
+        { "Content-Type" => "application/json" },
+        [
+          [
+            {
+              title: "Test Title",
+              body: "Lorem Ipsum",
+            },
+          ].to_json,
+        ],
+      ]
+    end
+  end
+
+  describe "GET /admin/entries" do
+    context "with Rack::Test", :autodoc do
+      it "returns entries" do
+        get "/admin/entries", params, env
+        last_response.status.should == 200
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,6 +130,7 @@ files:
 - lib/autodoc/templates/document.md.erb
 - lib/autodoc/templates/toc.md.erb
 - lib/autodoc/version.rb
+- spec/autodoc/documents_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -158,6 +159,7 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20130607075126_create_recipes.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/doc/admin/entries.md
 - spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
 - spec/dummy/doc/toc.md
@@ -168,6 +170,7 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/admin/entries_spec.rb
 - spec/requests/entries_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
@@ -196,6 +199,7 @@ signing_key:
 specification_version: 4
 summary: Auto-generate JSON API documents from your request-specs.
 test_files:
+- spec/autodoc/documents_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -224,6 +228,7 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/migrate/20130607075126_create_recipes.rb
 - spec/dummy/db/schema.rb
+- spec/dummy/doc/admin/entries.md
 - spec/dummy/doc/entries.md
 - spec/dummy/doc/recipes.md
 - spec/dummy/doc/toc.md
@@ -234,6 +239,8 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/requests/admin/entries_spec.rb
 - spec/requests/entries_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
+has_rdoc: