teapot 3.5.3 → 3.6.0

data/lib/teapot/select.rb

@@ -1,39 +1,24 @@
-# 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_relative 'loader'
-require_relative 'package'
+# Released under the MIT License.
+# Copyright, 2019-2026, by Samuel Williams.
 
-require 'build/rulebook'
-require 'build/text/substitutions'
-require 'build/text/merge'
+require_relative "loader"
+require_relative "package"
+
+require "build/rulebook"
+require "build/text/substitutions"
+require "build/text/merge"
 
 module Teapot
 	class AlreadyDefinedError < StandardError
 		def initialize(definition, previous)
 			super "Definition #{definition.name} in #{definition.path} has already been defined in #{previous.path}!"
 		end
-
+		
 		def self.check(definition, definitions)
 			previous = definitions[definition.name]
-
+			
 			raise self.new(definition, previous) if previous
 		end
 	end

data/lib/teapot/target.rb

@@ -1,29 +1,14 @@
-# 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
 	class BuildError < StandardError

data/lib/teapot/version.rb

@@ -1,23 +1,8 @@
-# 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.
 
 module Teapot
-	VERSION = "3.5.3"
+	VERSION = "3.6.0"
 end

data/lib/teapot.rb

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

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,178 @@
+# ![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](http://www.teapot.nz) for more details.
+
+### Create Project
+
+Firstly, create your project by running:
+
+    $ teapot create "My Project" https://github.com/kurocha generate-project
+    $ cd my-project
+
+You will be asked to merge the project file. At present, merge tools are not very good and thus you may need to take a moment to review the changes. You want to keep most of the original file, but you would like to add the `define_target` blocks which are being added.
+
+In the resulting project directory that has been created, you can see the list of dependencies:
+
+    $ teapot list
+    ... lots of output ...
+
+To only see things exported by your current project, you can run:
+
+    $ teapot list root
+    Package root (from /private/tmp/my-project):
+    	#<Teapot::Project "my-project">
+    		My Project description.
+    		- Summary: A brief one line summary of the project.
+    		- License: MIT License
+    		- Version: 0.1.0
+    		- Author: Samuel Williams <samuel.williams@oriontransfer.co.nz>
+    	#<Teapot::Target "my-project-library">
+    		- depends on "Build/Files"
+    		- depends on "Build/Clang"
+    		- depends on :platform
+    		- depends on "Language/C++14" {:private=>true}
+    		- provides "Library/MyProject"
+    	#<Teapot::Target "my-project-test">
+    		- depends on "Library/UnitTest"
+    		- depends on "Library/MyProject"
+    		- provides "Test/MyProject"
+    	#<Teapot::Target "my-project-executable">
+    		- depends on "Build/Files"
+    		- depends on "Build/Clang"
+    		- depends on :platform
+    		- depends on "Language/C++14" {:private=>true}
+    		- depends on "Library/MyProject"
+    		- provides "Executable/MyProject"
+    	#<Teapot::Target "my-project-run">
+    		- depends on "Executable/MyProject"
+    		- provides "Run/MyProject"
+    	#<Teapot::Configuration "development" visibility=private>
+    		- references root from /private/tmp/my-project
+    		- clones platforms from https://github.com/kurocha/platforms
+    		- clones unit-test from https://github.com/kurocha/unit-test
+    		- clones generate-cpp-class from https://github.com/kurocha/generate-cpp-class
+    		- clones generate-project from https://github.com/kurocha/generate-project
+    		- clones variants from https://github.com/kurocha/variants
+    		- clones platform-darwin-osx from https://github.com/kurocha/platform-darwin-osx
+    		- clones platform-darwin-ios from https://github.com/kurocha/platform-darwin-ios
+    		- clones build-clang from https://github.com/kurocha/build-clang
+    		- clones build-darwin from https://github.com/kurocha/build-darwin
+    		- clones build-files from https://github.com/kurocha/build-files
+    		- clones streams from https://github.com/kurocha/streams
+    		- clones generate-template from https://github.com/kurocha/generate-template
+    	#<Teapot::Configuration "my-project" visibility=public>
+    		- references root from /private/tmp/my-project
+
+### Run Tests
+
+Testing is a good idea, and teapot supports test driven development.
+
+    $ teapot Test/MyProject
+
+#### Wildcard Targets
+
+To run all tests:
+
+    $ teapot "Test/*"
+
+Provided you are using an environment that supports sanitizers, you can test more thoroughly using:
+
+    $ teapot "Test/*" variant-sanitize
+
+### Run Project
+
+We can now build and run the project executable:
+
+    $ teapot Run/MyProject
+    I'm a little teapot,
+    Short and stout,
+    Here is my handle (one hand on hip),
+    Here is my spout (other arm out with elbow and wrist bent).
+    When I get all steamed up,
+    Hear me shout,
+    Tip me over and pour me out! (lean over toward spout)
+    
+                                  ~
+                       ___^___   __
+                   .- /       \./ /
+                  /  /          _/
+                  \__|         |
+                      \_______/
+
+The resulting executables and libraries will be framework dependent, but are typically located in:
+
+    $ cd teapot/platforms/development/$PLATFORM-debug/bin
+    $ ./$PROJECT_NAME
+
+### Cloning Project
+
+You can clone another project which will fetch all dependencies:
+
+    $ teapot clone https://github.com/kurocha/tagged-format
+    $ cd tagged-format
+    $ teapot build Executable/TaggedFormat
+
+## Open Issues
+
+  - Should packages be built into a shared prefix or should they be built into unique prefixes and joined together either via install or `-L` and `-I`?
+      - Relative include paths might fail to work correctly if headers are not installed into same directory.
+  - Should packages have some way to expose system requirements, e.g. installed compiler, libraries, etc. Perhaps some kind of `Package#valid?` which allows custom logic?
+
+## Releases
+
+Please see the [project releases](http://www.teapot.nzreleases/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.3
+  version: 3.6.0
 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
@@ -180,55 +179,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rugged
-  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'
-- !ruby/object:Gem::Dependency
-  name: samovar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: pstore
   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
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -236,35 +193,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rugged
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: samovar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
-description:
-email:
+        version: '2.0'
 executables:
 - teapot
 extensions: []
@@ -291,11 +246,14 @@ files:
 - lib/teapot/select.rb
 - lib/teapot/target.rb
 - lib/teapot/version.rb
+- license.md
+- notes.md
+- readme.md
+- releases.md
 homepage: http://www.teapot.nz
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,15 +261,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.
 test_files: []