graph_lib 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f1d7845f4d37b26dce97a69825c98a40d4f28cb474cddb41c7f5e2988c6e89e
+  data.tar.gz: c128b41df038ab5d31ac705f24f72d803993d7c888ca1cd79cfac1d2cc299d8f
+SHA512:
+  metadata.gz: 7b3c97475e9d041685b8be31885d67cbf87c7c66180bfa24869fe074938f0528f6da6ff6b77675cd0d670a260ee8d2c8ead0d8ebddfb7ac92242a050bb1fb6b2
+  data.tar.gz: 1b94d3c4217dbd319c87c6d7aa2a507f4c822adc6464a04afdfb6859569d4fb755ef46700d33a381b3a523f97f02bb5c059c1af8433c0e236fac2935512484ce

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   1.17.1

data/README.md

@@ -0,0 +1,44 @@
+# GraphLib
+
+A very minimal graph organization library in Ruby.
+
+Allows you to add vertices and edges and know about parents and
+children.
+
+```ruby
+require './graph.rb'
+
+g = Graph.new
+g.add_vertex("a")
+g.add_vertex("b")
+g.add_vertex("c")
+g.add_vertex("d")
+
+g.add_edge("a", "b")
+g.add_edge("a", "c")
+g.add_edge("b", "d")
+g.add_edge("c", "d")
+
+g.children_for("a")
+g.parents_for("d")
+```
+
+If you try to add an edge between nodes that don't exist, you get an
+error...
+
+You can also generate a graph directly from a json document like this:
+
+```json
+{
+  "vertices": ["a", "b", "c", "d"],
+  "edges": [
+    ["a", "b"],
+    ["a", "c"],
+    ["b", "d"],
+    ["c", "d"]
+  ]
+}
+```
+
+Do this by either calling `Graph.from_hash(graph_hash)` or
+`Graph.from_file('graph.json')`.

data/lib/graph.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'vertex'
+
+class Graph
+  def initialize
+    @vertices = []
+  end
+
+  def add_vertex(name)
+    vertex = Vertex.new(name)
+    @vertices << vertex
+    vertex
+  end
+
+  def add_edge(from, to)
+    names = @vertices.map(&:name)
+    #return false unless names.include?(from) && names.include?(to)
+    @vertices[names.index(from)].add_child(to)
+    @vertices[names.index(to)].add_parent(from)
+    nil
+  end
+
+  def children_for(vertex)
+    names = @vertices.map(&:name)
+    children_names = @vertices[names.index(vertex)].children
+    children = children_names.collect do |child|
+      @vertices[names.index(child)]
+    end
+    children
+  end
+
+  def parents_for(vertex)
+    names = @vertices.map(&:name)
+    parent_names = @vertices[names.index(vertex)].parents
+    parents = parent_names.collect do |parent|
+      @vertices[names.index(parent)]
+    end
+    parents
+  end
+
+  def get_vertex(name)
+    names = @vertices.map(&:name)
+    @vertices[names.index(name)]
+  end
+
+  def self.from_hash(hash)
+    g = Graph.new
+    hash['vertices'].each do |vertex|
+      g.add_vertex(vertex)
+    end
+
+    hash['edges'].each do |from, to|
+      g.add_edge(from, to)
+    end
+    return g
+  end
+
+  def self.from_file(filename)
+    self.from_hash(JSON.parse(File.read(filename)))
+  end
+end

data/lib/vertex.rb

@@ -0,0 +1,31 @@
+class Vertex
+  def initialize(name)
+    @name = name
+    @children = []
+    @parents = []
+  end
+
+  def add_child(name)
+    @children << name
+  end
+
+  def add_parent(name)
+    @parents << name
+  end
+
+  def name
+    @name
+  end
+
+  def children
+    @children
+  end
+
+  def parents
+    @parents
+  end
+
+  def root?
+    @parents.empty?
+  end
+end

data/spec/graph.json

@@ -0,0 +1,9 @@
+{
+  "vertices": ["a", "b", "c", "d"],
+  "edges": [
+    ["a", "b"],
+    ["a", "c"],
+    ["b", "d"],
+    ["c", "d"]
+  ]
+}

data/spec/graph_spec.rb

@@ -0,0 +1,85 @@
+require './lib/graph.rb'
+
+RSpec.describe Graph do
+  before do
+    @graph = Graph.new
+  end
+
+  describe '#add_vertex' do
+    it 'creates and adds a new vertex' do
+      expect(Vertex).to receive(:new).with('a')
+      @graph.add_vertex('a')
+    end
+  end
+
+  describe '#get_vertex' do
+    it 'returns the vertex by that name' do
+      @graph.add_vertex('a')
+      @graph.add_vertex('b')
+      @graph.add_vertex('c')
+      @graph.add_edge('a', 'b')
+      @graph.add_edge('b', 'c')
+
+      b = @graph.get_vertex('b')
+      expect(b.name).to eq 'b'
+      expect(b.parents.first).to eq 'a'
+      expect(b.children.first).to eq 'c'
+    end
+  end
+
+  describe '#add_edge' do
+    it 'creates a new edge between two existing vertices' do
+      a = @graph.add_vertex('a')
+      b = @graph.add_vertex('b')
+      expect(a).to receive(:add_child).with('b')
+      expect(b).to receive(:add_parent).with('a')
+      @graph.add_edge('a', 'b')
+    end
+  end
+
+  describe '#children_for' do
+    it 'returns an array of all children of a node' do
+      a = @graph.add_vertex('a')
+      b = @graph.add_vertex('b')
+      c = @graph.add_vertex('c')
+      @graph.add_edge('a', 'b')
+      @graph.add_edge('a', 'c')
+      expect(@graph.children_for('a')).to match_array [b, c]
+    end
+  end
+
+  describe '#parents_for' do
+    it 'returns an array of all parents of a node' do
+      a = @graph.add_vertex('a')
+      b = @graph.add_vertex('b')
+      @graph.add_edge('a', 'b')
+      expect(@graph.parents_for('b')).to match_array [a]
+    end
+  end
+
+  describe '.from_hash' do
+    it 'creates a graph according to a hash spec' do
+      hash = {
+        'vertices' => ['a', 'b', 'c', 'd'],
+        'edges' => [
+          ['a', 'b'],
+          ['a', 'c'],
+          ['b', 'd'],
+          ['c', 'd']
+        ]
+      }
+
+      graph = Graph.from_hash(hash)
+      expect(graph.children_for('a').map(&:name)).to match_array ['b', 'c']
+      expect(graph.parents_for('d').map(&:name)).to match_array ['b', 'c']
+    end
+  end
+
+  describe '.from_file' do
+    it 'creates a graph according to a hash spec' do
+      graph = Graph.from_file('./spec/graph.json')
+      expect(graph.children_for('a').map(&:name)).to match_array ['b', 'c']
+      expect(graph.parents_for('d').map(&:name)).to match_array ['b', 'c']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/vertex_spec.rb

@@ -0,0 +1,36 @@
+require './lib/vertex.rb'
+
+RSpec.describe Vertex do
+  before do
+    @vertex = Vertex.new('some node')
+  end
+
+  describe '#add_child' do
+    it 'adds a child to the children array' do
+      @vertex.add_child('a')
+      expect(@vertex.children).to eq ['a']
+    end
+  end
+
+  describe '#add_parent' do
+    it 'adds a parent to the parents array' do
+      @vertex.add_parent('a')
+      expect(@vertex.parents).to eq ['a']
+    end
+  end
+
+  describe '#root?' do
+    context 'when no parents present' do
+      it 'returns true' do
+        expect(@vertex.root?).to eq true
+      end
+    end
+
+    context 'when parents present' do
+      it 'returns false' do
+        @vertex.add_parent('a')
+        expect(@vertex.root?).to eq false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: graph_lib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Peikert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: t.s.peikert+yappl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/graph.rb
+- lib/vertex.rb
+- spec/graph.json
+- spec/graph_spec.rb
+- spec/spec_helper.rb
+- spec/vertex_spec.rb
+homepage: https://github.com/TPei/graph_lib
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: ruby gem for a very minimal graph implementation
+test_files: []