autodoc 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef275eb78df3509c88876a0bd109e7f89643de23
-  data.tar.gz: db8b38671a7ed14cbb5532ef66e3a1d87b4822a3
+  metadata.gz: 4091505d95ad9fee545f12914131cc4ffb5d0bb8
+  data.tar.gz: 4d2ee5af70e47de188b1f1cda129a729124b7f87
 SHA512:
-  metadata.gz: a2d471b8f401d03dd2a98535332168676ed7cdfa5c1fc88ee2da088e8e36fe2dbc6235fe19187f6ee9f804046ff9850f29798195df6de4f7a544dd88f64fba91
-  data.tar.gz: fa592e835e2846134d5223b1911872dcb46485a7f30c56e986c90e36ec87c5abf81da18ea61db91730f4dee92bd7c5d1b0da53fad5976d288658aecf51748956
+  metadata.gz: 14b86765ab33b40aabcc5b0626d6cdd3bf787d09ef867aecbca2ca992a8a4daa350d59442cbf0af3e75303e215d794a28441aee077278c177740d698c7eb19e9
+  data.tar.gz: ad652164ef57957aeff23ac715879d688a7cf3c73a11c891ee93bf8a265764a7019221e9ca921a323fab2b5d04332bc2ec2476b320972abb3ba876868bb7097d

data/Gemfile

@@ -6,4 +6,6 @@ group :test do
   gem "pry-rails"
   gem "rspec-rails"
   gem "weak_parameters"
+  gem "protected_attributes"
+  gem "rack-test"
 end

data/lib/autodoc.rb

@@ -1,6 +1,7 @@
 require "autodoc/collector"
 require "autodoc/configuration"
 require "autodoc/document"
+require "autodoc/transaction"
 require "autodoc/version"
 
 module Autodoc
@@ -19,7 +20,8 @@ if ENV["AUTODOC"] && defined?(RSpec)
   RSpec.configure do |config|
     config.after(:each, type: :request) do
       if example.metadata[:autodoc]
-        Autodoc.collector.collect(example, request, response)
+        txn = Autodoc::Transaction.build(self)
+        Autodoc.collector.collect(example, txn)
       end
     end
 

data/lib/autodoc/collector.rb

@@ -1,7 +1,7 @@
 module Autodoc
   class Collector
-    def collect(example, request, response)
-      documents[example.file_path] << Autodoc::Document.render(example, request, response)
+    def collect(example, txn)
+      documents[example.file_path] << Autodoc::Document.render(example, txn)
     end
 
     def documents

data/lib/autodoc/document.rb

@@ -7,10 +7,13 @@ module Autodoc
       new(*args).render
     end
 
-    attr_reader :example, :request, :response
+    attr_reader :example, :transaction
 
-    def initialize(example, request, response)
-      @example, @request, @response = example, request, response
+    delegate :method, :request_body, :response_status, :response_header, :response_body_raw, :controller, :action,
+      to: :transaction
+
+    def initialize(example, txn)
+      @example, @transaction = example, txn
     end
 
     def render
@@ -23,16 +26,12 @@ module Autodoc
       "#{example.description.capitalize}."
     end
 
-    def method
-      request.method
-    end
-
     def path
       example.full_description[%r<(GET|POST|PUT|DELETE) ([^ ]+)>, 2]
     end
 
     def response_body
-      "\n" + JSON.pretty_generate(JSON.parse(response.body))
+      "\n" + JSON.pretty_generate(JSON.parse(response_body_raw))
     rescue JSON::ParserError
     end
 
@@ -48,18 +47,10 @@ module Autodoc
       end
     end
 
-    def response_status
-      response.status
-    end
-
     def parameters
       validators.map {|validator| Parameter.new(validator) }.join("\n")
     end
 
-    def request_body
-      request.body.string
-    end
-
     def has_request_body?
       request_body.present?
     end
@@ -69,12 +60,12 @@ module Autodoc
     end
 
     def validators
-      WeakParameters.stats[request.params[:controller]][request.params[:action]].try(:validators)
+      WeakParameters.stats[controller][action].try(:validators)
     end
 
     def response_headers
       Autodoc.configuration.headers.map do |header|
-        "\n#{header}: #{response.headers[header]}" if response.headers[header]
+        "\n#{header}: #{response_header(header)}" if response_header(header)
       end.compact.join
     end
 

data/lib/autodoc/transaction.rb

@@ -0,0 +1,45 @@
+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/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/autodoc/document_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Autodoc::Document do
   describe ".render" do
     subject do
-      described_class.render(example, request, response)
+      described_class.render(example, transaction)
     end
 
     let(:example) do
@@ -34,6 +34,10 @@ describe Autodoc::Document do
       )
     end
 
+    let(:transaction) do
+      Autodoc::Transaction.new(request, response)
+    end
+
     let(:method) do
       "GET"
     end

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -1,7 +1,7 @@
 class RecipesController < ApplicationController
   validates :create do
     string :name, required: true, except: %w[alice bob]
-    integer :type, only: "1".."3"
+    integer :type, only: 1..3
   end
 
   def show

data/spec/dummy/app/models/recipe.rb

@@ -1,3 +1,4 @@
 class Recipe < ActiveRecord::Base
   attr_accessible :name, :type
+  self.inheritance_column = :_type
 end

data/spec/dummy/config/application.rb

@@ -1,12 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
-# Pick the frameworks you want:
 require "active_record/railtie"
 require "action_controller/railtie"
-require "action_mailer/railtie"
-require "active_resource/railtie"
-require "sprockets/railtie"
-# require "rails/test_unit/railtie"
 
 Bundler.require(*Rails.groups)
 require "autodoc"
@@ -55,9 +50,6 @@ module Dummy
     # parameters by using an attr_accessible or attr_protected declaration.
     config.active_record.whitelist_attributes = true
 
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
   end

data/spec/dummy/config/environments/development.rb

@@ -6,9 +6,6 @@ Dummy::Application.configure do
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -19,19 +16,6 @@ Dummy::Application.configure do
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-
-  # Do not compress assets
-  config.assets.compress = false
-
   # Expands the lines which load the assets
   config.assets.debug = true
 end

data/spec/dummy/config/environments/production.rb

@@ -64,4 +64,8 @@ Dummy::Application.configure do
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
   # config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  config.eager_load = true
+
+  config.assets.js_compressor = :uglifier
 end

data/spec/dummy/config/environments/test.rb

@@ -11,9 +11,6 @@ Dummy::Application.configure do
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
-
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -24,14 +21,8 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
-
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  config.eager_load = false
 end

data/spec/dummy/config/initializers/secret_token.rb

@@ -5,3 +5,4 @@
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
 Dummy::Application.config.secret_token = '2da8e59639e7c92b0da46798ed97a45be5834c72cdd9a4ad141dadc5b1175f991b05ef02dde00f9c27cadb3790311e642010b89ed1dad598539980a1ae88be61'
+Dummy::Application.config.secret_key_base = '7bea42a7812ad8da2fa753be701ed39a8b35f014c0cfcc876ad08180f2b25504e67ed24fc4470c51b229bbbc4731454c912e4609902e1c0bba65fb86037f7f1a'

data/spec/dummy/doc/recipes.md

@@ -3,7 +3,7 @@ Creates a new recipe.
 
 ### parameters
 * `name` string (required, except: `["alice", "bob"]`)
-* `type` integer (only: `"1".."3"`)
+* `type` integer (only: `1..3`)
 
 ### request
 ```
@@ -17,12 +17,43 @@ name=name&type=1
 ### response
 ```ruby
 Status: 201
-location: http://www.example.com/recipes/1
 response: 
 {
-  "created_at": "2013-10-08T07:24:05Z",
   "id": 1,
   "name": "name",
-  "updated_at": "2013-10-08T07:24:05Z"
+  "type": 1,
+  "created_at": "2013-10-22T22:41:07.886Z",
+  "updated_at": "2013-10-22T22:41:07.886Z"
+}
+```
+
+
+## POST /recipes
+Creates a new recipe.
+
+### parameters
+* `name` string (required, except: `["alice", "bob"]`)
+* `type` integer (only: `1..3`)
+
+### request
+```
+POST /recipes
+```
+
+```
+name=name&type=1
+```
+
+### response
+```ruby
+Status: 201
+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"
 }
 ```

data/spec/requests/recipes_spec.rb

@@ -52,5 +52,17 @@ 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.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -111,6 +111,7 @@ files:
 - lib/autodoc/collector.rb
 - lib/autodoc/configuration.rb
 - lib/autodoc/document.rb
+- lib/autodoc/transaction.rb
 - lib/autodoc/version.rb
 - spec/autodoc/document_spec.rb
 - spec/dummy/Rakefile