teapot 3.5.4 → 3.6.1

data/lib/teapot/target.rb

@@ -1,43 +1,32 @@
-# Copyright, 2012, 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 'pathname'
-require 'build/dependency'
-require_relative 'definition'
+# Released under the MIT License.
+# Copyright, 2012-2026, by Samuel Williams.
 
-require 'build/environment'
-require 'build/rulebook'
+require "pathname"
+require "build/dependency"
+require_relative "definition"
+
+require "build/environment"
+require "build/rulebook"
 
 module Teapot
+	# Raised during build operations.
 	class BuildError < StandardError
 	end
 	
+	# A build target.
 	class Target < Definition
 		include Build::Dependency
 		
+		# Initialize a new target.
 		def initialize(*)
 			super
 			
 			@build = nil
 		end
 		
+		# Make the target immutable after it has been completely defined with dependencies and build rules.
 		def freeze
 			return self if frozen?
 			
@@ -46,6 +35,9 @@ module Teapot
 			super
 		end
 		
+		# Define the build block for this target.
+		# @parameter block [Proc | Nil] The build block.
+		# @returns [Proc | Nil] The build block.
 		def build(&block)
 			if block_given?
 				@build = block
@@ -54,6 +46,7 @@ module Teapot
 			return @build
 		end
 		
+		# Update environments with the build block.
 		def update_environments!
 			return unless @build
 			

data/lib/teapot/version.rb

@@ -1,23 +1,9 @@
-# Copyright, 2012, 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
 
+# Released under the MIT License.
+# Copyright, 2012-2026, by Samuel Williams.
+
+# @namespace
 module Teapot
-	VERSION = "3.5.4"
+	VERSION = "3.6.1"
 end

data/lib/teapot.rb

@@ -1,26 +1,7 @@
-# Copyright, 2012, 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 "teapot/version"
+# Released under the MIT License.
+# Copyright, 2012-2026, by Samuel Williams.
 
+require "teapot/version"
 require "teapot/context"
-
-module Teapot
-end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2012-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/notes.md

@@ -0,0 +1,74 @@
+# Notes
+
+These are just some random design notes.
+
+## Target build vs environment
+
+It's cumbersome and causes a disconnect between `target.build` and environment provisions. Currently, it's written like this:
+
+```ruby
+define_target "time-library" do |target|
+	source_root = target.package.path + "source"
+	
+	target.build do
+		build prefix: target.name, static_library: "Time", source_files: source_root.glob("Time/**/*.cpp")
+	end
+	
+	target.depends "Build/Files"
+	target.depends "Build/Clang"
+	
+	target.depends :platform
+	target.depends "Language/C++11", private: true
+	
+	target.depends "Build/Files"
+	target.depends "Build/Clang"
+	
+	target.provides "Library/Time" do
+		append linkflags [
+			->{build_prefix + target.name + "Time.a"},
+		]
+		
+		append buildflags [
+			"-I", ->{source_root},
+		]
+	end
+end
+```
+
+Ideally, it's defined all in the environment:
+
+```
+target.provides "Library/Time" do
+	append linkflags do
+		build prefix: target.name, static_library: "Time", source_files: source_root.glob("Time/**/*.cpp")
+	end
+	
+	append buildflags [
+		"-I", ->{source_root},
+	]
+end
+```
+
+Perhaps with the ability to share build steps:
+
+```ruby
+append linkflags &target.build
+```
+
+## Modern format for package definitions.
+
+``` ruby
+define_target "test-project-library" do |target|
+	source_root = target.package.path + "source"
+	
+	target.depends "Language/C++14", private: true
+	
+	target.provides "Library/TestProject" do
+		append include_paths source_root
+		
+		library_path = build static_library: "TestProject", source_files: source_root.glob("TestProject/**/*.cpp")
+		
+		append linkflags library_path
+	end
+end
+```

data/readme.md

@@ -0,0 +1,64 @@
+# ![Teapot](materials/teapot.svg)
+
+Teapot is a decentralised build tool for managing complex cross-platform projects. It has many goals but it is primarily designed to improve the experience for developers trying to make cross-platform applications and libraries with a minimum of overhead.
+
+  - Provide useful feedback when dependencies are not met or errors are encountered.
+  - Decentralised dependency management allows use within private organisations without exposing code.
+  - Generators can simplify the construction of new projects as well as assist with the development of existing ones.
+  - The build subsystem provides a simple set of canonical operations for building libraries and executables to minimise configuration overhead.
+
+[![Development Status](https://github.com/kurocha/teapot/workflows/Test/badge.svg)](https://github.com/kurocha/teapot/actions?workflow=Test)
+
+## Installation
+
+Ensure that you already have a working install of Ruby 2.0.0+ and run the following to install `teapot`:
+
+    $ gem install teapot
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/teapot/) for more details.
+
+  - [Getting Started](https://ioquatix.github.io/teapot/guides/getting-started/index) - This guide explains how to use `teapot` to manage cross-platform project dependencies and build systems.
+
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/teapot/releases/index) for all releases.
+
+### v3.6.0
+
+  - Update dependencies.
+
+## 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
+
+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.
+
+### 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
+
+## v3.6.0
+
+  - Update dependencies.

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: teapot
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.6.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -37,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-04-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: build
@@ -101,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: build-text
   requirement: !ruby/object:Gem::Requirement
@@ -152,33 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: graphviz
+  name: process-group
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: process-group
+  name: pstore
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -207,70 +206,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-description:
-email:
 executables:
 - teapot
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/teapot
+- context/getting-started.md
+- context/index.yaml
 - lib/teapot.rb
 - lib/teapot/command.rb
 - lib/teapot/command/build.rb
@@ -291,11 +234,16 @@ files:
 - lib/teapot/select.rb
 - lib/teapot/target.rb
 - lib/teapot/version.rb
-homepage: http://www.teapot.nz
+- license.md
+- notes.md
+- readme.md
+- releases.md
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  documentation_uri: https://ioquatix.github.io/teapot/
+  funding_uri: https://github.com/sponsors/ioquatix
+  source_code_uri: https://github.com/ioquatix/teapot
 rdoc_options: []
 require_paths:
 - lib
@@ -303,15 +251,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
-summary: Teapot is a tool for managing complex cross-platform builds.
+summary: Teapot is a tool for managing cross-platform builds.
 test_files: []