meangirls 0.1.0

data/lib/meangirls/version.rb

@@ -0,0 +1,3 @@
+module Meangirls
+  VERSION = "0.1.0"
+end

data/meangirls.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meangirls/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "meangirls"
+  spec.version       = Meangirls::VERSION
+  spec.authors       = ["Kyle Kingsbury"]
+  spec.email         = ["aphyr@aphyr.com"]
+  spec.description   = %q{Serializable data types for eventually consistent systems.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/aphyr/meangirls"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bacon"
+  spec.add_development_dependency "mocha-on-bacon"
+  spec.add_development_dependency "yajl-ruby"
+end

data/spec/counter.rb

@@ -0,0 +1,58 @@
+shared :counter do
+  should 'create a counter' do
+    @class.new.should.be.kind_of? @class
+  end
+
+  should '==' do
+    a = @class.new
+    b = @class.new
+    a.should == b
+
+    a += 1
+    a.should.not == b
+    b += 2
+    a.should.not == b
+    a += 1
+    a.should == b
+
+    a.increment('foo', 2)
+    a.should.not == b
+    b.increment('foo', 2)
+    a.should == b
+  end
+
+  should '===' do
+    @s.should === @s
+    @s.should === 0
+    @s.should === 0.0
+  end
+
+  should '+' do
+    a = @s + 1
+    a.should.be.kind_of? Meangirls::Counter
+    a.should === 1
+
+    b = @class.new.increment('foo', 2)
+    b += 3
+    b.should === 5
+  end
+
+  should '-' do
+  end
+
+  should 'float?' do
+    @class.new.increment(1)
+  end
+
+  should 'merge' do
+  end
+
+  should 'increment' do
+  end
+
+  should 'to_i' do
+  end
+
+  should 'to_f' do
+  end
+end

data/spec/crdt.rb

@@ -0,0 +1,16 @@
+require 'yajl/json_gem'
+
+shared :crdt do
+  should 'as_json' do
+    j = @s.as_json
+    j.should.be.kind_of? Hash
+    j['type'].should == @s.type
+  end
+
+  should 'round trip' do
+    @examples.each do |t|
+      Meangirls.parse(t.as_json).should == t
+      Meangirls.parse(JSON.parse(t.as_json.to_json)).should == t
+    end
+  end
+end

data/spec/g_counter.rb

@@ -0,0 +1,14 @@
+describe 'g-counter' do
+  before do
+    @class = Meangirls::GCounter
+    @s = @class.new
+    @examples = [
+      @class.new,
+      @class.new.increment('a', 1),
+      @class.new.increment('a', 1).increment('b', 0).increment('c', 1500.125)
+    ]
+  end
+
+  behaves_like :crdt
+  behaves_like :counter
+end

data/spec/init.rb

@@ -0,0 +1,9 @@
+require 'bacon'
+require 'mocha-on-bacon'
+require "#{File.expand_path(File.dirname(__FILE__))}/prob"
+require "#{File.expand_path(File.dirname(__FILE__))}/crdt"
+require "#{File.expand_path(File.dirname(__FILE__))}/set"
+require "#{File.expand_path(File.dirname(__FILE__))}/counter"
+require "#{File.expand_path(File.dirname(__FILE__))}/../lib/meangirls"
+
+Bacon.summary_on_exit

data/spec/lww_set.rb

@@ -0,0 +1,65 @@
+describe 'lww-set' do
+  before do
+    @class = Meangirls::LWWSet
+    @idempotent = false
+    @s = @class.new
+    @examples = [
+      @class.new,
+      (@class.new << 1),
+      (@class.new - [1,2]),
+      (@class.new - [1,2] + [2,3]),
+      (@class.new + [1,2] - [2,3])
+    ]
+  end
+
+  behaves_like :crdt
+  behaves_like :set
+  behaves_like :prob
+
+  should '==' do
+    a = @class.new
+    b = @class.new
+    a.add 1, 0
+    b.add 1, 0
+    a.should == b
+
+    a.delete 1, 1
+    a.should.not == b
+    b.delete 1, 1
+    a.should == b
+  end
+
+  should 'preserve latest writes' do
+    crdt = @class.new
+    test_merge crdt do |siblings, merged|
+      # Reconstruct transaction log.
+      log = []
+      siblings.each do |s|
+        s.e.each do |e, pair|
+          if t = pair.add
+            log << [t, :add, e]
+          end
+          if t = pair.remove
+            log << [t, :remove, e]
+          end
+        end
+      end
+      log.sort_by!(&:first)
+
+      # Todo: compact log, removing identical timestamps and choosing operation based on crdt.bias.
+      # Not needed currently as local timestamps are guaranteed unique within process.
+
+      # Replay log on top of original
+      model = log.inject(crdt.to_set) do |set, op|
+        case op[1]
+        when :add
+          set.add op.last
+        when :remove
+          set.delete op.last
+        end
+      end
+
+      model == merged.to_set
+    end
+  end
+end

data/spec/or_set.rb

@@ -0,0 +1,41 @@
+describe 'or-set' do
+  before do
+    @class = Meangirls::ORSet
+    @idempotent = false
+    @s = @class.new
+    @examples = [
+      @class.new,
+      (@class.new << 1),
+      (@class.new - [1,2]),
+      (@class.new - [1,2] + [2,3]),
+      (@class.new + [1,2] - [2,3])
+    ]
+  end
+
+  behaves_like :crdt
+  behaves_like :set
+  behaves_like :prob
+
+  should '==' do
+    a = @class.new
+    b = @class.new
+    a.add 1, 0
+    b.add 1, 0
+    a.should == b
+
+    a.delete 1
+    a.should.not == b
+    b.delete 1
+    a.should == b
+  end
+
+  should 'preserve independent adds' do
+    test_merge @class.new do |sibs, merged|
+      sibs.inject(Set.new) do |present, sib|
+        present | sib.to_set
+      end.all? do |e|
+        merged.include? e
+      end
+    end
+  end
+end

data/spec/prob.rb

@@ -0,0 +1,93 @@
+shared :prob do
+  COUNT ||= 10000
+
+  require 'pp'
+  def serialize(crdt)
+    crdt.to_json
+  end
+
+  def deserialize(text)
+    Meangirls.parse JSON.parse text
+  end
+
+  # Serialize then deserialize CRDT.
+  def roundtrip(crdt)
+    deserialize serialize crdt
+  end
+
+  # Takes a CRDT and returns n copies.
+  def split(crdt, n = rand(10))
+    n.times.map do
+      roundtrip crdt
+    end
+  end
+
+  # Merge n CRDTs together.
+  def merge(crdts)
+    crdts.inject(&:merge)
+  end
+
+  # Generate a random operation on a CRDT.
+  def operation
+    op = if rand > 0.5
+        :add
+      else
+        :delete
+      end
+    [op, rand(10)]
+  end
+
+  # A sequence of operations on a CRDT.
+  def operations
+    rand(5).times.map do
+      operation
+    end
+  end
+
+  # Apply the given operations to this CRDT.
+  def apply(ops, crdt)
+    ops.inject(crdt) do |c, op|
+      begin
+        c.send *op
+      rescue Meangirls::DeleteNotAllowed
+      rescue Meangirls::ReinsertNotAllowed
+      end
+      c
+    end
+  end
+
+  # Split, apply operations, merge. 
+  def splurge(input, operations)
+    splits = split(input, operations.size).map.with_index do |c, i|
+      apply operations[i], c
+    end
+    merged = merge splits
+    [input, splits, merged]
+  end
+
+  # Attempts to generate failing sets of operations given a CRDT and a test
+  # block.
+  def test_merge(crdt, opts = {}, &block)
+    count = opts[:count] || COUNT
+    forks = opts[:forks] || rand(5) + 1
+
+    count.times do
+      operations = forks.times.map { operations() }
+      input, splits, merged = splurge crdt.clone, operations
+      if yield [splits, merged]
+      else
+        puts "Failed!"
+        puts "Input"
+        pp input
+        puts "Operations"
+        pp operations
+        puts "Siblings"
+        pp splits
+        puts "Merged"
+        pp merged
+        false.should.be.true
+      end
+    end
+    true.should.be.true
+  end
+end

data/spec/run

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'open3'
+require 'find'
+
+tests = []
+
+files, args = ARGV.partition do |arg|
+  File.exists? arg
+end
+
+dirs = files.empty? ? [File.dirname(__FILE__)] : files
+dirs.each do |dir|
+  Find.find(dir) do |path|
+    next unless path =~ /\.rb$/
+    next if path =~ /\/init\.rb$/
+    tests << path
+  end
+end
+
+system *(["bacon", "-r", File.expand_path(File.dirname(__FILE__) + "/init.rb")] + args + tests.sort)

data/spec/set.rb

@@ -0,0 +1,186 @@
+shared :set do
+  should 'create an empty set' do
+    n = @s
+    n.should.be.empty
+  end
+
+  if @idempotent
+    should '==' do
+      @s.should == @s
+      a = @class.new
+      b = @class.new
+      a.should == b
+      a << 1
+      a.should.not == b
+      b << 1
+      a.should == b
+      a.delete 1
+      a.should.not == b
+      b.delete 1
+      a.should == b
+    end
+  else
+    should '==' do
+      @s.should == @s
+      a = @class.new
+      b = @class.new
+      a.should == b
+      a << 1
+      a.should == a
+      a.delete 1
+      a.should == a
+    end
+  end
+
+  should '===' do
+    @s.should === @s
+    @s.should === []
+    @s.should === Set.new
+  
+    a = @class.new
+    a << 1
+    a << 2
+    a.should === [2,1]
+    a.should === [1,2].to_set
+    a.should === (1..2)
+
+    a.delete 1
+    a.should === [2]
+    a.should === [2].to_set
+    a.should === (2..2)
+  end
+
+  should '&' do
+    (@s & []).should === []
+    (@s & [1,2,3]).should === []
+
+    a = @class.new
+    a << 1
+    a << 2
+    (a & []).should === []
+    (a & [1,3]).should === [1]
+  end
+
+  should '|' do
+    (@s | []).should === []
+    (@s | [1,2,3]).should === [1,2,3]
+
+    a = @class.new
+    a << 1
+    a << 2
+    (a | []).should == a
+    (a | []).should === [1,2]
+    (a | [2,3]).should == (a << 3) if @idempotent
+    (a | [2,3]).should === [1,2,3]
+  end
+
+  should '-' do
+    (@s - []).should == @s
+    (@s - [1,2,3]).should === [] rescue Meangirls::DeleteNotAllowed
+
+    a = @class.new
+    a << 1
+    a << 2
+    (a - []).should == a
+    (a - [2]).should === [1]
+    (a - [2,3]).should === [1] rescue Meangirls::DeleteNotAllowed
+  end
+
+  should '<<' do
+    (@s << 1).should === [1]
+    (@s << 1 << 2).should === [1,2]
+  end
+
+  should 'delete' do
+    @s.delete(1).should == nil rescue Meangirls::DeleteNotAllowed
+    @s.should === []
+
+    a = @class.new
+    a << 1
+    a << 2
+    a.delete(1).should == 1
+    a.should === [2]
+  end
+
+  should 'empty' do
+    @s.should.be.empty
+    @s << 1
+    @s.should.not.be.empty
+    @s.delete 1
+    @s.should.be.empty
+  end
+
+  should 'merge empty sets' do
+    # Empty set
+    @s.merge(@s).should == @s
+  end
+
+  should 'merge with self' do
+    a = @class.new
+    a << 1
+    a << 2
+    a.merge(a).should == a
+  end
+
+  should 'merge disjoint sets' do
+    a = @class.new
+    a << 2
+
+    b = @class.new
+    b << 1
+    b << 3
+    a.merge(b).should === [1,2,3]
+    b.merge(a).should == a.merge(b)
+  end
+
+  should 'merge overlapping sets' do
+    a = @class.new
+    a << 1
+    a << 2
+    b = @class.new
+    b << 2
+    b << 3
+    a.merge(b).should === [1,2,3]
+    b.merge(a).should == a.merge(b)
+  end
+
+  ([@s.bias] | (@class.biases rescue [])).each do |bias|
+    should "merge biased towards #{bias}" do
+      Meangirls.expects(:timestamp).times(0..3).returns(0)
+      case bias
+      when 'a'
+        # Should preserve adds
+        a = @class.new
+        a.bias = 'a' if a.respond_to? :bias=
+        a << 1
+        a.delete 1
+        b = @class.new
+        b.bias = 'a' if b.respond_to? :bias=
+        b << 1
+        a.merge(b).should === [1]
+        b.merge(a).should == a.merge(b)
+      when 'r'
+        # Should preserve deletes
+        a = @class.new
+        a.bias = 'r' if a.respond_to? :bias=
+        a << 1
+        a.delete 1
+        b = @class.new
+        b.bias = 'r' if b.respond_to? :bias=
+        b << 1
+        a.merge(b).should === []
+        b.merge(a).should == a.merge(b)
+      end
+    end
+  end
+
+  should 'size' do
+    @s.size.should == 0
+    @s << 1
+    @s.size.should == 1
+    @s << 1
+    @s.size.should == 1
+    @s.delete 1
+    @s.size.should == 0
+  end
+end