autodoc 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d2c0efdba248e2389ee71279609112523677cce
-  data.tar.gz: b56df7831699c1b4a74a3d56d98b1da342147cb2
+  metadata.gz: 0c2aa5947baeb7bbb3aeb4ca8c94827db14643e4
+  data.tar.gz: 0c0c019f1d5845ed1226ce95235a4ba72990f0ef
 SHA512:
-  metadata.gz: 66deb224a2b8e1f584409f7795af9b43e1862518f92ff9aa84a02311a2bc336d00a0a1033be3fbedb4e7977ccc847f2cc9d1a91ee63b302f622f36d8cb0e8857
-  data.tar.gz: c7ab1e29455fd193163aed36655946689b1fd7d0f64442fe3fdd3d0b336c96994e0851a44f153c4ecde849893f0055a0f5415ae4f41e7b2840c603ac929c6c0f
+  metadata.gz: 023540cf07d6922fcaf674320778a5434e1f99467517edd4eeadfd8a5897ec0307a86489fd21c9c681d7315b11836e3d5d3d73ad18e2e05ca3a9cc011a3c884b
+  data.tar.gz: 2adc8b8e171ea8bae310b6a1793f84953a96a6c6e5d525b692f6afa5306e36e1ba57538b152b50a0d5ac3068ef4429895cf07b3c61f6a1ea8fd522b901434265

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.5
+* Support PATCH method
+
+## 0.3.4
+* Some improvements on the document template file
+
 ## 0.3.3
 * Fix ToC template for specs in sub-directory
 

data/README.md

@@ -8,14 +8,15 @@ gem "autodoc", group: :test
 
 ## Usage
 Run rspec with AUTODOC=1 to generate documents for your request-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)
+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
 # shell-command
 AUTODOC=1 rspec
 ```
 
-### Example for any Rack application with rack-test
+### Examples
+#### For any Rack application with rack-test
 ```ruby
 # spec/requests/entries_spec.rb
 describe "Entries" do
@@ -26,13 +27,15 @@ describe "Entries" do
   end
 
   describe "GET /entries", autodoc: true do
-    get "/entries"
-    last_response.status.should == 200
+    it "returns entries" do
+      get "/entries"
+      last_response.status.should == 200
+    end
   end
 end
 ```
 
-### Example for Rails application with rspec-rails
+#### For Rails application with rspec-rails
 ```ruby
 # spec/requests/recipes_spec.rb
 describe "Recipes" do
@@ -45,6 +48,24 @@ describe "Recipes" do
 end
 ```
 
+### Custom description
+You can write more detailed descriptions with `let(:description)`.
+
+```ruby
+describe "Recipes" do
+  describe "PUT /recipes/:id", autodoc: true do
+    let(:description) do
+      "Updates a recipe. `name` parameter is required."
+    end
+
+    it "updates a recipe" do
+      put "/recipes/#{recipe.id}", name: "Bob"
+      response.status.should == 204
+    end
+  end
+end
+```
+
 ### Configuration
 You can configure `Autodoc.configuration` to change its behavior:
 

data/lib/autodoc/document.rb

@@ -178,7 +178,7 @@ module Autodoc
     end
 
     def path
-      @context.example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
+      @context.example.full_description[%r<(GET|POST|PATCH|PUT|DELETE) ([^ ]+)>, 2]
     end
 
     def parameters_section

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2014-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,3 +243,4 @@ test_files:
 - spec/requests/entries_spec.rb
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
+has_rdoc: