autodoc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c9fe5187c39c827ab6be62b63806e00ac493ded
-  data.tar.gz: 7a818753de51a40957017592b3d4eae69b07ad77
+  metadata.gz: a9ef350c9fbfa8f0c91c49ea5c5acb2a629c6523
+  data.tar.gz: 39392c1e2cf3561ce80697fdbcd9218fb84978ac
 SHA512:
-  metadata.gz: 804a15e5737d47de9b21d636b95973dcc489be4ea92f4c640b7a6349406d955d94cfbb7eb1259b77d48fc1fd762c85fe07115737933efc67adef931d40d3d8b7
-  data.tar.gz: 8e026ef386e3c3c255264965f8ebb7f215a437e1082e004472bf34a380dc6054f6c2bbc292dc79b579d461776e22bf05c0051da0269a686a3868cab5a0066d71
+  metadata.gz: e798ec5836925fe93635c501839d496097730c16bb3aca7687429f2ada856be3ecdce649e7aa30e9fd006c21e7ace1b9cfdafc08cb6b0baeef18e40305d8ef00
+  data.tar.gz: b2fe73a5cc1732fca123ebcad91f4c60935ac238fbae10727a2125d181a79114019fe0d935efc94cecb6609a7460eafb270e99c5947d481b2c18f2286bc395ac

data/README.md

@@ -58,3 +58,35 @@ response:
 }
 ```
 </pre>
+
+## Custom template
+You can customize autodoc's template ([Example](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/document.rb#L126-L139)).
+Here are avilable variables:
+
+* description
+* method
+* parameters_section
+* path
+* request_body_section
+* response_body
+* response_headers
+* response_status
+
+<pre>
+Autodoc.configuration.template = &lt;&lt;-EOF
+  ## &lt;%= request.method %&gt; &lt;%= path %&gt;
+  &lt;%= example.description.capitalize %&gt;.
+  &lt;%= parameters_section %&gt;
+  ### request
+  ```
+  &lt;%= request.method %&gt; &lt;%= request.path %&gt;
+  ```
+  &lt;%= request_body_section %&gt;
+  ### response
+  ```ruby
+  Status: &lt;%= response.status %&gt;&lt;%= headers %&gt;
+  response: &lt;%= response_body %&gt;
+  ```
+
+EOF
+</pre>

data/autodoc.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Autodoc::VERSION
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
-  spec.summary       = "Auto-generate API documents from your request-specs."
+  spec.summary       = "Auto-generate JSON API documents from your request-specs."
   spec.homepage      = "https://github.com/r7kamura/autodoc"
   spec.license       = "MIT"
 

data/lib/autodoc/configuration.rb

@@ -7,7 +7,7 @@
 #
 module Autodoc
   class Configuration
-    attr_accessor :headers
+    attr_accessor :headers, :template
 
     def initialize
       reset
@@ -15,6 +15,22 @@ module Autodoc
 
     def reset
       @headers = %w[location]
+      @template = <<-EOF.strip_heredoc
+        ## <%= method %> <%= path %>
+        <%= description %>
+        <%= parameters_section %>
+        ### request
+        ```
+        <%= method %> <%= path %>
+        ```
+        <%= request_body_section %>
+        ### response
+        ```ruby
+        Status: <%= response_status %><%= response_headers %>
+        response: <%= response_body %>
+        ```
+
+      EOF
     end
   end
 end

data/lib/autodoc/document.rb

@@ -14,13 +14,17 @@ module Autodoc
     end
 
     def render
-      ERB.new(template).result(binding)
+      ERB.new(Autodoc.configuration.template).result(binding)
     end
 
     private
 
-    def template
-      File.read(__FILE__).split("__END__\n", 2).last
+    def description
+      "#{example.description.capitalize}."
+    end
+
+    def method
+      request.method
     end
 
     def path
@@ -44,6 +48,10 @@ module Autodoc
       end
     end
 
+    def response_status
+      response.status
+    end
+
     def parameters
       validators.map {|validator| Parameter.new(validator) }.join("\n")
     end
@@ -64,7 +72,7 @@ module Autodoc
       WeakParameters.stats[request.params[:controller]][request.params[:action]].try(:validators)
     end
 
-    def headers
+    def response_headers
       Autodoc.configuration.headers.map do |header|
         "\n#{header}: #{response.headers[header]}" if response.headers[header]
       end.compact.join
@@ -109,19 +117,3 @@ module Autodoc
     end
   end
 end
-
-__END__
-## <%= request.method %> <%= path %>
-<%= example.description.capitalize %>.
-<%= parameters_section %>
-### request
-```
-<%= request.method %> <%= request.path %>
-```
-<%= request_body_section %>
-### response
-```ruby
-Status: <%= response.status %><%= headers %>
-response: <%= response_body %>
-```
-

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/autodoc/document_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe Autodoc::Document do
+  describe ".render" do
+    subject do
+      described_class.render(example, request, response)
+    end
+
+    let(:example) do
+      double(
+        description: description,
+        full_description: "#{method} #{path} #{description}",
+      )
+    end
+
+    let(:description) do
+      "returns a recipe"
+    end
+
+    let(:request) do
+      double(
+        body: StringIO.new,
+        params: {},
+        method: method,
+        path: path,
+      )
+    end
+
+    let(:response) do
+      double(
+        body: response_body,
+        headers: {},
+        status: 200,
+      )
+    end
+
+    let(:method) do
+      "GET"
+    end
+
+    let(:path) do
+      "/recipes/1"
+    end
+
+    let(:response_body) do
+      {}.to_json
+    end
+
+    context "without Autodoc.configuration.template" do
+      it "uses default template" do
+        should == <<-EOF.strip_heredoc
+          ## GET /recipes/1
+          Returns a recipe.
+
+          ### request
+          ```
+          GET /recipes/1
+          ```
+
+          ### response
+          ```ruby
+          Status: 200
+          response: 
+          {}
+          ```
+
+        EOF
+      end
+    end
+
+    context "with Autodoc.configuration.template" do
+      before do
+        Autodoc.configuration.template = <<-EOF.strip_heredoc
+          ### request
+          ```
+          <%= method %> <%= path %>
+          ```
+          <%= request_body_section %>
+          ### response
+          ```ruby
+          Status: <%= response_status %><%= response_headers %>
+          response: <%= response_body %>
+          ```
+
+          ## <%= method %> <%= path %>
+          <%= description %>
+          <%= parameters_section %>
+        EOF
+      end
+
+      after do
+        Autodoc.configuration.reset
+      end
+
+      it "uses custom template" do
+        should == <<-EOF.strip_heredoc
+          ### request
+          ```
+          GET /recipes/1
+          ```
+
+          ### response
+          ```ruby
+          Status: 200
+          response: 
+          {}
+          ```
+
+          ## GET /recipes/1
+          Returns a recipe.
+
+        EOF
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -112,6 +112,7 @@ files:
 - lib/autodoc/configuration.rb
 - lib/autodoc/document.rb
 - lib/autodoc/version.rb
+- spec/autodoc/document_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -173,8 +174,9 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Auto-generate API documents from your request-specs.
+summary: Auto-generate JSON API documents from your request-specs.
 test_files:
+- spec/autodoc/document_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css