cache_box 0.0.1.pre.preview1 → 0.0.1.pre.preview6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b591535ab5ba124dca095013f08a3be9b348e0138a1738ec6c3088f388e8b9
-  data.tar.gz: 33183202f61274a5f3cfbae070bb83a8f2749b99596daeb98a43f173da8e5ea7
+  metadata.gz: ab194a6029ec0a9e3a9ac5cb8cdac124f7a06ab1d4066d50665bbdf9548a727a
+  data.tar.gz: 06e3109c3d4f9437bd70768d21c69cc3252cc316f60a68072c5d1d8edb7fa4b6
 SHA512:
-  metadata.gz: e14a3c9b73792b6debc38676ce17f28ecfc81981e96476c7d6038ef4a1b9cd9af48513fc4569b9155edb5aa1c685e0ed2ad7844be2ff4e98ae905dce131fdff0
-  data.tar.gz: fd250b2db538d59d215ab656def286afca52d09894d1ea667484a1927441bd1d50638c5a1f0c187a89fb92cb40f7863c5b018fba8ae47867eec15df65edb8233
+  metadata.gz: 2229714e8ce3c5d92eb5a34cfdf047d6f0e315a56db856ea9c05bebacc22ca2c0881689d822df58c01f608cafd00d323b2e64f7decce15695ca671a1383fd1c1
+  data.tar.gz: 83b5d7dac66492c48ea35c5ec82a70c249260d6e0f1961322ed9016ddafa1d0a7fecd6a3323db42cf7f9f2e29d6bced25d50d0117a76ac9af1215d17bb1e8639

data/cache_box.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name    = 'cache_box'
-  spec.version = '0.0.1-preview1'
+  spec.version = '0.0.1-preview6'
   spec.authors = ['Codruț Constantin Gușoi']
   spec.email   = ['codrut.gusoi+git-commit@gmail.com']
 
@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
   ]
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake',     '~> 12.0'
-  spec.add_development_dependency 'rubocop',  '~> 0.88'
+  spec.add_development_dependency 'minitest',   '~> 5.14'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake',       '~> 13.0'
+  spec.add_development_dependency 'rubocop',    '~> 0.88'
 end

data/lib/cache_box.rb

@@ -4,68 +4,129 @@ require 'fileutils'
 require_relative 'cache_box_chain'
 
 class CacheBox
-  def initialize(namespace = :default_namespace)
+  # Input:
+  #
+  # namespace = String | Symbol # Default: :namespace
+  #
+  # Output: N/A
+  def initialize(namespace = :namespace)
     validate!(namespace, 'namespace')
 
     @namespace = namespace
-    @state     = {}
+    @state     = { complete: {}, result: {}, storage: {} }
     @root      = File.join(Dir.pwd, '.cache')
     @directory = File.join(@root, @namespace.to_s)
   end
 
-  def reset!(namespace = :default_namespace)
+  # Input:
+  #
+  # namespace = String | Symbol # Default: :namespace
+  #
+  # Output: self
+  def reset!(namespace = :namespace)
     initialize(namespace)
 
     self
   end
 
-  def with(name = :default_name, *args)
+  # Input:
+  #
+  # name   = String | Symbol # Default: :name
+  # args   = Array[...Object]
+  # &block = Proc(*args)
+  #
+  # Output: Object # Anything the &block returns.
+  def with(name = :name, *args)
     validate!(name, 'name')
 
-    file   = File.join(@directory, name.to_s)
-    result = find(name, file)
+    name   = name.to_s
+    file   = File.join(@directory, name)
+    result = find!(name, file)
     return result unless result.nil?
 
-    store(yield(*args), name, file)
+    result = yield(*args)
+
+    @state[:complete][name] = true
+    @state[:result][name]   = result
+    @state[:storage].delete(name)
+    store!(name, file)
+
+    result
   end
 
-  def with_many(name = :default_name, *args)
+  # Input:
+  #
+  # name   = String | Symbol # Default: :name
+  # args   = Array[...Object]
+  # &block = Proc(Hash{...Object => Object}, *args)
+  #
+  # Output: Object # Anything the &block returns.
+  def with_many(name = :name, *args)
     validate!(name, 'name')
 
-    file   = File.join(@directory, name.to_s)
-    result = find(name, file)
+    name   = name.to_s
+    file   = File.join(@directory, name)
+    result = find!(name, file)
     return result unless result.nil?
 
-    storage = {}
+    storage = @state[:storage][name] || {}
     begin
-      yield(storage, *args)
+      result = yield(storage, *args)
+
+      @state[:complete][name] = true
+      @state[:result][name]   = result
+      @state[:storage].delete(name)
+      store!(name, file)
+
+      result
     ensure
-      store(storage, name, file)
+      unless @state[:complete][name]
+        @state[:storage][name] = storage
+      end
+
+      store!(name, file)
     end
-    storage
   end
 
-  def has?(name = :default_name)
+  # Input:
+  #
+  # name = String | Symbol # Default: :name
+  #
+  # Output: true | false
+  def has?(name = :name)
     validate!(name, 'name')
 
-    file = File.join(@directory, name.to_s)
+    name = name.to_s
+    return true if @state[:result].key?(name)
+
+    file = File.join(@directory, name)
     load!(name, file)
 
-    @state.key?(name)
+    @state[:result].key?(name)
   end
 
+  # Output: self
   def expire!
-    @state = {}
+    @state = { complete: {}, result: {}, storage: {} }
     FileUtils.remove_entry_secure(@directory, true)
 
     self
   end
 
-  def expire(name = :default_name)
+  # Input:
+  #
+  # name = String | Symbol # Default: :name
+  #
+  # Output: self
+  def expire(name = :name)
     validate!(name, 'name')
 
-    @state.delete(name)
-    file = File.join(@directory, name.to_s)
+    name = name.to_s
+    @state[:complete].delete(name)
+    @state[:result].delete(name)
+    @state[:storage].delete(name)
+
+    file = File.join(@directory, name)
     FileUtils.remove_entry_secure(file, true)
 
     self
@@ -73,36 +134,64 @@ class CacheBox
 
   private
 
+  # Input:
+  #
+  # arg  = String | Symbol
+  # name = String
+  #
+  # Output: N/A
   def validate!(arg, name)
-    return if arg.is_a?(Symbol)
+    return if arg.is_a?(Symbol) || arg.is_a?(String)
 
     klass = arg.class
     value = arg.inspect
 
-    raise(ArgumentError, "#{name} must be a Symbol, got #{klass}: #{value}")
+    raise(ArgumentError, "#{name} must be a Symbol or String, got #{klass}: #{value}")
   end
 
+  # Input:
+  #
+  # name = String
+  # file = String # Path
+  #
+  # Output: N/A
   def load!(name, file)
-    return unless @state[name].nil? && File.exist?(file)
+    if File.exist?(file)
+      data = Marshal.load(File.read(file))
 
-    content      = File.read(file)
-    @state[name] = Marshal.load(content)
+      @state[:complete][name] = data[:complete] if data.key?(:complete)
+      @state[:result][name]   = data[:result]   if data.key?(:result)
+      @state[:storage][name]  = data[:storage]  if data.key?(:storage)
+    end
   end
 
-  def find(name, file)
+  # Input:
+  #
+  # name = String
+  # file = String # Path
+  #
+  # Output: Object # Anything
+  def find!(name, file)
     load!(name, file)
 
-    @state[name]
+    @state[:result][name]
   end
 
-  def store(value, name, file)
-    @state[name] = value
-
-    content = Marshal.dump(value)
-
-    FileUtils.mkdir_p(@directory) unless Dir.exist?(@directory)
+  # Input:
+  #
+  # file = String # Path
+  #
+  # Output: N/A
+  def store!(name, file)
+    data = {}
+    data[:complete] = @state[:complete][name] if @state[:complete][name]
+    data[:result]   = @state[:result][name]   if @state[:result][name]
+    data[:storage]  = @state[:storage][name]  if @state[:storage][name] && !@state[:complete][name]
+
+    content = Marshal.dump(data)
+
+    directory = File.dirname(file)
+    FileUtils.mkdir_p(directory) unless Dir.exist?(directory)
     File.write(file, content)
-
-    value
   end
 end

data/lib/cache_box_chain.rb

@@ -2,18 +2,35 @@
 
 class CacheBox
   class Chain
-    def initialize(namespace = :default_namespace)
+    # Input:
+    #
+    # namespace = String | Symbol # Default: :namespace
+    #
+    # Output: N/A
+    def initialize(namespace = :namespace)
       @cache = ::CacheBox.new(namespace)
       @chain = []
     end
 
-    def reset!(namespace = :default_namespace)
+    # Input:
+    #
+    # namespace = String | Symbol # Default: :namespace
+    #
+    # Output: self
+    def reset!(namespace = :namespace)
       @cache.reset!(namespace)
       @chain = []
 
       self
     end
 
+    # Input:
+    #
+    # name   = String | Symbol
+    # args   = Array[...Object]
+    # &block = Proc(*args)
+    #
+    # Output: self
     def chain(name, *args, &block)
       validate_chain!(name, &block)
 
@@ -24,6 +41,13 @@ class CacheBox
       self
     end
 
+    # Input:
+    #
+    # name   = String | Symbol
+    # args   = Array[...Object]
+    # &block = Proc(Hash{...Object => Object}, *args)
+    #
+    # Output: self
     def chain_many(name, *args, &block)
       validate_chain!(name, &block)
 
@@ -34,6 +58,11 @@ class CacheBox
       self
     end
 
+    # Input:
+    #
+    # all = nil | :all # Default: nil
+    #
+    # Output: Object # Anything the last block in the chain returns.
     def run!(all = nil)
       validate_run!(all)
 
@@ -44,12 +73,18 @@ class CacheBox
       end
     end
 
+    # Output: self
     def expire!
       @cache.expire!
 
       self
     end
 
+    # Input:
+    #
+    # names = ...(String | Symbol)
+    #
+    # Output: self
     def expire(*names)
       names.each do |name|
         @cache.expire(name)
@@ -60,12 +95,21 @@ class CacheBox
 
     private
 
+    # Input:
+    #
+    # name   = String | Symbol
+    # &block = Proc
+    #
+    # Output: N/A
     def validate_chain!(name, &block)
-      unless name.is_a?(Symbol)
+      unless name.is_a?(Symbol) || name.is_a?(String)
         klass = name.class
         value = name.inspect
 
-        raise(ArgumentError, "name must be a Symbol, got #{klass}: #{value}")
+        raise(
+          ArgumentError,
+          "name must be a Symbol or a String, got #{klass}: #{value}"
+        )
       end
 
       return unless block.nil?
@@ -76,6 +120,11 @@ class CacheBox
       )
     end
 
+    # Input:
+    #
+    # arg = nil | :all
+    #
+    # Output: N/A
     def validate_run!(arg)
       return if arg.nil? || arg == :all
 
@@ -89,6 +138,7 @@ class CacheBox
       )
     end
 
+    # Output: Object # Anything the last callable returns.
     def run_all
       result = nil
       @chain.each do |_name, args, callable|
@@ -102,6 +152,7 @@ class CacheBox
       result
     end
 
+    # Output: Object # Anything the last executed callable returns.
     def run_chain
       work = []
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_box
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.preview1
+  version: 0.0.1.pre.preview6
 platform: ruby
 authors:
 - Codruț Constantin Gușoi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement