memoize_until 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 572f76ed252765bca587e9d9d68fb28327c02783ac1066d061147315c542a996
-  data.tar.gz: 36ef39ba60fba0f2ca3b0c26a9f082442f72ed4a1780952a79a78c1eb89305bf
+  metadata.gz: 8d5800dd9464ea0e52a7c86dece3eba58dd9ac3c4aa4844d71619f7bdd18f740
+  data.tar.gz: 259618aa762f0c5000e77a5bd9926031290308f57c463962fb44a854ee7e7a2e
 SHA512:
-  metadata.gz: ae171d5e3b67e3c0cb79116c4436206031c7924088f4fdb446dc89d937a4144427905c42b64c77d92a5d15acb3a413b30ebe0f85ff03f333c22185c12f7de171
-  data.tar.gz: a6f78d6a8097ae44332acd264b2a9e3df00ce0bca795e4f59c85bb1ce24ca08e348d6f357f0c6043c24365144c84fb8d42208a07620b8be6c3dea6f9befef61e
+  metadata.gz: 1fa974aca2175396f8a18cebc69811332f08faeecfbcc0028d5c0c628b22eb02c1891949d50513ebed5aaaefb6a6d13bebbc21874afab048057eea3efcbef8a5
+  data.tar.gz: f6e5ff67499b9addec68276bbf0f6b2278baf371f2c0e7c927ae0852f713e0b8c71cc3c06022b0f142c7882c0e869b45d7083a18e263e48231ffc2d6e769edb4

data/.github/workflows/.rubocop.yml

@@ -0,0 +1,19 @@
+name: "rubocop"
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6.9'
+          bundler-cache: true
+      - name: Rubocop
+        run: bundle exec rubocop

data/.github/workflows/.tests.yml

@@ -0,0 +1,24 @@
+name: minitest
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.6.9, 2.7, 3.0, 3.1, 3.2]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Bundle Install
+        run: bundle install
+      - name: Run tests
+        run: rake

data/.gitignore

@@ -9,4 +9,5 @@
 /tmp/
 .vscode/
 *.gem
-.DS_Store
+.DS_Store
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.6.9
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 175
+
+Metrics/MethodLength:
+  Max: 15
+
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/memoize_until/store.rb'
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/memoize_until/base.rb'

data/CHANGELOG.md

@@ -1,3 +1,9 @@
-## 1.2.1  - 08 May, 2020
+## 1.3.1  - 21 April, 2023
+* [DEPRECATION FIX] File.exists? is changed to File.exist?, since File.exists? is deprecated in Ruby 3.x. [#11](https://github.com/freshworks/memoize_until/pull/11). Thanks to [@ruban-thilak](https://github.com/ruban-thilak).
+* [ENHANCEMENT] Add CI checks for rubocop and minitest via Github actions. [#12](https://github.com/freshworks/memoize_until/pull/12). Thanks to [@ruban-thilak](https://github.com/ruban-thilak).
+
+## 1.3.0  - 18 March, 2021
+* [ENHANCEMENT] memoize_until is now thread safe [fc2b98f](https://github.com/freshworks/memoize_until/commit/fc2b98f197e641a5668ded1d332f9412fe231422). Thanks to [@ritikesh](https://github.com/ritikesh).
 
-* 🚀 [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).
+## 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/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+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/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.1

data/lib/memoize_until/base.rb

@@ -1,26 +1,26 @@
-class MemoizeUntil
+# frozen_string_literal: true
 
+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"))
+
+  if defined?(Rails) && File.exist?(Rails.root.join('/config/memoize_until.yml'))
+    memoizable_attributes.deep_merge!(YAML.load_file(Rails.root.join('/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] = Store.new(kind)
+
+    keys.each do |key|
       TYPE_FACTORY[kind].add(key)
-    }
-    
+    end
+
     # 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.
@@ -32,9 +32,8 @@ class MemoizeUntil
     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
@@ -47,7 +46,7 @@ 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

data/lib/memoize_until/extensions.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 class MemoizeUntil
-	
-	class NotImplementedError < StandardError; end
-	
-	class NullObject
-		
-		def self.instance
-			@@null_object ||= NullObject.new
-		end
-		
-	end
-end
+  class NotImplementedError < StandardError; end
+
+  class NullObject
+    @null_object ||= NullObject.new
+
+    def self.instance
+      @null_object
+    end
+  end
+end

data/lib/memoize_until/railtie.rb

@@ -1,14 +1,16 @@
-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'
+# frozen_string_literal: true
 
-        # patches
-        require 'memoize_until/time_patch'
+class MemoizeUntil
+  class 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
+  end
+end

data/lib/memoize_until/store.rb

@@ -1,35 +1,44 @@
+# frozen_string_literal: true
+
 class MemoizeUntil
   class Store
-    attr_reader :_store, :_kind
+    attr_reader :_store, :_kind, :_mutex
 
     def initialize(kind)
       @_store = {}
       @_kind = kind
+      @_mutex = Mutex.new
     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)
+    def fetch(key)
       now = Time.now.public_send(_kind)
       value = get(key, now)
-      unless value
+
+      if value.nil?
         clear_all(key)
-        value = set(key, now, yield)
+        value = set(key, now, set_nil(yield))
       end
+
       unset_nil(value)
     end
 
     # add runtime keys
     def add(key)
-      _store[key] ||= {}
+      _mutex.synchronize do
+        _store[key] ||= {}
+      end
     end
 
     # clears all previously memoized values for the given key
     # only clears memory in the process that this code runs.
     # added for supporting fetch and custom scripts
     def clear_all(key)
-      _store[key] = {}
+      _mutex.synchronize do
+        _store[key] = {}
+      end
     end
 
     # clears previously memoized value for "now" for the given key
@@ -37,7 +46,7 @@ class MemoizeUntil
     # added for supporting custom scripts / test cases
     def clear_now(key)
       now = Time.now.public_send(_kind)
-      _store[key][now] = nil
+      set(key, now, nil)
     end
 
     private
@@ -53,13 +62,18 @@ class MemoizeUntil
     end
 
     def set(key, now, value)
-      _store[key][now] = set_nil(value)
+      _mutex.synchronize do
+        _store[key][now] = value
+      end
     end
 
     def get(key, now)
-      purpose = _store[key]
-      raise NotImplementedError unless purpose
-      purpose[now]
+      _mutex.synchronize do
+        purpose = _store[key]
+        raise NotImplementedError unless purpose
+
+        purpose[now]
+      end
     end
   end
-end
+end

data/lib/memoize_until/time_patch.rb

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

data/lib/memoize_until.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # initialise the store and the memoize_until class
 require 'memoize_until/store'
 
 # require the railtie
-require 'memoize_until/railtie'
+require 'memoize_until/railtie'

data/memoize_until.gemspec

@@ -1,37 +1,41 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-version = File.read(File.expand_path("VERSION", __dir__)).strip
+version = File.read(File.expand_path('VERSION', __dir__)).strip
 
 Gem::Specification.new do |spec|
-  spec.name          = "memoize_until"
+  spec.name          = 'memoize_until'
   spec.version       = version
-  spec.authors       = ["Ritikesh"]
-  spec.email         = ["ritikesh.ganpathraj@freshworks.com"]
+  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"
+  spec.summary       = 'Local Memoization Pattern!'
+  spec.description   = '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"
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
 
-    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.required_ruby_version = '>= 2.6.9'
+
+  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'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_development_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rubocop', '~> 1.49'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.30.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memoize_until
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Ritikesh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.30.0
 description: Local Memoization Pattern to store complex and repeated computations
   in memory until the next hour/day/week
 email:
@@ -46,7 +74,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/.rubocop.yml"
+- ".github/workflows/.tests.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -70,7 +101,8 @@ 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: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Local Memoization Pattern!
 test_files: []