tangle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb6c6e2247f126a8309178790612215cd099aaecaf909de00f114a1fb04e5caf
+  data.tar.gz: 42386680537801bfb1be9d1f14f684f6a82fe857246fdfe492d9ae31a602d980
+SHA512:
+  metadata.gz: f231571ede13d8261d03c3a9c6410cf184ec79deb5a612aa9f655533410f296846e417aebde6a81c04bc7706253737689560b0fb0fabb52a9388314cc7514187
+  data.tar.gz: 0a52fa6c13da5c282167690c7f1fa73a70b5c9175f7e34f9d68bfcdd0036f305dfe177fb2ad2153c7722bdf4fef989b694cc68cfb56edefb52ee424c28ff98aa

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/Gemfile.lock
+/vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at calle@discord.bofh.se. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tangle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Calle Englund
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tangle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tangle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+desc 'Run RuboCop'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options << '--display-cop-names'
+end
+
+desc 'Run RSpec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tangle'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path vendor/bundle
+
+# Do any other automated setup that you need to do here

data/lib/tangle.rb

@@ -0,0 +1,8 @@
+require 'tangle/version'
+require 'tangle/graph'
+
+# Tangle manages graphs of things
+#
+module Tangle
+  # Your code goes here...
+end

data/lib/tangle/edge.rb

@@ -0,0 +1,67 @@
+module Tangle
+  #
+  # An edge in a graph, connecting two vertices
+  #
+  class Edge
+    extend Forwardable
+
+    # Create a new edge between vertices
+    #
+    # Edge.new(vtx1) => Edge (loop)
+    # Edge.new(vtx1, vtx2) => Edge
+    #
+    # End users should probably use Graph#add_edge instead.
+    #
+    def initialize(vertex1, vertex2 = vertex1, graph: nil)
+      @vertices = Set[vertex1, vertex2]
+      @graph = graph
+
+      raise ArgumentError unless valid_edge?
+    end
+
+    # Follow the edge from a vertex to the other end
+    #
+    # walk(vertex) => Vertex
+    #
+    def walk(from_vertex)
+      raise RuntimeError unless @vertices.include?(from_vertex)
+      @vertices.find { |other| other != from_vertex } || from_vertex
+    end
+
+    # Duplicate an edge into another graph, replacing original vertices with
+    # their already prepared duplicates in the other graph. Returns nil if any
+    # of the vertices does not exist in the other graph.
+    # End users should probably use Graph#subgraph instead.
+    #
+    # dup_into(graph) => Edge or nil
+    #
+    # Raises an ArgumentError if graph would remain the same.
+    #
+    def dup_into(graph)
+      raise ArgumentError if graph == @graph
+
+      vertices = @vertices.map do |vertex|
+        graph.get_vertex(vertex.vertex_id)
+      end
+      Edge.new(*vertices, graph: graph)
+    rescue KeyError
+      nil
+    end
+
+    def inspect
+      "#<#{self.class}: #{@vertices}>"
+    end
+
+    attr_reader :name
+    attr_reader :graph
+    attr_reader :vertices
+
+    def_delegators :@vertices, :include?
+
+    private
+
+    def valid_edge?
+      @vertices.all? { |vertex| vertex.graph == @graph }
+    end
+  end
+end

data/lib/tangle/graph.rb

@@ -0,0 +1,175 @@
+require 'tangle/vertex'
+require 'tangle/edge'
+
+module Tangle
+  #
+  # Base class for all kinds of graphs
+  #
+  class 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
+    #
+    # 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
+    # get assigned unique names (within the graph).
+    #
+    # +vertices+ can contain anything, and the Vertex object that is created
+    # will delegate all missing methods to its content.
+    #
+    # +edges+ can contain an array of exactly two, either names of vertices
+    # or vertices.
+    #
+    # Any subclass of Graph should also subclass Edge to manage its unique
+    # constraints.
+    #
+    def initialize(vertices: nil, edges: nil)
+      @vertices_by_id = {}
+      @vertices_by_name = {}
+      @edges = []
+
+      initialize_vertices(vertices)
+      initialize_edges(edges)
+    end
+
+    # Get all edges.
+    #
+    # edges => Array
+    #
+    def edges(&selector)
+      if block_given?
+        @edges.select(&selector)
+      else
+        @edges
+      end
+    end
+
+    # Add a new edge to the graph
+    #
+    # add_edge(vtx1, vtx2, ...) => Edge
+    #
+    def add_edge(*vertices, **kvargs)
+      vertices = vertices.map { |v| get_vertex(v) }
+      insert_edge(Edge.new(*vertices, graph: self, **kvargs))
+    end
+
+    # Get all vertices.
+    #
+    # vertices => Array
+    #
+    def vertices
+      if block_given?
+        @vertices_by_id.select { |_, vertex| yield(vertex) }
+      else
+        @vertices_by_id
+      end.values
+    end
+
+    # Add a new vertex to the graph
+    #
+    # add_vertex(...) => Vertex
+    #
+    # Optional named arguments:
+    #   name: unique name or label for vertex
+    #   contents: delegate object for missing methods
+    #
+    def add_vertex(**kvargs)
+      insert_vertex(Vertex.new(graph: self, **kvargs))
+    end
+
+    def get_vertex(name_or_vertex)
+      case name_or_vertex
+      when Vertex
+        name_or_vertex
+      else
+        @vertices_by_name[name_or_vertex] ||
+          @vertices_by_id.fetch(name_or_vertex)
+      end
+    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(&selector)
+      graph = Graph.new
+
+      dup_vertices_into(graph, &selector)
+      dup_edges_into(graph)
+
+      graph
+    end
+    alias dup subgraph
+
+    protected
+
+    # Insert a prepared vertex into the graph
+    #
+    def insert_vertex(vertex)
+      raise ArgumentError unless vertex.graph.eql?(self)
+
+      @vertices_by_name[vertex.name] = vertex unless vertex.name.nil?
+      @vertices_by_id[vertex.vertex_id] = vertex
+    end
+
+    # Insert a prepared edge into the graph
+    #
+    def insert_edge(edge)
+      raise ArgumentError unless edge.graph.eql?(self)
+
+      @edges << edge
+      edge
+    end
+
+    private
+
+    def initialize_vertices(vertices)
+      return if vertices.nil?
+
+      case vertices
+      when Hash
+        initialize_named_vertices(vertices)
+      else
+        initialize_anonymous_vertices(vertices)
+      end
+    end
+
+    def initialize_named_vertices(vertices)
+      vertices.each do |name, delegate|
+        add_vertex(name: name, delegate: delegate)
+      end
+    end
+
+    def initialize_anonymous_vertices(vertices)
+      vertices.each do |delegate|
+        add_vertex(delegate: delegate)
+      end
+    end
+
+    def initialize_edges(edges)
+      return if edges.nil?
+
+      edges.each do |vertices|
+        add_edge(*vertices)
+      end
+    end
+
+    def dup_vertices_into(graph, &selector)
+      vertices(&selector).each do |vertex|
+        graph.insert_vertex(vertex.dup_into(graph))
+      end
+    end
+
+    def dup_edges_into(graph)
+      edges.each do |edge|
+        new_edge = edge.dup_into(graph)
+        graph.insert_edge(new_edge) unless new_edge.nil?
+      end
+    end
+  end
+end

data/lib/tangle/version.rb

@@ -0,0 +1,3 @@
+module Tangle
+  VERSION = '0.1.0'.freeze
+end

data/lib/tangle/vertex.rb

@@ -0,0 +1,81 @@
+require 'delegate'
+require 'pp'
+
+module Tangle
+  #
+  # A named vertex in a graph
+  #
+  class Vertex < SimpleDelegator
+    include PP::ObjectMixin
+
+    # Create a new vertex
+    #
+    # Vertex.new(...) => Vertex
+    #
+    # Named arguments:
+    #   graph: a Graph or nil for an orphaned vertex
+    #   name: anything that's hashable and unique within the graph
+    #   delegate: delegate object for missing methods
+    #
+    def initialize(graph: nil,
+                   name: nil,
+                   delegate: nil,
+                   vertex_id: object_id)
+      super(delegate) unless delegate.nil?
+
+      @graph = graph
+      @name = name
+      @delegate = delegate
+      @vertex_id = vertex_id
+    end
+
+    # Duplicate a vertex in a new graph, keeping all other contained attributes
+    # End users should probably use Graph#subgrap instead.
+    #
+    # dup_into(new_graph) => Vertex
+    #
+    # Raises an ArgumentError if graph would remain the same.
+    #
+    def dup_into(graph)
+      raise ArgumentError if graph == @graph
+
+      Vertex.new(
+        graph:     graph,
+        name:      @name,
+        delegate:  @delegate,
+        vertex_id: @vertex_id
+      )
+    end
+
+    # Return all edges that touch this vertex
+    #
+    def edges
+      return [] if @graph.nil?
+
+      @graph.edges { |edge| edge.include? self }
+    end
+
+    # If two vertices have the same vertex_id, they have the same value
+    #
+    def ==(other)
+      @vertex_id == other.vertex_id
+    end
+
+    # If two vertices have the same vertex_id, they have the same value
+    #
+    def !=(other)
+      @vertex_id != other.vertex_id
+    end
+
+    # If two vertices have the same object_id, they are identical
+    #
+    def eql?(other)
+      @object_id == other.object_id
+    end
+
+    attr_reader :graph
+    attr_reader :name
+    attr_reader :delegate
+    attr_reader :vertex_id
+  end
+end

data/tangle.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tangle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tangle'
+  spec.version       = Tangle::VERSION
+  spec.authors       = ['Calle Englund']
+  spec.email         = ['calle@discord.bofh.se']
+
+  spec.summary       = 'Tangle implements graphs of things'
+  spec.homepage      = 'https://github.com/notcalle/ruby-tangle'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tangle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calle Englund
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: 
+email:
+- calle@discord.bofh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tangle.rb
+- lib/tangle/edge.rb
+- lib/tangle/graph.rb
+- lib/tangle/version.rb
+- lib/tangle/vertex.rb
+- tangle.gemspec
+homepage: https://github.com/notcalle/ruby-tangle
+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.4
+signing_key: 
+specification_version: 4
+summary: Tangle implements graphs of things
+test_files: []