Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Pull refactored memoized helpers into 2.99 #939

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
### Dev

Enhancements

* Clean up some internal use of Enumerable methods. (Vipul A M)

Bug fixes

* Refactor memoized helpers (let, subject, named subject) to use an internalised
method name to avoid conflict with outside methods. Avoids complex ordering
issues with `LetDefinitions` module. See #908 #817 #871 rspec/rspec-rails#738 .
(Andy Lindeman, Jon Rowe)

### 2.14.0.rc1 / 2013-05-27
[full changelog](http://github.com/rspec/rspec-core/compare/v2.13.1...v2.14.0.rc1)

Expand Down
41 changes: 29 additions & 12 deletions lib/rspec/core/memoized_helpers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -190,16 +190,12 @@ module ClassMethods
# end
# end
def let(name, &block)
# We have to pass the block directly to `define_method` to
# allow it to use method constructs like `super` and `return`.
raise "#let or #subject called without a block" if block.nil?
MemoizedHelpers.module_for(self).send(:define_method, name, &block)

# Apply the memoization. The method has been defined in an ancestor
# module so we can use `super` here to get the value.
define_method(name) do
__memoized.fetch(name) { |k| __memoized[k] = super(&nil) }
end
MemoizedHelpers.define_memoized_method(
self,
name,
MemoizedHelpers.memoized_method_name_for(name, 'let'),
&block
)
end

# Just like `let`, except the block is invoked by an implicit `before`
Expand Down Expand Up @@ -291,10 +287,11 @@ def let!(name, &block)
# @see MemoizedHelpers#should
def subject(name=nil, &block)
if name
let(name, &block)
subject_method_name = MemoizedHelpers.memoized_method_name_for(name, "subject")
MemoizedHelpers.define_memoized_method(self, name, subject_method_name, &block)
alias_method :subject, name

self::NamedSubjectPreventSuper.send(:define_method, name) do
self::NamedSubjectPreventSuper.__send__(:define_method, subject_method_name) do
raise NotImplementedError, "`super` in named subjects is not supported"
end
else
Expand Down Expand Up @@ -477,6 +474,26 @@ def self.module_for(example_group)
end
end

# @api private
def self.memoized_method_name_for(name, let_or_subject)
"__rspec_#{let_or_subject}_definition_#{name}"
end

# @api private
def self.define_memoized_method(example_group, name, memoized_method_name, &block)
raise "#let or #subject called without a block" if block.nil?

# We have to pass the block directly to `define_method` to
# allow it to use method constructs like `super` and `return`.
module_for(example_group).__send__(:define_method, memoized_method_name, &block)

# Apply the memoization. The method has been defined in an ancestor
# module so we can use the decorated name here to get the value.
example_group.__send__(:define_method, name) do
__memoized.fetch(name) { |k| __memoized[k] = send(memoized_method_name, &nil) }
end
end

if Module.method(:const_defined?).arity == 1 # for 1.8
# @api private
#
Expand Down
19 changes: 19 additions & 0 deletions spec/rspec/core/memoized_helpers_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,25 @@ def define_and_run_group
})
end
end

context "when included modules have hooks that define memoized helpers" do
it "allows memoized helpers to override methods in previously included modules" do
group = ExampleGroup.describe do
# this replicates the ordering scenario that breaks in #817
include Module.new {
def self.included(m); m.let(:unrelated) { :unrelated }; end
}

include Module.new {
def hello_message; "Hello from module"; end
}

let(:hello_message) { "Hello from let" }
end

expect(group.new.hello_message).to eq("Hello from let")
end
end
end

describe "#let!" do
Expand Down