build-dependency 1.0.0

data/lib/build/dependency/partial_chain.rb

@@ -0,0 +1,95 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'chain'
+
+module Build
+	module Dependency
+		class Chain
+			def partial(provider)
+				PartialChain.expand(self, provider.dependencies)
+			end
+		end
+		
+		class PartialChain < Resolver
+			# An `UnresolvedDependencyError` will be thrown if there are any unresolved dependencies.
+			def self.expand(*args)
+				chain = self.new(*args)
+				
+				chain.freeze
+				
+				return chain
+			end
+			
+			def initialize(chain, dependencies)
+				super()
+				
+				@chain = chain
+				
+				# The list of dependencies that needs to be satisfied:
+				@dependencies = dependencies.collect{|dependency| Depends[dependency]}
+				
+				expand_top
+			end
+			
+			def selection
+				@chain.selection
+			end
+			
+			attr :dependencies
+			
+			def providers
+				@chain.providers
+			end
+			
+			def freeze
+				return unless frozen?
+				
+				@chain.freeze
+				@dependencies.freeze
+				
+				super
+			end
+			
+			protected
+			
+			def expand_top
+				expand_nested(@dependencies, TOP)
+			end
+			
+			def expand(dependency, parent)
+				unless @dependencies.include?(dependency)
+					return if dependency.private?
+				end
+				
+				super(dependency, parent)
+			end
+			
+			def find_provider(dependency, parent)
+				@chain.resolved[dependency]
+			end
+			
+			def provision_for(provider, dependency)
+				# @chain.resolved[provider] does work, but it points to the most recently added provision, but we want the provision related to the specific dependency.
+				provider.provision_for(dependency)
+			end
+		end
+	end
+end

data/lib/build/dependency/unit.rb

@@ -0,0 +1,135 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'set'
+
+module Build
+	module Dependency
+		def self.included(klass)
+			klass.include(Unit)
+		end
+		
+		# A provision is a thing which satisfies a dependency.
+		Provision = Struct.new(:name, :provider, :value) do
+			def alias?
+				false
+			end
+		end
+		
+		Alias = Struct.new(:name, :provider, :dependencies) do
+			def alias?
+				true
+			end
+		end
+		
+		Resolution = Struct.new(:provider, :dependency) do
+			def name
+				dependency.name
+			end
+		end
+		
+		Depends = Struct.new(:name) do
+			def initialize(name, **options)
+				super(name)
+				
+				@options = options
+			end
+			
+			attr :options
+			
+			def private?
+				@options[:private]
+			end
+			
+			def alias?
+				name.is_a?(Symbol)
+			end
+			
+			def self.[] name_or_dependency
+				name_or_dependency.is_a?(self) ? name_or_dependency : self.new(name_or_dependency)
+			end
+		end
+		
+		module Unit
+			def freeze
+				return unless frozen?
+				
+				provisions.freeze
+				dependencies.freeze
+				
+				super
+			end
+			
+			# Assign a priority to this unit.
+			def priority= value
+				@priority = value
+			end
+			
+			# The units default priority
+			def priority
+				@priority ||= 0
+			end
+			
+			# @return Hash<String, Provision> a table of named provisions.
+			def provisions
+				@provisions ||= {}
+			end
+			
+			# @return Set<Dependency>
+			def dependencies
+				@dependencies ||= Set.new
+			end
+			
+			# Does this unit provide the named thing?
+			def provides?(dependency)
+				provisions.key?(dependency.name)
+			end
+			
+			def provision_for(dependency)
+				provisions[dependency.name]
+			end
+			
+			# Mark this unit as providing the named thing, with an optional block.
+			def provides(name_or_aliases, &block)
+				if String === name_or_aliases || Symbol === name_or_aliases
+					name = name_or_aliases
+					
+					provisions[name] = Provision.new(name, self, block)
+				else
+					aliases = name_or_aliases
+					
+					aliases.each do |name, dependencies|
+						provisions[name] = Alias.new(name, self, Array(dependencies))
+					end
+				end
+			end
+			
+			def depends(*names, **options)
+				names.each do |name|
+					dependencies << Depends.new(name, **options)
+				end
+			end
+			
+			def depends?(name)
+				dependencies.include?(name)
+			end
+		end
+	end
+end

data/lib/build/dependency/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Build
+	module Dependency
+		VERSION = "1.0.0"
+	end
+end

data/lib/build/dependency/visualization.rb

@@ -0,0 +1,151 @@
+# Copyright, 20127, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'graphviz'
+
+module Build
+	module Dependency
+		class Visualization
+			def initialize
+				@base_attributes = {
+					:shape => 'box',
+					:style => 'filled',
+					:fillcolor => 'white',
+					:fontname => 'Monaco',
+				}
+				
+				@provision_attributes = @base_attributes.dup
+				
+				@alias_attributes = @base_attributes.merge(
+					:fillcolor => 'lightgrey',
+				)
+				
+				@dependency_attributes = @base_attributes.merge(
+					:fillcolor => 'orange',
+				)
+				
+				@selection_attributes = {
+					:fillcolor => 'lightbrown',
+				}
+				
+				@private_edge_attributes = {
+					:arrowhead => 'empty',
+					:color => '#0000005f'
+				}
+				
+				@provider_attributes = {
+					:fillcolor => 'lightblue',
+				}
+				
+				@provider_edge_attributes = {
+					:arrowhead => 'none',
+				}
+			end
+			
+			attr :base_attributes
+			attr :provision_attributes
+			
+			attr :provider_attributes
+			attr :provider_edge_attributes
+			
+			attr :alias_attributes
+			
+			attr :dependency_attributes
+			attr :selection_attributes
+			attr :private_edge_attributes
+			
+			def generate(chain)
+				graph = Graphviz::Graph.new
+				graph.attributes[:ratio] = :auto
+				
+				chain.ordered.each do |resolution|
+					provider = resolution.provider
+					name = provider.name
+					
+					# Provider is the dependency that provides the dependency referred to by name.
+					node = graph.add_node(name.to_s, @base_attributes.dup)
+					
+					if chain.dependencies.include?(resolution.dependency)
+						node.attributes.update(@dependency_attributes)
+					elsif chain.selection.include?(provider.name)
+						node.attributes.update(@selection_attributes)
+					end
+					
+					# A provision has dependencies...
+					provider.dependencies.each do |dependency|
+						if dependency_node = graph.nodes[dependency.name.to_s]
+							edge = node.connect(dependency_node)
+							
+							if dependency.private?
+								edge.attributes.update(@private_edge_attributes)
+							end
+						end
+					end
+					
+					# A provision provides other provisions...
+					provider.provisions.each do |provision_name, provision|
+						next if name == provision_name
+						
+						provides_node = graph.nodes[provision_name.to_s] || graph.add_node(provision_name.to_s, @provision_attributes)
+						
+						if provision.alias?
+							provides_node.attributes = @alias_attributes
+						end
+						
+						node.attributes.update(@provider_attributes)
+						
+						unless provides_node.connected?(node)
+							edge = provides_node.connect(node)
+							
+							edge.attributes.update(@provider_edge_attributes)
+						end
+					end
+				end
+				
+				chain.provisions.each do |provision|
+					node = graph.nodes[provision.name.to_s]
+					
+					node.attributes.update(penwidth: 2.0)
+				end
+				
+				# Put all dependencies at the same level so as to not make the graph too confusingraph.
+				done = Set.new
+				chain.ordered.each do |resolution|
+					provider = resolution.provider
+					name = "subgraph-#{provider.name}"
+					
+					subgraph = graph.nodes[name] || graph.add_subgraph(name, :rank => :same)
+					
+					provider.dependencies.each do |dependency|
+						next if done.include? dependency
+						
+						done << dependency
+						
+						if dependency_node = graph.nodes[dependency.name.to_s]
+							subgraph.add_node(dependency_node.name)
+						end
+					end
+				end
+				
+				return graph
+			end
+		end
+	end
+end

data/partial.svg

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.40.1 (20161225.0304)
+ -->
+<!-- Title: G Pages: 1 -->
+<svg width="465pt" height="332pt"
+ viewBox="0.00 0.00 465.00 332.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 328)">
+<title>G</title>
+<polygon fill="#ffffff" stroke="transparent" points="-4,4 -4,-328 461,-328 461,4 -4,4"/>
+<!-- Variant/debug -->
+<g id="node1" class="node">
+<title>Variant/debug</title>
+<polygon fill="#add8e6" stroke="#000000" stroke-width="2" points="130,-36 4,-36 4,0 130,0 130,-36"/>
+<text text-anchor="middle" x="67" y="-14.3" font-family="Monaco" font-size="14.00" fill="#000000">Variant/debug</text>
+</g>
+<!-- variant -->
+<g id="node2" class="node">
+<title>variant</title>
+<polygon fill="#d3d3d3" stroke="#000000" points="104.5,-108 29.5,-108 29.5,-72 104.5,-72 104.5,-108"/>
+<text text-anchor="middle" x="67" y="-86.3" font-family="Monaco" font-size="14.00" fill="#000000">variant</text>
+</g>
+<!-- variant&#45;&gt;Variant/debug -->
+<g id="edge1" class="edge">
+<title>variant&#45;&gt;Variant/debug</title>
+<path fill="none" stroke="#000000" d="M67,-71.8314C67,-61 67,-47.2876 67,-36.4133"/>
+</g>
+<!-- Platform/linux -->
+<g id="node3" class="node">
+<title>Platform/linux</title>
+<polygon fill="#add8e6" stroke="#000000" stroke-width="2" points="134,-180 0,-180 0,-144 134,-144 134,-180"/>
+<text text-anchor="middle" x="67" y="-158.3" font-family="Monaco" font-size="14.00" fill="#000000">Platform/linux</text>
+</g>
+<!-- Platform/linux&#45;&gt;variant -->
+<g id="edge2" class="edge">
+<title>Platform/linux&#45;&gt;variant</title>
+<path fill="none" stroke="#000000" d="M67,-143.8314C67,-136.131 67,-126.9743 67,-118.4166"/>
+<polygon fill="#000000" stroke="#000000" points="70.5001,-118.4132 67,-108.4133 63.5001,-118.4133 70.5001,-118.4132"/>
+</g>
+<!-- platform -->
+<g id="node4" class="node">
+<title>platform</title>
+<polygon fill="#d3d3d3" stroke="#000000" points="109,-252 25,-252 25,-216 109,-216 109,-252"/>
+<text text-anchor="middle" x="67" y="-230.3" font-family="Monaco" font-size="14.00" fill="#000000">platform</text>
+</g>
+<!-- platform&#45;&gt;Platform/linux -->
+<g id="edge3" class="edge">
+<title>platform&#45;&gt;Platform/linux</title>
+<path fill="none" stroke="#000000" d="M67,-215.8314C67,-205 67,-191.2876 67,-180.4133"/>
+</g>
+<!-- lib -->
+<g id="node5" class="node">
+<title>lib</title>
+<polygon fill="#ffa500" stroke="#000000" stroke-width="2" points="94,-324 40,-324 40,-288 94,-288 94,-324"/>
+<text text-anchor="middle" x="67" y="-302.3" font-family="Monaco" font-size="14.00" fill="#000000">lib</text>
+</g>
+<!-- lib&#45;&gt;platform -->
+<g id="edge4" class="edge">
+<title>lib&#45;&gt;platform</title>
+<path fill="none" stroke="#000000" stroke-opacity="0.372549" d="M67,-287.8314C67,-280.131 67,-270.9743 67,-262.4166"/>
+<polygon fill="none" stroke="#000000" stroke-opacity="0.372549" points="70.5001,-262.4132 67,-252.4133 63.5001,-262.4133 70.5001,-262.4132"/>
+</g>
+<!-- Compiler/clang -->
+<g id="node6" class="node">
+<title>Compiler/clang</title>
+<polygon fill="#add8e6" stroke="#000000" points="349,-180 215,-180 215,-144 349,-144 349,-180"/>
+<text text-anchor="middle" x="282" y="-158.3" font-family="Monaco" font-size="14.00" fill="#000000">Compiler/clang</text>
+</g>
+<!-- Language/C++14 -->
+<g id="node7" class="node">
+<title>Language/C++14</title>
+<polygon fill="#ffffff" stroke="#000000" stroke-width="2" points="305,-252 171,-252 171,-216 305,-216 305,-252"/>
+<text text-anchor="middle" x="238" y="-230.3" font-family="Monaco" font-size="14.00" fill="#000000">Language/C++14</text>
+</g>
+<!-- Language/C++14&#45;&gt;Compiler/clang -->
+<g id="edge5" class="edge">
+<title>Language/C++14&#45;&gt;Compiler/clang</title>
+<path fill="none" stroke="#000000" d="M249.1031,-215.8314C255.7222,-205 264.102,-191.2876 270.7474,-180.4133"/>
+</g>
+<!-- Language/C++17 -->
+<g id="node8" class="node">
+<title>Language/C++17</title>
+<polygon fill="#ffffff" stroke="#000000" points="457,-252 323,-252 323,-216 457,-216 457,-252"/>
+<text text-anchor="middle" x="390" y="-230.3" font-family="Monaco" font-size="14.00" fill="#000000">Language/C++17</text>
+</g>
+<!-- Language/C++17&#45;&gt;Compiler/clang -->
+<g id="edge6" class="edge">
+<title>Language/C++17&#45;&gt;Compiler/clang</title>
+<path fill="none" stroke="#000000" d="M362.747,-215.8314C346.3751,-204.9167 325.6147,-191.0764 309.2442,-180.1628"/>
+</g>
+</g>
+</svg>