Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

! Fix class including a module with Memoizable raises error #62

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
25 changes: 21 additions & 4 deletions lib/dry/core/memoizable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,30 @@ def new(*)
end
end

def self.included(klass)
def self.included(base)
super

if klass <= Object
klass.extend(ClassInterface::Object)
setup_base(base)
end

# @api private
def self.setup_base(base)
if base <= Object
base.extend(ClassInterface::Object)
else
klass.extend(ClassInterface::BasicObject)
base.extend(ClassInterface::BasicObject)
end

# Ensures a module included by another class/module still works
# e.g. rails concern module pattern
if base.is_a?(Module) && !base.is_a?(Class)
# Use `append_featured` to avoid commonly used `included` overriding
# Causing the setup to be skipped
def base.append_features(base)
super

Dry::Core::Memoizable.setup_base(base)
end
end
end

Expand Down
210 changes: 154 additions & 56 deletions spec/dry/core/memoizable_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -124,86 +124,184 @@ def initialize(*args, **kwargs, &block)
end

context "test calls" do
let(:klass) { Class.new.include(Dry::Core::Memoizable) }
context "a class including memoizable directly" do
let(:klass) { Class.new.include(Dry::Core::Memoizable) }

let(:instance) { klass.new }
let(:instance) { klass.new }

let(:counter) { Concurrent::AtomicFixnum.new }
let(:counter) { Concurrent::AtomicFixnum.new }

context "no args" do
before do
counter = self.counter
klass.define_method(:meth) { counter.increment }
klass.memoize(:meth)
context "no args" do
before do
counter = self.counter
klass.define_method(:meth) { counter.increment }
klass.memoize(:meth)
end

it "gets called only once" do
instance.meth
instance.meth
instance.meth

expect(counter.value).to eql(1)
end
end

it "gets called only once" do
instance.meth
instance.meth
instance.meth
context "pos arg" do
before do
counter = self.counter
klass.define_method(:meth) { |req| counter.increment }
klass.memoize(:meth)
end

it "memoizes results" do
instance.meth(1)
instance.meth(1)
instance.meth(2)
instance.meth(2)

expect(counter.value).to eql(1)
expect(counter.value).to eql(2)
end
end
end

context "pos arg" do
before do
counter = self.counter
klass.define_method(:meth) { |req| counter.increment }
klass.memoize(:meth)
context "splat" do
before do
counter = self.counter
klass.define_method(:meth) { |v, *args| counter.increment }
klass.memoize(:meth)
end

it "memoizes results" do
instance.meth(1)
instance.meth(1)
expect(counter.value).to eql(1)

instance.meth(1, 2)
instance.meth(1, 2)
expect(counter.value).to eql(2)

instance.meth(1, 2, 3)
instance.meth(1, 2, 3)
expect(counter.value).to eql(3)
end
end

it "memoizes results" do
instance.meth(1)
instance.meth(1)
instance.meth(2)
instance.meth(2)
context "**kwargs" do
before do
counter = self.counter
klass.define_method(:meth) { |foo:, **kwargs| counter.increment }
klass.memoize(:meth)
end

it "memoizes results" do
instance.meth(foo: 1)
instance.meth(foo: 1)
expect(counter.value).to eql(1)

expect(counter.value).to eql(2)
instance.meth(foo: 1, bar: 2)
instance.meth(foo: 1, bar: 2)
expect(counter.value).to eql(2)

instance.meth(foo: 1, baz: 2)
instance.meth(foo: 1, baz: 2)
expect(counter.value).to eql(3)
end
end
end

context "splat" do
before do
counter = self.counter
klass.define_method(:meth) { |v, *args| counter.increment }
klass.memoize(:meth)
context "a class including a module including memoizable" do
let(:m0dule) do
Module.new.tap do |module_in_tap|
module_in_tap.include(Dry::Core::Memoizable)

# This will potentially prevent class/module including this module
# from setting up memoizable properly
def module_in_tap.included(_base)
super
end
end
end
let(:klass) { Class.new.include(m0dule) }

it "memoizes results" do
instance.meth(1)
instance.meth(1)
expect(counter.value).to eql(1)
let(:instance) { klass.new }

instance.meth(1, 2)
instance.meth(1, 2)
expect(counter.value).to eql(2)
let(:counter) { Concurrent::AtomicFixnum.new }

instance.meth(1, 2, 3)
instance.meth(1, 2, 3)
expect(counter.value).to eql(3)
context "no args" do
before do
counter = self.counter
m0dule.define_method(:meth) { counter.increment }
m0dule.memoize(:meth)
end

it "gets called only once" do
instance.meth
instance.meth
instance.meth

expect(counter.value).to eql(1)
end
end
end

context "**kwargs" do
before do
counter = self.counter
klass.define_method(:meth) { |foo:, **kwargs| counter.increment }
klass.memoize(:meth)
context "pos arg" do
before do
counter = self.counter
m0dule.define_method(:meth) { |req| counter.increment }
m0dule.memoize(:meth)
end

it "memoizes results" do
instance.meth(1)
instance.meth(1)
instance.meth(2)
instance.meth(2)

expect(counter.value).to eql(2)
end
end

it "memoizes results" do
instance.meth(foo: 1)
instance.meth(foo: 1)
expect(counter.value).to eql(1)
context "splat" do
before do
counter = self.counter
m0dule.define_method(:meth) { |v, *args| counter.increment }
m0dule.memoize(:meth)
end

instance.meth(foo: 1, bar: 2)
instance.meth(foo: 1, bar: 2)
expect(counter.value).to eql(2)
it "memoizes results" do
instance.meth(1)
instance.meth(1)
expect(counter.value).to eql(1)

instance.meth(foo: 1, baz: 2)
instance.meth(foo: 1, baz: 2)
expect(counter.value).to eql(3)
instance.meth(1, 2)
instance.meth(1, 2)
expect(counter.value).to eql(2)

instance.meth(1, 2, 3)
instance.meth(1, 2, 3)
expect(counter.value).to eql(3)
end
end

context "**kwargs" do
before do
counter = self.counter
m0dule.define_method(:meth) { |foo:, **kwargs| counter.increment }
m0dule.memoize(:meth)
end

it "memoizes results" do
instance.meth(foo: 1)
instance.meth(foo: 1)
expect(counter.value).to eql(1)

instance.meth(foo: 1, bar: 2)
instance.meth(foo: 1, bar: 2)
expect(counter.value).to eql(2)

instance.meth(foo: 1, baz: 2)
instance.meth(foo: 1, baz: 2)
expect(counter.value).to eql(3)
end
end
end
end
Expand Down