connected 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3207847fee29e8a23ed1a8456571a8e88ab3e73c3d2df63d8cadad3b34b6382f
-  data.tar.gz: 6c9944da0f906bb91ad8add7ae63dfed303452ac8f4f6b228b8e769cdb69de96
+  metadata.gz: b64513edd7cde21b6e0bc6f9de81c212fd221fd6e5bbfa288ff740c4c77d1c91
+  data.tar.gz: ea3e881fbe51977b4c9af37ce16ef1b37c401b7496ee1d816a4c393e1531678d
 SHA512:
-  metadata.gz: 12ba3ef422355e9b9cc608a29c90579af5e4adee228e94bc4348de44e595c8e673c9ec12cc319143a28b6e39d26807ede22232edfe12756feed08a21a4768f4c
-  data.tar.gz: 4ab7b7e541f3171dbd841980f0d63d0ad83a0cf18504d6d11b2a8e499ba70f4738f0ad093737b10e38af485f055f10268f9152c32a2ba111c23abbc2adacdb84
+  metadata.gz: fa98e68ddf6456ab303edc691af58e0b33d149562d7b0cd50ab52289e512bda2dc4fc62bf5320929c5ca1f4b393af9acb9a9b7eede3a16999f32ecf4ec089330
+  data.tar.gz: 8a4a5311a6b928d845859943986a71de53e4b904b4bd83a0585d4f72ac889d4c265c95225019c3955f5a7daccf02300e3e0cc3cbbd49765ea1272a2ee12475a9

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/.rubocop.yml

@@ -1,44 +1,55 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Metrics/MethodLength:
-  Max: 30
+require:
+- rubocop-rake
+- rubocop-rspec
 
 Layout/LineLength:
   Max: 100
 
-Metrics/ClassLength:
-  Max: 150
+AllCops:
+  Exclude:
+  - 'db/schema.rb'
+  - 'vendor/**/*'
+  TargetRubyVersion: 3.1
+  NewCops: enable
 
-Metrics/ModuleLength:
-  Max: 150
+Metrics/AbcSize:
+  Max: 21
 
-Metrics/CyclomaticComplexity:
-  Max: 7
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+  - 'spec/**/*_spec.rb'
+  - 'Rakefile'
+  - '*.gemspec'
 
-Metrics/AbcSize:
+Metrics/MethodLength:
   Max: 25
 
-Metrics/PerceivedComplexity:
-  Max: 8
+Metrics/ModuleLength:
+  Max: 160
   Exclude:
-    - 'spec/**/*_spec.rb'
+  - 'spec/**/*_spec.rb'
 
-Metrics/BlockLength:
-  Max: 35
+Metrics/ClassLength:
+  Max: 300
   Exclude:
-    - '*.gemspec'
-    - Rakefile
-    - 'spec/**/*_spec.rb'
-    - 'spec/spec_helper.rb'
+  - 'spec/**/*_spec.rb'
 
-Metrics/ParameterLists:
-  Max: 6
+Gemspec/RequireMFA:
+  Enabled: false
 
-Naming/MethodParameterName:
+Style/MixinUsage:
   Exclude:
-    - 'spec/**/*.rb'
+  - "bin/console"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
 
-Security/Eval:
+Style/StringConcatenation:
   Exclude:
-    - Gemfile
+  - 'Rakefile'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in spf.gemspec
 gemspec

data/Gemfile.lock

@@ -1,54 +1,99 @@
 PATH
   remote: .
   specs:
-    connected (0.1.0)
+    connected (0.1.1)
+      matrix
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.0)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    matrix (0.4.2)
+    mini_portile2 (2.8.0)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    racc (1.6.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.85.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-cobertura (1.3.1)
-      simplecov (~> 0.8)
-    simplecov-html (0.12.2)
-    unicode-display_width (1.7.0)
-    yard (0.9.25)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.47.2)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
@@ -57,11 +102,14 @@ DEPENDENCIES
   bundler (~> 2)
   connected!
   rake (~> 13)
-  rspec (~> 3.0)
-  rubocop (~> 0.50)
-  simplecov (~> 0.15)
-  simplecov-cobertura (~> 1.3)
+  rspec (~> 3.10)
+  rubocop (~> 1.40)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.11)
+  simplecov (~> 0.21)
+  simplecov-cobertura (~> 2.1)
+  solargraph (~> 0.45)
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.3.26

data/README.md

@@ -2,7 +2,7 @@
 
 # Connected
 
-_Connected_ aims to be useful for overlaying and solving both directed and undirected graphs. The goal is to provide generic mixins to add a solver to real code, rather than an academic demonstration of how Dijkstra's algorithm works.
+_Connected_ aims to be useful for overlaying and searching both directed and undirected graphs. The goal is to provide generic mixins that add graph search capabilities to real code, rather than an academic demonstration of how Dijkstra's algorithm works.
 
 ## Installation
 
@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ### Simple Uses
 
-For a simpler use-cases, the classes `Connected::GenericNode`, `Connected::GenericConnection`, and `Connected::Path` will suffice. These can either be subclassed or extended to wrap any real work. First, I'll just demonstrate how they work with an undirected graph (meaning a set of bidirectional connections):
+For simpler use-cases, the classes `Connected::GenericNode`, `Connected::GenericConnection`, and `Connected::Path` will suffice. These can either be subclassed or extended to wrap any real work. First, I'll just demonstrate how they work with an undirected graph (meaning a set of bidirectional connections):
 
 ```ruby
 require 'connected'
@@ -115,7 +115,33 @@ Path.find(from: node_a, to: node_d).to_s
 # => "a -> b -> d"
 ```
 
-All the above examples are based on connections created using `node.connects_to other_node`, which creates a bi-directional connection. For representing _directed_ graph, you can add `directed: true` to the method which causes it to only create the connection you explicitly described (meaning it won't create the connection back for you).
+All the above examples are based on connections created using `node.connects_to other_node`, which creates a bi-directional connection. For representing a _directed_ graph, you can add `directed: true` to the method which causes it to only create the connection you explicitly described (meaning it won't create the connection back for you). Under the hood, however, the graph itself is _always_ directed; this is just a convenient way to not automatically make both directions of a connection.
+
+Speaking of graphs, there is also a `Connected::GenericGraph` class that can be used either explicitly for slightly more complicated scenarios or it can be created dynamically as needed:
+
+```ruby
+node_a.subtree # returns a GenericGraph based on all nodes reachable from `node_a`
+# => #<Connected::GenericGraph:0x00007f...
+node_a.subtree.radius
+# => 4
+node_a.subtree.diameter
+# => 7
+node_a.subtree.adjacency_matrix
+# => Matrix[[1, 1, 1, 1], [1, 1, 1, 1], [1, 1, 1, 0], [1, 1, 0, 1]]
+node_a.subtree.complete?
+# => false
+```
+
+This dynamic graph is also used on some methods directly on Edges:
+
+```ruby
+node_a.eccentricity
+# => 7
+node_a.neighborhood
+# => #<Connected::GenericGraph:0x00007fd35...
+node_a.neighborhood.vertices.map(&:name)
+# => ["b", "c"]
+```
 
 ### Overlaying on Other Objects
 

data/Rakefile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'yard'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 YARD::Rake::YardocTask.new do |y|
   y.options = [
-    '--markup', 'markdown'
+    "--markup", "markdown"
   ]
 end
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'connected'
+require "bundler/setup"
+require "connected"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'connected'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/connected.gemspec

@@ -1,35 +1,40 @@
 # frozen_string_literal: true
 
-require_relative 'lib/connected/version'
+require_relative "lib/connected/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'connected'
+  spec.name          = "connected"
   spec.version       = Connected::VERSION
-  spec.authors       = ['Jonathan Gnagy']
-  spec.email         = ['jonathan.gnagy@gmail.com']
+  spec.authors       = ["Jonathan Gnagy"]
+  spec.email         = ["jonathan.gnagy@gmail.com"]
 
-  spec.summary       = 'A shortest path first gem'
-  spec.description   = 'A Ruby object-oriented solver for directed and undirected ' \
-                       'graphs based loosely on Dijkstra\'s algorithm'
-  spec.homepage      = 'https://github.com/jgnagy/connected'
+  spec.summary       = "A shortest path first gem"
+  spec.description   = "A Ruby object-oriented search library for directed and undirected " \
+                       "graphs based loosely on Dijkstra's algorithm"
+  spec.homepage      = "https://github.com/jgnagy/connected"
 
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.license       = "MIT"
+  spec.required_ruby_version = "~> 3.1"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.50'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'simplecov-cobertura', '~> 1.3'
-  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_dependency "matrix"
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rubocop", "~> 1.40"
+  spec.add_development_dependency "rubocop-rake",        "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec",       "~> 2.11"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "simplecov-cobertura", "~> 2.1"
+  spec.add_development_dependency "solargraph",          "~> 0.45"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

data/lib/connected/generic_connection.rb

@@ -13,7 +13,7 @@ module Connected
       validate_metric(metric)
       validate_state(state)
 
-      raise 'Invalid Connection from and to same Vertex' if from == to
+      raise "Invalid Connection from and to same Vertex" if from == to
 
       @from = from
       @to = to
@@ -34,19 +34,19 @@ module Connected
     private
 
     def validate_from(node)
-      raise 'Invalid from Node' unless node.is_a?(Vertex)
+      raise "Invalid from Node" unless node.is_a?(Vertex)
     end
 
     def validate_to(node)
-      raise 'Invalid to Node' unless node.is_a?(Vertex)
+      raise "Invalid to Node" unless node.is_a?(Vertex)
     end
 
     def validate_metric(num)
-      raise 'Invalid metric' unless num.is_a?(Numeric) && num.positive?
+      raise "Invalid metric" unless num.is_a?(Numeric) && num.positive?
     end
 
     def validate_state(value)
-      raise 'Invalid state' unless %i[open closed].include?(value)
+      raise "Invalid state" unless %i[open closed].include?(value)
     end
   end
 end

data/lib/connected/generic_graph.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Connected
+  # A generic implementation of a Graph
+  class GenericGraph
+    include Graph
+  end
+end

data/lib/connected/generic_node.rb

@@ -18,10 +18,10 @@ module Connected
       return true if neighbors.include?(other)
 
       connections << GenericConnection.new(
-        from: self, to: other, metric: metric, state: state.to_sym
+        from: self, to: other, metric:, state: state.to_sym
       )
 
-      other.connects_to(self, metric: metric, state: state) unless directed
+      other.connects_to(self, metric:, state:) unless directed
     end
 
     def disconnect_from(other, directed: false)

data/lib/connected/graph.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Connected
+  # A collection of related vertices and edges
+  module Graph
+    include Comparable
+
+    def initialize(vertices:, edges: nil)
+      @vertices = vertices
+      @edges = edges
+    end
+
+    def adjacency_matrix
+      rows = @vertices.map do |i|
+        @vertices.map do |j|
+          i == j || i.neighbors.include?(j) ? 1 : 0
+        end.to_a
+      end.to_a
+      Matrix.rows(rows)
+    end
+
+    # A "complete graph" is one where all vertices connect to all others
+    def complete?
+      density == 1 || vertices.size == 1
+    end
+
+    # The density is the ratio to a complete graph of the same number of vertices
+    def density
+      return 0 if edges.size.zero? # otherwise we'd divide by 0!
+
+      # Assumes an directed graph for now, therefore e / n(n -1)
+      # is the ratio of edges (e) to edges in a complete graph
+      edges.size.to_f / ((vertices.size * (vertices.size - 1)))
+    end
+
+    # The diameter of a graph is the longest of all shortest paths between all vertices on a graph
+    def diameter
+      longest = nil
+      vertices.each do |v|
+        dist = v.eccentricity
+        longest = dist if longest.nil? || dist > longest
+      end
+
+      longest
+    end
+
+    def edges
+      @edges || vertices.map(&:connections).flatten.uniq
+    end
+
+    def length
+      edges.size
+    end
+
+    def radius
+      shortest = nil
+      vertices.each do |v|
+        ecc = v.eccentricity
+        shortest = ecc if shortest.nil? || ecc < shortest
+      end
+
+      shortest
+    end
+
+    def vertices
+      @vertices
+    end
+
+    def <=>(other)
+      vertices == other.vertices && edges == other.edges
+    end
+  end
+end

data/lib/connected/path.rb

@@ -46,14 +46,22 @@ module Connected
       nodes.last
     end
 
-    def to_s(separator = ' -> ')
+    def to_s(separator = " -> ")
       nodes.map(&:name).join(separator)
     end
 
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
-    def self.all(from:, to:, include_closed: false, debug: false, suboptimal: false)
+    def self.all(
+      from:,
+      to:,
+      include_closed: false,
+      debug: false,
+      suboptimal: false,
+      min_by: :cost,
+      cache: {}
+    )
       paths = []
 
       path_queue = from.neighbors.map { |n| new([from, n]) }
@@ -62,50 +70,55 @@ module Connected
         this_path = path_queue.pop
         next unless this_path.open? || include_closed
 
-        puts "Walking from #{this_path.nodes.map(&:name).join(' to ')}" if debug
+        unless suboptimal
+          next if cache[this_path.to.name]&.<= this_path.send(min_by.to_sym)
+
+          cache[this_path.to.name] = this_path.send(min_by.to_sym)
+        end
+
+        puts "Walking from #{this_path.nodes.map(&:name).join(" to ")}" if debug
 
         if this_path.to == to
-          puts "Found destination with #{this_path.nodes.map(&:name).join(' to ')}" if debug
+          puts "Found destination with #{this_path.nodes.map(&:name).join(" to ")}" if debug
           paths << this_path
         else
-          highmetric = paths.max_by(&:cost)&.cost
-          highops = paths.max_by(&:hops)&.hops
+          maxmeasure = paths.map(&min_by.to_sym).max
 
           this_path.to.neighbors.each do |n|
             new_path = this_path.branch(n)
             next unless new_path
 
-            if paths.empty? || new_path.cost <= highmetric || new_path.hops <= highops || suboptimal
+            if paths.empty? || new_path.send(min_by.to_sym) <= maxmeasure || suboptimal
               path_queue.unshift(new_path)
             elsif debug
-              puts "Skipping #{new_path.nodes.map(&:name).join(' to ')}"
+              puts "Skipping #{new_path.nodes.map(&:name).join(" to ")}"
             end
           end
         end
       end
 
       # Return the list of paths, sorted first by cost then by hops
-      paths.sort_by { |p| [p.cost, p.hops] }
+      paths.sort_by { |p| min_by == :cost ? p.cost : p.hops }
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
 
-    def self.find(from:, to:, include_closed: false)
-      all(from: from, to: to, include_closed: include_closed).first
+    def self.find(from:, to:, include_closed: false, min_by: :cost, cache: {})
+      all(from:, to:, include_closed:, min_by:, cache:).first
     end
 
     private
 
     def validate_nodes(list)
       # Want to throw an exception if there are loops
-      raise 'Invalid Nodes list, duplicates found' unless list.size == list.uniq.size
+      raise "Invalid Nodes list, duplicates found" unless list.size == list.uniq.size
 
       list.each_with_index do |item, index|
         break if index == list.size - 1
 
         # Each node should connect to the next (no leaves except the end of the list)
-        raise 'Invalid Nodes list, broken chain' unless item.neighbors.include?(list[index + 1])
+        raise "Invalid Nodes list, broken chain" unless item.neighbors.include?(list[index + 1])
       end
 
       true

data/lib/connected/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Connected
-  VERSION = '0.1.0'
+  VERSION = "0.1.1"
 end

data/lib/connected/vertex.rb

@@ -8,14 +8,69 @@ module Connected
       raise "#connections() MUST be implemented on #{self.class.name}"
     end
 
+    def edges
+      connections
+    end
+
+    def graph
+      @graph || subtree
+    end
+
     # A shortcut for retrieving this node's neighbors
     def neighbors
       connections.map(&:to).uniq
     end
 
+    # The neighborhood of a Vertex is a Graph of all neighbors and any connections
+    # they have to each other.
+    # @see https://en.wikipedia.org/wiki/Neighbourhood_(graph_theory)
+    def neighborhood(closed: false)
+      vertices = neighbors
+      vertices << self if closed
+      n_edges = vertices.map(&:connections).flatten.uniq.select { |c| vertices.include?(c.to) }
+      GenericGraph.new(vertices:, edges: n_edges)
+    end
+
     # Retrieves the Connection object responsible for connecting to a Node
     def connection_to(other)
       connections.select { |c| c.to == other }.min_by(&:metric)
     end
+
+    def eccentricity
+      reachable_vertices.map do |r|
+        self == r ? nil : Path.find(from: self, to: r).cost
+      end.compact.max
+    end
+
+    def reaches?(other)
+      reachable_vertices.include?(other)
+    end
+
+    def reachable_from?(other)
+      other.reachable_vertices.include?(self)
+    end
+
+    def reachable_vertices
+      rverts = neighbors + [self]
+
+      queue = (neighbors.map(&:neighbors).flatten.uniq - neighbors)
+
+      until queue.empty?
+        this_vert = queue.pop
+        next if this_vert == self
+
+        rverts << this_vert
+        this_vert.neighbors.each do |v|
+          queue << v unless rverts.include?(v)
+        end
+      end
+
+      rverts.uniq
+    end
+
+    # A subtree is a subgraph including all edges and vertices reachable from a vertex
+    def subtree
+      GenericGraph.new(vertices: reachable_vertices)
+    end
   end
 end

data/lib/connected.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
-require 'connected/version'
-require 'connected/edge'
-require 'connected/vertex'
-require 'connected/generic_node'
-require 'connected/generic_connection'
-require 'connected/path'
+# Standard Library
+require "matrix"
+
+# Internal
+require "connected/version"
+require "connected/edge"
+require "connected/vertex"
+require "connected/graph"
+require "connected/generic_graph"
+require "connected/generic_node"
+require "connected/generic_connection"
+require "connected/path"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: connected
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: matrix
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,56 +58,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +164,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: A Ruby object-oriented solver for directed and undirected graphs based
-  loosely on Dijkstra's algorithm
+description: A Ruby object-oriented search library for directed and undirected graphs
+  based loosely on Dijkstra's algorithm
 email:
 - jonathan.gnagy@gmail.com
 executables: []
@@ -120,6 +176,7 @@ files:
 - ".images/logo.png"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -132,7 +189,9 @@ files:
 - lib/connected.rb
 - lib/connected/edge.rb
 - lib/connected/generic_connection.rb
+- lib/connected/generic_graph.rb
 - lib/connected/generic_node.rb
+- lib/connected/graph.rb
 - lib/connected/path.rb
 - lib/connected/version.rb
 - lib/connected/vertex.rb
@@ -146,16 +205,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A shortest path first gem