horcrux 0.0.1

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011-* rick olson
+
+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,90 @@
+# Horcrux
+
+A Horcrux is a powerful object in which a Dark wizard or witch has hidden a
+fragment of his or her soul for the purpose of attaining immortality.
+
+The Horcrux ruby gem is an abstract key/value store adapter library.  
+
+Horcrux adapters are shims around key/value systems.  They need to define at
+least these three methods:
+
+```ruby
+def get(key)
+  client[key]
+end
+
+def set(key, value)
+  client[key] = value
+  true
+end
+
+def delete(key)
+  client.delete(key) ? true : false
+end
+```
+
+See Horcrux::Memory for a simple example.
+
+They should also include the Horcrux::Methods module.  If the underlying
+key/value system can perform some operations more efficiently, they can 
+be overridden:
+
+```ruby
+# using a redis client
+def set_all(*keys)
+  args = keys.to_a
+  args.flatten!
+  client.mset *args
+  Array.new(keys.size, true) # redis set always succeeds
+end
+```
+
+Adapters can also choose a Serializer object.  A Serializer is any object that
+responds to #dump and #load.  This means Marshal and Yajl can be passed in
+directly. Here's what a custom MessagePack serializer might look like:
+
+```ruby
+module MessagePackSerializer
+  def self.pack(value)
+    value.to_msgpack
+  end
+
+  def self.unpack(str)
+    MessagePack.unpack(str)
+  end
+end
+```
+
+You can then pass this in while creating your Horcrux adapter:
+
+```ruby
+@adapter = Horcrux::Memory.new({}, MessagePackSerializer)
+```
+
+## ToyStore Adapter
+
+A lot of these ideas came from [the Adapter gem][adapter].  It ties into a rad
+[Toystore ORM][toystore].  Check them out... if they work for you, use them!
+
+Horcrux differs in a few areas:
+
+* Focus on batch get/set/delete operations.
+* Doesn't mimic the Hash API.
+* Serializers are a separate object.  BYOS.
+* Boring test/unit tests.  
+* Ruby 1.8.7 and Ruby 1.9.x compatibility.
+
+[adapter]: https://github.com/newtoy/adapter
+[toystore]: https://github.com/newtoy/toystore
+
+## Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version
+   unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have
+   your own version, that is fine but bump version in a commit by itself I can
+   ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+

data/Rakefile

@@ -0,0 +1,134 @@
+#!/usr/bin/env rake
+
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{gem_file}"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/horcrux.gemspec

@@ -0,0 +1,55 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'horcrux'
+  s.version           = '0.0.1'
+  s.date              = '2012-01-01'
+  s.rubyforge_project = 'horcrux'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Simple key/value adapter library."
+  s.description = "Simple key/value adapter library."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@gmail.com'
+  s.homepage = 'http://github.com/technoweenie/horcrux'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'test-unit'
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE.md
+    README.md
+    Rakefile
+    horcrux.gemspec
+    lib/horcrux.rb
+    test/memory_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ %r{^test/*/.+\.rb} }
+end

data/lib/horcrux.rb

@@ -0,0 +1,175 @@
+# See the README.md
+module Horcrux
+  VERSION = "0.0.1"
+
+  # Implements the optional methods of a Horcrux adapter.
+  module Methods
+    def self.included(klass)
+      klass.send :attr_reader, :client, :serializer
+    end
+
+    # Public: Sets up an adapter with the client.
+    #
+    # client     - This is the object that the adapter uses to store and
+    #              retrieve data.
+    # serializer - An object that responds to #pack and #unpack for
+    #              serializing and deserializing values.  Default: a
+    #              StringSerializer.
+    def initialize(client, serializer = nil)
+      @client = client
+      @serializer = serializer || StringSerializer
+    end
+
+    # Public: Gets all the values for the given keys.
+    #
+    #     @adapter.get_all('a', 'b')
+    #     # => ['1', '2']
+    #
+    # keys - One or more String keys.
+    #
+    # Returns an Array of unpacked values in the order of their associated
+    # keys.
+    def get_all(*keys)
+      keys.map { |k| get(k) }
+    end
+
+    # Public: Sets the given values.
+    #
+    #     @adapter.set_all 'a' => '1', 'b' => '2'
+    #     # => ['a', 'b']
+    #
+    # values - A Hash of String keys and Object values.
+    #
+    # Returns an Array of the successfully written String keys.
+    def set_all(values)
+      good_keys = []
+      values.each do |key, value|
+        good_keys << key if set(key, value)
+      end
+      good_keys
+    end
+
+    # Public: Deletes the given keys.
+    #
+    #     @adapter.delete_all 'a', 'b'
+    #     # => [true, false]
+    #
+    # keys - One or more String keys.
+    #
+    # Returns an Array of Booleans specifying whether the deletes were
+    # successful.
+    def delete_all(*keys)
+      keys.map { |k| delete(k) }
+    end
+
+    # Public: Determines if the key is set.
+    #
+    # key - A String key.
+    #
+    # Returns true if the key is set, or false.
+    def key?(key)
+      !get(key).nil?
+    end
+
+    # Public: Either gets the value of the key, or sets it if it doesn't exist.
+    #
+    #     # if 'some-cache' is not set, call #slow_method
+    #     @adapter.fetch('some-cache') { slow_method }
+    #
+    # key - A String key.
+    #
+    # Yields if the key does not exist.  The key is set to the return value of
+    # the block.
+    # Returns the Object value.
+    def fetch(key)
+      get(key) || begin
+        value = yield
+        set(key, value)
+        value
+      end
+    end
+
+    # Public: Transforms the given application key to the internal key that
+    # the storage system uses.
+    # 
+    # key - The String key. 
+    #
+    # Returns the String internal key for the adapter.
+    def key_for(key)
+      key.to_s
+    end
+  end
+
+  # Passes values through Horcrux untouched.
+  module NullSerializer
+    def self.dump(value)
+      value
+    end
+
+    def self.load(str)
+      str
+    end
+  end
+
+  # Ensures that Horcrux values are turned to strings.
+  module StringSerializer
+    def self.dump(value)
+      value.to_s
+    end
+
+    def self.load(str)
+      str
+    end
+  end
+
+  class Memory
+    include Methods
+
+    # Sample Horcrux adapter that stores unmodified values in a ruby Hash.
+    #
+    # client - Optional Hash.
+    def initialize(client = {}, serializer = NullSerializer)
+      @client = client
+      @serializer = serializer
+    end
+
+    # Public: Uses Hash#key? to check the existence of a key.
+    #
+    # key - String key.
+    #
+    # Returns true if the key exists, or false.
+    def key?(key)
+      client.key? key_for(key)
+    end
+
+    # Public: Gets the value for the given key.
+    #
+    # key - The String key.
+    #
+    # Returns the Object value.
+    def get(key)
+      serializer.load client[key_for(key)]
+    end
+
+    # Public: Sets the value for the given key.
+    #
+    # key   - The String key.
+    # value - The Object value.
+    #
+    # Returns true if the operation succeeded, or false.
+    def set(key, value)
+      client[key_for(key)] = serializer.dump(value)
+      true
+    end
+
+    # Public: Deletes the value for the given key.
+    #
+    # key - The String key.
+    #
+    # Returns true if a value was deleted, or false.
+    def delete(key)
+      !client.delete(key_for(key)).nil?
+    end
+  end
+end
+

data/test/memory_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require File.expand_path('../../lib/horcrux', __FILE__)
+
+module Horcrux
+  class MemoryTest < Test::Unit::TestCase
+    def setup
+      @adapter = Memory.new({})
+    end
+
+    def test_reads_set_values
+      assert_nil @adapter.get('a')
+      assert_equal true, @adapter.set('a', '1')
+      assert_equal '1', @adapter.get('a')
+    end
+
+    def test_deletes_values
+      assert_equal true, @adapter.set('a', '1')
+      assert_equal '1', @adapter.get('a')
+      assert_equal true, @adapter.delete('a')
+      assert_equal false, @adapter.delete('a')
+    end
+
+    def test_fetch_sets_fallback
+      assert_nil @adapter.get 'a'
+      assert_equal '1', @adapter.fetch('a') { '1' }
+      assert_equal '1', @adapter.get('a')
+      assert_equal '1', @adapter.fetch('a') { '2' }
+    end
+
+    def test_checks_for_existence_of_key
+      assert !@adapter.key?('a')
+      assert_equal true, @adapter.set('a', '1')
+      assert @adapter.key?('a')
+    end
+
+    def test_multi_get
+      @adapter.set 'a', '1'
+      @adapter.set 'c', '3'
+      assert_equal ['1', nil, '3'], @adapter.get_all('a', 'b', 'c')
+    end
+
+    def test_multi_set
+      assert_nil @adapter.get('a')
+      assert_nil @adapter.get('b')
+
+      @adapter.set_all 'a' => '1', 'b' => '2'
+
+      assert_equal '1', @adapter.get('a')
+      assert_equal '2', @adapter.get('b')
+    end
+
+    def test_multi_delete
+      @adapter.set_all 'a' => '1', 'b' => '2'
+
+      assert_equal '1', @adapter.get('a')
+      assert_equal '2', @adapter.get('b')
+
+      assert_equal [true, true, false], @adapter.delete_all('a', 'b', 'c')
+
+      assert_nil @adapter.get('a')
+      assert_nil @adapter.get('b')
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: horcrux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rick Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70345353049180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70345353049180
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70345353048680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70345353048680
+description: Simple key/value adapter library.
+email: technoweenie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- horcrux.gemspec
+- lib/horcrux.rb
+- test/memory_test.rb
+homepage: http://github.com/technoweenie/horcrux
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: horcrux
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 2
+summary: Simple key/value adapter library.
+test_files:
+- test/memory_test.rb