autodoc 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b183416b270d62f730b447ecf874adbe4a98a3c
-  data.tar.gz: f97bce1b7f34b7cd873027f161c8dbe03fb881fa
+  metadata.gz: 23c07c4c85ad1c66193733e371af30832c1ef8d0
+  data.tar.gz: 4da0100e043b131ffafbf8e824dcfb37c53e344e
 SHA512:
-  metadata.gz: 1d82ae6802bd524f235ac12354426c7938ff6cb03984f6fd7e0b21433b851368b6cb41b0cdf49a3cba9b18c96bac9b83aa03b5db6fd45b03f615dfc4b783fb50
-  data.tar.gz: 6025d431e657cc03a59f80875c1fbaf2b797e5ef0faa5f2c7c60f21a4f75ea2924b29fab7fdfef991e5d20cc209905ef2af35f31b3876e1d574300397d401978
+  metadata.gz: 698d341f91a205c3a89485ca9120fbfa4790e1804746ab0e23da0ffe81ace672b821ac2612de6e68be733cddca16cae0e1183c6715e7e998549de3778ef5f64f
+  data.tar.gz: 3df52d3c08b2f791be3363e379495338a052b03ab308e1c0e83fd9b977e2354fda31bb6b111814b8bb7fec36c4941a397d88e3c3c3fc830da2c1bf3bf53d3414

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.6
+* fix ToC generator
+
 ## 0.2.5
 * add ToC generator
 * use Autodoc.configuration.path to change documents path

data/README.md

@@ -7,31 +7,26 @@ gem "autodoc", group: :test
 ```
 
 ## Usage
-All request-specs tagged with `:autodoc` will be auto-documented.
+Run rspec with AUTODOC=1 to generate documents for the specs tagged with `:autodoc`.  
+example: [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/recipes.md), [doc/toc.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/toc.md)
+
+```sh
+# shell-command
+AUTODOC=1 rspec
+```
 
 ```ruby
 # spec/requests/recipes_spec.rb
 describe "Recipes" do
-  let(:params) do
-    { name: "alice", type: 1 }
-  end
-
   describe "POST /recipes", autodoc: true do
     it "creates a new recipe" do
-      post "/recipes.json", params
+      post "/recipes.json", name: "alice", type: 1
       response.status.should == 201
     end
   end
 end
 ```
 
-Run rspec with AUTODOC=1 to generate documents. ([example](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/recipes.md))
-
-```sh
-# shell-command
-AUTODOC=1 rspec
-```
-
 ### Configuration
 You can configure `Autodoc.configuration` to change its behavior:
 
@@ -40,3 +35,9 @@ You can configure `Autodoc.configuration` to change its behavior:
 * template - [String] ERB template for each document (default: [document.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/document.md.erb))
 * toc_template - [String] ERB template for ToC (default: [toc.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/toc.md.erb))
 * toc - [Boolean] whether to generate toc.md (default: false)
+
+```ruby
+# example
+Autodoc.configuration.path = "doc/api"
+Autodoc.configuration.toc = true
+```

data/lib/autodoc/document.rb

@@ -28,7 +28,7 @@ module Autodoc
     end
 
     def identifier
-      title.gsub(" ", "-").gsub(/[:_\/]/, "").downcase
+      title.gsub(" ", "-").gsub(/[:\/]/, "").downcase
     end
 
     private

data/lib/autodoc/documents.rb

@@ -26,6 +26,7 @@ module Autodoc
     end
 
     def write_toc
+      toc_path.parent.mkpath
       toc_path.open("w") {|file| file << render_toc }
     end
 

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/spec/dummy/doc/recipes.md

@@ -1,30 +1,21 @@
-## POST /recipes
-Creates a new recipe.
-
-### parameters
-* `name` string (required, except: `["alice", "bob"]`)
-* `type` integer (only: `1..3`)
+## GET /recipes/:id
+Returns the recipe.
 
 ### request
 ```
-POST /recipes
-```
-
-```
-name=name&type=1
+GET /recipes/:id
 ```
 
 ### response
 ```ruby
-Status: 201
-Location: http://www.example.com/recipes/1
+Status: 200
 response: 
 {
   "id": 1,
-  "name": "name",
-  "type": 1,
-  "created_at": "2013-11-30T18:15:08.928Z",
-  "updated_at": "2013-11-30T18:15:08.928Z"
+  "name": "test",
+  "type": 2,
+  "created_at": "2013-11-30T19:04:12.608Z",
+  "updated_at": "2013-11-30T19:04:12.608Z"
 }
 ```
 
@@ -47,13 +38,13 @@ name=name&type=1
 ### response
 ```ruby
 Status: 201
-Location: http://example.org/recipes/1
+Location: http://www.example.com/recipes/1
 response: 
 {
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-11-30T18:15:08.938Z",
-  "updated_at": "2013-11-30T18:15:08.938Z"
+  "created_at": "2013-11-30T19:04:12.684Z",
+  "updated_at": "2013-11-30T19:04:12.684Z"
 }
 ```

data/spec/dummy/doc/toc.md

@@ -1,4 +1,4 @@
 ## Table of Contents
 * [recipes.md](recipes.md)
+ * [GET /recipes/:id](recipes.md#get-recipesid)
  * [POST /recipes](recipes.md#post-recipes)
- * [POST /recipes](recipes.md#post-recipes-1)

data/spec/requests/recipes_spec.rb

@@ -6,13 +6,30 @@ describe "Recipes" do
   end
 
   let(:params) do
-    {
-      name: "name",
-      type: 1,
-    }
+    {}
+  end
+
+  describe "GET /recipes/:id" do
+    let(:recipe) do
+      Recipe.create(name: "test", type: 2)
+    end
+
+    context "with valid condition (using Rack::Test)", :autodoc do
+      include Rack::Test::Methods
+
+      it "returns the recipe" do
+        get "/recipes/#{recipe.id}", params, env
+        last_response.status.should == 200
+      end
+    end
   end
 
   describe "POST /recipes" do
+    before do
+      params[:name] = "name"
+      params[:type] = 1
+    end
+
     context "without required param" do
       before do
         params.delete(:name)
@@ -52,17 +69,5 @@ describe "Recipes" do
         response.status.should == 201
       end
     end
-
-    context "with valid condition (client using Rack::Test)", :autodoc do
-      include Rack::Test::Methods
-      before do
-        header 'Accept', 'application/json'
-      end
-
-      it "creates a new recipe" do
-        post "/recipes", params
-        last_response.status.should == 201
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -219,4 +219,3 @@ test_files:
 - spec/dummy/script/rails
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
-has_rdoc: