cache_box 0.0.1.pre.preview2 → 0.0.1.pre.preview3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc75a2d7008957a8c53dabf66772390d5eca8e964f6ab92f35fe57c063d5e52
-  data.tar.gz: 28c08be79e3a089f14897a42805a3a3b0b12f44a49c8fda8bc81884763aacc72
+  metadata.gz: 111176139c5bc21c2938a934ceda7d643ad1dedeed2055c7bf53782d7eabd599
+  data.tar.gz: ebcb405c0f2de33d53ae26d758a6f80c049793fe0dda8db1c482ea6660ddb455
 SHA512:
-  metadata.gz: 948602c9c4a3aac655c6a2c13a8284d92f9da2246a7b901133c050adb2119ceadb4936fe750cb27ab5d5afe383326e2e02cf623fb5c3d5145acb6a9dce289aa2
-  data.tar.gz: c8f3529d877814c4007d31699dabbd4fc375714b52184f36ec6660f3c126463f90afbe522c5e7eee42f62c0495ea9483753f02de66f533297dd855ec0b20f88e
+  metadata.gz: 51b2fd10d3484697d46ea07ec50d5a5ff6304f3abc22ed77546bc3702410519b38c0c47e549d183f1c74e860a170715fdef4c127b1cf9da2aaf665f0d88a7ef5
+  data.tar.gz: 67ee7653c76f8bcc9b20af7c461d9bafac6408852a6a1279eb033ff22eafbfbd7fc33dfff421a6131a5c15967e29e7604c7007d6461687a0134b1dda07081f98

data/cache_box.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name    = 'cache_box'
-  spec.version = '0.0.1-preview2'
+  spec.version = '0.0.1-preview3'
   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
+  # 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
 
+  # Input:
+  #
+  # namespace = String | Symbol # Default: :namespace
+  #
+  # Output: self
   def reset!(namespace = :namespace)
     initialize(namespace)
 
     self
   end
 
+  # 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
 
+  # 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
 
+  # 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
 
+  # 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,6 +134,12 @@ class CacheBox
 
   private
 
+  # Input:
+  #
+  # arg  = String | Symbol
+  # name = String
+  #
+  # Output: N/A
   def validate!(arg, name)
     return if arg.is_a?(Symbol) || arg.is_a?(String)
 
@@ -82,28 +149,50 @@ class CacheBox
     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]
+      @state[:result][name]   = data[:result]
+      @state[:store][name]    = data[:store] unless data[:complete]
+    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
+  # Input:
+  #
+  # file = String # Path
+  #
+  # Output: N/A
+  def store!(name, file)
+    data = {
+      complete: @state[:complete][name],
+      result:   @state[:result][name],
+    }
+    data[:store] = @state[:store][:name] unless @state[:complete][name]
 
-    content = Marshal.dump(value)
+    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,11 +2,21 @@
 
 class CacheBox
   class Chain
+    # Input:
+    #
+    # namespace = String | Symbol # Default: :namespace
+    #
+    # Output: N/A
     def initialize(namespace = :namespace)
       @cache = ::CacheBox.new(namespace)
       @chain = []
     end
 
+    # Input:
+    #
+    # namespace = String | Symbol # Default: :namespace
+    #
+    # Output: self
     def reset!(namespace = :namespace)
       @cache.reset!(namespace)
       @chain = []
@@ -14,6 +24,13 @@ class CacheBox
       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,6 +95,12 @@ class CacheBox
 
     private
 
+    # Input:
+    #
+    # name   = String | Symbol
+    # &block = Proc
+    #
+    # Output: N/A
     def validate_chain!(name, &block)
       unless name.is_a?(Symbol) || name.is_a?(String)
         klass = name.class
@@ -79,6 +120,11 @@ class CacheBox
       )
     end
 
+    # Input:
+    #
+    # arg = nil | :all
+    #
+    # Output: N/A
     def validate_run!(arg)
       return if arg.nil? || arg == :all
 
@@ -92,6 +138,7 @@ class CacheBox
       )
     end
 
+    # Output: Object # Anything the last callable returns.
     def run_all
       result = nil
       @chain.each do |_name, args, callable|
@@ -105,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.preview2
+  version: 0.0.1.pre.preview3
 platform: ruby
 authors:
 - Codruț Constantin Gușoi
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-18 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
@@ -52,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.88'
-description:
+description: 
 email:
 - codrut.gusoi+git-commit@gmail.com
 executables: []
@@ -67,7 +81,7 @@ homepage: https://gitlab.com/sdwolfz/cache_box_rb
 licenses:
 - BSD 3-clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.3
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: A simple, fast, and easy to use file backed cache.
 test_files: []