Remove deprecation warnings

Author: oestrich

Gemfile.lock

@@ -6,7 +6,7 @@ PATH
       i18n (>= 0.1.0)
       json (>= 1.4.6)
       mustache (>= 0.99.4)
-      rspec (~> 2.99.0.rc1)
+      rspec (~> 3.0.0.rc1)
 
 GEM
   remote: http://rubygems.org/
@@ -80,17 +80,21 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.1.0)
-    rspec (2.99.0.rc1)
-      rspec-core (= 2.99.0.rc1)
-      rspec-expectations (= 2.99.0.rc1)
-      rspec-mocks (= 2.99.0.rc1)
-    rspec-core (2.99.0.rc1)
-    rspec-expectations (2.99.0.rc1)
-      diff-lcs (>= 1.1.3, < 2.0)
+    rspec (3.0.0.rc1)
+      rspec-core (= 3.0.0.rc1)
+      rspec-expectations (= 3.0.0.rc1)
+      rspec-mocks (= 3.0.0.rc1)
+    rspec-core (3.0.0.rc1)
+      rspec-support (= 3.0.0.rc1)
+    rspec-expectations (3.0.0.rc1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.0.0.rc1)
     rspec-its (1.0.1)
       rspec-core (>= 2.99.0.beta1)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-mocks (2.99.0.rc1)
+    rspec-mocks (3.0.0.rc1)
+      rspec-support (= 3.0.0.rc1)
+    rspec-support (3.0.0.rc1)
     safe_yaml (0.9.7)
     sinatra (1.4.4)
       rack (~> 1.4)

lib/rspec_api_documentation/api_formatter.rb

@@ -2,43 +2,39 @@
 
 module RspecApiDocumentation
   class ApiFormatter < RSpec::Core::Formatters::BaseTextFormatter
+    RSpec::Core::Formatters.register self, :example_passed, :example_failed, :stop
+
     def initialize(output)
       super
 
       output.puts "Generating API Docs"
     end
 
-    def start(example_count)
+    def start(notification)
       super
 
       RspecApiDocumentation.documentations.each(&:clear_docs)
     end
 
-    def example_group_started(example_group)
+    def example_group_started(notification)
       super
 
-      output.puts "  #{example_group.description}"
+      output.puts "  #{@example_group.description}"
     end
 
-    def example_passed(example)
-      super
-
-      output.puts "    * #{example.description}"
+    def example_passed(example_notification)
+      output.puts "    * #{example_notification.example.description}"
 
       RspecApiDocumentation.documentations.each do |documentation|
-        documentation.document_example(example)
+        documentation.document_example(example_notification.example)
       end
     end
 
-    def example_failed(example)
-      super
-
-      output.puts "    ! #{example.description} (FAILED)"
+    def example_failed(example_notification)
+      output.puts "    ! #{example_notification.example.description} (FAILED)"
     end
 
     def stop
-      super
-
       RspecApiDocumentation.documentations.each(&:write)
     end
   end

lib/rspec_api_documentation/dsl/endpoint.rb

@@ -12,12 +12,7 @@ module Endpoint
 
     module ClassMethods
       def example_request(description, params = {}, &block)
-        file_path = caller.first[0, caller.first =~ /:/]
-
-        location = caller.first[0, caller.first =~ /(:in|$)/]
-        location = relative_path(location)
-
-        example description, :location => location, :file_path => file_path do
+        example description do
           do_request(params)
           instance_eval &block if block_given?
         end

rspec_api_documentation.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_runtime_dependency "rspec", "~> 2.99.0.rc1"
+  s.add_runtime_dependency "rspec", "~> 3.0.0.rc1"
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "i18n", ">= 0.1.0"
   s.add_runtime_dependency "mustache", ">= 0.99.4"

spec/api_documentation_spec.rb

@@ -15,11 +15,11 @@
       test_file = configuration.docs_dir.join("test")
       FileUtils.mkdir_p configuration.docs_dir
       FileUtils.touch test_file
-      FileUtils.stub(:cp_r)
+      allow(FileUtils).to receive(:cp_r)
       subject.clear_docs
 
-      File.directory?(configuration.docs_dir).should be_truthy
-      File.exists?(test_file).should be_falsey
+      expect(File.directory?(configuration.docs_dir)).to be_truthy
+      expect(File.exists?(test_file)).to be_falsey
     end
   end
 
@@ -30,29 +30,29 @@
     let!(:wrapped_example) { RspecApiDocumentation::Example.new(example, configuration) }
 
     before do
-      RspecApiDocumentation::Example.stub(:new).and_return(wrapped_example)
+      allow(RspecApiDocumentation::Example).to receive(:new).and_return(wrapped_example)
     end
 
     it "should create a new wrapped example" do
-      RspecApiDocumentation::Example.should_receive(:new).with(example, configuration).and_return(wrapped_example)
+      expect(RspecApiDocumentation::Example).to receive(:new).with(example, configuration).and_return(wrapped_example)
       documentation.document_example(example)
     end
 
     context "when the given example should be documented" do
-      before { wrapped_example.stub(:should_document?).and_return(true) }
+      before { allow(wrapped_example).to receive(:should_document?).and_return(true) }
 
       it "should add the wrapped example to the index" do
         documentation.document_example(example)
-        documentation.index.examples.should eq([wrapped_example])
+        expect(documentation.index.examples).to eq([wrapped_example])
       end
     end
 
     context "when the given example should not be documented" do
-      before { wrapped_example.stub(:should_document?).and_return(false) }
+      before { allow(wrapped_example).to receive(:should_document?).and_return(false) }
 
       it "should not add the wrapped example to the index" do
         documentation.document_example(example)
-        documentation.index.examples.should be_empty
+        expect(documentation.index.examples).to be_empty
       end
     end
   end
@@ -68,8 +68,9 @@ class RspecApiDocumentation::Writers::TextileWriter; end
       end
 
       it "should return the classes from format" do
-        subject.writers.should == [RspecApiDocumentation::Writers::HtmlWriter, RspecApiDocumentation::Writers::JsonWriter,
-                                   RspecApiDocumentation::Writers::TextileWriter]
+        expect(subject.writers).to eq([RspecApiDocumentation::Writers::HtmlWriter,
+                                       RspecApiDocumentation::Writers::JsonWriter,
+                                       RspecApiDocumentation::Writers::TextileWriter])
       end
     end
 
@@ -79,7 +80,7 @@ class RspecApiDocumentation::Writers::TextileWriter; end
       end
 
       it "should return the classes from format" do
-        subject.writers.should == [RspecApiDocumentation::Writers::HtmlWriter]
+        expect(subject.writers).to eq([RspecApiDocumentation::Writers::HtmlWriter])
       end
     end
   end
@@ -90,13 +91,13 @@ class RspecApiDocumentation::Writers::TextileWriter; end
     let(:textile_writer) { double(:textile_writer) }
 
     before do
-      subject.stub(:writers => [html_writer, json_writer, textile_writer])
+      allow(subject).to receive(:writers).and_return([html_writer, json_writer, textile_writer])
     end
 
     it "should write the docs in each format" do
-      html_writer.should_receive(:write).with(subject.index, configuration)
-      json_writer.should_receive(:write).with(subject.index, configuration)
-      textile_writer.should_receive(:write).with(subject.index, configuration)
+      expect(html_writer).to receive(:write).with(subject.index, configuration)
+      expect(json_writer).to receive(:write).with(subject.index, configuration)
+      expect(textile_writer).to receive(:write).with(subject.index, configuration)
       subject.write
     end
   end

spec/api_formatter_spec.rb

@@ -11,45 +11,47 @@
 
     before do
       RspecApiDocumentation.documentations.each do |configuration|
-        configuration.stub(
-          :clear_docs => nil,
-          :document_example => nil,
-          :write => nil
-        )
+        allow(configuration).to receive(:clear_docs)
+        allow(configuration).to receive(:document_example)
+        allow(configuration).to receive(:write)
       end
     end
 
     it "should clear all docs on start" do
       RspecApiDocumentation.documentations.each do |configuration|
-        configuration.should_receive(:clear_docs)
+        expect(configuration).to receive(:clear_docs)
       end
 
-      formatter.start(0)
+      formatter.start(RSpec::Core::Notifications::StartNotification.new(0, 0))
     end
 
     it "should document passing examples" do
       example = group.example("Ordering a cup of coffee") {}
 
       RspecApiDocumentation.documentations.each do |configuration|
-        configuration.should_receive(:document_example).with(example)
+        expect(configuration).to receive(:document_example).with(example)
       end
 
-      formatter.example_passed(example)
+      formatter.example_passed(RSpec::Core::Notifications::ExampleNotification.for(example))
     end
 
     it "should write the docs on stop" do
       RspecApiDocumentation.documentations.each do |configuration|
-        configuration.should_receive(:write)
+        expect(configuration).to receive(:write)
       end
 
       formatter.stop
     end
   end
 
   describe "output" do
+    let(:reporter) { RSpec::Core::Reporter.new(RSpec::Core::Configuration.new) }
+
     before do
       # don't do any work
-      RspecApiDocumentation.stub(:documentations).and_return([])
+      allow(RspecApiDocumentation).to receive(:documentations).and_return([])
+
+      reporter.register_listener formatter, :start, :example_group_started, :example_passed, :example_failed, :stop
     end
 
     context "with passing examples" do
@@ -60,8 +62,8 @@
       end
 
       it "should list the generated docs" do
-        group.run(formatter)
-        output.string.split($/).should eq([
+        group.run(reporter)
+        expect(output.string.split($/)).to eq([
           "Generating API Docs",
           "  Orders",
           "    * Ordering a cup of coffee",
@@ -74,13 +76,13 @@
     context "with failing examples" do
       before do
         group.example("Ordering a cup of coffee") {}
-        group.example("Updating an order") { true.should eq(false) }
-        group.example("Viewing an order") { true.should eq(false) }
+        group.example("Updating an order") { expect(true).to eq(false) }
+        group.example("Viewing an order") { expect(true).to eq(false) }
       end
 
       it "should indicate failures" do
-        group.run(formatter)
-        output.string.split($/).should eq([
+        group.run(reporter)
+        expect(output.string.split($/)).to eq([
           "Generating API Docs",
           "  Orders",
           "    * Ordering a cup of coffee",

spec/configuration_spec.rb

@@ -13,18 +13,18 @@
   describe ".add_setting" do
     it 'should allow creating a new setting' do
       RspecApiDocumentation::Configuration.add_setting :new_setting
-      configuration.should respond_to(:new_setting)
-      configuration.should respond_to(:new_setting=)
+      expect(configuration).to respond_to(:new_setting)
+      expect(configuration).to respond_to(:new_setting=)
     end
 
     it 'should allow setting a default' do
       RspecApiDocumentation::Configuration.add_setting :new_setting, :default => "default"
-      configuration.new_setting.should == "default"
+      expect(configuration.new_setting).to eq("default")
     end
 
     it "should allow the default setting to be a lambda" do
       RspecApiDocumentation::Configuration.add_setting :another_setting, :default => lambda { |config| config.new_setting }
-      configuration.another_setting.should == "default"
+      expect(configuration.another_setting).to eq("default")
     end
   end
 
@@ -62,37 +62,37 @@
     it "should take a block" do
       called = false
       subject.define_group(:foo) { called = true }
-      called.should eq(true)
+      expect(called).to eq(true)
     end
 
     it "should yield a sub-configuration" do
       subject.define_group(:foo) do |config|
-        config.should be_a(described_class)
-        config.parent.should equal(subject)
+        expect(config).to be_a(described_class)
+        expect(config.parent).to equal(subject)
       end
     end
 
     it "should set the sub-configuration filter" do
       subject.define_group(:foo) do |config|
-        config.filter.should eq(:foo)
+        expect(config.filter).to eq(:foo)
       end
     end
 
     it "should inherit its parents configurations" do
       subject.format = :json
       subject.define_group(:sub) do |config|
-        config.format.should == :json
+        expect(config.format).to eq(:json)
       end
     end
 
     it "should scope the documentation directory" do
       subject.define_group(:sub) do |config|
-        config.docs_dir.should == subject.docs_dir.join('sub')
+        expect(config.docs_dir).to eq(subject.docs_dir.join('sub'))
       end
     end
   end
 
-  it { should be_a(Enumerable) }
+  it { expect(subject).to be_a(Enumerable) }
 
   it "should enumerate through recursively and include self" do
     configs = [subject]
@@ -105,7 +105,7 @@
         end
       end
     end
-    subject.to_a.should eq(configs)
+    expect(subject.to_a).to eq(configs)
   end
 
   describe "#groups" do