build-dependency 1.5.1 → 1.6.0

data/lib/build/dependency.rb

@@ -1,28 +1,13 @@
-# 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.
+# frozen_string_literal: true
 
-require_relative 'dependency/version'
+# Released under the MIT License.
+# Copyright, 2017-2026, by Samuel Williams.
 
-require_relative 'dependency/provider'
+require_relative "dependency/version"
 
-require_relative 'dependency/chain'
-require_relative 'dependency/partial_chain'
+require_relative "dependency/provider"
 
-require_relative 'dependency/visualization'
+require_relative "dependency/chain"
+require_relative "dependency/partial_chain"
+
+require_relative "dependency/visualization"

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2017-2026, by Samuel Williams.  
+
+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,64 @@
+# Build::Dependency
+
+Build::Dependency provides dependency resolution algorithms.
+
+[![Development Status](https://github.com/ioquatix/build-dependency/workflows/Test/badge.svg)](https://github.com/ioquatix/build-dependency/actions?workflow=Test)
+
+## Motivation
+
+Build::Dependency helps you resolve complex dependency graphs in your build systems and applications. It supports:
+
+  - **Full dependency resolution** with automatic ordering
+  - **Partial chains** for incremental builds
+  - **Private dependencies** that don't leak to dependents
+  - **Wildcard matching** for batch dependencies
+  - **Mermaid visualization** for diagram generation
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/build-dependency/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/build-dependency/guides/getting-started/index) - This guide explains how to use `build-dependency` for dependency resolution in your projects.
+
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/build-dependency/releases/index) for all releases.
+
+### v1.6.0
+
+  - Change visualization to use Mermaid flowcharts for better readability and diagram generation.
+
+## See Also
+
+  - [build](https://github.com/ioquatix/build) — General build system using dependency resolution.
+  - [teapot](https://github.com/ioquatix/teapot) — Package management using dependency resolution.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+Please see the [project releases](https://ioquatix.github.io/build-dependency/releases/index) for all releases.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v1.6.0
+
+  - Change visualization to use Mermaid flowcharts for better readability and diagram generation.

data/test/build/dependency/chain.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2026, by Samuel Williams.
+
+require "build/dependency_context"
+
+describe Build::Dependency do
+	with "valid dependency resolution" do
+		let(:a) do
+			Build::DependencyContext::Package.new("apple-tree").tap do |package|
+				package.provides "apple" do
+					fruit ["apple"]
+				end
+			end
+		end
+		
+		let(:b) do
+			Build::DependencyContext::Package.new("orange-tree").tap do |package|
+				package.provides "orange" do
+					fruit ["orange"]
+				end
+			end
+		end
+		
+		let(:c) do
+			Build::DependencyContext::Package.new("blender").tap do |package|
+				package.provides "fruit-juice" do
+					juice ["ice", "cold"]
+				end
+				
+				package.depends "apple"
+				package.depends "orange"
+			end
+		end
+		
+		it "should resolve direct dependency chain" do
+			chain = Build::Dependency::Chain.expand(["fruit-juice"], [a, b, c])
+			expect(chain.ordered.collect(&:provider)).to be == [a, b, c]
+			expect(chain.unresolved).to be == []
+		end
+		
+		it "should resolve wildcard dependency chain" do
+			chain = Build::Dependency::Chain.expand(["fruit-*"], [a, b, c])
+			expect(chain.ordered.collect(&:provider)).to be == [a, b, c]
+			expect(chain.unresolved).to be == []
+		end
+		
+		let(:d) do
+			Build::DependencyContext::Package.new("bakery").tap do |package|
+				package.provides "pie"
+				package.depends "apple"
+			end
+		end
+		
+		it "shouldn't include unrelated units" do
+			chain = Build::Dependency::Chain.expand(["pie"], [a, b, c, d])
+			
+			expect(chain.unresolved).to be == []
+			expect(chain.ordered.collect(&:provider)).to be == [a, d]
+		end
+		
+		it "should format nicely" do
+			chain = Build::Dependency::Chain.expand(["fruit-juice"], [a, b, c])
+			resolution = chain.ordered.first
+			expect(resolution.to_s).to be == 'resolution "apple-tree" -> "apple"'
+		end
+	end
+	
+	with "incomplete dependency resolution" do
+		it "should report conflicts" do
+			apple = Build::DependencyContext::Package.new("apple")
+			apple.provides "apple"
+			apple.provides "fruit"
+			
+			bananna = Build::DependencyContext::Package.new("bananna")
+			bananna.provides "fruit"
+			
+			salad = Build::DependencyContext::Package.new("salad")
+			salad.depends "fruit"
+			salad.provides "salad"
+			
+			chain = Build::Dependency::Chain.new(["salad"], [apple, bananna, salad])
+			expect(chain.unresolved.first).to be == [Build::Dependency::Depends.new("fruit"), salad]
+			expect(chain.conflicts).to be == {Build::Dependency::Depends.new("fruit") => [apple, bananna]}
+			
+			chain = Build::Dependency::Chain.new(["salad"], [apple, bananna, salad], ["apple"])
+			expect(chain.unresolved).to be == []
+			expect(chain.conflicts).to be == {}
+		end
+	end
+	
+	with "multiple provisions" do
+		let(:fruit) do
+			Build::DependencyContext::Package.new("fruit").tap do |package|
+				package.provides "apple" do
+				end
+				
+				package.provides "orange" do
+				end
+			end
+		end
+		
+		let(:salad) do
+			Build::DependencyContext::Package.new("salad").tap do |package|
+				package.depends "apple"
+				package.depends "orange"
+				package.provides "salad"
+			end
+		end
+		
+		let(:lunch) do
+			Build::DependencyContext::Package.new("lunch").tap do |package|
+				package.depends "apple"
+				package.depends "salad"
+				package.provides "lunch"
+			end
+		end
+		
+		let(:chain) {Build::Dependency::Chain.new(["lunch"], [fruit, salad, lunch])}
+		
+		it "should include both provisions" do
+			expect(chain.provisions.count).to be == 4
+			expect(chain.provisions.collect(&:name)).to be == ["apple", "orange", "salad", "lunch"]
+		end
+		
+		it "should include both provisions in partial chain" do
+			partial_chain = chain.partial(lunch)
+			expect(partial_chain.provisions.count).to be == 3
+			expect(partial_chain.provisions.collect(&:name)).to be == ["apple", "orange", "salad"]
+		end
+	end
+	
+	it "should resolve aliases" do
+		apple = Build::DependencyContext::Package.new("apple")
+		apple.provides "apple"
+		apple.provides :fruit => "apple"
+		
+		bananna = Build::DependencyContext::Package.new("bananna")
+		bananna.provides "bananna"
+		bananna.provides :fruit => "bananna"
+		
+		salad = Build::DependencyContext::Package.new("salad")
+		salad.depends :fruit
+		salad.provides "salad"
+		
+		chain = Build::Dependency::Chain.expand(["salad"], [apple, bananna, salad], ["apple"])
+		expect(chain.unresolved).to be == []
+		expect(chain.conflicts).to be == {}
+		
+		expect(chain.ordered.size).to be == 2
+		expect(chain.ordered[0].provider).to be == apple
+		expect(chain.ordered[1].provider).to be == salad
+	end
+	
+	it "should select dependencies with high priority" do
+		bad_apple = Build::DependencyContext::Package.new("bad_apple")
+		bad_apple.provides "apple"
+		bad_apple.priority = 20
+		
+		good_apple = Build::DependencyContext::Package.new("good_apple")
+		good_apple.provides "apple"
+		good_apple.priority = 40
+		
+		chain = Build::Dependency::Chain.expand(["apple"], [bad_apple, good_apple])
+		
+		expect(chain.unresolved).to be == []
+		expect(chain.conflicts).to be == {}
+		
+		# Should select higher priority package by default:
+		expect(chain.ordered).to be == [good_apple.resolution_for(
+			Build::Dependency::Depends["apple"]
+		)]
+	end
+	
+	it "should expose direct dependencies" do
+		system = Build::DependencyContext::Package.new("linux")
+		system.provides "linux"
+		system.provides "clang"
+		system.provides system: "linux"
+		system.provides compiler: "clang"
+		
+		library = Build::DependencyContext::Package.new("library")
+		library.provides "library"
+		library.depends :system
+		library.depends :compiler
+		
+		application = Build::DependencyContext::Package.new("application")
+		application.provides "application"
+		application.depends :compiler
+		application.depends "library"
+		
+		chain = Build::Dependency::Chain.expand(["application"], [system, library, application])
+		
+		expect(chain.unresolved).to be == []
+		expect(chain.conflicts).to be == {}
+		expect(chain.ordered).to be == [
+			system.resolution_for(Build::Dependency::Depends.new("clang")),
+			library.resolution_for(Build::Dependency::Depends.new("library")),
+			application.resolution_for(Build::Dependency::Depends.new("application")),
+		]
+	end
+	
+	it "should raise UnresolvedDependencyError when expanding with unresolved dependencies" do
+		missing = Build::DependencyContext::Package.new("missing")
+		missing.provides "missing"
+		missing.depends "does-not-exist"
+		
+		expect do
+			Build::Dependency::Chain.expand(["missing"], [missing])
+		end.to raise_exception(Build::Dependency::UnresolvedDependencyError)
+	end
+	
+	it "can freeze a chain" do
+		apple = Build::DependencyContext::Package.new("apple")
+		apple.provides "apple"
+		
+		chain = Build::Dependency::Chain.new(["apple"], [apple])
+		
+		expect(chain.freeze).to be == chain
+		expect(chain).to be(:frozen?)
+	end
+end

data/test/build/dependency/partial_chain.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2026, by Samuel Williams.
+
+require "build/dependency_context"
+
+describe Build::Dependency::PartialChain do
+	with "app chain" do
+		include Build::DependencyContext::AppPackages
+		
+		let(:chain) {Build::Dependency::Chain.expand(["app", "lib"], packages)}
+		
+		it "should generate full list of ordered providers" do
+			expect(chain.ordered).to be == [
+				variant.resolution_for(Build::Dependency::Depends.new("Variant/debug")),
+				platform.resolution_for(Build::Dependency::Depends.new("Platform/linux")),
+				compiler.resolution_for(Build::Dependency::Depends.new("Language/C++17", private: true)),
+				lib.resolution_for(Build::Dependency::Depends.new("lib", private: true)),
+				app.resolution_for(Build::Dependency::Depends.new("app")),
+			]
+		end
+		
+		it "should generate a full list of provisions" do
+			expect(chain.provisions).to be == [
+				variant.provision_for(Build::Dependency::Depends.new("Variant/debug")),
+				platform.provision_for(Build::Dependency::Depends.new("Platform/linux")),
+				compiler.provision_for(Build::Dependency::Depends.new("Language/C++17", private: true)),
+				lib.provision_for(Build::Dependency::Depends.new("lib", private: true)),
+				compiler.provision_for(Build::Dependency::Depends.new("Language/C++14", private: true)),
+				app.provision_for(Build::Dependency::Depends.new("app")),
+				lib.provision_for(Build::Dependency::Depends.new("lib")),
+			]
+			
+			# Generate mermaid diagram
+			expect(visualization.generate(chain)).to be_a(String)
+		end
+		
+		let(:subject) {Build::Dependency::PartialChain.new(chain, app.dependencies)}
+		
+		it "should select app packages" do
+			expect(subject.ordered).to be == [
+				variant.resolution_for(Build::Dependency::Depends.new("Variant/debug")),
+				platform.resolution_for(Build::Dependency::Depends.new("Platform/linux")),
+				lib.resolution_for(Build::Dependency::Depends.new("lib", private: true)),
+				compiler.resolution_for(Build::Dependency::Depends.new("Language/C++14", private: true)),
+			]
+			
+			# Generate mermaid diagram
+			expect(visualization.generate(subject)).to be_a(String)
+		end
+	end
+	
+	with "private dependencies" do
+		let(:a) do
+			Build::DependencyContext::Package.new("a").tap do |package|
+				package.provides "a"
+			end
+		end
+		
+		let(:b) do
+			Build::DependencyContext::Package.new("b").tap do |package|
+				package.provides "b"
+				package.depends "a", private: true
+			end
+		end
+		
+		let(:c) do
+			Build::DependencyContext::Package.new("c").tap do |package|
+				package.provides "c"
+				package.depends "b"
+			end
+		end
+		
+		let(:d) do
+			Build::DependencyContext::Package.new("d").tap do |package|
+				package.provides "d"
+				package.depends "c"
+			end
+		end
+		
+		let(:chain) {Build::Dependency::Chain.expand(["d"], [a, b, c, d])}
+		
+		it "should include direct private dependencies" do
+			partial_chain = chain.partial(b)
+			
+			expect(partial_chain.ordered.collect(&:provider)).to be == [a]
+		end
+		
+		it "shouldn't include nested private dependencies" do
+			partial_chain = chain.partial(c)
+			
+			expect(partial_chain.ordered.collect(&:provider)).to be == [b]
+		end
+		
+		it "should follow non-private dependencies" do
+			partial_chain = chain.partial(d)
+			
+			expect(partial_chain.ordered.collect(&:provider)).to be == [b, c]
+		end
+		
+		it "should access underlying chain selection" do
+			partial_chain = chain.partial(d)
+			
+			expect(partial_chain.selection).to be == chain.selection
+		end
+		
+		it "should access underlying chain providers" do
+			partial_chain = chain.partial(d)
+			
+			expect(partial_chain.providers).to be == chain.providers
+		end
+		
+		it "can freeze a partial chain" do
+			partial_chain = chain.partial(d)
+			
+			expect(partial_chain.freeze).to be == partial_chain
+			expect(partial_chain).to be(:frozen?)
+		end
+	end
+end

data/test/build/dependency/provider.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2026, by Samuel Williams.
+
+require "build/dependency_context"
+
+describe Build::Dependency::Provider do
+	include Build::DependencyContext::AppPackages
+	
+	let(:provider) do
+		Build::DependencyContext::Package.new("test").tap do |package|
+			package.depends "a", private: true
+			package.depends "b", public: true
+			package.depends :variant
+			
+			package.provides "c" do
+				puts "Hello World"
+			end
+			
+			package.provides platform: "linux"
+		end
+	end
+	
+	it "should have specified dependencies" do
+		expect(provider.dependencies.count).to be == 3
+	end
+	
+	it "should have specified provisions" do
+		expect(provider.provisions.count).to be == 2
+	end
+	
+	with Build::Dependency::Provision do
+		let(:subject) {provider.provisions["c"]}
+		
+		it "should have name" do
+			expect(subject.name).to be == "c"
+		end
+		
+		it "should not be an alias" do
+			expect(subject).not.to be(:alias?)
+		end
+		
+		it "should format nicely" do
+			expect(subject.to_s).to be == 'provides "c"'
+		end
+	end
+	
+	with "Build::Dependency::Depends (private)" do
+		let(:subject) {provider.dependencies["a"]}
+		
+		it "should have a name" do
+			expect(subject.name).to be == "a"
+		end
+		
+		it "should not be an alias" do
+			expect(subject).not.to be(:alias?)
+		end
+		
+		it "should format nicely" do
+			expect(subject.to_s).to be == "depends on \"a\" #{{private: true}.inspect}"
+		end
+		
+		it "should be private" do
+			expect(subject).to be(:private?)
+		end
+		
+		it "should not be public" do
+			expect(subject).not.to be(:public?)
+		end
+	end
+	
+	with "Build::Dependency::Depends (public)" do
+		let(:subject) {provider.dependencies["b"]}
+		
+		it "should be public" do
+			expect(subject).to be(:public?)
+		end
+		
+		it "should not be private" do
+			expect(subject).not.to be(:private?)
+		end
+	end
+	
+	with "Build::Dependency::Depends (variant)" do
+		let(:subject) {provider.dependencies[:variant]}
+		
+		it "should not be public" do
+			expect(subject).not.to be(:public?)
+		end
+		
+		it "should not be private" do
+			expect(subject).not.to be(:private?)
+		end
+	end
+	
+	with Build::Dependency::Alias do
+		let(:subject) {provider.provisions[:platform]}
+		
+		it "should be an alias" do
+			expect(subject).to be(:alias?)
+		end
+		
+		it "should format nicely" do
+			expect(subject.to_s).to be == 'provides :platform -> "linux"'
+		end
+		
+		it "should enumerate dependencies" do
+			# Create a package with an alias that has dependencies
+			pkg = Build::DependencyContext::Package.new("multi-platform")
+			pkg.provides :os => ["linux", "darwin"]
+			
+			alias_provision = pkg.provisions[:os]
+			expect(alias_provision).to be(:alias?)
+			
+			# Check the raw dependencies array first
+			expect(alias_provision.dependencies).to be == ["linux", "darwin"]
+			
+			# Enumerate with a block
+			dependencies = []
+			alias_provision.each_dependency do |dep|
+				dependencies << dep
+			end
+			
+			expect(dependencies.size).to be == 2
+			expect(dependencies[0]).to be_a(Build::Dependency::Depends)
+			expect(dependencies[0].name).to be == "linux"
+			expect(dependencies[1]).to be_a(Build::Dependency::Depends)
+			expect(dependencies[1].name).to be == "darwin"
+		end
+	end
+	
+	it "should check dependencies" do
+		a_dep = Build::Dependency::Depends.new("a")
+		b_dep = Build::Dependency::Depends.new("b")
+		missing_dep = Build::Dependency::Depends.new("does-not-exist")
+		
+		expect(provider.dependencies).to be(:include?, a_dep)
+		expect(provider.dependencies).to be(:include?, b_dep)
+		expect(provider.dependencies).not.to be(:include?, missing_dep)
+	end
+	
+	with Build::Dependency::Provision do
+		let(:provision) {provider.provisions["c"]}
+		
+		it "should enumerate provider dependencies" do
+			# Each provision can enumerate its provider's dependencies
+			dependencies = []
+			provision.each_dependency do |dep|
+				dependencies << dep
+			end
+			
+			expect(dependencies.size).to be == 3
+			expect(dependencies).to be(:include?, Build::Dependency::Depends.new("a", private: true))
+		end
+	end
+	
+	with Build::Dependency::Resolution do
+		let(:simple_provider) do
+			Build::DependencyContext::Package.new("simple").tap do |package|
+				package.provides "simple"
+			end
+		end
+		
+		let(:chain) {Build::Dependency::Chain.expand(["simple"], [simple_provider])}
+		let(:resolution) {chain.ordered.first}
+		
+		it "should have name from dependency" do
+			expect(resolution.name).to be == "simple"
+		end
+	end
+	
+	with "Depends without options" do
+		let(:simple_dep) {Build::Dependency::Depends.new("simple")}
+		
+		it "should format without options" do
+			expect(simple_dep.to_s).to be == 'depends on "simple"'
+		end
+	end
+	
+	it "can freeze a provider" do
+		pkg = Build::DependencyContext::Package.new("frozen")
+		pkg.provides "frozen"
+		pkg.depends "something"
+		
+		expect(pkg.freeze).to be == pkg
+		expect(pkg).to be(:frozen?)
+	end
+end