build 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00349494157af5d057e1ee2a70c3b65c8dd6873fd60419e50f90cb47d2d77018'
-  data.tar.gz: 0131571a8d92702daba61ab85c00ede57e1856505ea06a39e504296759a8e123
+  metadata.gz: 9be6ae7b6f18b932ee30e00ac9951d3095215722bc8ff479a58a5c51cd7f81e5
+  data.tar.gz: 3afcfb408bb6b50028db3454fa457d35e54a5fa28e1caec6761d32eed2c9f16f
 SHA512:
-  metadata.gz: c3196a81c93111aa37ba354b225c5796d6c9600205e229a863865c84c7b29d4bf7e817af4a41a8db50ced349a1b68feb281708ac765e089d9dbe576496576fce
-  data.tar.gz: cce38609f20d57f6d751a5ba2ae80f321bc8d16eca34fb0f512d3b514d5695cc3bc418e9dee904ae1c821d10cd7cf67308fb13f1a28331d28889135f177a10fa
+  metadata.gz: b8d546ed317a43d2f41bf5c356c84b7fcd05040993041367b3c7197334a003f5dace3866fb3133033fa0e18c0ca814c98675c7a16f82726396fd30ca587a4eb8
+  data.tar.gz: c77c91809ebe9132923e383f618fef77e49a8571cdbd670b538625bb003cff57dd1dc0a60da5c344bb3a344326fcea7b5c4a8e35e9f92c5529ca6c8f2600ea9c

data/context/getting-started.md

@@ -0,0 +1,70 @@
+# Getting Started
+
+This guide explains how to get started with `build`, a task-driven build system similar to make.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add build
+~~~
+
+## Core Concepts
+
+`build` has several core concepts:
+
+- A {ruby Build::Rule} which represents a named build operation with typed input and output parameters.
+- A {ruby Build::Rulebook} which is a collection of rules organized by process name for fast lookup.
+- A {ruby Build::Controller} which manages the build graph and executes rules concurrently.
+
+## Usage
+
+Define rules using `Build::Rule` inside a build environment, then organize them into a rulebook:
+
+~~~ ruby
+require "build/environment"
+require "build/rulebook"
+require "build/rule"
+
+environment = Build::Environment.new do
+  define Build::Rule, "copy.file" do
+    input :source
+    output :destination
+    
+    apply do |parameters|
+      cp parameters[:source], parameters[:destination]
+    end
+  end
+  
+  define Build::Rule, "compile.cpp" do
+    input :source
+    output :object
+    
+    apply do |parameters|
+      run! "clang++", "-c", parameters[:source], "-o", parameters[:object]
+    end
+  end
+end
+
+rulebook = Build::Rulebook.for(environment.flatten)
+~~~
+
+### Running a Build
+
+Use {ruby Build::Controller} to orchestrate the build graph. The controller handles dependency resolution and runs rules concurrently where possible:
+
+~~~ ruby
+require "build/controller"
+
+controller = Build::Controller.new do |controller|
+  controller.add_chain(chain, [], environment)
+end
+
+controller.run
+
+if controller.failed?
+  $stderr.puts "Build failed!"
+  exit(1)
+end
+~~~

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Build is a framework for creating task based build systems.
+metadata:
+  documentation_uri: https://ioquatix.github.io/build/
+  source_code_uri: https://github.com/kurocha/build.git
+  funding_uri: https://github.com/sponsors/ioquatix
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to get started with `build`, a task-driven
+    build system similar to make.

data/lib/build/build_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 require "fileutils"
 require "build/graph"

data/lib/build/chain_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2019, by Samuel Williams.
+# Copyright, 2016-2026, by Samuel Williams.
 
 require "build/files"
 require "build/graph"

data/lib/build/controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2019, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 require "build/files"
 require "build/makefile"

data/lib/build/dependency_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 require "build/graph"
 

data/lib/build/name.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2019, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	# Represents a human-readable name with helpers for generating identifiers, target names, and macros.

data/lib/build/provision_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 require "build/graph"
 

data/lib/build/rule.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2019, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 module Build
 	# A rule is a function with a specific set of input and output parameters, which can match against a given set of specific arguments. For example, there might be several rules for compiling, but the specific rules depend on the language being compiled.

data/lib/build/rule_node.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2019, by Samuel Williams.
+# Copyright, 2016-2026, by Samuel Williams.
 
 require "build/graph"
 

data/lib/build/rulebook.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2019, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 require_relative "rule"
 

data/lib/build/task.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2019, by Samuel Williams.
+# Copyright, 2016-2026, by Samuel Williams.
 
 require "fileutils"
 require "build/graph"

data/lib/build/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2024, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 # @namespace
 module Build
-	VERSION = "2.7.0"
+	VERSION = "2.8.0"
 end

data/lib/build.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015, by Samuel Williams.
+# Copyright, 2015-2026, by Samuel Williams.
 
 require_relative "build/version"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2015-2024, by Samuel Williams.  
+Copyright, 2015-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

data/readme.md

@@ -4,30 +4,20 @@ Build is a ruby gem providing systems for building task driven build systems sim
 
 [![Development Status](https://github.com/ioquatix/build/workflows/Test/badge.svg)](https://github.com/ioquatix/build/actions?workflow=Test)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'build'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install build
-
 ## Usage
 
-Please see the [project documentation](https://ioquatix.github.io/build) for more details.
+Please see the [project documentation](https://ioquatix.github.io/build/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/build/guides/getting-started/index) - This guide explains how to get started with `build`, a task-driven build system similar to make.
 
 ## Releases
 
-Please see the [project releases](https://ioquatix.github.io/buildreleases/index) for all releases.
+Please see the [project releases](https://ioquatix.github.io/build/releases/index) for all releases.
 
 ### v2.7.0
 
+  - Remove logger dependency and options.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -38,6 +28,22 @@ We welcome contributions to this project.
 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
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### 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.

data/releases.md

@@ -1,3 +1,5 @@
 # Releases
 
 ## v2.7.0
+
+  - Remove logger dependency and options.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: build
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -94,30 +94,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: graphviz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
 - lib/build.rb
 - lib/build/build_node.rb
 - lib/build/chain_node.rb
 - lib/build/controller.rb
 - lib/build/dependency_node.rb
-- lib/build/graphviz.rb
 - lib/build/name.rb
 - lib/build/provision_node.rb
 - lib/build/rule.rb
@@ -128,13 +115,12 @@ files:
 - license.md
 - readme.md
 - releases.md
-homepage: https://github.com/kurocha/build
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://ioquatix.github.io/build
-  funding_uri: https://github.com/sponsors/ioquatix
+  documentation_uri: https://ioquatix.github.io/build/
   source_code_uri: https://github.com/kurocha/build.git
+  funding_uri: https://github.com/sponsors/ioquatix
 rdoc_options: []
 require_paths:
 - lib
@@ -142,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Build is a framework for creating task based build systems.
 test_files: []

data/lib/build/graphviz.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2015, by Samuel Williams.
-
-module Build
-	# Generate a Graphviz graph visualisation of the build graph.
-	# @parameter walker [Build::Graph::Walker] The completed walker containing tasks.
-	# @returns [Graphviz::Graph] A graph object ready for rendering.
-	def self.graph_visualisation(walker)
-		graph = Graphviz::Graph.new("G", rankdir: "LR")
-		
-		walker.tasks.each do |node, task|
-			input_nodes = []
-			output_nodes = []
-			
-			task.inputs.each do |path|
-				input_nodes << graph.add_node(path.basename)
-			end
-			
-			task.outputs.each do |path|
-				output_nodes << graph.add_node(path.basename)
-			end
-			
-			if output_nodes.size == 1
-				input_nodes.each do |input_node|
-					edge = input_node.connect(output_nodes.first)
-					edge.attributes[:label] = node.title
-				end
-			end
-		end
-		
-		return graph
-	end
-end