hammerstore 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b856d43cf2fa1168f640b3782d96dcc3bfc06892
+  data.tar.gz: fdbadfb55318a05883717e412edf31f5145079a9
+SHA512:
+  metadata.gz: 915e7123a9b03db0964e0a2ecd50c1e02cf40f4529e8f8d1372ed50adbf4af6b300d189e0250870d95a14a7b768dee7f82f45690f32c4e5217da2cb518092fb3
+  data.tar.gz: cc3b2d43f712676526520a2a15bfc6e7d490019c8df152b78446d9fe6885b1b9b17b18baba9d0cfd7efd96c7c8daece15eef641eace76e79a021e209a2e9a735

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*.gem
+coverage/
+.coveralls.yml
+.bundle
+Gemfile.lock
+teststore

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Encoding:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+before_install:
+- sudo apt-get update
+- echo $(pwd)
+- sudo apt-get install libsnappy-dev
+- git clone git://github.com/spotify/sparkey.git
+- cd sparkey
+- autoreconf --install
+- ./configure --prefix=/usr
+- make
+- sudo make install
+- cd /home/travis/build/akerl/hammerstore
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+notifications:
+  email: false
+  irc:
+    channels:
+      secure: hkPXdLuGLuCCciK79SXxjWa8BHtaCjBH29ReuAjtyFb/PQcrb/yGOP7L2YVM5uP1dAIv1RQM0CLRdHvXK0f8nlU9y+i10dRXGf4REyan3xW8n+cpMQrd1thm1Kf8q/leLjRuwpwcIFuO2SSyO8/2rwqdy2+BhCMPDg2jXzecd9Q=
+    template:
+    - "%{repository}/%{branch}/%{build_number}: %{message} -- %{build_url}"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Les Aker
+
+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,30 @@
+hammerstore
+=========
+
+[![Gem Version](https://img.shields.io/gem/v/hammerstore.svg)](https://rubygems.org/gems/hammerstore)
+[![Dependency Status](https://img.shields.io/gemnasium/akerl/hammerstore.svg)](https://gemnasium.com/akerl/hammerstore)
+[![Code Climate](https://img.shields.io/codeclimate/github/akerl/hammerstore.svg)](https://codeclimate.com/github/akerl/hammerstore)
+[![Coverage Status](https://img.shields.io/coveralls/akerl/hammerstore.svg)](https://coveralls.io/r/akerl/hammerstore)
+[![Build Status](https://img.shields.io/travis/akerl/hammerstore.svg)](https://travis-ci.org/akerl/hammerstore)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+[Hammerspace](https://github.com/airbnb/hammerspace) storage backend for [BasicCache](https://github.com/akerl/basiccache)
+
+## Usage
+
+```
+require 'basiccache'
+require 'hammerstore'
+
+store = HammerStore.new('/path/to/hammerstore')
+cache = BasicCache.new store
+```
+
+## Installation
+
+    gem install hammerstore
+
+## License
+
+hammerstore is released under the MIT License. See the bundled LICENSE file for details.
+

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Update bundle'
+task :bundle do
+  `bundle update`
+end
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+desc 'Run travis-lint on .travis.yml'
+task :travislint do
+  print 'There is an issue with your .travis.yml' unless system('travis-lint')
+end
+
+task default: [:spec, :travislint, :rubocop, :build, :install]
+task release: [:bundle]

data/hammerstore.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'hammerstore'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime("%Y-%m-%d")
+
+  s.summary     = 'Hammerspace backend for BasicCache'
+  s.description = "Stores cached values in Hammerspace"
+  s.authors     = ['Les Aker']
+  s.email       = 'me@lesaker.org'
+  s.homepage    = 'https://github.com/akerl/hammerstore'
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
+
+  s.add_dependency 'basiccache'
+  s.add_dependency 'hammerspace'
+
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'travis-lint'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fuubar'
+end

data/lib/hammerstore.rb

@@ -0,0 +1,86 @@
+require 'hammerspace'
+
+##
+# Hammerspace-backed Store designed for BasicCache
+module HammerStore
+  class << self
+    ##
+    # Insert a helper .new() method for creating a new Store object
+
+    def new(*args)
+      self::Store.new(*args)
+    end
+  end
+
+  ##
+  # Hammerspace-backed store object
+  class Store
+    attr_reader :raw
+
+    ##
+    # Generate an empty store
+
+    def initialize(file)
+      @raw = Hammerspace.new(file)
+    end
+
+    ##
+    # Clears a specified key or the whole store
+
+    def clear!(key = nil)
+      if key.nil?
+        @raw.clear && {}
+      else
+        key = prep(key)
+        value = @raw[key]
+        @raw.delete key
+        parse value
+      end
+    end
+
+    ##
+    # Retrieve a key
+
+    def [](key)
+      parse @raw[prep(key)]
+    end
+
+    ##
+    # Set a key
+
+    def []=(key, value)
+      @raw[prep(key)] = prep(value)
+    end
+
+    ##
+    # Return the size of the store
+
+    def size
+      @raw.size
+    end
+
+    ##
+    # Check for a key in the store
+
+    def include?(key)
+      @raw.key? prep(key)
+    end
+
+    ##
+    # Array of keys in the store
+
+    def keys
+      @raw.keys.map { |x| parse x }
+    end
+
+    private
+
+    def prep(object)
+      Marshal.dump object
+    end
+
+    def parse(object)
+      object.nil? ? nil : Marshal.load(object)
+    end
+  end
+end

data/spec/hammerstore_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'set'
+
+describe HammerStore do
+  describe '#new' do
+    it 'creates store objects' do
+      test = HammerStore.new 'teststore'
+      expect(test).to be_an_instance_of HammerStore::Store
+    end
+  end
+
+  describe HammerStore::Store do
+    let(:keys) { [1, 2, 3, 4, 5, :foo, 'foo'].to_set }
+    let(:store) do
+      store = HammerStore::Store.new 'teststore'
+      store.clear!
+      (1..5).each { |i| store[i] = i + 5 }
+      store[:foo] = :bar
+      store['foo'] = 'bar'
+      store
+    end
+
+    describe '#initialize' do
+      it 'creates a new store raw object' do
+        expect(store.raw).to be_an_instance_of Hammerspace::Hash
+      end
+    end
+    describe '#clear!' do
+      describe 'when given no argument' do
+        it 'empties the store' do
+          expect(store.clear!).to eql Hash.new
+        end
+      end
+      describe 'when given an argument' do
+        it 'removes a key from the store' do
+          old_size = store.size
+          store.clear! 1
+          expect(store.size).to eql old_size - 1
+        end
+      end
+    end
+    describe '#[]' do
+      it 'retrieves a key' do
+        expect(store[1]).to eql 6
+        expect(store[:foo]).to eql :bar
+        expect(store['foo']).to eql 'bar'
+      end
+    end
+    describe '#[]=' do
+      it 'sets a key' do
+        expect(store[6] = 10).to eql 10
+      end
+    end
+    describe '#size' do
+      it 'returns the size of the store' do
+        expect(store.size).to eql 7
+      end
+    end
+    describe '#include?' do
+      it 'checks for a key in the store' do
+        expect(store.include? :fish).to be_false
+        expect(store.include? 1).to be_true
+      end
+    end
+    describe '#keys' do
+      it 'lists the keys in the store' do
+        expect(store.keys.to_set).to eql keys
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'hammerstore'

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: hammerstore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Les Aker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: basiccache
+  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'
+- !ruby/object:Gem::Dependency
+  name: hammerspace
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stores cached values in Hammerspace
+email: me@lesaker.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hammerstore.gemspec
+- lib/hammerstore.rb
+- spec/hammerstore_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/akerl/hammerstore
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Hammerspace backend for BasicCache
+test_files:
+- spec/hammerstore_spec.rb
+- spec/spec_helper.rb