Skip to content

Commit

Permalink
Give more context on deprecation messages
Browse files Browse the repository at this point in the history
  • Loading branch information
@hugobarauna
hugobarauna committed Oct 18, 2013
1 parent 164042a commit 7bbb4c9
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 25 deletions.
26 changes: 19 additions & 7 deletions lib/rspec/matchers/built_in/have.rb
View file
Expand Up @@ -143,9 +143,21 @@ def print_deprecation_message(query_method)

deprecation_message = "the rspec-collection_matchers gem "
deprecation_message << "or replace your expectation with something like "
deprecation_message << "`expect(#{cardinality_expression(query_method)}).#{expectation_format_method} #{matcher_expression}`"
deprecation_message << "`expect(#{cardinality_expression(query_method)}).#{expectation_format_method} #{suggested_matcher_expression}`"

RSpec.deprecate("`#{matcher_method}`", :replacement => deprecation_message)
RSpec.deprecate("`#{expectation_expression(query_method)}`", :replacement => deprecation_message)
end

def expectation_expression(query_method)
if @negative_expectation
RSpec::Expectations::Syntax.negative_expression('your_object', original_matcher_expression)
else
RSpec::Expectations::Syntax.positive_expression('your_object', original_matcher_expression)
end
end

def original_matcher_expression
"#{matcher_method}(#{@expected}).#{@collection_name}"
end

def expectation_format_method
Expand All @@ -162,23 +174,23 @@ def cardinality_expression(query_method)
expression << String(query_method)
end

def matcher_expression
send("matcher_expression_for_#{@relativity}")
def suggested_matcher_expression
send("suggested_matcher_expression_for_#{@relativity}")
end

def matcher_expression_for_exactly
def suggested_matcher_expression_for_exactly
"eq(#{@expected})"
end

def matcher_expression_for_at_most
def suggested_matcher_expression_for_at_most
if @negative_expectation
"be > #{@expected}"
else
"be <= #{@expected}"
end
end

def matcher_expression_for_at_least
def suggested_matcher_expression_for_at_least
if @negative_expectation
"be < #{@expected}"
else
Expand Down
78 changes: 60 additions & 18 deletions spec/rspec/matchers/have_spec.rb
View file
Expand Up @@ -464,21 +464,25 @@ def array.send; :sent; end

context "when the target is a collection" do
it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have(3).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to eq(3)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to have(3).items
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have(4).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to_not eq(4)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to_not have(4).items
end
Expand All @@ -494,22 +498,26 @@ def initialize(words)
end

it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have(3).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to eq(3)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to have(3).words
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have(4).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to_not eq(4)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to_not have(4).words
Expand All @@ -519,22 +527,28 @@ def initialize(words)
context "when the target is an enumerator" do
it "prints a specific message for the positive expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).to have(3).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to eq(3)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to have(3).letters
end

it "prints a specific message for the negative expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).not_to have(4).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to_not eq(4)`"

expect(RSpec).to receive(:deprecate).with("`have`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to_not have(4).letters
end
Expand All @@ -552,21 +566,25 @@ def initialize(words)

context "when the target is a collection" do
it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have_at_most(3).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to be <= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to have_at_most(3).items
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have_at_most(2).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to be > 2`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to_not have_at_most(2).items
end
Expand All @@ -582,22 +600,26 @@ def initialize(words)
end

it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have_at_most(3).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to be <= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to have_at_most(3).words
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have_at_most(2).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to be > 2`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to_not have_at_most(2).words
Expand All @@ -607,22 +629,28 @@ def initialize(words)
context "when the target is an enumerator" do
it "prints a specific message for the positive expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).to have_at_most(3).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to be <= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to have_at_most(3).letters
end

it "prints a specific message for the negative expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).not_to have_at_most(2).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to be > 2`"

expect(RSpec).to receive(:deprecate).with("`have_at_most`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to_not have_at_most(2).letters
end
Expand All @@ -640,21 +668,25 @@ def initialize(words)

context "when the target is a collection" do
it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have_at_least(3).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to be >= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to have_at_least(3).items
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have_at_least(4).items"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.size).to be < 4`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect([1, 2, 3]).to_not have_at_least(4).items
end
Expand All @@ -670,22 +702,26 @@ def initialize(words)
end

it "prints a specific message for the positive expectation format" do
expectation_expression = "expect(your_object).to have_at_least(3).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to be >= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to have_at_least(3).words
end

it "prints a specific message for the negative expectation format" do
expectation_expression = "expect(your_object).not_to have_at_least(4).words"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.words.size).to be < 4`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

target = BagOfWords.new(%w[foo bar baz])
expect(target).to_not have_at_least(4).words
Expand All @@ -695,22 +731,28 @@ def initialize(words)
context "when the target is an enumerator" do
it "prints a specific message for the positive expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).to have_at_least(3).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to be >= 3`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to have_at_least(3).letters
end

it "prints a specific message for the negative expectation format" do
target = %w[a b c].to_enum(:each)

expectation_expression = "expect(your_object).not_to have_at_least(4).letters"

message = "the rspec-collection_matchers gem " +
"or replace your expectation with something like " +
"`expect(your_object.count).to be < 4`"

expect(RSpec).to receive(:deprecate).with("`have_at_least`", :replacement => message)
expect(RSpec).to receive(:deprecate).with("`#{expectation_expression}`", :replacement => message)

expect(target).to_not have_at_least(4).letters
end
Expand Down

0 comments on commit 7bbb4c9

Please sign in to comment.