memoize_until 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f66521ac063cd6908fb61b5e05754a72a16beb3ba9862409f28b3b0beda85d1
+  data.tar.gz: 4749947d376dcb95804afffe1621da5a31c5a604904254b2c478800e47ea8602
+SHA512:
+  metadata.gz: 3ceebecdc00e71e8618ad3404a1d85acc1e15cf3e9d5177aed0a8fd2258d8f9e8f3a7527c1bfaac5494a6f968febaaa7008c7e1a34a0dcf310f18abc0e43c029
+  data.tar.gz: 264f732011f7209d9254c6d0dd78f29b6f666467be328fd6d93ee5db03c4b123fa1f312a49882d58461e2d7fc462425e363ce271a56efb23d78d00531a751a10

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode/
+*.gem
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ritikesh.g@freshdesk.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in memoize_until.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ritikesh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# MemoizeUntil
+
+This gem is an extension to the standard `memoization` pattern for storing expensive computations or network calls `in-memory`. Unlike other memoization extensions which expire after a pre-defined interval, this gem provides a consistent memoization behavior across multiple processes/servers i.e. keys expire simultaneously across all processes.
+
+Usage:
+```ruby
+gem install memoize_until
+> irb
+irb:> require 'memoize_until'
+irb:> result = MemoizeUntil.day(:default) do
+irb:> 	# PerformSomeComplexOperation
+irb:> end # memoizes(until the end of the day) and returns the result of #PerformSomeComplexOperation
+irb:> p result.inspect
+```
+
+The default API that the gem provides is: `MemoizeUntil#min, MemoizeUntil#hour, MemoizeUntil#day, MemoizeUntil#week, MemoizeUntil#month` with `default` purposes(keys). 
+
+To add new purposes during run_time, you can also leverage the `add_to` API:
+```ruby
+irb:> MemoizeUntil.add_to(:day, :runtime_key) 
+irb:> result = MemoizeUntil.day(:runtime_key) do
+irb:> 	# PerformSomeComplexRuntimeOperation
+irb:> end # memoizes(until the end of the day) and returns the result of #PerformSomeComplexOperation
+irb:> p result.inspect
+```
+The same can be done for other default kinds as well: `min, hour, week, month`
+
+## Rails
+
+To use this gem in a rails application, add the following line to your `Gemfile` and you are good to go.
+
+```ruby
+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 run test cases,
+```shell
+bundle install
+ruby -Ilib:test test/memoize_until_test.rb
+```
+
+This project is Licensed under the MIT License. Further details can be found [here](/LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.2.0

data/examples/memoize_until.yml

@@ -0,0 +1,7 @@
+:day:
+  - :default
+  - :flags_from_redis
+:hour:
+  - :integration_settings_from_external_app
+:min:
+  - :micro_service_availability

data/lib/memoize_until.rb

@@ -0,0 +1,5 @@
+# initialise the store and the memoize_until class
+require 'memoize_until/store'
+
+# require the railtie
+require 'memoize_until/railtie'

data/lib/memoize_until/base.rb

@@ -0,0 +1,50 @@
+class MemoizeUntil
+
+  memoizable_attributes = YAML.load_file("#{__dir__}/config/defaults.yml")
+  
+  if defined?(Rails) && File.exists?("#{Rails.root}/config/memoize_until.yml")
+    memoizable_attributes.deep_merge!(YAML.load_file("#{Rails.root}/config/memoize_until.yml"))
+  end
+
+  TYPE_FACTORY = {}
+  private_constant :TYPE_FACTORY
+  
+  memoizable_attributes.each do |kind, keys|
+    
+    TYPE_FACTORY[kind] =  Store.new(kind)
+    
+    keys.each { |key|
+      TYPE_FACTORY[kind].add(key)
+    }
+    
+    # Memoizes a complex operation for the pre-specified interval
+    #
+    # @param key [Symbol] the purpose defined in memoize_until.yml or :default.
+    
+    # @yield use this block to set the value to be memoized for the given moment
+    #
+    # @example Memoizing per day.
+    #   MemoizeUntil.day(:default) do
+    #     # other code
+    #   end
+    #
+    # @return returns the memoized value for the key & moment
+    define_singleton_method(kind) do |key, &block|
+      TYPE_FACTORY[kind].fetch(key, &block)
+    end
+    
+  end
+  
+  # Adds a purpose at runtime for the specified kind.
+  #
+  # @param kind [Symbol] one of the default or customised kind supported
+  # @param key [Symbol] the purpose defined in memoize_until.yml or :default.
+  #
+  # @example Memoizing per day.
+  #   MemoizeUntil.add_to(:day, :runtime_key)
+  #
+  # @return {}
+  def self.add_to(kind, key)
+    TYPE_FACTORY[kind].add(key)
+  end
+end

data/lib/memoize_until/config/defaults.yml

@@ -0,0 +1,10 @@
+:min:
+  - :default
+:hour:
+  - :default
+:day:
+  - :default
+:week:
+  - :default
+:month:
+  - :default

data/lib/memoize_until/extensions.rb

@@ -0,0 +1,12 @@
+class MemoizeUntil
+	
+	class NotImplementedError < StandardError; end
+	
+	class NullObject
+		
+		def self.instance
+			@@null_object ||= NullObject.new
+		end
+		
+	end
+end

data/lib/memoize_until/railtie.rb

@@ -0,0 +1,14 @@
+class MemoizeUntil::Railtie < Rails::Railtie
+    
+    initializer "memoize_until.config_hook" do
+        # initialising the memoize_until classes
+        require 'memoize_until/base'
+        
+        # require extensions
+        require 'memoize_until/extensions'
+
+        # patches
+        require 'memoize_until/time_patch'
+    end
+    
+end

data/lib/memoize_until/store.rb

@@ -0,0 +1,65 @@
+class MemoizeUntil
+  class Store
+    attr_reader :_store, :_kind
+
+    def initialize(kind)
+      @_store = {}
+      @_kind = kind
+    end
+
+    # returns the value from memory if already memoized for "now" for the given key
+    # else evaluates the block and memoizes that
+    # caches nils too
+    def fetch(key, &block)
+      now = Time.now.public_send(_kind)
+      value = get(key, now)
+      unless value
+        clear_all(key)
+        value = set(key, now, yield)
+      end
+      unset_nil(value)
+    end
+
+    # add runtime keys
+    def add(key)
+      _store[key] ||= {}
+    end
+
+    # 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
+    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
+    def clear_now(key)
+      now = Time.now.public_send(_kind)
+      _store[key][now] = nil
+    end
+
+    private
+
+    # caches nils through a pseudo object
+    def set_nil(value)
+      value.nil? ? NullObject.instance : value
+    end
+
+    # replaces cached pseudo object and returns nil
+    def unset_nil(value)
+      value.is_a?(NullObject) ? nil : value
+    end
+
+    def set(key, now, value)
+      _store[key][now] = set_nil(value)
+    end
+
+    def get(key, now)
+      purpose = _store[key]
+      raise NotImplementedError unless purpose
+      purpose[now]
+    end
+  end
+end

data/lib/memoize_until/time_patch.rb

@@ -0,0 +1,9 @@
+unless Time.instance_methods.include?(:week)
+	module MemoizeUntil::TimePatch
+    # returns number representing the nth week of the month
+    def week
+        self.day / 7
+    end
+	end
+	Time.prepend MemoizeUntil::TimePatch
+end

data/memoize_until.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+version = File.read(File.expand_path("VERSION", __dir__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = "memoize_until"
+  spec.version       = version
+  spec.authors       = ["Ritikesh"]
+  spec.email         = ["ritikesh.ganpathraj@freshworks.com"]
+
+  spec.summary       = %q{Local Memoization Pattern!}
+  spec.description   = %q{Local Memoization Pattern to store complex and repeated computations in memory until the next hour/day/week}
+  spec.homepage      = "https://github.com/freshdesk/memoize_until"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/freshdesk/memoize_until"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: memoize_until
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Ritikesh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Local Memoization Pattern to store complex and repeated computations
+  in memory until the next hour/day/week
+email:
+- ritikesh.ganpathraj@freshworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/memoize_until.yml
+- lib/memoize_until.rb
+- lib/memoize_until/base.rb
+- lib/memoize_until/config/defaults.yml
+- lib/memoize_until/extensions.rb
+- lib/memoize_until/railtie.rb
+- lib/memoize_until/store.rb
+- lib/memoize_until/time_patch.rb
+- memoize_until.gemspec
+homepage: https://github.com/freshdesk/memoize_until
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/freshdesk/memoize_until
+  source_code_uri: https://github.com/freshdesk/memoize_until
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Local Memoization Pattern!
+test_files: []