chanzuckerberg / redis-memo

A Redis-based version addressable caching system. Memoize pure functions, aggregated database queries, and 3rd party API calls.
https://rubygems.org/gems/redis-memo
MIT License
33 stars 3 forks source link

[doc] Add docs for RedisMemo::Memoizable and RedisMemo::Memoizable::Invalidation #82

Closed katyho closed 3 years ago

katyho commented 3 years ago

Summary

Rdocs for the RedisMemo::Memoizable and RedisMemo::Memoizable::Invalidation classes

Testing

codecov[bot] commented 3 years ago

Codecov Report

Merging #82 (359bd22) into main (3dd9c57) will increase coverage by 0.00%. The diff coverage is 100.00%.

:exclamation: Current head 359bd22 differs from pull request most recent head 047c377. Consider uploading reports for the commit 047c377 to get more accurate results Impacted file tree graph

@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   97.63%   97.64%           
=======================================
  Files          40       40           
  Lines        2328     2335    +7     
=======================================
+ Hits         2273     2280    +7     
  Misses         55       55           
Impacted Files Coverage Δ
lib/redis_memo.rb 97.56% <ø> (ø)
lib/redis_memo/future.rb 98.36% <ø> (ø)
lib/redis_memo/batch.rb 100.00% <100.00%> (ø)
lib/redis_memo/memoizable.rb 94.64% <100.00%> (+0.19%) :arrow_up:
lib/redis_memo/memoizable/invalidation.rb 100.00% <100.00%> (ø)
lib/redis_memo/memoize_method.rb 98.03% <100.00%> (ø)
lib/redis_memo/memoize_query.rb 97.14% <100.00%> (+0.08%) :arrow_up:
spec/after_commit_spec.rb 100.00% <100.00%> (ø)
spec/memoizable/invalidation_spec.rb 97.14% <100.00%> (ø)
spec/memoizable_spec.rb 100.00% <100.00%> (ø)
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3dd9c57...047c377. Read the comment docs.