cache_box 0.0.1.pre.preview1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19b591535ab5ba124dca095013f08a3be9b348e0138a1738ec6c3088f388e8b9
+  data.tar.gz: 33183202f61274a5f3cfbae070bb83a8f2749b99596daeb98a43f173da8e5ea7
+SHA512:
+  metadata.gz: e14a3c9b73792b6debc38676ce17f28ecfc81981e96476c7d6038ef4a1b9cd9af48513fc4569b9155edb5aa1c685e0ed2ad7844be2ff4e98ae905dce131fdff0
+  data.tar.gz: fd250b2db538d59d215ab656def286afca52d09894d1ea667484a1927441bd1d50638c5a1f0c187a89fb92cb40f7863c5b018fba8ae47867eec15df65edb8233

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2020, Codruț Constantin Gușoi
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the software nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/cache_box.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name    = 'cache_box'
+  spec.version = '0.0.1-preview1'
+  spec.authors = ['Codruț Constantin Gușoi']
+  spec.email   = ['codrut.gusoi+git-commit@gmail.com']
+
+  spec.summary  = 'A simple, fast, and easy to use file backed cache.'
+  spec.homepage = 'https://gitlab.com/sdwolfz/cache_box_rb'
+  spec.license  = 'BSD 3-clause'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.files = [
+    'lib/cache_box.rb',
+    'lib/cache_box_chain.rb',
+    'LICENSE',
+    'cache_box.gemspec'
+  ]
+  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'
+end

data/lib/cache_box.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'cache_box_chain'
+
+class CacheBox
+  def initialize(namespace = :default_namespace)
+    validate!(namespace, 'namespace')
+
+    @namespace = namespace
+    @state     = {}
+    @root      = File.join(Dir.pwd, '.cache')
+    @directory = File.join(@root, @namespace.to_s)
+  end
+
+  def reset!(namespace = :default_namespace)
+    initialize(namespace)
+
+    self
+  end
+
+  def with(name = :default_name, *args)
+    validate!(name, 'name')
+
+    file   = File.join(@directory, name.to_s)
+    result = find(name, file)
+    return result unless result.nil?
+
+    store(yield(*args), name, file)
+  end
+
+  def with_many(name = :default_name, *args)
+    validate!(name, 'name')
+
+    file   = File.join(@directory, name.to_s)
+    result = find(name, file)
+    return result unless result.nil?
+
+    storage = {}
+    begin
+      yield(storage, *args)
+    ensure
+      store(storage, name, file)
+    end
+    storage
+  end
+
+  def has?(name = :default_name)
+    validate!(name, 'name')
+
+    file = File.join(@directory, name.to_s)
+    load!(name, file)
+
+    @state.key?(name)
+  end
+
+  def expire!
+    @state = {}
+    FileUtils.remove_entry_secure(@directory, true)
+
+    self
+  end
+
+  def expire(name = :default_name)
+    validate!(name, 'name')
+
+    @state.delete(name)
+    file = File.join(@directory, name.to_s)
+    FileUtils.remove_entry_secure(file, true)
+
+    self
+  end
+
+  private
+
+  def validate!(arg, name)
+    return if arg.is_a?(Symbol)
+
+    klass = arg.class
+    value = arg.inspect
+
+    raise(ArgumentError, "#{name} must be a Symbol, got #{klass}: #{value}")
+  end
+
+  def load!(name, file)
+    return unless @state[name].nil? && File.exist?(file)
+
+    content      = File.read(file)
+    @state[name] = Marshal.load(content)
+  end
+
+  def find(name, file)
+    load!(name, file)
+
+    @state[name]
+  end
+
+  def store(value, name, file)
+    @state[name] = value
+
+    content = Marshal.dump(value)
+
+    FileUtils.mkdir_p(@directory) unless Dir.exist?(@directory)
+    File.write(file, content)
+
+    value
+  end
+end

data/lib/cache_box_chain.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+class CacheBox
+  class Chain
+    def initialize(namespace = :default_namespace)
+      @cache = ::CacheBox.new(namespace)
+      @chain = []
+    end
+
+    def reset!(namespace = :default_namespace)
+      @cache.reset!(namespace)
+      @chain = []
+
+      self
+    end
+
+    def chain(name, *args, &block)
+      validate_chain!(name, &block)
+
+      @chain.push(
+        [name, args, proc { |*all| @cache.with(name, *all, &block) }]
+      )
+
+      self
+    end
+
+    def chain_many(name, *args, &block)
+      validate_chain!(name, &block)
+
+      @chain.push(
+        [name, args, proc { |*all| @cache.with_many(name, *all, &block) }]
+      )
+
+      self
+    end
+
+    def run!(all = nil)
+      validate_run!(all)
+
+      if all
+        run_all
+      else
+        run_chain
+      end
+    end
+
+    def expire!
+      @cache.expire!
+
+      self
+    end
+
+    def expire(*names)
+      names.each do |name|
+        @cache.expire(name)
+      end
+
+      self
+    end
+
+    private
+
+    def validate_chain!(name, &block)
+      unless name.is_a?(Symbol)
+        klass = name.class
+        value = name.inspect
+
+        raise(ArgumentError, "name must be a Symbol, got #{klass}: #{value}")
+      end
+
+      return unless block.nil?
+
+      raise(
+        ArgumentError,
+        'The `#chain/2` method needs to be called with a block'
+      )
+    end
+
+    def validate_run!(arg)
+      return if arg.nil? || arg == :all
+
+      klass = arg.class
+      value = arg.inspect
+
+      raise(
+        ArgumentError,
+        'The `run!` method only accepts `nil` or the Symbol `:all` as an ' \
+        "argument, got #{klass}: #{value}"
+      )
+    end
+
+    def run_all
+      result = nil
+      @chain.each do |_name, args, callable|
+        input = []
+        input << result if result
+        input += args if args
+
+        result = callable.call(*input)
+      end
+
+      result
+    end
+
+    def run_chain
+      work = []
+
+      @chain.reverse_each do |name, args, callable|
+        work.push([name, args, callable])
+
+        break if @cache.has?(name)
+      end
+
+      result = nil
+      work.reverse_each do |_name, args, callable|
+        input = []
+        input << result if result
+        input += args if args
+
+        result = callable.call(*input)
+      end
+
+      result
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: cache_box
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.preview1
+platform: ruby
+authors:
+- Codruț Constantin Gușoi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-17 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.88'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.88'
+description:
+email:
+- codrut.gusoi+git-commit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- cache_box.gemspec
+- lib/cache_box.rb
+- lib/cache_box_chain.rb
+homepage: https://gitlab.com/sdwolfz/cache_box_rb
+licenses:
+- BSD 3-clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.3
+signing_key:
+specification_version: 4
+summary: A simple, fast, and easy to use file backed cache.
+test_files: []