memoize_until 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f66521ac063cd6908fb61b5e05754a72a16beb3ba9862409f28b3b0beda85d1
-  data.tar.gz: 4749947d376dcb95804afffe1621da5a31c5a604904254b2c478800e47ea8602
+  metadata.gz: 572f76ed252765bca587e9d9d68fb28327c02783ac1066d061147315c542a996
+  data.tar.gz: 36ef39ba60fba0f2ca3b0c26a9f082442f72ed4a1780952a79a78c1eb89305bf
 SHA512:
-  metadata.gz: 3ceebecdc00e71e8618ad3404a1d85acc1e15cf3e9d5177aed0a8fd2258d8f9e8f3a7527c1bfaac5494a6f968febaaa7008c7e1a34a0dcf310f18abc0e43c029
-  data.tar.gz: 264f732011f7209d9254c6d0dd78f29b6f666467be328fd6d93ee5db03c4b123fa1f312a49882d58461e2d7fc462425e363ce271a56efb23d78d00531a751a10
+  metadata.gz: ae171d5e3b67e3c0cb79116c4436206031c7924088f4fdb446dc89d937a4144427905c42b64c77d92a5d15acb3a413b30ebe0f85ff03f333c22185c12f7de171
+  data.tar.gz: a6f78d6a8097ae44332acd264b2a9e3df00ce0bca795e4f59c85bb1ce24ca08e348d6f357f0c6043c24365144c84fb8d42208a07620b8be6c3dea6f9befef61e

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.2.1  - 08 May, 2020
+
+* 🚀 [ENHANCEMENT] Public method `clear_now_for` added to `MemoizeUntil`, delegating the method to the underlying store object. This is done to support writing unit test cases without touching getting dirty with the private `Store` API. [#8](https://github.com/freshdesk/memoize_until/pull/8). Thanks to [@ritikesh](https://github.com/ritikesh).

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Ritikesh
+Copyright (c) 2018 FRESHWORKS, INC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -36,6 +36,18 @@ gem 'memoize_until'
 For most use cases, the list of purposes that come will not suffice. You can define your custom list of config purposes that you wish to memoize for, by including a `config/memoize_until.yml` in the root directory of your application. Here is an [example](/examples/memoize_until.yml) to help you with the file structure. 
 
 ## Testing
+
+To clear the currently memoized value for a purpose, you can use the `clear_now` API.
+
+```ruby
+irb:> MemoizeUntil.day(:default) { 1 } # 1
+irb:> MemoizeUntil.clear_now_for(:day, :default) 
+irb:> MemoizeUntil.day(:default) { 2 } # 2
+```
+
+#### Note: This API only clears the currently memoized value in the current running process and will not mitigate to other processes in a multiprocess world. This is recommended to be used only for testing setup.
+
+## Contributing
 To run test cases,
 ```shell
 bundle install

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.2.1

data/lib/memoize_until/base.rb

@@ -47,4 +47,19 @@ class MemoizeUntil
   def self.add_to(kind, key)
     TYPE_FACTORY[kind].add(key)
   end
+  
+  # clears previously memoized value for "now" for the given key
+  # only clears memory in the process that this code runs on.
+  # added for supporting custom scripts / test cases
+  #
+  # @param kind [Symbol] one of the default or customised kind supported
+  # @param key [Symbol] the purpose defined in memoize_until.yml or :default.
+  #
+  # @example Clearing currently memoised value for today for :default.
+  #   MemoizeUntil.clear_for(:day, :default)
+  #
+  # @return nil
+  def self.clear_now_for(kind, key)
+    TYPE_FACTORY[kind].clear_now(key)
+  end
 end

data/lib/memoize_until/store.rb

@@ -27,14 +27,14 @@ class MemoizeUntil
 
     # clears all previously memoized values for the given key
     # only clears memory in the process that this code runs.
-    # added for fetch and custom scripts
+    # added for supporting fetch and custom scripts
     def clear_all(key)
       _store[key] = {}
     end
 
     # clears previously memoized value for "now" for the given key
-    # only clears memory in the process that this code runs.
-    # added for custom scripts
+    # only clears memory in the process that this code runs on.
+    # added for supporting custom scripts / test cases
     def clear_now(key)
       now = Time.now.public_send(_kind)
       _store[key][now] = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memoize_until
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Ritikesh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt