mementus 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 419399d50dad3b0243a7756f259e99f64bec6da5
-  data.tar.gz: 12a25815a2bb6fd8beebdfd1d9aaf696f1ee5e03
+  metadata.gz: 1a13c8d4774fbdfad2b26d1180ae51cf1befb116
+  data.tar.gz: c58bafb8b1aeb71e7179bc64947809537e7c90e7
 SHA512:
-  metadata.gz: 4a8c602c0b356d31062eac51d63fc4e93b1740abc417baed0824018d04f75308ac12fdfb47953689bce86bfa8600a62675036d7e15a7107a4e3d3ae287125b85
-  data.tar.gz: b68d9dd85cf13935e41006c8814242243d1b3701672037a79e831433b011ac2b6a3861b1b13dc959c8a1a560349e01967d58ac8c727b0ded0cf3c2d1d5694e96
+  metadata.gz: a4973b6f437b39fbbd0d01dbc9a296ed26cb60e4d18554c9c78fc41d4cc6140edc6847e117afcd690b2088485e08e6c4d7c74c688f1162e19654c850568240f4
+  data.tar.gz: 43cb0c147dbaebb0964b5896432915aec14b16f34f64b25e6e55b678345adfcba016e4648a06c4c2a8fecb439b17b8964c22783d959fded2340599984fafc023

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 maetl
+Copyright (c) 2014-2016 Editorial Technology
 
 MIT License
 

data/README.md

@@ -1,3 +1,19 @@
 # Mementus
 
 [![Build Status](https://travis-ci.org/maetl/mementus.svg?branch=master)](https://travis-ci.org/maetl/mementus)
+
+## Roadmap
+
+| Version | Summary                                                  |
+|---------|----------------------------------------------------------|
+| `0.6`   | Support fiber based lazily evaluated pipeline traversals |
+| `0.7`   | Implement basic filter, side effect and transform pipes  |
+| `0.8`   | API support for Dijkstra/A* traversals using edge props  |
+| `0.9`   | Pluggable graph structure representations                |
+| `0.10`  | API support for tsort and strongly connected components  |
+| `0.11`  | Expand graph library with interesting sample data        |
+| `0.12`  | Import/export via JSON and XML formats                   |
+
+## License
+
+Provided under the terms of the MIT License. See the `LICENSE` file in the root of this project for more information.

data/lib/mementus/edge.rb

@@ -2,9 +2,10 @@ module Mementus
   class Edge
     attr_reader :from, :to, :label, :id
 
-    def initialize(id: nil, from:, to:, label: :edge)
+    def initialize(id: nil, from:, to:, label: :edge, props: {})
       @id = id
       @label = label
+      @props = props.freeze
 
       @from = if from.is_a?(Integer)
         Node.new(id: from)
@@ -19,6 +20,10 @@ module Mementus
       end
     end
 
+    def [](prop)
+      @props[prop]
+    end
+
     def nodes
       [@from, @to]
     end

data/lib/mementus/edge_builder.rb

@@ -21,7 +21,7 @@ module Mementus
     end
 
     def to_edge
-      Edge.new(id: id, from: from, to: to, label: label)
+      Edge.new(id: id, from: from, to: to, label: label, props: props)
     end
   end
 end

data/lib/mementus/element_builder.rb

@@ -1,5 +1,17 @@
 module Mementus
   module ElementBuilder
-    attr_accessor :id, :label, :props
+    attr_accessor :id, :label
+
+    def props
+      @props ||= {}
+    end
+
+    def props=(props_map)
+      @props = props_map
+    end
+
+    def []=(prop_key, value)
+      props[prop_key] = value
+    end
   end
 end

data/lib/mementus/graph_builder.rb

@@ -14,12 +14,14 @@ module Mementus
       @structure.set_edge(edge)
     end
 
-    def add_node(id: nil, label: nil)
-      @structure.set_node(Node.new(id: id, label: label))
+    def add_node(id: nil, label: nil, props: {})
+      id = @node_ids.next_id unless id
+      @structure.set_node(Node.new(id: id, label: label, props: props))
     end
 
-    def add_edge(id: nil, from: nil, to: nil, label: nil)
-      @structure.set_edge(Edge.new(id: id, from: from, to: to, label: label))
+    def add_edge(id: nil, from: nil, to: nil, label: nil, props: {})
+      id = @edge_ids.next_id unless id
+      @structure.set_edge(Edge.new(id: id, from: from, to: to, label: label, props: props))
     end
 
     def create_node(&block)

data/lib/mementus/node.rb

@@ -2,9 +2,14 @@ module Mementus
   class Node
     attr_reader :id, :label
 
-    def initialize(id: nil, label: nil)
+    def initialize(id: nil, label: nil, props: {})
       @id = id
       @label = label
+      @props = props.freeze
+    end
+
+    def [](prop)
+      @props[prop]
     end
   end
 end

data/lib/mementus/node_builder.rb

@@ -3,7 +3,7 @@ module Mementus
     include ElementBuilder
 
     def to_node
-      Node.new(id: id, label: label)
+      Node.new(id: id, label: label, props: props)
     end
   end
 end

data/lib/mementus/node_proxy.rb

@@ -13,8 +13,8 @@ module Mementus
       @node.label
     end
 
-    def outgoing
-
+    def [](prop)
+      @node[prop]
     end
 
     def each_adjacent(&block)

data/lib/mementus/pipes/incoming.rb

@@ -0,0 +1,17 @@
+module Mementus
+  module Pipes
+    class Incoming
+      def process(graph, node)
+        incoming = []
+
+        graph.each_node do |graph_node|
+          graph.each_adjacent(graph_node.id) do |adj_node|
+            incoming << graph_node if adj_node.id == node.id
+          end
+        end
+
+        incoming
+      end
+    end
+  end
+end

data/lib/mementus/pipes/incoming_edges.rb

@@ -0,0 +1,18 @@
+module Mementus
+  module Pipes
+    class IncomingEdges
+      def process(graph, source)
+        ids = source.respond_to?(:id) ? [source.id] : source.map(&:id)
+        incoming = []
+
+        graph.each_node do |graph_node|
+          graph.each_adjacent(graph_node.id) do |adj_node|
+            incoming << Mementus::Edge.new(from: graph_node, to: adj_node) if ids.include?(adj_node.id)
+          end
+        end
+
+        incoming
+      end
+    end
+  end
+end

data/lib/mementus/pipes/node.rb

@@ -0,0 +1,13 @@
+module Mementus
+  module Pipes
+    class Node
+      def initialize(id)
+        @id = id
+      end
+
+      def process(graph, id)
+        graph.node(id || @id)
+      end
+    end
+  end
+end

data/lib/mementus/pipes/outgoing.rb

@@ -0,0 +1,15 @@
+module Mementus
+  module Pipes
+    class Outgoing
+      def process(graph, source)
+        if source.respond_to?(:adjacent)
+          source.adjacent
+        else
+          source.inject([]) do |result, node|
+            result.concat(node.adjacent)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mementus/pipes/outgoing_edges.rb

@@ -0,0 +1,11 @@
+module Mementus
+  module Pipes
+    class OutgoingEdges
+      def process(graph, node)
+        graph.each_adjacent(node.id).map do |id|
+          Mementus::Edge.new(from: node, to: id)
+        end
+      end
+    end
+  end
+end

data/lib/mementus/processor.rb

@@ -0,0 +1,58 @@
+module Mementus
+  class Processor
+    def initialize(graph, start_pipe)
+      @graph = graph
+      @pipeline = [start_pipe]
+    end
+
+    def append_next(pipe)
+      @pipeline << pipe
+    end
+
+    def process
+      output = nil
+      @pipeline.each do |pipe|
+        output = pipe.process(@graph, output)
+      end
+      output
+    end
+
+    def id
+      process.id
+    end
+
+    def one
+      output = process
+
+      if output.respond_to?(:each)
+        output.first
+      else
+        output
+      end
+    end
+
+    def all
+      process.to_a
+    end
+
+    def out
+      append_next(Pipes::Outgoing.new)
+      self
+    end
+
+    def out_e
+      append_next(Pipes::OutgoingEdges.new)
+      self
+    end
+
+    def in
+      append_next(Pipes::Incoming.new)
+      self
+    end
+
+    def in_e
+      append_next(Pipes::IncomingEdges.new)
+      self
+    end
+  end
+end

data/lib/mementus/version.rb

@@ -1,3 +1,3 @@
 module Mementus
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/lib/mementus.rb

@@ -4,7 +4,12 @@ require 'mementus/structure/incidence_list'
 require 'mementus/node'
 require 'mementus/edge'
 require 'mementus/node_proxy'
-require 'mementus/pipeline'
+require 'mementus/processor'
+require 'mementus/pipes/incoming_edges'
+require 'mementus/pipes/incoming'
+require 'mementus/pipes/node'
+require 'mementus/pipes/outgoing_edges'
+require 'mementus/pipes/outgoing'
 require 'mementus/depth_first_search'
 require 'mementus/breadth_first_search'
 require 'mementus/query/traversal'

data/spec/edge_spec.rb

@@ -25,6 +25,24 @@ describe Mementus::Edge do
     expect(edge.label).to eq(:relationship)
   end
 
+  it 'returns nil when missing prop is accessed' do
+    edge = Mementus::Edge.new(from: 1, to: 2)
+
+    expect(edge[:title]).to be_nil
+  end
+
+  it 'initializes with props given' do
+    edge = Mementus::Edge.new(from: 1, to: 2, props: { :title => 'Relationship' })
+
+    expect(edge[:title]).to eq('Relationship')
+  end
+
+  it 'does not allow mutation of props' do
+    node = Mementus::Edge.new(from: 1, to: 2, props: { title: 'Relationship' })
+
+    expect { node[:title] = 'Edge' }.to raise_error(NoMethodError)
+  end
+
   it 'should test equality based on value' do
     edge1 = Mementus::Edge.new(from: 1, to: 2, label: :relationship)
     edge2 = Mementus::Edge.new(from: 1, to: 2, label: :relationship)

data/spec/graph_spec.rb

@@ -27,17 +27,39 @@ describe Mementus::Graph do
     expect(graph.node(1).id).to eq(1)
   end
 
+  specify '#add_node -> with auto id' do
+    graph = Mementus::Graph.new do
+      add_node
+    end
+
+    expect(graph.node(1).id).to eq(1)
+  end
+
+  specify '#add_node -> with props' do
+    graph = Mementus::Graph.new do
+      add_node(props: { title: 'Vertex' })
+    end
+
+    expect(graph.node(1)[:title]).to eq('Vertex')
+  end
+
   specify '#create_node' do
     graph = Mementus::Graph.new do
       create_node do |node|
         node.id = 20
         node.label = :vertex
+        node.props[:title] = 'Vertex'
       end
     end
 
     expect(graph.nodes_count).to eq(1)
     expect(graph.edges_count).to eq(0)
-    expect(graph.node(20).id).to eq(20)
+
+    graph.node(20).tap do |node|
+      expect(node.id).to eq(20)
+      expect(node.label).to eq(:vertex)
+      expect(node[:title]).to eq('Vertex')
+    end
   end
 
   specify '#set_edge' do
@@ -60,6 +82,23 @@ describe Mementus::Graph do
     expect(graph.edges_count).to eq(1)
     expect(graph.node(1).id).to eq(1)
     expect(graph.node(2).id).to eq(2)
+    expect(graph.edge(3).id).to eq(3)
+  end
+
+  specify '#add_edge -> with auto id' do
+    graph = Mementus::Graph.new do
+      add_edge(from: 1, to: 2)
+    end
+
+    expect(graph.edge(1).id).to eq(1)
+  end
+
+  specify '#add_edge -> with props' do
+    graph = Mementus::Graph.new do
+      add_edge(from: 1, to: 2, props: { title: 'Relationship' })
+    end
+
+    expect(graph.edge(1)[:title]).to eq('Relationship')
   end
 
   specify '#create_edge' do
@@ -67,14 +106,33 @@ describe Mementus::Graph do
       create_edge do |edge|
         edge.id = 123
         edge.label = :relationship
-        edge.from = "A"
-        edge.to = "B"
+        edge.from = 'A'
+        edge.to = 'B'
+        edge.props[:name] = 'Relationship'
       end
     end
 
     expect(graph.nodes_count).to eq(2)
     expect(graph.edges_count).to eq(1)
-    expect(graph.edge(123).id).to eq(123)
+    graph.edge(123).tap do |edge|
+      expect(edge.id).to eq(123)
+      expect(edge.label).to eq(:relationship)
+      expect(edge.from.id).to eq('A')
+      expect(edge.to.id).to eq('B')
+      expect(edge[:name]).to eq('Relationship')
+    end
+  end
+
+  specify '#create_edge -> with props' do
+    graph = Mementus::Graph.new do
+      create_edge do |edge|
+        edge.from = 'A'
+        edge.to = 'B'
+        edge.props = {
+          name: 'Relationship'
+        }
+      end
+    end
   end
 
   specify '#has_node?' do

data/spec/node_spec.rb

@@ -1,16 +1,40 @@
 require 'spec_helper'
 
 describe Mementus::Node do
-  it 'should initialize with id' do
+  it 'initializes with id' do
     node = Mementus::Node.new(id: 22)
 
     expect(node.id).to eq(22)
   end
 
-  it 'should initialize with id and label' do
+  it 'initializes with label' do
+    node = Mementus::Node.new(label: :vertex)
+
+    expect(node.label).to eq(:vertex)
+  end
+
+  it 'initializes with id and label' do
     node = Mementus::Node.new(id: 22, label: :vertex)
 
     expect(node.id).to eq(22)
     expect(node.label).to eq(:vertex)
   end
+
+  it 'returns nil when missing prop is accessed' do
+    node = Mementus::Node.new
+
+    expect(node[:title]).to be_nil
+  end
+
+  it 'initializes with props hash' do
+    node = Mementus::Node.new(props: { title: 'Vertex' })
+
+    expect(node[:title]).to eq('Vertex')
+  end
+
+  it 'does not allow mutation of props' do
+    node = Mementus::Node.new(props: { title: 'Vertex' })
+
+    expect { node[:title] = 'Node' }.to raise_error(NoMethodError)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mementus
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - maetl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,12 @@ files:
 - lib/mementus/node.rb
 - lib/mementus/node_builder.rb
 - lib/mementus/node_proxy.rb
-- lib/mementus/pipeline.rb
+- lib/mementus/pipes/incoming.rb
+- lib/mementus/pipes/incoming_edges.rb
+- lib/mementus/pipes/node.rb
+- lib/mementus/pipes/outgoing.rb
+- lib/mementus/pipes/outgoing_edges.rb
+- lib/mementus/processor.rb
 - lib/mementus/query/source.rb
 - lib/mementus/query/step.rb
 - lib/mementus/query/traversal.rb

data/lib/mementus/pipeline.rb

@@ -1,119 +0,0 @@
-module Mementus
-  class Processor
-    def initialize(graph, start_pipe)
-      @graph = graph
-      @pipeline = [start_pipe]
-    end
-
-    def append_next(pipe)
-      @pipeline << pipe
-    end
-
-    def process
-      output = nil
-      @pipeline.each do |pipe|
-        output = pipe.process(@graph, output)
-      end
-      output
-    end
-
-    def id
-      process.id
-    end
-
-    def one
-      output = process
-
-      if output.respond_to?(:each)
-        output.first
-      else
-        output
-      end
-    end
-
-    def all
-      process.to_a
-    end
-
-    def out
-      append_next(Pipes::Outgoing.new)
-      self
-    end
-
-    def out_e
-      append_next(Pipes::OutgoingEdges.new)
-      self
-    end
-
-    def in
-      append_next(Pipes::Incoming.new)
-      self
-    end
-
-    def in_e
-      append_next(Pipes::IncomingEdges.new)
-      self
-    end
-  end
-
-  module Pipes
-    class Node
-      def initialize(id)
-        @id = id
-      end
-
-      def process(graph, id)
-        graph.node(id || @id)
-      end
-    end
-
-    class Outgoing
-      def process(graph, source)
-        if source.respond_to?(:adjacent)
-          source.adjacent
-        else
-          source.inject([]) do |result, node|
-            result.concat(node.adjacent)
-          end
-        end
-      end
-    end
-
-    class OutgoingEdges
-      def process(graph, node)
-        graph.each_adjacent(node.id).map do |id|
-          Mementus::Edge.new(from: node, to: id)
-        end
-      end
-    end
-
-    class Incoming
-      def process(graph, node)
-        incoming = []
-
-        graph.each_node do |graph_node|
-          graph.each_adjacent(graph_node.id) do |adj_node|
-            incoming << graph_node if adj_node.id == node.id
-          end
-        end
-
-        incoming
-      end
-    end
-
-    class IncomingEdges
-      def process(graph, source)
-        ids = source.respond_to?(:id) ? [source.id] : source.map(&:id)
-        incoming = []
-
-        graph.each_node do |graph_node|
-          graph.each_adjacent(graph_node.id) do |adj_node|
-            incoming << Mementus::Edge.new(from: graph_node, to: adj_node) if ids.include?(adj_node.id)
-          end
-        end
-
-        incoming
-      end
-    end
-  end
-end