1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
|
require File.expand_path('../test_helper', __FILE__)
require 'memoist'
class MemoistTest < Minitest::Test
class CallCounter
def initialize
@calls = {}
end
def call(method_name)
@calls[method_name] ||= 0
@calls[method_name] += 1
end
def count(method_name)
@calls[method_name] ||= 0
end
end
class Person
extend Memoist
def initialize
@counter = CallCounter.new
end
def name_calls
@counter.count(:name)
end
def student_name_calls
@counter.count(:student_name)
end
def name_query_calls
@counter.count(:name?)
end
def is_developer_calls
@counter.count(:is_developer?)
end
def age_calls
@counter.count(:age)
end
def name
@counter.call(:name)
'Josh'
end
def name?
@counter.call(:name?)
true
end
memoize :name?
def update(_name)
'Joshua'
end
memoize :update
def age
@counter.call(:age)
nil
end
memoize :name, :age
def age?
@counter.call(:age?)
true
end
memoize 'age?'
def sleep(hours = 8)
@counter.call(:sleep)
hours
end
memoize :sleep
def sleep_calls
@counter.count(:sleep)
end
def update_attributes(_options = {})
@counter.call(:update_attributes)
true
end
memoize :update_attributes
def update_attributes_calls
@counter.count(:update_attributes)
end
protected
def memoize_protected_test
'protected'
end
memoize :memoize_protected_test
private
def is_developer?
@counter.call(:is_developer?)
'Yes'
end
memoize :is_developer?
end
class Student < Person
def name
@counter.call(:student_name)
"Student #{super}"
end
memoize :name, identifier: :student
end
class Teacher < Person
def seniority
'very_senior'
end
memoize :seniority
end
class Company
attr_reader :name_calls
def initialize
@name_calls = 0
end
def name
@name_calls += 1
'37signals'
end
end
module Rates
extend Memoist
attr_reader :sales_tax_calls
def sales_tax(price)
@sales_tax_calls ||= 0
@sales_tax_calls += 1
price * 0.1025
end
memoize :sales_tax
end
class Calculator
extend Memoist
include Rates
attr_reader :fib_calls
def initialize
@fib_calls = 0
end
def fib(n)
@fib_calls += 1
if n == 0 || n == 1
n
else
fib(n - 1) + fib(n - 2)
end
end
memoize :fib
def add_or_subtract(i, j, add)
if add
i + j
else
i - j
end
end
memoize :add_or_subtract
def counter
@count ||= 0
@count += 1
end
memoize :counter
end
class Book
extend Memoist
STATUSES = %w[new used].freeze
CLASSIFICATION = %w[fiction nonfiction].freeze
GENRES = %w[humor romance reference sci-fi classic philosophy].freeze
attr_reader :title, :author
def initialize(title, author)
@title = title
@author = author
end
def full_title
"#{@title} by #{@author}"
end
memoize :full_title
class << self
extend Memoist
def all_types
STATUSES.product(CLASSIFICATION).product(GENRES).collect(&:flatten)
end
memoize :all_types
end
end
class Abb
extend Memoist
def run(*_args)
flush_cache if respond_to?(:flush_cache)
execute
end
def execute
some_method
end
def some_method
# Override this
end
end
class Bbb < Abb
def some_method
:foo
end
memoize :some_method
end
def setup
@person = Person.new
@calculator = Calculator.new
@book = Book.new('My Life', "Brian 'Fudge' Turmuck")
end
def test_memoization
assert_equal 'Josh', @person.name
assert_equal 1, @person.name_calls
3.times { assert_equal 'Josh', @person.name }
assert_equal 1, @person.name_calls
end
def test_memoize_with_optional_arguments
assert_equal 4, @person.sleep(4)
assert_equal 1, @person.sleep_calls
3.times { assert_equal 4, @person.sleep(4) }
assert_equal 1, @person.sleep_calls
3.times { assert_equal 4, @person.sleep(4, :reload) }
assert_equal 4, @person.sleep_calls
end
def test_memoize_with_options_hash
assert_equal true, @person.update_attributes(age: 21, name: 'James')
assert_equal 1, @person.update_attributes_calls
3.times { assert_equal true, @person.update_attributes(age: 21, name: 'James') }
assert_equal 1, @person.update_attributes_calls
3.times { assert_equal true, @person.update_attributes({ age: 21, name: 'James' }, :reload) }
assert_equal 4, @person.update_attributes_calls
end
def test_memoization_with_punctuation
assert_equal true, @person.name?
@person.memoize_all
@person.unmemoize_all
end
def test_memoization_when_memoize_is_called_with_punctuated_string
assert_equal true, @person.age?
@person.memoize_all
@person.unmemoize_all
end
def test_memoization_flush_with_punctuation
assert_equal true, @person.name?
@person.flush_cache(:name?)
3.times { assert_equal true, @person.name? }
assert_equal 2, @person.name_query_calls
end
def test_memoization_with_nil_value
assert_nil @person.age
assert_equal 1, @person.age_calls
3.times { assert_nil @person.age }
assert_equal 1, @person.age_calls
end
def test_reloadable
assert_equal 1, @calculator.counter
assert_equal 2, @calculator.counter(:reload)
assert_equal 2, @calculator.counter
assert_equal 3, @calculator.counter(true)
assert_equal 3, @calculator.counter
end
def test_flush_cache
assert_equal 1, @calculator.counter
assert @calculator.instance_variable_get(:@_memoized_counter)
@calculator.flush_cache(:counter)
assert_equal false, @calculator.instance_variable_defined?(:@_memoized_counter)
assert_equal 2, @calculator.counter
end
def test_class_flush_cache
@book.memoize_all
assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
Book.memoize_all
assert_instance_of Array, Book.instance_variable_get(:@_memoized_all_types)
Book.flush_cache
assert_equal false, Book.instance_variable_defined?(:@_memoized_all_types)
end
def test_class_flush_cache_preserves_instances
@book.memoize_all
Book.memoize_all
assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
Book.flush_cache
assert_equal false, Book.instance_variable_defined?(:@_memoized_all_types)
assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
end
def test_flush_cache_in_child_class
x = Bbb.new
# This should not throw error
x.run
end
def test_unmemoize_all
assert_equal 1, @calculator.counter
assert_equal true, @calculator.instance_variable_defined?(:@_memoized_counter)
assert @calculator.instance_variable_get(:@_memoized_counter)
@calculator.unmemoize_all
assert_equal false, @calculator.instance_variable_defined?(:@_memoized_counter)
assert_equal 2, @calculator.counter
end
def test_all_memoized_structs
# Person memoize :age, :age?, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
# Student < Person memoize :name, :identifier => :student
# Teacher < Person memoize :seniority
expected = %w[age age? is_developer? memoize_protected_test name name? sleep update update_attributes]
structs = Person.all_memoized_structs
assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
assert_equal '@_memoized_name', structs.detect { |s| s.memoized_method == :name }.ivar
# Same expected methods
structs = Student.all_memoized_structs
assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
assert_equal '@_memoized_student_name', structs.detect { |s| s.memoized_method == :name }.ivar
expected = (expected << 'seniority').sort
structs = Teacher.all_memoized_structs
assert_equal expected, structs.collect(&:memoized_method).collect(&:to_s).sort
assert_equal '@_memoized_name', structs.detect { |s| s.memoized_method == :name }.ivar
end
def test_unmemoize_all_subclasses
# Person memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
# Student < Person memoize :name, :identifier => :student
# Teacher < Person memoize :seniority
teacher = Teacher.new
assert_equal 'Josh', teacher.name
assert_equal 'Josh', teacher.instance_variable_get(:@_memoized_name)
assert_equal 'very_senior', teacher.seniority
assert_equal 'very_senior', teacher.instance_variable_get(:@_memoized_seniority)
teacher.unmemoize_all
assert_equal false, teacher.instance_variable_defined?(:@_memoized_name)
assert_equal false, teacher.instance_variable_defined?(:@_memoized_seniority)
student = Student.new
assert_equal 'Student Josh', student.name
assert_equal 'Student Josh', student.instance_variable_get(:@_memoized_student_name)
assert_equal false, student.instance_variable_defined?(:@_memoized_seniority)
student.unmemoize_all
assert_equal false, @calculator.instance_variable_defined?(:@_memoized_student_name)
end
def test_memoize_all
@calculator.memoize_all
assert_equal true, @calculator.instance_variable_defined?(:@_memoized_counter)
end
def test_memoize_all_subclasses
# Person memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
# Student < Person memoize :name, :identifier => :student
# Teacher < Person memoize :seniority
teacher = Teacher.new
teacher.memoize_all
assert_equal 'very_senior', teacher.instance_variable_get(:@_memoized_seniority)
assert_equal 'Josh', teacher.instance_variable_get(:@_memoized_name)
student = Student.new
student.memoize_all
assert_equal 'Student Josh', student.instance_variable_get(:@_memoized_student_name)
assert_equal 'Student Josh', student.name
assert_equal false, student.instance_variable_defined?(:@_memoized_seniority)
end
def test_memoization_cache_is_different_for_each_instance
assert_equal 1, @calculator.counter
assert_equal 2, @calculator.counter(:reload)
assert_equal 1, Calculator.new.counter
end
def test_memoization_class_variables
@book.memoize_all
assert_equal "My Life by Brian 'Fudge' Turmuck", @book.instance_variable_get(:@_memoized_full_title)
assert_equal "My Life by Brian 'Fudge' Turmuck", @book.full_title
Book.memoize_all
assert_instance_of Array, Book.instance_variable_get(:@_memoized_all_types)
assert_equal 24, Book.all_types.count
end
def test_memoized_is_not_affected_by_freeze
@person.freeze
assert_equal 'Josh', @person.name
assert_equal 'Joshua', @person.update('Joshua')
end
def test_memoization_with_args
assert_equal 55, @calculator.fib(10)
assert_equal 11, @calculator.fib_calls
end
def test_reloadable_with_args
assert_equal 55, @calculator.fib(10)
assert_equal 11, @calculator.fib_calls
assert_equal 55, @calculator.fib(10, :reload)
assert_equal 12, @calculator.fib_calls
assert_equal 55, @calculator.fib(10, true)
assert_equal 13, @calculator.fib_calls
end
def test_memoization_with_boolean_arg
assert_equal 4, @calculator.add_or_subtract(2, 2, true)
assert_equal 2, @calculator.add_or_subtract(4, 2, false)
end
def test_object_memoization
[Company.new, Company.new, Company.new].each do |company|
company.extend Memoist
company.memoize :name
assert_equal '37signals', company.name
assert_equal 1, company.name_calls
assert_equal '37signals', company.name
assert_equal 1, company.name_calls
end
end
def test_memoized_module_methods
assert_equal 1.025, @calculator.sales_tax(10)
assert_equal 1, @calculator.sales_tax_calls
assert_equal 1.025, @calculator.sales_tax(10)
assert_equal 1, @calculator.sales_tax_calls
assert_equal 2.5625, @calculator.sales_tax(25)
assert_equal 2, @calculator.sales_tax_calls
end
def test_object_memoized_module_methods
company = Company.new
company.extend(Rates)
assert_equal 1.025, company.sales_tax(10)
assert_equal 1, company.sales_tax_calls
assert_equal 1.025, company.sales_tax(10)
assert_equal 1, company.sales_tax_calls
assert_equal 2.5625, company.sales_tax(25)
assert_equal 2, company.sales_tax_calls
end
def test_double_memoization_with_identifier
# Person memoize :age, :is_developer?, :memoize_protected_test, :name, :name?, :sleep, :update, :update_attributes
# Student < Person memoize :name, :identifier => :student
# Teacher < Person memoize :seniority
Person.memoize :name, identifier: :again
p = Person.new
assert_equal 'Josh', p.name
assert p.instance_variable_get(:@_memoized_again_name)
# HACK: tl;dr: Don't memoize classes in test that are used elsewhere.
# Calling Person.memoize :name, :identifier => :again pollutes Person
# and descendents since we cache the memoized method structures.
# This populates those structs, verifies Person is polluted, resets the
# structs, cleans up cached memoized_methods
Student.all_memoized_structs
Person.all_memoized_structs
Teacher.all_memoized_structs
assert Person.memoized_methods.any? { |m| m.ivar == '@_memoized_again_name' }
[Student, Teacher, Person].each(&:clear_structs)
assert Person.memoized_methods.reject! { |m| m.ivar == '@_memoized_again_name' }
assert_nil Student.memoized_methods.reject! { |m| m.ivar == '@_memoized_again_name' }
assert_nil Teacher.memoized_methods.reject! { |m| m.ivar == '@_memoized_again_name' }
end
def test_memoization_with_a_subclass
student = Student.new
student.name
student.name
assert_equal 1, student.student_name_calls
assert_equal 1, student.name_calls
end
def test_memoization_is_chainable
klass = Class.new do
def foo
'bar'
end
end
klass.extend Memoist
chainable = klass.memoize :foo
assert_equal :foo, chainable
end
def test_protected_method_memoization
person = Person.new
assert_raises(NoMethodError) { person.memoize_protected_test }
assert_equal 'protected', person.send(:memoize_protected_test)
end
def test_private_method_memoization
person = Person.new
assert_raises(NoMethodError) { person.is_developer? }
assert_equal 'Yes', person.send(:is_developer?)
assert_equal 1, person.is_developer_calls
assert_equal 'Yes', person.send(:is_developer?)
assert_equal 1, person.is_developer_calls
end
end
|