autodoc 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1a3b176d6aa9f963f08ec8c08c31b339c155c5c
-  data.tar.gz: 6f06ff04224ea790295f69bf40032856cd9f5b53
+  metadata.gz: f054c99b4001c7140761188519330f9171da9739
+  data.tar.gz: 8cb4384257257f9fc78c8ea102b85f49a6103143
 SHA512:
-  metadata.gz: 14f4de722da14a0c747ceb26e8ddbbfc3e22c521182f078440b6cd81d3056f96f5b168f18413fa882350fc36a935524bc1efa7305316cfaaddd10385ee497136
-  data.tar.gz: a2d4754f50257b51009047582fcbe101f71a799db5ba7c69c00fe102f03aaa8f145a98565404b495bc753da897a4af5701b8fdaa38c77fb2854b5cabd5b1db3b
+  metadata.gz: 104578c24c698cd2dcf4f43a04ea0228a74d922294febbf59b29aef717c65f942f892a3e90a9e972bb39b2dc9450dc286611e18fb358a0afc2624fced8fab3ba
+  data.tar.gz: 293abadf0e4ddf420ba2bd2447df878f8bccae1fd8817021f0c81961ac4eebe54fe5c2bc789e419bf834ec93cac9fb86c589f35021c8add616815b8177e9647d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.0
+* Support RSpec 3
+
 ## 0.3.6
 * Show dummy message if Content-Type might be BINARY
 

data/Gemfile

@@ -4,7 +4,11 @@ gemspec
 
 group :test do
   gem "pry-rails"
-  gem "rspec-rails"
+  if ENV['RSPEC2']
+    gem "rspec-rails", "~> 2.14.1"
+  else
+    gem "rspec-rails"
+  end
   gem "weak_parameters"
   gem "protected_attributes"
   gem "rack-test"

data/lib/autodoc/document.rb

@@ -11,13 +11,14 @@ module Autodoc
       new(*args).render
     end
 
-    def initialize(context)
+    def initialize(context, example)
       @context = context
+      @example = example
     end
 
     def pathname
       @path ||= begin
-        payload = @context.example.file_path.gsub(%r<\./spec/requests/(.+)_spec\.rb>, '\1.md')
+        payload = example.file_path.gsub(%r<\./spec/requests/(.+)_spec\.rb>, '\1.md')
         Autodoc.configuration.pathname + payload
       end
     end
@@ -36,6 +37,14 @@ module Autodoc
 
     private
 
+    def example
+      if ::RSpec::Core::Version::STRING.split('.').first == "3"
+        @example
+      else
+        @context.example
+      end
+    end
+
     def request
       @request ||= begin
         if using_rack_test?
@@ -176,12 +185,12 @@ module Autodoc
       if @context.respond_to?(:description)
         @context.description.strip_heredoc
       else
-        "#{@context.example.description.capitalize}."
+        "#{example.description.capitalize}."
       end
     end
 
     def path
-      @context.example.full_description[%r<(GET|POST|PATCH|PUT|DELETE) ([^ ]+)>, 2]
+      example.full_description[%r<(GET|POST|PATCH|PUT|DELETE) ([^ ]+)>, 2]
     end
 
     def parameters_section

data/lib/autodoc/documents.rb

@@ -6,8 +6,8 @@ module Autodoc
       @table = Hash.new {|table, key| table[key] = [] }
     end
 
-    def append(context)
-      document = Autodoc::Document.new(context.clone)
+    def append(context, example)
+      document = Autodoc::Document.new(context.clone, example.clone)
       @table[document.pathname] << document
     end
 

data/lib/autodoc/rspec.rb

@@ -1,7 +1,7 @@
 require "rspec"
 
-RSpec.configuration.after(:each, autodoc: true) do
-  Autodoc.documents.append(self)
+RSpec.configuration.after(:each, autodoc: true) do |example|
+  Autodoc.documents.append(self, example)
 end
 
 RSpec.configuration.after(:suite) do

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/spec/autodoc/documents_spec.rb

@@ -3,7 +3,11 @@ require "spec_helper"
 describe Autodoc::Documents do
   describe "#render_toc" do
     before do
-      documents.append(context)
+      if ::RSpec::Core::Version::STRING.split('.').first == "3"
+        documents.append(context, example)
+      else
+        documents.append(context, double)
+      end
     end
 
     let(:documents) do
@@ -11,8 +15,17 @@ describe Autodoc::Documents do
     end
 
     let(:context) do
-      mock = double(example: example, request: request)
-      mock.stub(clone: mock)
+      if ::RSpec::Core::Version::STRING.split('.').first == "3"
+        mock = double(example: example, request: request, file_path: file_path, full_description: full_description)
+      else
+        mock = double(example: example, request: request)
+      end
+
+      if ::RSpec::Core::Version::STRING.split('.').first == "3"
+        allow(mock).to receive_messages(clone: mock)
+      else
+        mock.stub(clone: mock)
+      end
       mock
     end
 
@@ -43,8 +56,8 @@ describe Autodoc::Documents do
 
       it "includes links to recipes.md" do
         toc = documents.send(:render_toc)
-        toc.should include("[recipes.md](recipes.md)")
-        toc.should include("[GET /recipes](recipes.md#get-recipes)")
+        expect(toc).to include("[recipes.md](recipes.md)")
+        expect(toc).to include("[GET /recipes](recipes.md#get-recipes)")
       end
     end
 
@@ -59,8 +72,8 @@ describe Autodoc::Documents do
 
       it "includes links to admin/recipes.md" do
         toc = documents.send(:render_toc)
-        toc.should include("[admin/recipes.md](admin/recipes.md)")
-        toc.should include("[GET /admin/recipes](admin/recipes.md#get-adminrecipes)")
+        expect(toc).to include("[admin/recipes.md](admin/recipes.md)")
+        expect(toc).to include("[GET /admin/recipes](admin/recipes.md#get-adminrecipes)")
       end
     end
   end

data/spec/dummy/db/schema.rb

@@ -9,15 +9,15 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130607075126) do
+ActiveRecord::Schema.define(version: 20130607075126) do
 
-  create_table "recipes", :force => true do |t|
+  create_table "recipes", force: true do |t|
     t.string   "name"
     t.integer  "type"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
 end

data/spec/requests/admin/entries_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "Admin::Entries" do
+describe "Admin::Entries", type: :request do
   include Rack::Test::Methods
 
   let(:env) do
@@ -29,10 +29,10 @@ describe "Admin::Entries" do
   end
 
   describe "GET /admin/entries" do
-    context "with Rack::Test", :autodoc do
+    context "with Rack::Test", autodoc: true do
       it "returns entries" do
         get "/admin/entries", params, env
-        last_response.status.should == 200
+        expect(last_response.status).to eq(200)
       end
     end
   end

data/spec/requests/entries_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "Entries" do
+describe "Entries", type: :request do
   include Rack::Test::Methods
 
   let(:env) do
@@ -29,10 +29,10 @@ describe "Entries" do
   end
 
   describe "GET /entries" do
-    context "with Rack::Test", :autodoc do
+    context "with Rack::Test", autodoc: true do
       it "returns entries" do
         get "/entries", params, env
-        last_response.status.should == 200
+        expect(last_response.status).to eq(200)
       end
     end
   end

data/spec/requests/recipes_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "Recipes" do
+describe "Recipes", type: :request do
   let(:env) do
     { "ACCEPT" => "application/json", "CONTENT_TYPE" => "application/json" }
   end
@@ -14,7 +14,7 @@ describe "Recipes" do
       Recipe.create(name: "test", type: 2)
     end
 
-    context "with valid condition (using Rack::Test)", :autodoc do
+    context "with valid condition (using Rack::Test)", autodoc: true do
       before do
         env["Content-Type"] = "application/json"
       end
@@ -23,7 +23,7 @@ describe "Recipes" do
 
       it "returns the recipe" do
         get "/recipes/#{recipe.id}", params, env
-        last_response.status.should == 200
+        expect(last_response.status).to eq(200)
       end
     end
   end
@@ -41,7 +41,7 @@ describe "Recipes" do
 
       it "returns 400" do
         post "/recipes", params.to_json, env
-        response.status.should == 400
+        expect(response.status).to eq(400)
       end
     end
 
@@ -52,7 +52,7 @@ describe "Recipes" do
 
       it "returns 400" do
         post "/recipes", params.to_json, env
-        response.status.should == 400
+        expect(response.status).to eq(400)
       end
     end
 
@@ -63,11 +63,11 @@ describe "Recipes" do
 
       it "creates a new recipe" do
         post "/recipes", params.to_json, env
-        response.status.should == 201
+        expect(response.status).to eq(201)
       end
     end
 
-    context "with valid condition", :autodoc do
+    context "with valid condition", autodoc: true do
       let(:description) do
         <<-EOS
           Creates
@@ -79,7 +79,7 @@ describe "Recipes" do
 
       it "creates a new recipe" do
         post "/recipes", params.to_json, env
-        response.status.should == 201
+        expect(response.status).to eq(201)
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 ENV["RAILS_ENV"] ||= "test"
 require File.expand_path("../../spec/dummy/config/environment", __FILE__)
 require "rspec/rails"
-require "rspec/autorun"
 
 Autodoc.configuration.toc = true
 Autodoc.configuration.path = "spec/dummy/doc"
@@ -16,6 +15,4 @@ RSpec.configure do |config|
   # automatically. This will be the default behavior in future versions of
   # rspec-rails.
   config.infer_base_class_for_anonymous_controllers = false
-
-  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport