teapot 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1ba885e20ffa47e9a547dfff26ae744bab48818
-  data.tar.gz: 58ee0e7fe91f9e1d4a8bc9f2738b6db0157cd31c
+  metadata.gz: b6c26b7fd1bd7b215a6130f89ba2124873edeea0
+  data.tar.gz: c821f7f75b9adf8eaf642358d5972e837f84c031
 SHA512:
-  metadata.gz: b43e0131d630c2ead6a7f227d8d0a032668cd7623fe55fbe41c43446ab75709ab0e594b76230d82931fb9a1b424d694e4c47b48560995c67bd5b74eceffb233e
-  data.tar.gz: 7d33816958b4074785eed639758e44ff2206c9073c4fea310da6d2ab3a147a6f0a8b42eae26be4e92a0804fb4ca7da2b8f589e7ce29193799408195fda547d79
+  metadata.gz: 84f9731a34a8c113b20487dc446cee883884bfdeb3b56739ecd4fc179339cb435a57cdee691193e528f2ebfc6bd8900ea34aae702e6a277f2dda9dab5d0f9083
+  data.tar.gz: f5184593cf742a328d5cf0d8b67350c3dccd4f416a97551202f897595931f94f99196b2d667d392735c98ba575e664083210116f2cf9d37b1a8ea85e7c46ff33

data/.travis.yml

@@ -2,7 +2,8 @@ language: ruby
 sudo: false
 before_install:
   # For testing purposes:
-  - git config --local user.name "Samuel Williams"
+  - git config --global user.name "Samuel Williams"
+  - git config --global user.email "samuel@oriontransfer.net"
 rvm:
   - 2.1.8
   - 2.2.4

data/bin/teapot

@@ -35,47 +35,16 @@ ensure
 	$stderr.puts Rainbow("Elapsed Time: %0.3fs" % elapsed_time).magenta
 end
 
-def parse_argv
-	if split_index = ARGV.index('--')
-		ARGV.shift(split_index).tap{ARGV.shift}
-	else
-		ARGV.slice!(0..-1)
-	end
-end
-
-# Get the arguments up until "--"
-ARGUMENTS = parse_argv
-
-OPTIONS = Trollop::options(ARGUMENTS) do
-	banner Rainbow("Teapot: a decentralised package manager and build tool.").bright.blue
-	version "teapot #{Teapot::VERSION}"
-	
-	opt :configuration, "Specify a specific build configuration.", :type => :string
-	
-	opt :limit, "Limit build to <i> concurrent processes at once where possible", :type => :integer
-	
-	opt :only, "Only compiled direct dependencies."
-	opt :continuous, "Run the build graph continually (experimental).", :type => :boolean, :short => :n
-	
-	opt :in, "Work in the given directory.", :type => :string
-	opt :unlock, "Don't use package lockfile when fetching."
-	
-	opt :force, "Force the operation if it would otherwise be be stopped due to a warning."
-	
-	opt :verbose, "Verbose output and error backtraces.", :type => :boolean
-	
-	opt :version, "Print version and exit", :short => :none
-	opt :help, "Show this message"
-end
+options = Teapot::Command::Top.parse(ARGV)
 
 track_time do
 	begin
-		Teapot::Command.new(ARGUMENTS, OPTIONS).invoke
+		options.invoke
 	rescue Teapot::IncompatibleTeapotError => error
 		$stderr.puts error.message.color(:red)
 		$stderr.puts "Supported minimum version #{Teapot::MINIMUM_LOADER_VERSION.dump} to #{Teapot::LOADER_VERSION.dump}."
 		
-		exit -3
+		exit 1
 	rescue Teapot::Dependency::UnresolvedDependencyError => error
 		$stderr.puts "Unresolved dependencies:"
 
@@ -93,17 +62,13 @@ track_time do
 	
 		$stderr.puts "Cannot continue due to unresolved dependencies!".color(:red)
 		
-		exit -5
+		exit 2
 	rescue StandardError => error
 		$stderr.puts error.message.color(:red)
 		
 		# Could be nice to have some improved error reporting.
-		if OPTIONS[:verbose]
-			$stderr.puts error.backtrace
-		else
-			$stderr.puts "Run with --verbose for more details."
-		end
+		$stderr.puts error.backtrace
 		
-		exit -10
+		exit 3
 	end
 end

data/lib/teapot/command.rb

@@ -29,79 +29,148 @@ require_relative 'controller/visualize'
 
 require_relative 'repository'
 
-require 'trollop'
-require 'pry'
+require 'flopp'
 
 module Teapot
-	# This module implements all top-level teapot commands.
-	class Command
-		def initialize(arguments, options)
-			@action, *@arguments = arguments
-			@options = options
-		end
-		
-		def controller(root = nil)
-			Teapot::Controller.new(root || @options[:in] || Dir.getwd, @options)
+	module Command
+		class Create < Flopp::Command
+			self.description = "Create a new teapot package using the specified repository."
+			
+			one :project_name, "The name of the new project in title-case, e.g. 'My Project'."
+			one :source, "The source repository to use for fetching packages, e.g. https://github.com/kurocha."
+			many :packages, "Any additional packages you'd like to include in the project."
+			
+			def invoke(parent)
+				project_path = parent.root || project_name.gsub(/\s+/, '-').downcase
+				root = ::Build::Files::Path.expand(project_path)
+				
+				if root.exist?
+					raise ArgumentError.new("#{root} already exists!")
+				end
+				
+				# Make the path:
+				root.create
+				
+				Teapot::Repository.new(root).init!
+				
+				parent.controller(root).create(@project_name, @source, @packages)
+			end
 		end
-		
-		def invoke
-			if @action == "invoke"
-				fail "The meaning of life is 42."
+
+		class Generate < Flopp::Command
+			self.description = "Run a generator to create files in your project."
+			
+			options do
+				option '-f/--force', "Force the generator to run even if the current work-tree is dirty."
 			end
 			
-			self.send(@action)
-		end
-		
-		def clean
-			controller.clean
-		end
-		
-		def fetch
-			controller.fetch
+			one :generator_name, "The name of the generator to be invoked."
+			many :arguments, "The arguments that will be passed to the generator."
+			
+			def invoke(parent)
+				generator_name, *arguments = @arguments
+				
+				parent.controller.generate(@generator_name, @arguments, @options[:force])
+			end
 		end
-		
-		def list
-			only = nil
+
+		class Fetch < Flopp::Command
+			self.description = "Fetch remote packages according to the specified configuration."
+			
+			# 3 typical use cases:
+			# - fetch current packages according to lockfile
+			# - write current pacakges into lockfile
+			# - update packages and update lockfile
 			
-			if @arguments.any?
-				only = Set.new(@arguments)
+			options do
+				option '--update', "Update dependencies to the latest versions."
+				option '--local', "Don't update from source, assume updated local packages."
 			end
 			
-			controller.list(only)
+			def invoke(parent)
+				parent.controller.fetch(**@options)
+			end
 		end
-		
-		def generate
-			generator_name, *arguments = @arguments
+
+		class List < Flopp::Command
+			self.description = "List provisions and dependencies of the specified package."
 			
-			controller.generate(generator_name, arguments, @options[:force])
+			many :packages, "Limit the listing to only these packages, or all packages if none specified."
+			
+			def invoke(parent)
+				if @packages.any?
+					only = Set.new(@packages)
+				end
+				
+				parent.controller.list(only)
+			end
 		end
-		
-		def build
-			controller.build(@arguments)
+
+		class Build < Flopp::Command
+			self.description = "Build the specified target."
+			
+			options do
+				option '-j/-l/--limit <n>', "Limit the build to <n> concurrent processes."
+				option '--only', "Only compile direct dependencies."
+				option '-c/--continuous', "Run the build graph continually (experimental)."
+			end
+			
+			many :targets, "Build these targets, or use them to help the dependency resolution process."
+			split :argv, "Arguments passed to child process(es) of build if any."
+			
+			def invoke(parent)
+				# TODO: This is a bit of a hack, figure out a way to pass it directly through to build subsystem.
+				ARGV.replace(@argv) if @argv
+				
+				parent.controller.build(@targets)
+			end
 		end
-		
-		alias brew build
-		
-		def visualize
-			controller.visualize(@arguments)
+
+		class Clean < Flopp::Command
+			self.description = "Delete everything in the teapot directory."
+			
+			def invoke(parent)
+				parent.controller.clean
+			end
 		end
 		
-		def create
-			project_name, source, *packages = @arguments
-			project_path = @options[:in] || project_name.gsub(/\s+/, '-').downcase
-			
-			root = Build::Files::Path.expand(project_path)
+		class Top < Flopp::Command
+			self.description = "A decentralised package manager and build tool."
+			#version "1.0.0"
 			
-			if root.exist?
-				abort "#{root} already exists!".color(:red)
+			options do
+				option '-c/--configuration <name>', "Specify a specific build configuration.", default: ENV['TEAPOT_CONFIGURATION']
+				option '-i/--in/--root <path>', "Work in the given root directory."
+				option '--verbose | --quiet', "Verbosity of output for debugging.", key: :logging
+				option '-h/--help', "Print out help information."
+				option '-v/--version', "Print out the application version."
 			end
 			
-			# Make the path:
-			root.create
+			nested '<command>',
+				'create' => Create,
+				'generate' => Generate,
+				'fetch' => Fetch,
+				'list' => List,
+				'build' => Build,
+				'clean' => Clean
 			
-			Teapot::Repository.new(root).init!
+			def root
+				@options[:root] || Dir.getwd
+			end
+			
+			def controller(root = nil, **options)
+				Teapot::Controller.new(root || self.root, @options)
+			end
 			
-			controller(root).create(project_name, source, packages)
+			def invoke(program_name: File.basename($0))
+				if @command.nil? or @options[:help]
+					print_usage(program_name)
+				elsif @options[:version]
+					puts "teapot v#{Teapot::VERSION}"
+				else
+					@command.invoke(self)
+				end
+			end
 		end
 	end
-end
+end

data/lib/teapot/context.rb

@@ -195,12 +195,16 @@ module Teapot
 			# Find the default configuration, if it exists:
 			@default_configuration = defined.default_configuration
 
-			if options[:configuration]
-				@configuration = @configurations[options[:configuration]]
+			if configuration_name = options[:configuration]
+				@configuration = @configurations[configuration_name]
 			else
 				@configuration = @default_configuration
 			end
-
+			
+			if @configuration.nil?
+				raise ArgumentError.new("Could not load configuration: #{configuration_name}")
+			end
+			
 			# Materialize the configuration:
 			@configuration.materialize if @configuration
 		end

data/lib/teapot/controller.rb

@@ -30,37 +30,46 @@ require 'build/logger'
 
 module Teapot
 	class Controller
-		MAXIMUM_FETCH_DEPTH = 20
-		
 		def initialize(root, options)
 			@root = Pathname(root)
 			@options = options
 			
-			log_output = @options.fetch(:log, $stdout)
-			
-			@logger = Logger.new(log_output)
-			
-			@logger.formatter = Build::CompactFormatter.new(verbose: options[:verbose])
-			
-			if options[:verbose]
-				@logger.level = Logger::DEBUG
-			else
-				@logger.level = Logger::INFO
-			end
-			
-			@options[:maximum_fetch_depth] ||= MAXIMUM_FETCH_DEPTH
+			@log_output = @options.fetch(:log, $stdout)
+			@logging = @options[:logging] 
+		end
+		
+		def verbose?
+			@logging == :verbose
 		end
 		
-		attr :logger
+		def quiet?
+			@logging == :quiet
+		end
+		
+		def logger
+			@logger ||= Logger.new(@log_output).tap do |logger|
+				logger.formatter = Build::CompactFormatter.new(verbose: verbose?)
+				
+				if verbose?
+					logger.level = Logger::DEBUG
+				elsif quiet?
+					logger.level = Logger::WARN
+				else
+					logger.level = Logger::INFO
+				end
+			end
+		end
 		
 		def log(*args)
-			@logger.info(*args)
+			logger.info(*args)
+		end
+		
+		def configuration
+			@options[:configuration]
 		end
 		
 		def context
-			@context ||= Context.new(@root,
-				:configuration => @options[:configuration]
-			)
+			@context ||= Context.new(@root, configuration: configuration)
 		end
 		
 		# Reload the current context, e.g. if it's been modified by a generator.

data/lib/teapot/controller/fetch.rb

@@ -23,17 +23,16 @@ require_relative '../repository'
 
 module Teapot
 	class Controller
-		def fetch
+		def fetch(**options)
 			resolved = Set.new
 			configuration = context.configuration
 			unresolved = context.unresolved(configuration.packages)
-			tries = 0
 			
-			while tries < @options[:maximum_fetch_depth]
+			while true
 				configuration.packages.each do |package|
 					next if resolved.include? package
 				
-					fetch_package(context, configuration, package)
+					fetch_package(context, configuration, package, **options)
 				
 					# We are done with this package, don't try to process it again:
 					resolved << package
@@ -49,8 +48,6 @@ module Teapot
 				if previously_unresolved == unresolved || unresolved.count == 0
 					break
 				end
-			
-				tries += 1
 			end
 		
 			if unresolved.count > 0
@@ -66,77 +63,108 @@ module Teapot
 		private
 
 		def current_commit(package)
-			IO.popen(['git', '--git-dir', (package.path + ".git").to_s, 'rev-parse', '--verify', 'HEAD']) do |io|
+			IO.popen(['git', '--git-dir', (package.path + '.git').to_s, 'rev-parse', '--verify', 'HEAD']) do |io|
 				io.read.chomp!
 			end
 		end
-
-		def fetch_package(context, configuration, package)
-			destination_path = package.path
-			lock_store = configuration.lock_store
 		
-			if package.local?
-				log "Linking local #{package}...".color(:cyan)
+		def current_branch(package)
+			IO.popen(['git', '--git-dir', (package.path + '.git').to_s, 'rev-parse', '--abbrev-ref', 'HEAD']) do |io|
+				io.read.chomp!
+			end		
+		end
 		
-				local_path = context.root + package.options[:local]
-	
-				# Make the top level directory if required:
-				destination_path.dirname.create
+		def current_metadata(package)
+			{
+				branch: current_branch(package),
+				commit: current_commit(package)
+			}
+		end
+		
+		def link_local_package(context, configuration, package)
+			log "Linking local #{package}...".color(:cyan)
 	
-				unless destination_path.exist?
-					destination_path.make_symlink(local_path)
-				end
-			elsif package.external?
-				package_lock = nil
-				
-				unless @options[:unlock]
-					package_lock = lock_store.transaction(true){|store| store[package.name]}
-				end
+			local_path = context.root + package.options[:local]
 
-				log "Fetching #{package}...".color(:cyan)
+			# Where we are going to put the package:
+			destination_path = package.path
 
-				base_uri = URI(package.options[:source].to_s)
+			# Make the top level directory if required:
+			destination_path.dirname.create
 
-				if base_uri.scheme == nil || base_uri.scheme == 'file'
-					base_uri = URI "file://" + File.expand_path(base_uri.path, context.root) + "/"
-				end
+			unless destination_path.exist?
+				destination_path.make_symlink(local_path)
+			end
+		end
 
-				branch = package.options.fetch(:version, 'master')
+		def clone_or_pull_package(context, configuration, package, package_lock)
+			log "Fetching #{package}...".color(:cyan)
 
-				if package_lock
-					log "Package locked to commit: #{package_lock[:branch]}/#{package_lock[:commit]}"
+			# Where we are going to put the package:
+			destination_path = package.path
 
-					branch = package_lock[:branch]
-				end
+			base_uri = URI(package.options[:source].to_s)
 
-				commit = package_lock ? package_lock[:commit] : nil
+			if base_uri.scheme == nil || base_uri.scheme == 'file'
+				base_uri = URI "file://" + File.expand_path(base_uri.path, context.root) + "/"
+			end
 
-				unless destination_path.exist?
-					log "Cloning package at path #{destination_path} ...".color(:cyan)
-			
-					begin
-						external_url = package.external_url(context.root)
+			branch = package.options.fetch(:branch, 'master')
 
-						Repository.new(destination_path).clone!(external_url, branch, commit)
-					rescue
-						log "Failed to clone #{external_url}...".color(:red)
+			if package_lock
+				log "Package locked to commit: #{package_lock[:branch]}/#{package_lock[:commit]}"
 
-						raise
-					end
-				else
-					log "Updating package at path #{destination_path} ...".color(:cyan)
+				branch = package_lock[:branch]
+			end
+
+			commit = package_lock ? package_lock[:commit] : nil
+
+			unless destination_path.exist?
+				log "Cloning package at path #{destination_path} ...".color(:cyan)
+		
+				begin
+					external_url = package.external_url(context.root)
+
+					Repository.new(destination_path).clone!(external_url, branch, commit)
+				rescue
+					log "Failed to clone #{external_url}...".color(:red)
+
+					raise
+				end
+			else
+				log "Updating package at path #{destination_path} ...".color(:cyan)
 
-					commit = package_lock ? package_lock[:commit] : nil
-					Repository.new(destination_path).update(branch, commit)
+				commit = package_lock ? package_lock[:commit] : nil
+				Repository.new(destination_path).update(branch, commit)
+			end
+		end
+
+		def fetch_package(context, configuration, package, update: false, local: false)
+			if package.local?
+				link_local_package(context, configuration, package)
+			elsif package.external?
+				lock_store = configuration.lock_store
+				
+				# If we are updating, don't bother reading the current branch/commit details.
+				unless update
+					package_lock = lock_store.transaction(true){|store| store[package.name]}
+				end
+				
+				unless local
+					clone_or_pull_package(context, configuration, package, package_lock)
 				end
 				
 				# Lock the package, unless it was already locked:
 				unless package_lock
+					metadata = current_metadata(package)
+					
 					lock_store.transaction do |store|
-						store[package.name] = {
-							:branch => branch,
-							:commit => current_commit(package)
-						}
+						store_metadata = store[package.name]
+						
+						if store_metadata.nil? or store_metadata[:commit] != metadata[:commit]
+							log("Updating lockfile for package #{package.name}: #{metadata[:commit]}...")
+							store[package.name] = metadata
+						end
 					end
 				end
 			end

data/lib/teapot/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Teapot
-	VERSION = "1.1.2"
+	VERSION = "1.2.0"
 end

data/spec/teapot/command_spec.rb

@@ -0,0 +1,41 @@
+# Copyright, 2016, 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 'teapot/command'
+
+module Teapot::CommandSpec
+	ROOT = Build::Files::Path.new(__dir__) + "command_spec"
+	PROJECT_PATH = ROOT + 'test-project'
+	
+	describe Teapot::Command::Top.parse(["--in", PROJECT_PATH.to_s, "create", "test-project", "https://github.com/kurocha", "project"]) do
+		before do
+			ROOT.mkpath
+		end
+		
+		after do
+			PROJECT_PATH.delete
+		end
+		
+		it "should create a new project" do
+			expect{subject.invoke}.to_not raise_error
+			expect(PROJECT_PATH + "teapot.rb").to be_exist
+		end
+	end
+end

data/teapot.gemspec

@@ -28,9 +28,7 @@ Gem::Specification.new do |spec|
 	
 	spec.required_ruby_version = '>= 2.1'
 	
-	spec.add_dependency "rainbow", "~> 2.0.0"
-	spec.add_dependency "trollop", "~> 2.1"
-	
+	spec.add_dependency "rainbow", "~> 2.0"
 	spec.add_dependency "system", "~> 0.1.3"
 	
 	spec.add_dependency "graphviz", "~> 0.3.0"
@@ -38,6 +36,8 @@ Gem::Specification.new do |spec|
 	spec.add_dependency "build", "~> 1.0.7"
 	spec.add_dependency "build-files", "~> 1.0.4"
 	
+	spec.add_dependency "flopp", "~> 1.0.1"
+	
 	# This could be a good option in the future for teapot fetch:
 	#spec.add_dependency "rugged"
 	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teapot
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: system
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: flopp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,7 @@ files:
 - materials/kurocha.svg
 - materials/teapot.png
 - materials/teapot.svg
+- spec/teapot/command_spec.rb
 - spec/teapot/context_spec.rb
 - spec/teapot/context_spec/teapot.rb
 - spec/teapot/dependency_spec.rb
@@ -225,6 +226,7 @@ signing_key:
 specification_version: 4
 summary: Teapot is a tool for managing complex cross-platform builds.
 test_files:
+- spec/teapot/command_spec.rb
 - spec/teapot/context_spec.rb
 - spec/teapot/context_spec/teapot.rb
 - spec/teapot/dependency_spec.rb