merkle_tree 0.1.0

data/spec/unit/leaves_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#leaves' do
+  it "returns empty array when tree has no leaves" do
+    merkle_tree = MerkleTree.new
+
+    expect(merkle_tree.leaves).to be_empty
+  end
+
+  it "returns all leaves" do
+    leaves = ["L1", "L2", "L3", "L4", "L5", "L6", "L7", "L8"]
+    merkle_tree = MerkleTree.new(*leaves)
+
+    expect(merkle_tree.leaves.size).to eq(leaves.size)
+  end
+end

data/spec/unit/new_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#new' do
+  it "creates tree from even number of messages" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4")
+
+    expect(merkle_tree.to_h).to eq({
+      root: {
+        value: "63442ffc2d48a92c8ba746659331f273748ccede648b27f4eacf00cb0786c439",
+        left: {
+          value: "f2b92f33b56466fce14bc2ccf6a92f6edfcd8111446644c20221d6ae831dd67c",
+          left: {
+            value: "dffe8596427fc50e8f64654a609af134d45552f18bbecef90b31135a9e7acaa0"
+          },
+          right: {
+            value: "d76354d8457898445bb69e0dc0dc95fb74cc3cf334f8c1859162a16ad0041f8d"
+          }
+        },
+        right: {
+          value: "8f75b0c1b3d1c0bb2eda264a43f8fdc5c72c853c95fbf2b01c1d5a3e12c6fe9a",
+          left: {
+            value: "842983de8fb1d277a3fad5c8295c7a14317c458718a10c5a35b23e7f992a5c80"
+          },
+          right: {
+            value: "4a5a97c6433c4c062457e9335709d57493e75527809d8a9586c141e591ac9f2c"
+          }
+        }
+      }
+    })
+  end
+
+  it "creates tree from odd number of messages by duplicating the last message" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3")
+
+    expect(merkle_tree.to_h).to eq({
+      root: {
+        value: "bdb1b6778b2923c883a078a6d8dbf40f99bb1a58bf5f650349f965bd8a222f43",
+        left: {
+          value: "f2b92f33b56466fce14bc2ccf6a92f6edfcd8111446644c20221d6ae831dd67c",
+          left: {
+            value: "dffe8596427fc50e8f64654a609af134d45552f18bbecef90b31135a9e7acaa0"
+          },
+          right: {
+            value: "d76354d8457898445bb69e0dc0dc95fb74cc3cf334f8c1859162a16ad0041f8d"
+          }
+        },
+        right: {
+          value: "5ca8ce04894dcfaacfe7b77d5f003b355ca0df2e0055d6c9fa3b006a8e56a2ba",
+          left: {
+            value: "842983de8fb1d277a3fad5c8295c7a14317c458718a10c5a35b23e7f992a5c80"
+          },
+          right: {
+            value: "842983de8fb1d277a3fad5c8295c7a14317c458718a10c5a35b23e7f992a5c80"
+          }
+        }
+      }
+    })
+  end
+
+  it "changes hashing function" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4",
+                                 digest: -> (val) { "(#{val}h)"})
+
+    expect(merkle_tree.to_h).to eq({
+      root: {
+        value: "(((L1h)(L2h)h)((L3h)(L4h)h)h)",
+        left: {
+          value: "((L1h)(L2h)h)",
+          left:  { value: "(L1h)" },
+          right: { value: "(L2h)" },
+        },
+        right: {
+          value: "((L3h)(L4h)h)",
+          left:  { value: "(L3h)" },
+          right: { value: "(L4h)" }
+        }
+      }
+    })
+  end
+end

data/spec/unit/node/build_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree::Node, '::build' do
+  it "combines two leaf nodes" do
+    nodes = [
+      MerkleTree::Leaf.build("L1", 0),
+      MerkleTree::Leaf.build("L2", 1)
+    ]
+
+    node = MerkleTree::Node.build(*nodes)
+
+    expect(node.value).to eq('f2b92f33b56466fce14bc2ccf6a92f6edfcd8111446644c20221d6ae831dd67c')
+    expect(node.left).to eq(nodes[0])
+    expect(node.right).to eq(nodes[1])
+    expect(node.left_index).to eq(0)
+    expect(node.right_index).to eq(1)
+  end
+
+  it "combines leaf node with empty node" do
+    leaf = MerkleTree::Leaf.build("L1", 0)
+    nodes = [
+      leaf,
+      MerkleTree::Node::EMPTY
+    ]
+
+    node = MerkleTree::Node.build(*nodes)
+
+    expect(node.value).to eq("15253c068a787616f4a6580d34a099f5bde3991f771a5c8a7841638db7e69e24")
+
+    expect(node.left_index).to eq(0)
+    expect(node.right_index).to eq(MerkleTree::Node::UNDEFINED)
+  end
+
+  it "combines 2 nodes" do
+    nodes_left = [
+      MerkleTree::Leaf.build("L1", 0),
+      MerkleTree::Leaf.build("L2", 1)
+    ]
+
+    nodes_right = [
+      MerkleTree::Leaf.build("L3", 2),
+      MerkleTree::Leaf.build("L4", 3)
+    ]
+
+    node_left = MerkleTree::Node.build(*nodes_left)
+    node_right = MerkleTree::Node.build(*nodes_right)
+
+    node = MerkleTree::Node.build(node_left, node_right)
+
+    expect(node.value).to eq("63442ffc2d48a92c8ba746659331f273748ccede648b27f4eacf00cb0786c439")
+    expect(node.left).to eq(node_left)
+    expect(node.right).to eq(node_right)
+    expect(node.left_index).to eq(0)
+    expect(node.right_index).to eq(3)
+  end
+end

data/spec/unit/node/eql_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree::Node, '#==' do
+  it "compares two different nodes" do
+    nodes_left = [
+      MerkleTree::Leaf.build("L1", 0),
+      MerkleTree::Leaf.build("L2", 1)
+    ]
+
+    nodes_right = [
+      MerkleTree::Leaf.build("L3", 2),
+      MerkleTree::Leaf.build("L4", 3)
+    ]
+
+    node_left = MerkleTree::Node.build(*nodes_left)
+    node_right = MerkleTree::Node.build(*nodes_right)
+
+    expect(node_left).to_not eq(node_right)
+  end
+
+  it "compares same node" do
+    nodes = [
+      MerkleTree::Leaf.build("L1", 0),
+      MerkleTree::Leaf.build("L2", 1)
+    ]
+
+    node = MerkleTree::Node.build(*nodes)
+
+    expect(node).to eq(node)
+  end
+end

data/spec/unit/root_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#root' do
+  it "returns empty root when no messages" do
+    merkle_tree = MerkleTree.new
+
+    expect(merkle_tree.root).to eq(MerkleTree::Node::EMPTY)
+  end
+
+  it "calculates root signature" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4")
+
+    expect(merkle_tree.root.value).to eq("63442ffc2d48a92c8ba746659331f273748ccede648b27f4eacf00cb0786c439")
+  end
+end

data/spec/unit/size_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#size' do
+  it "returns 0 when tree has no messages" do
+    merkle_tree = MerkleTree.new
+
+    expect(merkle_tree.size).to eq(0)
+  end
+
+  it "returns 15 when tree has 8 messages" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4", "L5", "L6", "L7", "L8")
+
+    expect(merkle_tree.size).to eq(15)
+  end
+end

data/spec/unit/subtree_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#subtree' do
+  it "return empty node for non existent index" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4")
+
+    expect(merkle_tree.subtree(10)).to eq(MerkleTree::Node::EMPTY)
+  end
+
+  it "extracts subtree for a given index" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4", "L5", "L6", "L7", "L8")
+
+    expect(merkle_tree.subtree(2).to_h).to eq({
+      value: "63442ffc2d48a92c8ba746659331f273748ccede648b27f4eacf00cb0786c439",
+      left: {
+        value: "f2b92f33b56466fce14bc2ccf6a92f6edfcd8111446644c20221d6ae831dd67c",
+        left: {
+          value: "dffe8596427fc50e8f64654a609af134d45552f18bbecef90b31135a9e7acaa0",
+        },
+        right: {
+          value: "d76354d8457898445bb69e0dc0dc95fb74cc3cf334f8c1859162a16ad0041f8d",
+        }
+      },
+      right: {
+        value: "8f75b0c1b3d1c0bb2eda264a43f8fdc5c72c853c95fbf2b01c1d5a3e12c6fe9a",
+        left: {
+          value: "842983de8fb1d277a3fad5c8295c7a14317c458718a10c5a35b23e7f992a5c80",
+        },
+        right: {
+          value: "4a5a97c6433c4c062457e9335709d57493e75527809d8a9586c141e591ac9f2c"
+        }
+      }
+    })
+  end
+end

data/spec/unit/to_s_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#to_s' do
+  it "prints all tree signatures indented by 2 spaces" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4")
+
+    expect(merkle_tree.to_s).to eq([
+      "63442ffc2d48a92c8ba746659331f273748ccede648b27f4eacf00cb0786c439",
+      "  f2b92f33b56466fce14bc2ccf6a92f6edfcd8111446644c20221d6ae831dd67c",
+      "    dffe8596427fc50e8f64654a609af134d45552f18bbecef90b31135a9e7acaa0",
+      "    d76354d8457898445bb69e0dc0dc95fb74cc3cf334f8c1859162a16ad0041f8d",
+      "  8f75b0c1b3d1c0bb2eda264a43f8fdc5c72c853c95fbf2b01c1d5a3e12c6fe9a",
+      "    842983de8fb1d277a3fad5c8295c7a14317c458718a10c5a35b23e7f992a5c80",
+      "    4a5a97c6433c4c062457e9335709d57493e75527809d8a9586c141e591ac9f2c"
+    ].join("\n"))
+  end
+end

data/spec/unit/update_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe MerkleTree, '#update' do
+  it "updates a leaf at index position with a new message" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4")
+    updated_merkle_tree = MerkleTree.new("L1", "L2", "L3*", "L4")
+    expected_leaf = MerkleTree::Leaf.build("L3*", 2)
+
+    updated_leaf = merkle_tree.update("L3*", 2)
+
+    expect(updated_leaf.value).to eq(expected_leaf.value)
+    expect(merkle_tree.root.value).to eq(updated_merkle_tree.root.value)
+  end
+
+  it "updates a leaf in tree with 8 messages with a new message" do
+    merkle_tree = MerkleTree.new("L1", "L2", "L3", "L4", "L5", "L6", "L7", "L8")
+    updated_merkle_tree = MerkleTree.new("L1", "L2", "L3*", "L4", "L5", "L6", "L7", "L8")
+    expected_leaf = MerkleTree::Leaf.build("L3*", 2)
+
+    updated_leaf = merkle_tree.update("L3*", 2)
+
+    expect(updated_leaf.value).to eq(expected_leaf.value)
+    expect(merkle_tree.root.value).to eq(updated_merkle_tree.root.value)
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,9 @@
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/merkle_tree')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,9 @@
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,32 @@
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:perf) do |task|
+      task.pattern = 'spec/perf{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: merkle_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  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: A binary tree of one-time singatures known as a merkle tree. Often used
+  in distributed systems such as Git, Cassandra or Bitcoin for efficiently summarizing
+  sets of data.
+email:
+- me@piotrmurach.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/merkle_tree.rb
+- lib/merkle_tree/leaf.rb
+- lib/merkle_tree/node.rb
+- lib/merkle_tree/version.rb
+- merkle_tree.gemspec
+- spec/perf/speed_spec.rb
+- spec/spec_helper.rb
+- spec/unit/add_spec.rb
+- spec/unit/auth_path_spec.rb
+- spec/unit/empty_spec.rb
+- spec/unit/height_spec.rb
+- spec/unit/include_spec.rb
+- spec/unit/leaf/build_spec.rb
+- spec/unit/leaf/eql_spec.rb
+- spec/unit/leaves_spec.rb
+- spec/unit/new_spec.rb
+- spec/unit/node/build_spec.rb
+- spec/unit/node/eql_spec.rb
+- spec/unit/root_spec.rb
+- spec/unit/size_spec.rb
+- spec/unit/subtree_spec.rb
+- spec/unit/to_s_spec.rb
+- spec/unit/update_spec.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+homepage: https://github.com/piotrmurach/merkle_tree
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/piotrmurach/merkle_tree
+  source_code_uri: https://github.com/piotrmurach/merkle_tree
+  changelog_uri: https://github.com/piotrmurach/merkle_tree/blob/master/CHANGELOG.md
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A binary tree of one-time signatures known as a merkle tree.
+test_files: []