tangle 0.8.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ee56b345a6f81de14bbc7bb9d16fbb10f9e2174b2588140a6881bd1ff31d0d5
-  data.tar.gz: 2172244bbb6ab3a91dff9fb4e6491fadc1f56762d984edf75c7f325b1ce9bed5
+  metadata.gz: be7e93897d5dcfbe1b739f977740f46d2bef0a050503244e1204f9bb2a387bac
+  data.tar.gz: ca037f66996798b77e0fdd2b2c734a880ce5f495caac85cd84a49748daa04547
 SHA512:
-  metadata.gz: 7bb4eeacbdf97538cef1a19738ac0260e47b56a19a6854d2de4dd735203001f7000f09239fbd3d6dcce377d8acf24a3b9647f1ddbbb2c152129b16e78de5fb16
-  data.tar.gz: 71837d3d43769c939200f450fb823ce6e82aec754527989e93ffac3db58eac2a8a99c816c9afc648dbbf97bf101b63e78656af86e487f6d3568f40333e2fa078
+  metadata.gz: 2f94196947e837391f4c09b194f7d2d07e76ce7bc0215faad944eecf3c75109840f309e4b07ddd976b9466f382f7c8c0a0caffde4b68fa09c4d6fea32eb10669
+  data.tar.gz: 464b75f77486d466c0621bd272fdab22db7047ee58648e8af98799dfc0c1ff2da64534304c55c1bc41b7db67052801aa9ac41ec53d9b352e3d93cbae9499d958

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+%YAML 1.1
+---
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+...

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 /Gemfile.lock
 /vendor
+coverage

data/.rubocop.yml

@@ -1,3 +1,9 @@
+%YAML 1.1
+---
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/*_spec.rb'
@@ -6,7 +12,12 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/*_spec.rb'
 
-# Rubocop 0.56 causes false positives
-# https://github.com/bbatsov/rubocop/issues/5887
-Lint/SplatKeywordArguments:
-  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+...

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+## [0.11.0] - 2021-05-30
+
+This release updates dependencies, changes the minimum Ruby version to 2.6, and adds support for Ruby version 3.
+
+### Added
+
+- Ruby version 3 is now supported, and mixin initializers should not rely on keyword splat semantics for a `Hash` argument.
+
+### Changed
+
+- The minimum required Ruby version is now 2.6.
+
+- Dependencies have been updated.
+
+
+## [0.10.2] - 2019-07-05
+
+### Changed
+
+- `Currify::currify`now raises a `CurrifyError` < `ArgumentError` when the method takes no arguments, instead of the curried method failing when called
+
+- Development dependency on `bundler` is updated to `~> 2.0`.
+
+### Fixed
+
+- `Graph#connected_subgraph` and `Graph#disconnected_subgraph` called an invalid method to determine connectedness of candidate vertices
+
+
+## [Older]
+These releases have no change logs.
+
+
+[Unreleased]: https://github.com/notCalle/ruby-tangle/compare/v0.11.0..HEAD
+[0.11.0]: https://github.com/notCalle/ruby-tangle/compare/v0.10.2..v0.11.0
+[0.10.2]: https://github.com/notCalle/ruby-tangle/compare/v0.10.1..v0.10.2
+[Older]: https://github.com/notCalle/ruby-tangle/releases/tag/v0.10.1

data/Gemfile

@@ -1,12 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-begin
-  require 'git-version-bump'
-rescue LoadError
-  gem 'git-version-bump', '~> 0.15'
-else
-  # Specify your gem's dependencies in tangle.gemspec
-  gemspec
-end
+# Specify your gem's dependencies in tangle.gemspec
+gemspec

data/README.md

@@ -1,4 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/tangle.svg)](https://badge.fury.io/rb/tangle) [![Maintainability](https://api.codeclimate.com/v1/badges/0d92a4d05b6bb5c06dce/maintainability)](https://codeclimate.com/github/notCalle/ruby-tangle/maintainability)
+[![Gem Version](https://badge.fury.io/rb/tangle.svg)](https://badge.fury.io/rb/tangle)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0d92a4d05b6bb5c06dce/maintainability)](https://codeclimate.com/github/notCalle/ruby-tangle/maintainability)
+[![codecov](https://codecov.io/gh/notCalle/ruby-tangle/branch/master/graph/badge.svg)](https://codecov.io/gh/notCalle/ruby-tangle)
+[![Ruby](https://github.com/notCalle/ruby-tangle/actions/workflows/ruby.yml/badge.svg)](https://github.com/notCalle/ruby-tangle/actions/workflows/ruby.yml)
 
 # Tangle
 
@@ -12,10 +15,12 @@ Tangle aims to untangle your graphs, by providing a set of classes for managing
  * ~~Tree~~
 
 **Feature mixins**:
- * Connectedness
+ * Filesystem directory graph
  * ~~Coloring~~
  * ~~GraphViz~~
 
+See the [changelog](CHANGELOG.md) for recent changes.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -81,7 +86,7 @@ Tangle::Graph.new(mixins: [WeightedEdges])
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/notCalle/tangle. Pull requests should be rebased to HEAD of `master` before submitting, and all commits must be signed with valid GPG key. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/notCalle/tangle. Pull requests should be rebased to HEAD of `main` before submitting, and all commits must be signed with valid GPG key. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 
@@ -20,7 +22,7 @@ task :check_version do
   raise 'Internal revision!' unless GVB.internal_revision.empty?
 end
 
-task test: %i[spec rubocop]
+task test: %i[rubocop spec]
 task build: %i[spec]
 task release: %i[rubocop check_version]
 task default: %i[test]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'tangle'
@@ -7,8 +8,8 @@ require 'tangle'
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
-# Pry.start
+require 'pry'
+Pry.start
 
-require 'irb'
-IRB.start(__FILE__)
+# require 'irb'
+# IRB.start(__FILE__)

data/bin/setup

@@ -4,6 +4,5 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-bundle update
 
 # Do any other automated setup that you need to do here

data/lib/tangle.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'tangle/version'
 require 'tangle/errors'
-require 'tangle/graph'
-require 'tangle/simple/graph'
+require 'tangle/undirected/graph'
+require 'tangle/undirected/simple/graph'
 require 'tangle/directed/graph'
 require 'tangle/directed/acyclic/graph'
 
@@ -20,8 +22,9 @@ require 'tangle/directed/acyclic/graph'
 # => Directed graph with no edge cycles
 #
 module Tangle
-  MultiGraph = Tangle::Graph
-  SimpleGraph = Tangle::Simple::Graph
+  Graph = Tangle::Undirected::Graph
+  MultiGraph = Tangle::Undirected::Graph
+  SimpleGraph = Tangle::Undirected::Simple::Graph
   DiGraph = Tangle::Directed::Graph
   DAG = Tangle::Directed::Acyclic::Graph
 end

data/lib/tangle/base_graph.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require_relative 'currify'
+require_relative 'mixin'
+require_relative 'base_graph_protected'
+require_relative 'base_graph_private'
+
+module Tangle
+  #
+  # Abstract base class for (un)directed graphs
+  #
+  class BaseGraph
+    include Tangle::Currify
+    include Tangle::Mixin::Initialize
+    include Tangle::BaseGraphProtected
+    include Tangle::BaseGraphPrivate
+
+    # Initialize a new graph, preloading it with vertices and edges
+    #
+    # Graph[+vertices+] => Graph
+    # Graph[+vertices+, +edges+) => Graph
+    #
+    # When +vertices+ is a hash, it contains initialization kwargs as
+    # values and vertex names as keys. When +vertices+ is an array of
+    # initialization kwargs, the vertices will be be anonymous.
+    #
+    # +edges+ can contain an array of exactly two, either names of vertices
+    # or vertices.
+    #
+    # Any kwarg supported by Graph.new is also allowed.
+    #
+    def self.[](vertices, edges = {}, **kwargs)
+      graph = new(**kwargs)
+      vertices.each { |vertex| graph.add_vertex(vertex) }
+      edges.each { |from, to| graph.add_edge(from, to) }
+      graph
+    end
+
+    # Initialize a new graph, optionally preloading it with vertices and edges
+    #
+    # Graph.new() => Graph
+    # Graph.new(mixins: [MixinModule, ...], ...) => Graph
+    #
+    # +mixins+ is an array of modules that can be mixed into the various
+    # classes that makes up a graph. Initialization of a Graph, Vertex or Edge
+    # looks for submodules in each mixin, with the same name and extends
+    # any created object. Defaults to [Tangle::Mixin::Connectedness].
+    #
+    # Any subclass of Graph should also subclass Edge to manage its unique
+    # constraints.
+    #
+    def initialize(currify: false, mixins: [], **kwargs)
+      @currify = currify
+      initialize_vertices
+      initialize_edges
+      initialize_mixins(mixins: mixins, **kwargs)
+    end
+
+    # Return a subgraph, optionally filtered by a vertex selector block
+    #
+    # subgraph => Graph
+    # subgraph { |vertex| ... } => Graph
+    #
+    # Unless a selector is provided, the subgraph contains the entire graph.
+    #
+    def subgraph(included = nil, &selector)
+      result = clone
+      result.select_vertices!(included) unless included.nil?
+      result.select_vertices!(&selector) if block_given?
+      result
+    end
+
+    def clone
+      result = super
+      result.copy_vertices_and_edges(self)
+      result
+    end
+
+    def to_s
+      "#<#{self.class}: #{vertices.count} vertices, #{edges.count} edges>"
+    end
+    alias inspect to_s
+
+    # Fetch a vertex by its name
+    def fetch(name)
+      @vertices_by_name.fetch(name)
+    end
+
+    # Return a named vertex
+    def [](name)
+      @vertices_by_name[name]
+    end
+
+    # Return all vertices in the graph
+    def vertices
+      @vertices.keys
+    end
+
+    # Select vertices in the graph
+    def select(&selector)
+      @vertices.each_key.select(&selector)
+    end
+
+    # Add a vertex into the graph
+    #
+    # If a name: is given, or the vertex responds to :name,
+    # it will be registered by name in the graph
+    def add_vertex(vertex, name: nil)
+      name ||= callback(vertex, :name)
+      insert_vertex(vertex, name)
+      define_currified_methods(vertex, :vertex) if @currify
+      callback(vertex, :added_to_graph, self)
+      self
+    end
+    alias << add_vertex
+
+    # Remove a vertex from the graph
+    def remove_vertex(vertex)
+      @vertices[vertex].each do |edge|
+        remove_edge(edge) if edge.include?(vertex)
+      end
+      delete_vertex(vertex)
+      callback(vertex, :removed_from_graph, self)
+    end
+
+    # Get all edges.
+    #
+    # edges => Array
+    #
+    def edges(vertex = nil)
+      return @edges if vertex.nil?
+
+      @vertices.fetch(vertex)
+    end
+    currify :vertex, :edges
+
+    # Add a new edge to the graph
+    #
+    # add_edge(vtx1, vtx2, ...) => Edge
+    #
+    def add_edge(*vertices, **kvargs)
+      edge = new_edge(*vertices, mixins: @mixins, **kvargs)
+      insert_edge(edge)
+      vertices.each { |vertex| callback(vertex, :edge_added, edge) }
+      edge
+    end
+
+    # Remove an edge from the graph
+    def remove_edge(edge)
+      delete_edge(edge)
+      edge.each_vertex { |vertex| callback(vertex, :edge_removed, edge) }
+    end
+  end
+end

data/lib/tangle/{graph_vertices.rb → base_graph_private.rb}

@@ -1,49 +1,26 @@
-require 'set'
+# frozen_string_literal: true
 
 module Tangle
-  # Vertex related methods in a graph
-  module GraphVertices
-    # Fetch a vertex by its name
-    def fetch(name)
-      @vertices_by_name.fetch(name)
-    end
-
-    # Return a named vertex
-    def [](name)
-      @vertices_by_name[name]
-    end
-
-    # Return all vertices in the graph
-    def vertices
-      @vertices.keys
-    end
-
-    # Add a vertex into the graph
-    #
-    # If a name: is given, it will be registered by name
-    def add_vertex(vertex, name: nil)
-      @vertices[vertex] = Set[]
-      @vertices_by_name[name] = vertex unless name.nil?
-      self
-    end
-    alias << add_vertex
+  #
+  # Private methods of BaseGraph
+  #
+  module BaseGraphPrivate
+    private
 
-    # Remove a vertex from the graph
-    def remove_vertex(vertex)
-      @vertices[vertex].each do |edge|
-        remove_edge(edge) if edge.include?(vertex)
-      end
-      @vertices.delete(vertex)
+    def callback(receiver, method, *args)
+      receiver.send(method, *args) if receiver.respond_to?(method)
     end
 
-    private
-
     # Initialize vertex related attributes
     def initialize_vertices
       @vertices = {}
       @vertices_by_name = {}
     end
 
+    def initialize_edges
+      @edges = Set[]
+    end
+
     # Yield each reachable vertex to a block, breadth first
     def each_vertex_breadth_first(start_vertex, walk_method)
       remaining = [start_vertex]