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

Rename without_memo -> without_memoization #85

Closed katyho closed 3 years ago

katyho commented 3 years ago

Summary

codecov[bot] commented 3 years ago

Codecov Report

Merging #85 (6dbcf31) into main (ec027bc) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #85   +/-   ##
=======================================
  Coverage   97.67%   97.67%           
=======================================
  Files          40       40           
  Lines        2367     2367           
=======================================
  Hits         2312     2312           
  Misses         55       55           
Impacted Files Coverage Δ
lib/redis_memo.rb 97.61% <100.00%> (ø)
lib/redis_memo/future.rb 98.36% <100.00%> (ø)
lib/redis_memo/memoize_method.rb 98.07% <100.00%> (ø)
.../memoize_query/cached_select/connection_adapter.rb 94.11% <100.00%> (ø)
lib/redis_memo/memoize_query/invalidation.rb 99.09% <100.00%> (ø)
lib/redis_memo/testing.rb 95.83% <100.00%> (ø)
spec/memoize_method_spec.rb 100.00% <100.00%> (ø)
spec/memoize_query_spec.rb 100.00% <100.00%> (ø)

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 ec027bc...6dbcf31. Read the comment docs.

donaldong commented 3 years ago

Oh! We also need to update some wiki pages for this.

Maybe we should check in the wiki pages into the codebase as well, so it's easier to do those type of refactoring

katyho commented 3 years ago

Oh! We also need to update some wiki pages for this.

Maybe we should check in the wiki pages into the codebase as well, so it's easier to do those type of refactoring

This would be good! Also to do a more thorough read through of wikis and to polish some of the language. I don't think that Github supports this out of the box though (e.g. you can't make a pull request to edit a wiki..)

donaldong commented 3 years ago

Github wiki is also a git repo lol ... I think we can just maintain them in the codebase and force-push to the wiki repo when we want to make changes

https://github.com/chanzuckerberg/redis-memo.wiki.git

donaldong commented 3 years ago

https://github.com/chanzuckerberg/redis-memo/pull/86

katyho commented 3 years ago

Github wiki is also a git repo lol ... I think we can just maintain them in the codebase and force-push to the wiki repo when we want to make changes

https://github.com/chanzuckerberg/redis-memo.wiki.git

The link above returns a 404 for me

What do you mean force-push to the wiki repo? Are we going to automate that somehow, or do contributors need to manually make sure that the wiki is updated after updating the github repo?

donaldong commented 3 years ago

Oh that's a 404 for me as well. But it is a legit git repo we can clone from (and push to)

Are we going to automate that somehow, or do contributors need to manually make sure that the wiki is updated after updating the github repo?

I was thinking about making this a manual process, since it's somewhat rare (in #86) https://github.com/chanzuckerberg/redis-memo/blob/af841a822daa0df31cc78af3e327ae2d1a241ec8/docs/README.md

but it's possible to automate this too! (an interesting idea!)