hanover 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Bryce Kerley
+
+MIT License
+
+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,29 @@
+# Hanover
+
+Hanover is a Riak-based implementation of a couple CRDTs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hanover'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hanover
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+task :test => :riak_running
+
+task :riak_running do
+  begin
+    sh 'curl -s localhost:8091 > /dev/null'
+  rescue => e
+    puts "Couldn't see that Riak is running on port 8091. Sad trombone. :("
+    raise e
+  end
+end

data/hanover.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hanover/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bryce Kerley"]
+  gem.email         = ["bkerley@brycekerley.net"]
+  gem.description   = %q{A Riak-based CRDT implementation of sets and counters.}
+  gem.summary       = %q{Riak-based CRDT implementation.}
+  gem.homepage      = "https://github.com/bkerley/hanover"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hanover"
+  gem.require_paths = ["lib"]
+  gem.version       = Hanover::VERSION
+  
+  gem.add_dependency 'riak-client', '~> 1.0.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'shoulda-context'
+end

data/lib/hanover.rb

@@ -0,0 +1,13 @@
+require 'set'
+require 'json'
+require 'riak'
+
+require "hanover/version"
+
+module Hanover
+  # Your code goes here...
+end
+
+%w{g_set two_p_set g_counter persistence}.each do |f|
+  require_relative File.join('hanover', f)
+end

data/lib/hanover/g_counter.rb

@@ -0,0 +1,54 @@
+module Hanover
+  class GCounter
+    attr_accessor :counts
+    def initialize
+      self.counts = Hash.new{0}
+    end
+    
+    def to_json
+      {
+        type: 'GCounter',
+        c: counts
+        }.to_json
+    end
+    
+    def self.from_json(json)
+      # don't symbolize keys
+      h = JSON.parse json
+      raise ArgumentError.new 'unexpected type field in JSON' unless h['type'] == 'GCounter'
+
+      gc = new
+      gc.counts = h['c']
+      return gc
+    end
+    
+    def increment
+      counts[tag] += 1
+    end
+    
+    def value
+      counts.values.inject(0, &:+)
+    end
+    
+    def merge(other)
+      new_keys = Set.new
+      new_keys.merge counts.keys
+      new_keys.merge other.counts.keys
+      
+      new_keys.each do |k|
+        counts[k] = [counts[k], other.counts[k]].max
+      end
+    end
+    
+    def tag
+      radix = 36
+      [
+        object_id.to_s(radix),
+        Process.uid.to_s(radix), 
+        Process.gid.to_s(radix), 
+        Process.pid.to_s(radix), 
+        `hostname`.strip
+        ].join
+    end
+  end
+end

data/lib/hanover/g_set.rb

@@ -0,0 +1,37 @@
+module Hanover
+  class GSet
+    attr_accessor :members
+    def initialize
+      self.members = Set.new
+    end
+    
+    def self.from_json(json)
+      h = JSON.parse json, symbolize_names: true
+      raise ArgumentError.new 'unexpected type field in JSON' unless h[:type] == 'GSet'
+      
+      gs = new
+      gs.members.merge h[:a]
+      
+      return gs
+    end
+    
+    def add(atom)
+      self.members.add atom
+    end
+    
+    def include?(atom)
+      self.members.include? atom
+    end
+    
+    def to_json(*args)
+      {
+        type: 'GSet',
+        a: self.members.to_a
+        }.to_json(*args)
+    end
+    
+    def merge(other)
+      self.members.merge other.members
+    end
+  end
+end

data/lib/hanover/persistence.rb

@@ -0,0 +1,88 @@
+module Hanover
+  class Persistence
+    attr_reader :key, :content
+    def initialize(content, key = nil)
+      @content = content
+      @key = key
+      @klass = @content.class
+      
+      save
+    end
+    
+    def respond_to?(name)
+      methods.include?(name) || @content.respond_to?(name)
+    end
+    
+    def method_missing(name, *args, &block)
+      result = @content.send name, *args, &block
+      save unless @robject.raw_data == @content.to_json
+      result
+    end
+    
+    def initialize_from_key(key)
+      @key = key
+      @robject = bucket.get key
+
+      get_klass
+      @content = @klass.new
+      perform_merges
+    end
+    
+    def reload
+      @robject.reload
+      perform_merges
+    end
+    
+    def inspect
+      "#<Hanover::Persistence::0x#{object_id.to_s(16)} @key=#{@robject.key} #{@content.inspect}>"
+    end
+    
+    def self.find(key)
+      p = allocate
+      p.initialize_from_key key
+      return p
+    end
+    
+    def self.client
+      return @client if defined? @client
+      @client = Riak::Client.new http_port: 8091
+    end
+    
+    private
+    def save
+      create unless @robject
+      @robject.raw_data = @content.to_json
+      @robject.content_type = 'application/json'
+      @robject.store
+      reload
+    end
+    
+    def create
+      @robject = bucket.new @key      
+      @robject.raw_data = @content.to_json
+      
+      @robject.store
+      @key = @robject.key
+    end
+    
+    def perform_merges
+      if @robject.conflict?
+         @robject.siblings.each {|s| @content.merge @klass.from_json s.raw_data }
+       else
+         @content.merge @klass.from_json @robject.raw_data
+       end
+    end
+    
+    def get_klass
+      if @robject.conflict?
+        @klass = Hanover.const_get @robject.siblings.first.data['type']
+      else
+        @klass = Hanover.const_get @robject.data['type']
+      end
+    end
+    
+    def bucket
+      self.class.client.bucket 'hanover'
+    end
+  end
+end

data/lib/hanover/two_p_set.rb

@@ -0,0 +1,52 @@
+module Hanover
+  class TwoPSet
+    attr_accessor :added, :removed
+    
+    def initialize
+      self.added = GSet.new
+      self.removed = GSet.new
+    end
+    
+    def self.from_json(json)
+      h = JSON.parse json, symbolize_names: true
+      raise ArgumentError.new 'unexpected type field in JSON' unless h[:type] == 'TwoPSet'
+
+      tps = new
+      tps.added = GSet.from_json h[:a].to_json
+      tps.removed = GSet.from_json h[:r].to_json
+      
+      return tps
+    end
+    
+    def include?(atom)
+      members.include? atom
+    end
+    
+    def members
+      self.added.members - self.removed.members
+    end
+    
+    def add(atom)
+      raise ArgumentError.new 'already removed' if self.removed.include? atom
+      
+      self.added.add atom
+    end
+    
+    def remove(atom)
+      self.removed.add atom
+    end
+    
+    def merge(other)
+      self.added.merge other.added
+      self.removed.merge other.removed
+    end
+    
+    def to_json(*args)
+      {
+        type: 'TwoPSet',
+        a: self.added,
+        r: self.removed
+        }.to_json *args
+    end
+  end
+end

data/lib/hanover/version.rb

@@ -0,0 +1,3 @@
+module Hanover
+  VERSION = "0.0.1"
+end

data/test/g_counter_test.rb

@@ -0,0 +1,36 @@
+require_relative 'helper'
+
+class GCounterTest < HanoverCase
+  context 'GCounter' do
+    subject { GCounter.new }
+
+    should 'increment' do
+      assert_equal 0, subject.value
+      
+      subject.increment
+      subject.increment
+      
+      assert_equal 2, subject.value
+    end
+    
+    should 'merge' do
+      other = subject.class.new
+      subject.increment
+      other.increment
+      
+      subject.merge other
+      
+      assert_equal 2, subject.value
+    end
+    
+    should 'round trip from JSON' do
+      subject.increment
+      subject.increment
+      
+      j = subject.to_json
+      other = subject.class.from_json j
+      
+      assert_equal 2, other.value
+    end
+  end
+end

data/test/g_set_test.rb

@@ -0,0 +1,37 @@
+require_relative 'helper'
+
+class GSetTest < HanoverCase
+  context 'GSet' do
+    subject { GSet.new }
+    should 'have entries after addition' do
+      subject.add :alpha
+      subject.add :bravo
+      
+      assert_includes subject, :alpha
+      assert_includes subject, :bravo
+    end
+    
+    should 'merge' do
+      other = GSet.new
+      
+      subject.add :charlie
+      other.add :delta
+      
+      subject.merge other
+      
+      assert_includes subject, :charlie
+      assert_includes subject, :delta
+    end
+    
+    should 'json round trip' do
+      subject.add 'echo'
+      subject.add 'foxtrot'
+      subject.add 7
+      
+      j = subject.to_json
+      other = GSet.from_json j
+      
+      assert_equal subject.members, other.members
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'shoulda-context'
+require 'minitest/autorun'
+
+require_relative File.join('..', 'lib', 'hanover')
+
+class HanoverCase < MiniTest::Unit::TestCase
+  include Shoulda::Context::Assertions
+  include Shoulda::Context::InstanceMethods
+  extend Shoulda::Context::ClassMethods
+  
+  include Hanover
+end

data/test/persistence_test.rb

@@ -0,0 +1,52 @@
+require_relative 'helper'
+
+class PersistenceTest < HanoverCase
+  context 'the Persistence class' do
+    subject { Persistence }
+    
+    should 'wrap a CRDT' do
+      wrapped = Persistence.new GSet.new
+
+      assert wrapped.key
+      assert_kind_of GSet, wrapped.content
+    end
+    
+    should 'load successfully' do
+      wrapped = Persistence.new GSet.new
+      
+      found = Persistence.find wrapped.key
+      
+      assert_equal wrapped.key, found.key
+    end
+  end
+  
+  context 'a wrapped GSet' do
+    subject { Persistence.new GSet.new }
+
+    should 'name itself' do
+      assert subject.key
+    end
+    
+    should 'delegate adding elements to the set' do
+      subject.add 'alpha'
+      subject.add 'bravo'
+      
+      assert_includes subject, 'alpha'
+      assert_includes subject, 'bravo'
+    end
+    
+    should 'support parallel adds consistently' do
+      other = Persistence.find subject.key
+      subject.add 'alpha'
+      other.add 'bravo'
+      subject.reload
+      
+      third = Persistence.find subject.key
+      
+      assert_includes subject, 'alpha'
+      assert_includes subject, 'bravo'
+      assert_includes third, 'alpha'
+      assert_includes third, 'bravo'
+    end
+  end
+end

data/test/two_p_set_test.rb

@@ -0,0 +1,48 @@
+require_relative 'helper'
+
+class TwoPSetTest < HanoverCase
+  context 'TwoPSet' do
+    subject { TwoPSet.new }
+    
+    should 'support adding and removing' do
+      subject.add :alpha
+      subject.add :bravo
+      
+      assert_includes subject, :alpha
+      assert_includes subject, :bravo
+      
+      subject.remove :bravo
+      
+      refute_includes subject, :bravo
+    end
+    
+    should 'merge' do
+      other = subject.class.new
+      
+      subject.add 'echo'
+      other.add 'foxtrot'
+      subject.add 'george'
+      other.remove 'george'
+      
+      assert_includes subject.members, 'george'
+      
+      subject.merge other
+      
+      assert_includes subject, 'echo'
+      assert_includes subject, 'foxtrot'
+      
+      refute_includes subject, 'george'
+    end
+    
+    should 'round trip from JSON' do
+      subject.add 'charlie'
+      subject.add 'delta'
+      subject.remove 'delta'
+      
+      j = subject.to_json
+      other = subject.class.from_json j
+      
+      assert_equal subject.members, other.members
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hanover
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bryce Kerley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Riak-based CRDT implementation of sets and counters.
+email:
+- bkerley@brycekerley.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hanover.gemspec
+- lib/hanover.rb
+- lib/hanover/g_counter.rb
+- lib/hanover/g_set.rb
+- lib/hanover/persistence.rb
+- lib/hanover/two_p_set.rb
+- lib/hanover/version.rb
+- test/g_counter_test.rb
+- test/g_set_test.rb
+- test/helper.rb
+- test/persistence_test.rb
+- test/two_p_set_test.rb
+homepage: https://github.com/bkerley/hanover
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Riak-based CRDT implementation.
+test_files:
+- test/g_counter_test.rb
+- test/g_set_test.rb
+- test/helper.rb
+- test/persistence_test.rb
+- test/two_p_set_test.rb