autodoc 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195ad826ae28c1a37c803892d5d9aebc2795e0f8
-  data.tar.gz: 04dd5257253195ca002a42ad3c739024becacdc6
+  metadata.gz: 0989cfe76444a6c585c644685c02a57d28c10386
+  data.tar.gz: bc53f5170027552ded6804d7d579ba9623306d38
 SHA512:
-  metadata.gz: 2d1a23fb5c9536cd3e474eba5123712a0bdc184292b71f637f74e29e00e830c9215d05090ed6f9641ff219bae68dec9d302408b86988c819f69be6f3efb2e9ad
-  data.tar.gz: a2c936e794832fb3677e9e6aef952bbe680765ce5aeaaf05c99d7f89848ca946008eacae8ba129b1c2f7057ac10347b55883be264cdf85327c9a40be677adb2b
+  metadata.gz: 876a3a38f18353a84e10650afb995186789453e387c730fc270aabb955796a61629d8dd7c3a8abb8d9a0fe49cf0281e3b32298e0d27f11135fa910672ba850c4
+  data.tar.gz: edce3d786a7ce4199637d3a9e61038e32c61a0ba8f8fdb6b7a5ae0d319cedde849deffd7594b0737a96f88387f1e922145444fd93a0a983043450888343e9e17

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.3
+* clean up dependencies & implementation
+
 ## 0.2.2
 * fix default documented headers
 

data/autodoc.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "actionpack"
   spec.add_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rails", ">= 3.2.11"

data/lib/autodoc.rb

@@ -1,14 +1,12 @@
-require "rspec"
-require "autodoc/collector"
 require "autodoc/configuration"
 require "autodoc/document"
-require "autodoc/transaction"
 require "autodoc/version"
+require "autodoc/rspec" if ENV["AUTODOC"]
 
 module Autodoc
   class << self
-    def collector
-      @collector ||= Autodoc::Collector.new
+    def contexts
+      @contexts ||= []
     end
 
     def configuration
@@ -16,25 +14,3 @@ module Autodoc
     end
   end
 end
-
-if ENV["AUTODOC"]
-  RSpec.configure do |config|
-    config.after(:each, type: :request) do
-      if example.metadata[:autodoc]
-        txn = Autodoc::Transaction.build(self)
-        Autodoc.collector.collect(example, txn)
-      end
-    end
-
-    config.after(:suite) do
-      Autodoc.collector.documents.each do |filepath, documents|
-        filepath = filepath.gsub("./spec/requests/", "").gsub("_spec.rb", ".md")
-        pathname = Rails.root.join("doc")
-        pathname += ENV["AUTODOC"] if ENV["AUTODOC"] != "1"
-        pathname += filepath
-        pathname.parent.mkpath
-        pathname.open("w") {|file| file << documents.join("\n").rstrip + "\n" }
-      end
-    end
-  end
-end

data/lib/autodoc/configuration.rb

@@ -1,37 +1,21 @@
-# You can configure documented headers.
-#
-# Examples
-#
-#   # response.headers["X-Content-Type-Options"] will be documented.
-#   Autodoc.configuration.headers << "X-Content-Type-Options"
-#
 module Autodoc
   class Configuration
-    attr_accessor :headers, :template
+    attr_writer :headers, :base_path, :template
 
-    def initialize
-      reset
+    def headers
+      @headers ||= %w[Location]
     end
 
-    def reset
-      @headers = %w[Location]
-      @template = <<-EOF.strip_heredoc
-        <%# coding: UTF-8 -%>
-        ## <%= method %> <%= path %>
-        <%= description %>
-        <%= parameters_section %>
-        ### request
-        ```
-        <%= method %> <%= path %>
-        ```
-        <%= request_body_section %>
-        ### response
-        ```ruby
-        Status: <%= response_status %><%= response_headers %>
-        response: <%= response_body %>
-        ```
+    def base_path
+      @base_path ||= begin
+        path = Rails.root.join("doc")
+        path += ENV["AUTODOC"] if ENV["AUTODOC"] != "1"
+        path
+      end
+    end
 
-      EOF
+    def template
+      @template ||= File.read(File.expand_path("../template.md.erb", __FILE__))
     end
   end
 end

data/lib/autodoc/document.rb

@@ -1,3 +1,4 @@
+require "action_dispatch/http/request"
 require "erb"
 
 module Autodoc
@@ -6,13 +7,10 @@ module Autodoc
       new(*args).render
     end
 
-    attr_reader :example, :transaction
+    attr_reader :example
 
-    delegate :method, :request_body, :response_status, :response_header, :response_body_raw, :controller, :action,
-      to: :transaction
-
-    def initialize(example, txn)
-      @example, @transaction = example, txn
+    def initialize(context)
+      @context = context
     end
 
     def render
@@ -21,12 +19,68 @@ module Autodoc
 
     private
 
+    def request
+      @request ||= begin
+        if using_rack_test?
+          ActionDispatch::Request.new(@context.last_request.env)
+        else
+          @context.request
+        end
+      end
+    end
+
+    def response
+      @response ||= begin
+        if using_rack_test?
+          @context.last_response
+        else
+          @context.response
+        end
+      end
+    end
+
+    def method
+      request.method
+    end
+
+    def request_body
+      request.body.string
+    end
+
+    def response_status
+      response.status
+    end
+
+    def response_header(header)
+      response.headers[header]
+    end
+
+    def response_body_raw
+      response.body
+    end
+
+    def controller
+      request.params[:controller]
+    end
+
+    def action
+      request.params[:action]
+    end
+
+    def using_rack_test?
+      !!defined?(Rack::Test::Methods) && @context.class.ancestors.include?(Rack::Test::Methods)
+    end
+
+    def transaction
+      @transaction ||= Autodoc::Transaction.build(@context)
+    end
+
     def description
-      "#{example.description.capitalize}."
+      "#{@context.example.description.capitalize}."
     end
 
     def path
-      example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
+      @context.example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
     end
 
     def response_body

data/lib/autodoc/rspec.rb

@@ -0,0 +1,16 @@
+require "rspec"
+
+RSpec.configuration.after(:each, autodoc: true) do
+  Autodoc.contexts << self.clone
+end
+
+RSpec.configuration.after(:suite) do
+  table = Autodoc.contexts.group_by {|context| context.example.file_path }
+  table.each do |path, contexts|
+    pathname = Autodoc.configuration.base_path + path.gsub("./spec/requests/", "").gsub("_spec.rb", ".md")
+    pathname.parent.mkpath
+    pathname.open("w") do |file|
+      file << contexts.map {|context| Autodoc::Document.render(context) }.join("\n").rstrip + "\n"
+    end
+  end
+end

data/lib/autodoc/template.md.erb

@@ -0,0 +1,14 @@
+<%# coding: UTF-8 -%>
+## <%= method %> <%= path %>
+<%= description %>
+<%= parameters_section %>
+### request
+```
+<%= method %> <%= path %>
+```
+<%= request_body_section %>
+### response
+```ruby
+Status: <%= response_status %><%= response_headers %>
+response: <%= response_body %>
+```

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/dummy/doc/recipes.md

@@ -17,13 +17,14 @@ name=name&type=1
 ### response
 ```ruby
 Status: 201
+Location: http://www.example.com/recipes/1
 response: 
 {
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-10-22T22:41:07.886Z",
-  "updated_at": "2013-10-22T22:41:07.886Z"
+  "created_at": "2013-11-30T13:59:21.061Z",
+  "updated_at": "2013-11-30T13:59:21.061Z"
 }
 ```
 
@@ -47,13 +48,13 @@ name=name&type=1
 ### response
 ```ruby
 Status: 201
-location: http://example.org/recipes/1
+Location: http://example.org/recipes/1
 response: 
 {
   "id": 1,
   "name": "name",
   "type": 1,
-  "created_at": "2013-10-22T22:41:07.900Z",
-  "updated_at": "2013-10-22T22:41:07.900Z"
+  "created_at": "2013-11-30T13:59:21.072Z",
+  "updated_at": "2013-11-30T13:59:21.072Z"
 }
 ```

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,12 +109,11 @@ files:
 - Rakefile
 - autodoc.gemspec
 - lib/autodoc.rb
-- lib/autodoc/collector.rb
 - lib/autodoc/configuration.rb
 - lib/autodoc/document.rb
-- lib/autodoc/transaction.rb
+- lib/autodoc/rspec.rb
+- lib/autodoc/template.md.erb
 - 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
@@ -164,7 +177,6 @@ signing_key:
 specification_version: 4
 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
@@ -203,3 +215,4 @@ test_files:
 - spec/dummy/script/rails
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/autodoc/collector.rb

@@ -1,11 +0,0 @@
-module Autodoc
-  class Collector
-    def collect(example, txn)
-      documents[example.file_path] << Autodoc::Document.render(example, txn)
-    end
-
-    def documents
-      @documents ||= Hash.new {|hash, key| hash[key] = [] }
-    end
-  end
-end

data/lib/autodoc/transaction.rb

@@ -1,45 +0,0 @@
-module Autodoc
-  class Transaction
-    def self.build(context)
-      if defined?(Rack::Test::Methods) && context.class.ancestors.include?(Rack::Test::Methods)
-        self.new(ActionDispatch::Request.new(context.last_request.env), context.last_response)
-      else
-        self.new(context.request, context.response)
-      end
-    end
-
-    attr_accessor :request, :response
-
-    def initialize(*args)
-      @request, @response = *args
-    end
-
-    def method
-      request.method
-    end
-
-    def request_body
-      request.body.string
-    end
-
-    def response_status
-      response.status
-    end
-
-    def response_header(header)
-      response.headers[header]
-    end
-
-    def response_body_raw
-      response.body
-    end
-
-    def controller
-      request.params[:controller]
-    end
-
-    def action
-      request.params[:action]
-    end
-  end
-end

data/spec/autodoc/document_spec.rb

@@ -1,124 +0,0 @@
-require "spec_helper"
-
-describe Autodoc::Document do
-  describe ".render" do
-    subject do
-      described_class.render(example, transaction)
-    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(:transaction) do
-      Autodoc::Transaction.new(request, response)
-    end
-
-    let(:method) do
-      "GET"
-    end
-
-    let(:path) do
-      "/recipes/1"
-    end
-
-    let(:response_body) do
-      { name: "recipe 1" }.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: 
-          {
-            "name": "recipe 1"
-          }
-          ```
-
-        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: 
-          {
-            "name": "recipe 1"
-          }
-          ```
-
-          ## GET /recipes/1
-          Returns a recipe.
-
-        EOF
-      end
-    end
-  end
-end