riak-ruby-ledger 0.0.4

data/test/lib/ledger/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+ 
+describe Riak::Ledger do
+ 
+  it "must be defined" do
+    assert Riak::Ledger::VERSION
+  end
+ 
+end

data/test/lib/ledger_test.rb

@@ -0,0 +1,142 @@
+require_relative '../test_helper'
+require 'riak'
+I18n.enforce_available_locales = false
+
+describe Riak::Ledger do
+  options1 = {:actor => "ACTOR1", :history_length => 5, :retry_count => 10}
+  options2 = {:actor => "ACTOR2", :history_length => 5, :retry_count => 10}
+
+  before do
+    client = Riak::Client.new pb_port: 8087
+    @bucket = client["ledger_test"]
+    @key = "player_1"
+
+
+    @ledger1 = Riak::Ledger.new(@bucket, @key, options1)
+    @ledger2 = Riak::Ledger.new(@bucket, @key, options2)
+  end
+
+  after do
+    @ledger1.delete()
+    @ledger2.delete()
+  end
+
+  it "have a valid starting state" do
+
+    assert_equal({:type=>"TGCounter", :c=>{"ACTOR1"=>{"total"=>0, "txns"=>[]}}}, @ledger1.counter.p.to_hash)
+    assert_equal({:type=>"TGCounter", :c=>{"ACTOR1"=>{"total"=>0, "txns"=>[]}}}, @ledger1.counter.n.to_hash)
+  end
+
+  it "must credit and debit" do
+    @ledger1.credit!("txn1", 10)
+    @ledger1.credit!("txn1", 10)
+    @ledger1.credit!("txn1", 10)
+
+    assert_equal 10, @ledger1.value
+
+    @ledger1.debit!("txn2", 5)
+    @ledger1.debit!("txn2", 5)
+    @ledger1.debit!("txn2", 5)
+
+    assert_equal 5, @ledger1.value
+  end
+
+  it "must have transaction" do
+    @ledger1.credit!("txn1", 10)
+    @ledger1.debit!("txn2", 5)
+
+    assert @ledger1.has_transaction? "txn1"
+    assert @ledger1.has_transaction? "txn2"
+    refute @ledger1.has_transaction? "txn3"
+  end
+
+  it "must save and find counters" do
+    @ledger1.credit!("txn1", 10)
+    @ledger1.debit!("txn2", 5)
+    @ledger2.credit!("txn1", 10) #ignore
+    @ledger2.debit!("txn2", 5) #ignore
+    @ledger2.debit!("txn3", 1)
+    @ledger2.credit!("txn5", 100)
+
+    l1 = Riak::Ledger.find!(@bucket, @key, options1)
+
+    l2 = Riak::Ledger.find!(@bucket, @key, options2)
+
+    assert_equal 104, l1.value
+    assert_equal 104, l2.value
+
+    assert l1.has_transaction? "txn1"
+    assert l1.has_transaction? "txn2"
+    assert l1.has_transaction? "txn5"
+    refute l1.has_transaction? "txn4"
+  end
+
+  it "must merge a single actor" do
+    @ledger1.credit!("txn1", 10)
+    @ledger1.credit!("txn2", 10)
+    @ledger1.credit!("txn3", 10)
+    @ledger1.credit!("txn4", 10)
+    @ledger1.credit!("txn5", 10)
+    @ledger1.credit!("txn6", 10)
+    @ledger1.credit!("txn7", 10)
+    @ledger1.credit!("txn8", 10)
+    @ledger1.credit!("txn9", 10)
+    @ledger1.credit!("txn10", 10)
+
+    @ledger1.credit!("txn11", 10)
+    @ledger1.credit!("txn11", 10)
+    @ledger1.credit!("txn11", 10)
+    @ledger1.credit!("txn11", 10)
+
+    assert_equal 110, @ledger1.value
+    #1st 5 transactions were merged into total
+    assert_equal 60, @ledger1.counter.p.counts["ACTOR1"]["total"]
+
+    refute @ledger1.has_transaction? "txn1"
+    refute @ledger1.has_transaction? "txn2"
+    refute @ledger1.has_transaction? "txn3"
+    refute @ledger1.has_transaction? "txn4"
+    refute @ledger1.has_transaction? "txn5"
+    refute @ledger1.has_transaction? "txn6"
+    assert @ledger1.has_transaction? "txn7"
+    assert @ledger1.has_transaction? "txn8"
+    assert @ledger1.has_transaction? "txn9"
+    assert @ledger1.has_transaction? "txn10"
+    assert @ledger1.has_transaction? "txn11"
+  end
+  #
+  #it "must merge a two actors" do
+  #  @ledger1.debit!("txn1", 10)
+  #  @ledger1.credit!("txn2", 10)
+  #  @ledger1.credit!("txn3", 10)
+  #  @ledger1.credit!("txn4", 10)
+  #  @ledger1.credit!("txn5", 10)
+  #  @ledger2.debit!("txn6", 10)
+  #  @ledger2.credit!("txn7", 10)
+  #  @ledger2.credit!("txn8", 10)
+  #  @ledger2.credit!("txn9", 10)
+  #  @ledger2.credit!("txn10", 10)
+  #
+  #  @ledger1.credit!("txn11", 10)
+  #  @ledger1.credit!("txn11", 10)
+  #  @ledger2.credit!("txn11", 10)
+  #  @ledger2.credit!("txn11", 10)
+  #
+  #  assert_equal 110, @ledger1.value
+  #  #1st 6 transactions were merged into total
+  #  assert_equal 60, @ledger1.counter.p.counts["ACTOR1"]["total"]
+  #
+  #  refute @ledger1.has_transaction? "txn1"
+  #  refute @ledger1.has_transaction? "txn2"
+  #  refute @ledger1.has_transaction? "txn3"
+  #  refute @ledger1.has_transaction? "txn4"
+  #  refute @ledger1.has_transaction? "txn5"
+  #  refute @ledger1.has_transaction? "txn6"
+  #  assert @ledger1.has_transaction? "txn7"
+  #  assert @ledger1.has_transaction? "txn8"
+  #  assert @ledger1.has_transaction? "txn9"
+  #  assert @ledger1.has_transaction? "txn10"
+  #  assert @ledger1.has_transaction? "txn11"
+  #end
+
+end

data/test/lib/tgcounter_test.rb

@@ -0,0 +1,99 @@
+require_relative '../test_helper'
+
+describe Riak::CRDT::TGCounter do
+  options1 = {:actor => "ACTOR1", :history_length => 5}
+  options2 = {:actor => "ACTOR2", :history_length => 5}
+
+  it "must have empty counts on new" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    assert_equal(0, counter.counts["ACTOR1"]["total"])
+    assert_equal([], counter.counts["ACTOR1"]["txns"].arr)
+  end
+
+  it "must increment" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+
+    assert_equal(0, counter.counts["ACTOR1"]["total"])
+    assert_equal(10, counter.counts["ACTOR1"]["txns"]["txn1"])
+  end
+
+  it "must have value" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+
+    assert_equal(20, counter.value)
+  end
+
+  it "must be idempotent before merge" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+
+    assert_equal(20, counter.value)
+  end
+
+  it "must have an added transaction" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+
+    assert counter.has_transaction? "txn1"
+    refute counter.has_transaction? "txn3"
+  end
+
+  it "must translate to and from json" do
+    json = "{\"type\":\"TGCounter\",\"c\":{\"ACTOR1\":{\"total\":0,\"txns\":[[\"txn1\",10],[\"txn2\",10]]}}}"
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+
+    c2 = counter.clone
+
+    assert_equal json, counter.to_json
+
+    assert_equal c2.counts, Riak::CRDT::TGCounter.from_json(json, options1).counts
+  end
+
+  it "must merge" do
+    counter = Riak::CRDT::TGCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn3", 10)
+
+    counter.increment("txn4", 10)
+    counter.increment("txn5", 10)
+    counter.increment("txn6", 10)
+    counter.increment("txn7", 10)
+    counter.increment("txn8", 10)
+
+    counter2 = Riak::CRDT::TGCounter.new(options2)
+    counter2.increment("txn1", 10)
+    counter2.increment("txn2", 10)
+    counter2.increment("txn3", 10)
+    counter2.increment("txn1", 10)
+    counter2.increment("txn1", 10)
+
+    counter2.increment("txn9", 10)
+    counter2.increment("txn10", 10)
+    counter2.increment("txn11", 10)
+    counter2.increment("txn12", 10)
+    counter2.increment("txn13", 10)
+
+    counter.merge(counter2)
+
+    assert_equal(0, counter.counts["ACTOR1"]["total"])
+    assert_equal(130, counter.value)
+
+    counter2.merge(counter)
+
+    assert_equal(30, counter2.counts["ACTOR2"]["total"])
+    assert_equal(130, counter2.value)
+  end
+end

data/test/lib/tpncounter_test.rb

@@ -0,0 +1,97 @@
+require_relative '../test_helper'
+
+describe Riak::CRDT::TPNCounter do
+  options1 = {:actor => "ACTOR1", :history_length => 5}
+  options2 = {:actor => "ACTOR2", :history_length => 5}
+
+  it "must have empty counts on new" do
+    assert_equal({:type=>"TGCounter", :c=>{"ACTOR1"=>{"total"=>0, "txns"=>[]}}}, Riak::CRDT::TPNCounter.new(options1).p.to_hash)
+    assert_equal({:type=>"TGCounter", :c=>{"ACTOR1"=>{"total"=>0, "txns"=>[]}}}, Riak::CRDT::TPNCounter.new(options1).n.to_hash)
+  end
+
+  it "must increment and decrement" do
+    counter = Riak::CRDT::TPNCounter.new(options1)
+    counter.increment("txn1", 10)
+    assert_equal(10, counter.value)
+
+    counter.decrement("txn2", 10)
+    assert_equal(0, counter.value)
+  end
+
+
+  it "must be idempotent before merge" do
+    counter = Riak::CRDT::TPNCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+    counter.decrement("txn3", 10)
+
+    assert_equal(10, counter.value)
+  end
+
+  it "must have an added transaction" do
+    counter = Riak::CRDT::TPNCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+    counter.decrement("txn4", 10)
+
+    assert counter.has_transaction? "txn1"
+    refute counter.has_transaction? "txn3"
+    assert counter.has_transaction? "txn4"
+  end
+
+  it "must translate to and from json" do
+    json = "{\"type\":\"TPNCounter\",\"p\":{\"type\":\"TGCounter\",\"c\":{\"ACTOR1\":{\"total\":0,\"txns\":[[\"txn1\",10]]}}},\"n\":{\"type\":\"TGCounter\",\"c\":{\"ACTOR1\":{\"total\":0,\"txns\":[[\"txn2\",5]]}}}}"
+    counter = Riak::CRDT::TPNCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.decrement("txn2", 5)
+
+    c2 = counter.clone
+
+    assert_equal json, counter.to_json
+
+    {"type"=>"TGCounter", "c"=>{"ACTOR1"=>{"total"=>0, "txns"=>[["txn1", 10]]}}}
+    assert_equal c2.p.counts, Riak::CRDT::TPNCounter.from_json(json, options1).p.counts
+    assert_equal c2.n.counts, Riak::CRDT::TPNCounter.from_json(json, options1).n.counts
+  end
+
+  it "must merge" do
+    counter = Riak::CRDT::TPNCounter.new(options1)
+    counter.increment("txn1", 10)
+    counter.increment("txn2", 10)
+    counter.increment("txn1", 10)
+    counter.increment("txn1", 10)
+    counter.decrement("txn3", 5)
+
+    counter.increment("txn4", 10)
+    counter.increment("txn5", 10)
+    counter.increment("txn6", 10)
+    counter.increment("txn7", 10)
+    counter.decrement("txn8", 5)
+
+    counter2 = Riak::CRDT::TPNCounter.new(options2)
+    counter2.increment("txn1", 10)
+    counter2.increment("txn2", 10)
+    counter2.increment("txn4", 10)
+    counter2.increment("txn1", 10)
+    counter2.decrement("txn5", 1)
+
+    counter2.increment("txn9", 10)
+    counter2.increment("txn10", 10)
+    counter2.increment("txn11", 10)
+    counter2.increment("txn12", 10)
+    counter2.decrement("txn13", 1)
+
+    counter.merge(counter2)
+
+    assert_equal(0, counter.p.counts["ACTOR1"]["total"])
+    assert_equal(88, counter.value)
+
+    counter2.merge(counter)
+
+    assert_equal(20, counter2.p.counts["ACTOR2"]["total"])
+    assert_equal(88, counter2.value)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledger'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: riak-ruby-ledger
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- drewkerrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: json
+  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: riak-client
+  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: A PNCounter CRDT based ledger with support for transaction ids and tunable
+  write idempotence
+email:
+- dkerrigan@basho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/crdt/tgcounter.rb
+- lib/crdt/tpncounter.rb
+- lib/ledger.rb
+- lib/ledger/version.rb
+- riak-ruby-ledger.gemspec
+- test/lib/ledger/version_test.rb
+- test/lib/ledger_test.rb
+- test/lib/tgcounter_test.rb
+- test/lib/tpncounter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/drewkerrigan/riak-ruby-ledger
+licenses:
+- Apache2
+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.1.11
+signing_key: 
+specification_version: 4
+summary: This gem attempts to provide a tunable Counter option by combining non-idempotent
+  GCounters and a partially idempotent GSet for calculating a running counter or ledger.
+  By allowing clients to set how many transactions to keep in the counter object as
+  well as set a retry policy on the Riak actions performed on the counter, a good
+  balance can be achieved.
+test_files:
+- test/lib/ledger/version_test.rb
+- test/lib/ledger_test.rb
+- test/lib/tgcounter_test.rb
+- test/lib/tpncounter_test.rb
+- test/test_helper.rb