persistent-cache-storage-directory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bca15b3f0dc16e0a56aec26b72b421c450da0c4
+  data.tar.gz: b759a45d7c38d4002a4f4618975dd00ca41001f3
+SHA512:
+  metadata.gz: 836b2c093d4a0c91ba1be7ec05dbb891c3d306cd19f28f4389fcce184a18d360953b3fc6a556aa4cf9470e1ea91e345c6c060f4cc9f058ea933e9710031107a6
+  data.tar.gz: 5b9579ebd87dc7b9ba03b682f01c00e1bb9cbe68539956610f4447ae24a432a710bb619c61906002b64d2be1215aa35569d0ebdf07075744e7017700bce723a6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+persistent-cache-storage-directory

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.ruby-version-jruby

@@ -0,0 +1 @@
+jruby-9.0.4.0

data/.ruby-version-ruby

@@ -0,0 +1 @@
+ruby-2.0.0-p643

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in persistent-cache-storage-directory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,53 @@
+# Persistent::Cache::StorageDirectory
+
+This gem provides a directory storage back-end to Persistent::Cache. Please see https://rubygems.org/gems/persistent-cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'persistent-cache-storage-directory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install persistent-cache-storage-directory
+
+## Usage
+
+Keys are required to be strings that are valid for use as directory names. The cache then stores from a storage root (configured in the StorageDirector constructor) with a subdirectory for each key, and a file called 'cache' for the value. The first line in the cache file is the timestamp of the entry.
+
+When a StorageDirectory is used, it can be asked whether a key is present and what the path to a cache value is using:
+
+    get_value_path(key)
+
+    key_cached?(key)
+
+Tell Persistent::Cache to use this provider so:
+
+    require 'persistent-cache/storage_directory'
+    require 'persistent-cache'
+
+    storage_location = "/tmp/directory-cache"
+    freshness = nil # forever or freshness in seconds
+    cache = Persistent::Cache.new(storage_location, freshness, Persistent::Cache::STORAGE_DIRECTORY)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evangraan/persistent-cache-storage-directory. This gem was sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "persistent/cache/storage/directory"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/persistent-cache/storage_directory.rb

@@ -0,0 +1,169 @@
+require 'persistent-cache/storage_api'
+require 'persistent-cache/version'
+
+module Persistent
+  class StorageDirectory < Persistent::Cache::StorageApi::API
+    CACHE_FILE = "cache.gz" unless defined? CACHE_FILE; CACHE_FILE.freeze
+
+    attr_accessor :storage_root
+
+    def initialize(storage_details)
+      raise ArgumentError.new("Storage details not provided") if storage_details.nil? or storage_details == ""
+      @storage_root = storage_details
+      connect_to_database
+    end
+
+    def connect_to_database
+      FileUtils.makedirs([@storage_root]) if not File.directory?(@storage_root)
+    end
+
+    def save_key_value_pair(key, value, timestamp = nil)
+      prepare_to_store_key_value(key, value, timestamp)
+      store_key_value(key, value, get_time(timestamp)) if not value.nil?
+    end
+
+    def lookup_key(key)
+      validate_key(key)
+      return [] if not File.exists? compile_value_path(key)
+      lookup_key_value_timestamp(key)
+    end
+
+    def delete_entry(key)
+      validate_key(key)
+      FileUtils.rm_rf(compile_key_path(key))
+    end
+
+    def size
+      count = Dir::glob("#{@storage_root}/**/#{CACHE_FILE}").size
+    end
+
+    def keys
+      return [] if size == 0
+      list_keys_sorted
+    end
+
+    def clear
+      keys.each do |key|
+        delete_entry(key[0])
+      end
+    end
+
+    def get_value_path(key)
+      validate_key(key)
+
+      return nil if not key_cached?(key)
+
+      compile_value_path(key)
+    end
+
+    def get_value_path_even_when_not_cached(key)
+      compile_value_path(key)
+    end
+
+    def key_cached?(key)
+      # don't read the value here, as it may be very large - rather look whether the key is present
+      File.exists? compile_key_path(key)
+    end
+
+    private
+
+    def list_keys_sorted
+      result = []
+      append_keys(result).sort
+    end
+
+    def append_keys(result)
+      get_key_directories.each do |dir|
+        result << extract_key_from_directory(dir)
+      end
+      result
+    end
+
+    def get_key_directories
+      subdirectories = Dir::glob("#{@storage_root}/**/")
+      #exclude the storage root directory itself
+      subdirectories[1..-1]
+    end
+
+    def extract_key_from_directory(dir)
+      key = dir.match(/#{@storage_root}\/(\w+)\//)[1]
+      [key]
+    end
+
+    def compile_key_path(key)
+      "#{@storage_root}/#{key}"
+    end
+
+    def compile_value_path(key)
+      "#{compile_key_path(key)}/#{CACHE_FILE}"
+    end
+
+    def validate_save_key_value_pair(key, value)
+      validate_key(key)
+      raise ArgumentError.new("Only string values allowed") if not value.is_a?(String)
+    end
+
+    def lookup_key_value_timestamp(key)
+      result = [[],[]]
+      data = File.read(compile_value_path(key))
+      format_value_timestamp(result, data)
+    end
+
+    def format_value_timestamp(result, data)
+      result[0][0] = data.lines.to_a[1..-1].join
+      result[0][1] = data.lines.to_a[0..0].join.split("\n")[0]
+      result
+    end
+
+    def validate_key(key)
+      raise ArgumentError.new("Only string keys allowed") if not key.is_a?(String)
+      root_path = Pathname.new(File.absolute_path(@storage_root))
+      key_path = Pathname.new(File.absolute_path(compile_key_path(key)))
+      relative = key_path.relative_path_from(root_path).to_s
+      raise ArgumentError.new("key is outside of storage_root scope") if relative.start_with?("..")
+      raise ArgumentError.new("key is the same as storage_root") if relative == "."
+    end
+
+    def empty_key_value(key)
+      FileUtils.makedirs([compile_key_path(key)]) if not File.exists?(compile_key_path(key))
+      FileUtils.rm_f(compile_value_path(key))
+    end
+
+    def get_time(timestamp)
+      timestamp.nil? ? Time.now.to_s : timestamp.to_s
+    end
+
+    def prepare_to_store_key_value(key, value, timestamp)
+      validate_save_key_value_pair(key, value)
+      delete_entry(key)
+      empty_key_value(key)
+    end
+
+    def store_key_value(key, value, timestamp)
+      tempfile = Tempfile.new("store_key_value")
+      store_value_timestamp_in_file(value, timestamp, tempfile)
+      sync_cache_value(key, tempfile)
+    end
+
+    def sync_cache_value(key, tempfile)
+      target = compile_value_path(key)
+      FileUtils.rm_f(target)
+      FileUtils.move(tempfile.path, target)
+    end
+
+    def store_value_timestamp_in_file(value, timestamp, tempfile)
+      output = File.open(tempfile, 'a')
+      write_value_timestamp(output, value, timestamp)
+      output.close
+    end
+
+    def write_value_timestamp(output, value, timestamp)
+      # Have to be explicit about writing to the file. 'puts' collapses newline at the end of the file and
+      # so does not guarantee exact replication of 'value' on lookup
+      output.write(timestamp)
+      output.write("\n")
+      output.write(value)
+      output.flush
+    end
+  end
+end

data/lib/persistent-cache/version.rb

@@ -0,0 +1,9 @@
+module Persistent
+  module Cache
+    module Storage
+      module Directory
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/persistent-cache-storage-directory.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'persistent-cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "persistent-cache-storage-directory"
+  spec.version       = Persistent::Cache::Storage::Directory::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{provides a directory storage back-end to Persistent::Cache.}
+  spec.description   = %q{provides a directory storage back-end to Persistent::Cache.}
+  spec.homepage      = "https://github.com/evangraan/persistent-cache-storage-directory"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "persistent-cache-storage-api"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: persistent-cache-storage-directory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: persistent-cache-storage-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: provides a directory storage back-end to Persistent::Cache.
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".ruby-version-jruby"
+- ".ruby-version-ruby"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/persistent-cache/storage_directory.rb
+- lib/persistent-cache/version.rb
+- persistent-cache-storage-directory.gemspec
+homepage: https://github.com/evangraan/persistent-cache-storage-directory
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: provides a directory storage back-end to Persistent::Cache.
+test_files: []