tangle 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b534152678b108e1d5ad38d3947ac056fc1218a01f7bab10f73dcb0f6868bc
-  data.tar.gz: 9ebf86f0191780d2b49f69f8b3e2cf8a0b57ac9117ff7d5dff57a0bfd52fa346
+  metadata.gz: 4456f429bc3e43dc2498e665b5ab50ceeba8ada36ed86fad33e477675237f53f
+  data.tar.gz: 961bfb96b98ec4bc56fc7e4feed6b36a7f5db1d5427ca636274e2799b609939a
 SHA512:
-  metadata.gz: cdb0d5204e4e6fc4de0d1a54f92fb73d3808322b7478de49fb9c571998fb18c49f400cbff042c4bd38218d2c966a9e7ca5ac697b7120d26bd46193e157bca4a6
-  data.tar.gz: 2eacf5cfb13389a359566563d6d72fae9ee86d1d373030b8677f6674d38cdec2663b5d5dfbb66a75aac6018ea41539691c75fcbee93deb4cefe48bde7cf7b591
+  metadata.gz: 7388845b841906216962b5b536084518a2ec2ddd645d5f13627efb860d0073a04c59afe5e088e664528e9c55a87a0deca1e6feeeee66a047b1f3ed0204b835de
+  data.tar.gz: 23a0299a55237a37a752ea57cbc477d70cae6a95ad80c44e004ca651a4f5faab266a9022bea668e6a73b51088811e46adee6a53a41deda278f79a8191768f6e8

data/README.md

@@ -1,8 +1,19 @@
+[![Gem Version](https://badge.fury.io/rb/tangle.svg)](https://badge.fury.io/rb/tangle)
+
 # Tangle
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tangle`. To experiment with that code, run `bin/console` for an interactive prompt.
+Tangle aims to untangle your graphs, by providing a set of classes for managing different types of graphs, and mixins for adding specific feature sets, like coloring or graphviz export.
+
+**Graph types**:
+ * SimpleGraph
+ * MultiGraph
+ * ~~DiGraph~~
+ * ~~DAG~~
+ * ~~Tree~~
 
-TODO: Delete this and the text above, and describe your gem
+**Feature mixins**:
+ * Connectedness
+ * ~~Coloring~~
 
 ## Installation
 
@@ -22,17 +33,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+g=Tangle::SimpleGraph.new
+g.add_vertex name: 'a'
+g.add_vertex name: 'b'
+g.add_edge 'a', 'b'
+g.connected?
+=> true
+g.add_edge 'b', 'b'
+=> Tangle::LoopError (loops not allowed)
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tangle. 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 `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.
 
 ## License
 
@@ -40,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Tangle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tangle/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Tangle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/notCalle/tangle/blob/master/CODE_OF_CONDUCT.md).

data/lib/tangle/edge.rb

@@ -6,6 +6,7 @@ module Tangle
   #
   class Edge
     extend Forwardable
+    include Tangle::Mixin::Initialize
 
     # Create a new edge between vertices
     #
@@ -18,6 +19,8 @@ module Tangle
       @vertices = Set[vertex1, vertex2]
       @graph = graph
 
+      initialize_mixins
+
       validate_edge
     end
 

data/lib/tangle/graph.rb

@@ -7,15 +7,15 @@ module Tangle
   # Base class for all kinds of graphs
   #
   class Graph
+    include Tangle::Mixin::Initialize
     Edge = Tangle::Edge
 
-    include Tangle::Mixin::Connectedness::Graph
-
     # Initialize a new graph, optionally preloading it with vertices and edges
     #
     # Graph.new() => Graph
     # Graph.new(vertices: +array_or_hash+) => Graph
     # Graph.new(vertices: +array_or_hash+, edges: +array_or_hash+) => Graph
+    # Graph.new(mixins: [MixinModule, ...], ...) => Graph
     #
     # When +array_or_hash+ is a hash, it contains the objects as values and
     # their names as keys. When +array_or_hash+ is an array the objects will
@@ -27,14 +27,21 @@ module Tangle
     # +edges+ can contain an array of exactly two, either names of vertices
     # or vertices.
     #
+    # +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(vertices: nil, edges: nil)
+    def initialize(vertices: nil, edges: nil,
+                   mixins: [Tangle::Mixin::Connectedness])
       @vertices_by_id = {}
       @vertices_by_name = {}
       @edges ||= []
 
+      initialize_mixins(mixins)
       initialize_vertices(vertices)
       initialize_edges(edges)
     end
@@ -111,6 +118,8 @@ module Tangle
     end
     alias dup subgraph
 
+    attr_reader :mixins
+
     protected
 
     # Insert a prepared vertex into the graph

data/lib/tangle/mixin.rb

@@ -1 +1,24 @@
 require 'tangle/mixin/connectedness'
+
+module Tangle
+  module Mixin
+    #
+    # Mixin to initialize the dynamic mixin system
+    #
+    module Initialize
+      private
+
+      def initialize_mixins(mixins = nil)
+        klass = self.class.name[/[^:]+$/].to_sym
+        @mixins = mixins unless mixins.nil?
+        mixins ||= @graph.mixins unless @graph.nil?
+
+        return if mixins.nil?
+
+        mixins.each do |mixin|
+          extend(mixin.const_get(klass)) if mixin.const_defined?(klass)
+        end
+      end
+    end
+  end
+end

data/lib/tangle/vertex.rb

@@ -8,7 +8,7 @@ module Tangle
   #
   class Vertex < SimpleDelegator
     include PP::ObjectMixin
-    include Tangle::Mixin::Connectedness::Vertex
+    include Tangle::Mixin::Initialize
 
     # Create a new vertex
     #
@@ -29,6 +29,8 @@ module Tangle
       @name = name
       @delegate = delegate
       @vertex_id = vertex_id
+
+      initialize_mixins
     end
 
     # Duplicate a vertex in a new graph, keeping all other contained attributes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tangle
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Calle Englund