rub 0.4.0

data/lib/rub/r/env.rb

@@ -0,0 +1,71 @@
+# Copyright 2013 Kevin Cox
+
+################################################################################
+#                                                                              #
+#  This software is provided 'as-is', without any express or implied           #
+#  warranty. In no event will the authors be held liable for any damages       #
+#  arising from the use of this software.                                      #
+#                                                                              #
+#  Permission is granted to anyone to use this software for any purpose,       #
+#  including commercial applications, and to alter it and redistribute it      #
+#  freely, subject to the following restrictions:                              #
+#                                                                              #
+#  1. The origin of this software must not be misrepresented; you must not     #
+#     claim that you wrote the original software. If you use this software in  #
+#     a product, an acknowledgment in the product documentation would be       #
+#     appreciated but is not required.                                         #
+#                                                                              #
+#  2. Altered source versions must be plainly marked as such, and must not be  #
+#     misrepresented as being the original software.                           #
+#                                                                              #
+#  3. This notice may not be removed or altered from any source distribution.  #
+#                                                                              #
+################################################################################
+
+require 'pathname'
+
+# Environment Information
+module R::Env
+	# @!attribute [r] self.cmd_dir
+	#   @return [Pathname] The directory from which rub was executed.
+	cattr_accessor :cmd_dir
+		
+	# @!attribute [r] self.global_cache
+	#   @return [Pathname] The global cache directory.
+	cattr_reader :global_cache
+	
+	@cmd_dir = Pathname.pwd
+	
+	# @private
+	def self.find_src_dir
+		d = @cmd_dir
+		while not (d+'root.rub').exist?
+			d = d.parent
+			
+			if d.root?
+				$stderr.puts('root.rub not found.  Make sure you are in the source directory.')
+				Sysexits.exit :usage
+			end
+		end
+		
+		d.parent + (d.basename.to_s+'/') # Ensure this ends in a '/'
+	end
+	private_class_method :find_src_dir
+
+	# @return [Pathname] The directory from which rub was executed.
+	def self.src_dir
+		@src_dir ||= find_src_dir
+	end
+	
+	# @return [Pathname] The build output directory.
+	def self.out_dir
+		@out_dir ||= src_dir + 'build/'
+	end
+	
+	@global_cache = XDG[:cache_home].to_path + 'rub/'
+	
+	# @return [Pathname] The project cache directory.
+	def self.project_cache
+		out_dir + "cache/"
+	end
+end

data/lib/rub/r/i/commandline.rb

@@ -0,0 +1,192 @@
+# Copyright 2013 Kevin Cox
+
+################################################################################
+#                                                                              #
+#  This software is provided 'as-is', without any express or implied           #
+#  warranty. In no event will the authors be held liable for any damages       #
+#  arising from the use of this software.                                      #
+#                                                                              #
+#  Permission is granted to anyone to use this software for any purpose,       #
+#  including commercial applications, and to alter it and redistribute it      #
+#  freely, subject to the following restrictions:                              #
+#                                                                              #
+#  1. The origin of this software must not be misrepresented; you must not     #
+#     claim that you wrote the original software. If you use this software in  #
+#     a product, an acknowledgment in the product documentation would be       #
+#     appreciated but is not required.                                         #
+#                                                                              #
+#  2. Altered source versions must be plainly marked as such, and must not be  #
+#     misrepresented as being the original software.                           #
+#                                                                              #
+#  3. This notice may not be removed or altered from any source distribution.  #
+#                                                                              #
+################################################################################
+
+require 'getoptlong'
+
+# Command line parsing and handling.
+module R::I::CommandLine
+	help = lambda do
+				puts <<EOS
+#{R::Version.info_string}
+
+Usage: #{$0} [options] [target...]
+
+Targets:
+Specify the targets to build.  If none are specified ':all' is assumed.
+
+Options:
+-o --out <dir>
+  Sets the Rub build directory.  This defaults to 'build/'.  This is
+  merely a scratch location and none of the files in this directory should
+  be used outside of Rub.  You may want to put this on fast storage (maybe
+  in RAM) to speed up complex builds.
+-D, --define <key>[=<value>]
+  Define a configuration option.  The key is everything up to the first
+  '=' and the value is everything after.  If the character before the '=' is '+'
+  or '^' it is treated as a '-A' or '-P' respectivly.  If there is no '=' it
+  is treated as a flag and it is set.  Latter '-D' options overwrite earlier
+  ones.
+-D, --define <key>+=<value>
+-A, --append <key>[+=<value>]
+-A, --append <key>[=<value>]
+  Append a configuration option to a list.  If the current value is not
+  a list it is overwritten.  The key and value specification is the same
+  as for '-D' except that a '+' is not nessary and is assumed.
+-D, --define  <key>^=<value>
+-P, --prepend <key>[^=<value>]
+-P, --prepend <key>[=<value>]
+  Prepend a configuration option to a list.  If the current value is not
+  a list it is overwritten.  The key and value specification is the same
+  as for '-D' except that a '^' is not nessary and is assumed.
+-S, --script <script>
+  Run a script.  This script should only set define options as all of Rub
+  may not be initilized yet.  The script is executed in order with other
+  '--script', '-D' and '-P' options.
+--explicit-scripts
+  Only run scripts specified on the command line.  This prevents system
+  and user defaults from being used.  Use with caution because it could
+  cause a build to fail if the provided definitions don't contain enough
+  information.
+--no-cache
+  Disable caching.  All state from previous runs will be discarded.  Caching
+  will still be performed inside a single run.
+--doc
+  Generate documentation of installed libraries.  All additional parameters will
+  be passed to yardoc.
+-V, --version
+  Print the version and exit.
+--version-number
+  Print just the version number.
+--version-describe
+  Print a short description of the version you are running.
+--version-verbose
+  Print lots of information about the code you are running.
+--version-version-commit
+  Print the version, and if not a release commit, the current commit.
+-h, --help
+  Print this help text and exit.
+EOS
+		exit
+	end
+	
+	class << self
+		attr_reader :cache
+	end
+	@cache = true
+
+	opts = GetoptLong.new(
+		['--out',    '-o',                      GetoptLong::REQUIRED_ARGUMENT ],
+		['-D', '--define',                      GetoptLong::REQUIRED_ARGUMENT ],
+		['-A', '--append',                      GetoptLong::REQUIRED_ARGUMENT ],
+		['-P', '--prepend',                     GetoptLong::REQUIRED_ARGUMENT ],
+		['-S', '--script',                      GetoptLong::REQUIRED_ARGUMENT ],
+		['--explicit-scripts',                  GetoptLong::NO_ARGUMENT       ],
+		['--no-cache',                          GetoptLong::NO_ARGUMENT       ],
+		['--doc',                               GetoptLong::NO_ARGUMENT       ],
+		['--help',    '-h',                     GetoptLong::NO_ARGUMENT       ],
+		['--version', '-V', '-v',               GetoptLong::NO_ARGUMENT       ],
+		['--version-number',                    GetoptLong::NO_ARGUMENT       ],
+		['--version-describe',                  GetoptLong::NO_ARGUMENT       ],
+		['--version-verbose',                   GetoptLong::NO_ARGUMENT       ],
+		['--version-version-commit',            GetoptLong::NO_ARGUMENT       ],
+	)
+	
+	scripts = [];
+	sysscripts = XDG[:config].paths.map do |d|
+		[:file, d+'rub/config.rub']
+	end.keep_if { |t, n| n.exist? }
+	
+	opts.each do |opt, arg|
+		case opt
+			when '--out'
+				Rub::Env.out_dir = Rub::Env.cmd_dir + arg
+			when '-D'
+				scripts.push [:define,  arg]
+			when '-A'
+				scripts.push [:append,  arg]
+			when '-P'
+				scripts.push [:prepend, arg]
+			when '-S'
+				scripts.push [:file,   Pathname(arg)]
+			when '--explicit-scripts'
+				sysscripts = []
+			when '--no-cache'
+				@cache = false
+			when '--doc'
+				lib    = Pathname.new(__FILE__).realpath.parent.parent.parent.parent
+				base   = lib.parent
+				
+				source = lib+'**/*.rb'
+				readme = [
+					base+'share/doc/'+R::Version.slug+'README.md', # Installed path.
+					base+'README.md'            # Dev path.
+				].find{|r| r.exist? }
+				pp readme
+				
+				exec(
+					'yardoc',
+					'--default-return', 'void',
+					*ARGV,
+					'-r', readme.to_s,
+					source.to_s
+				)
+			when '--help'
+				help.call
+			when '--version'
+				puts R::Version.info_string
+				exit 0
+			when '--version-number'
+				puts R::Version.number_string
+				exit 0
+			when '--version-describe'
+				puts R::Version.string
+				exit 0
+			when '--version-verbose'
+				puts R::Version.verbose
+				exit 0
+			when '--version-version-commit'
+				puts R::Version.version_commit
+				exit 0
+		end
+	end
+	
+	sysscripts.concat(scripts).each do | t, a |
+		case t
+			when :file
+				if not a.exist?
+					$stderr.puts "Can't load defines from \"#{a}\" because it doesn't exist!"
+					Sysexits.exit :noinput
+				end
+			
+				load a
+			when :define
+				D.define(a)
+			when :append
+				D.append(a)
+			when :prepend
+				D.prepend(a)
+		end
+	end
+end
+

data/lib/rub/r/i/runner.rb

@@ -0,0 +1,78 @@
+# Copyright 2013 Kevin Cox
+
+################################################################################
+#                                                                              #
+#  This software is provided 'as-is', without any express or implied           #
+#  warranty. In no event will the authors be held liable for any damages       #
+#  arising from the use of this software.                                      #
+#                                                                              #
+#  Permission is granted to anyone to use this software for any purpose,       #
+#  including commercial applications, and to alter it and redistribute it      #
+#  freely, subject to the following restrictions:                              #
+#                                                                              #
+#  1. The origin of this software must not be misrepresented; you must not     #
+#     claim that you wrote the original software. If you use this software in  #
+#     a product, an acknowledgment in the product documentation would be       #
+#     appreciated but is not required.                                         #
+#                                                                              #
+#  2. Altered source versions must be plainly marked as such, and must not be  #
+#     misrepresented as being the original software.                           #
+#                                                                              #
+#  3. This notice may not be removed or altered from any source distribution.  #
+#                                                                              #
+################################################################################
+
+# Functions for running build scripts.
+module R::I::Runner
+	@@loaded = {}
+
+	# Execute a file.
+	#
+	# Runs a script if it hasn't been run already.
+	#
+	# @param f [Pathname] The file to run.
+	# @return [void]
+	def self.do_file(f)
+		if @@loaded[f]
+			return
+		end
+	
+		if not f.exist?
+			$stderr.puts "\"#{f}\" is not readable!"
+			Sysexits.exit :noinput
+		end
+		
+		@@loaded[f] = true
+		
+		Dir.chdir f.dirname do
+			load f.to_s
+		end
+	end
+end
+
+module C
+	# Add a directory to the build.
+	#
+	# This will run the "dir.rub" file in that directory synchronously.  Any
+	# values that that directory defines will be available when this call
+	# returns.
+	#
+	# This function only runs scripts once, if the script has already run this
+	# function will return success without running the script, and as the script
+	# has already been run the exported values should be available.
+	def self.add_dir(dir)
+		dir = C.path(dir)
+		
+		if not dir.directory?
+			raise "\"#{dir}\" is not a directory!"
+		end
+		
+		dir += 'dir.rub'
+		if not dir.exist?
+			raise "\"#{dir}\" does not exist!"
+		end
+		dir = dir.realpath
+		
+		R::I::Runner.do_file(dir)
+	end
+end

data/lib/rub/r/persist.rb

@@ -0,0 +1,71 @@
+# Copyright 2013 Kevin Cox
+
+################################################################################
+#                                                                              #
+#  This software is provided 'as-is', without any express or implied           #
+#  warranty. In no event will the authors be held liable for any damages       #
+#  arising from the use of this software.                                      #
+#                                                                              #
+#  Permission is granted to anyone to use this software for any purpose,       #
+#  including commercial applications, and to alter it and redistribute it      #
+#  freely, subject to the following restrictions:                              #
+#                                                                              #
+#  1. The origin of this software must not be misrepresented; you must not     #
+#     claim that you wrote the original software. If you use this software in  #
+#     a product, an acknowledgment in the product documentation would be       #
+#     appreciated but is not required.                                         #
+#                                                                              #
+#  2. Altered source versions must be plainly marked as such, and must not be  #
+#     misrepresented as being the original software.                           #
+#                                                                              #
+#  3. This notice may not be removed or altered from any source distribution.  #
+#                                                                              #
+################################################################################
+
+module R
+	# @!attribute [r] self.ppersistant
+	#   @return [Hash] The project cache.
+	cattr_reader :ppersistant
+	
+	# @!attribute [r] self.spersistant
+	#   @return [Hash] The system cache.
+	cattr_reader :spersistant
+	
+	ppersistfile = R::Env.project_cache + "persistant.marshal"
+	if ppersistfile.exist? && R::I::CommandLine.cache
+		@ppersistant = Marshal.load(File.new(ppersistfile, 'r').read)
+	else
+		@ppersistant = {}
+	end
+	
+	END {
+		File.new(ppersistfile, 'w').write(Marshal.dump(@ppersistant))
+	}
+	
+	spersistfile = R::Env.global_cache + "persistant.marshal"
+	if spersistfile.exist? && R::I::CommandLine.cache
+		@spersistant = Marshal.load(spersistfile.read)
+	else
+		@spersistant = {}
+	end
+	
+	END {
+		spersistfile.open('w').write(Marshal.dump(@spersistant))
+	}
+	
+	# Clear the system cache.
+	def self.clear_system_cache
+		@spersistant.clear
+	end
+	# Clear the project cache.
+	def self.clear_project_cache
+		@ppersistant.clear
+	end
+	# Clear all caches.
+	def self.clear_cache
+		clear_system_cache
+		clear_project_cache
+	end
+end
+
+

data/lib/rub/r/target.rb

@@ -0,0 +1,250 @@
+# Copyright 2013 Kevin Cox
+
+################################################################################
+#                                                                              #
+#  This software is provided 'as-is', without any express or implied           #
+#  warranty. In no event will the authors be held liable for any damages       #
+#  arising from the use of this software.                                      #
+#                                                                              #
+#  Permission is granted to anyone to use this software for any purpose,       #
+#  including commercial applications, and to alter it and redistribute it      #
+#  freely, subject to the following restrictions:                              #
+#                                                                              #
+#  1. The origin of this software must not be misrepresented; you must not     #
+#     claim that you wrote the original software. If you use this software in  #
+#     a product, an acknowledgment in the product documentation would be       #
+#     appreciated but is not required.                                         #
+#                                                                              #
+#  2. Altered source versions must be plainly marked as such, and must not be  #
+#     misrepresented as being the original software.                           #
+#                                                                              #
+#  3. This notice may not be removed or altered from any source distribution.  #
+#                                                                              #
+################################################################################
+
+module R
+	# All targets.
+	#
+	# This should only be used for debugging.  Use {find_target}, {get_target}
+	# and {set_target} instead.
+	#
+	# @return [Hash{Pathname,Symbol=>Target}]
+	cattr_reader :targets
+	
+	@targets = {}
+	@sources = {}
+	
+	# Find a target.
+	#
+	# Returns a target for +path+ or nil.
+	#
+	# @param path [Pathname,String] The path of the target.
+	# @return [Target,nil] The target.
+	def self.find_target(path)
+		path = C.path(path)
+		@targets[path] || @sources[path]
+	end
+	
+	# Get a target.
+	#
+	# This function get's an existing target if it exists or returns a new
+	# source target if there is no existing target to build it.
+	#
+	# @param path [Pathname,String] The path of the target.
+	# @return [Target,TargetSource]
+	def self.get_target(path)
+		path = C.path(path)
+		
+		find_target(path) or @sources[path] ||= TargetSource.new(path)
+	end
+	
+	# Set a target to a path.
+	#
+	# This function registers +target+ as a way to build +path+.
+	#
+	# @param path [Pathname,String] The path that is build by the target.
+	# @param target [Target] The target that builds +path+.
+	# @return [void]
+	#
+	# @see Target#register.
+	def self.set_target(path, target)
+		if find_target(path)
+			$stderr.puts "Warning: #{path} can be built two ways."
+		end
+		@targets[C.path(path)] = target
+	end
+	
+	# The base target class.
+	#
+	# It has simple building logic and a way to register targets.  All
+	# targets should inherit from this class.
+	class Target
+		# Inputs
+		#
+		# @return [Set<Pathname>] The inputs this target depends on.
+		def input
+			Set.new
+		end
+		
+		# Outputs
+		#
+		# @return [Set<Pathname>] The outputs this target creates.
+		def output
+			Set.new
+		end
+		
+		# Description.
+		#
+		# Shown for :help.
+		# @return [String,nil]
+		def description
+			nil
+		end
+		
+		# Register this target.
+		#
+		# Registers this target as building it's {#output}s.
+		#
+		# @return [void]
+		def register
+			output.each do |d|
+				R.set_target(d, self)
+			end
+		end
+		
+		# Is this target up to date?
+		def clean?
+			false
+		end
+		
+		# Return a hash of this target.
+		#
+		# This hash should represent a unique build environment and change if
+		# anything in that environment does.  This includes, but is not limited
+		# to:
+		# - Input files.
+		# - Output files.
+		# - Build commands.
+		#
+		# @return [String] the hash.
+		def hash_input
+			Digest::SHA1.digest(
+				(
+					input.map{|i| R::get_target(i).hash_output(i) }
+				).join
+			)
+		end
+		
+		@@symbolcounter = rand(2**160) # Shouldn't repeat very often.
+		def hash_output(t)
+			if t.is_a? Symbol
+				@@symbolcounter++
+				"symbol-#{@@symbolcounter.to_s(16)}" # Never clean.
+			else
+				Digest::SHA1.file(t).to_s
+			end
+		end
+		
+		def hash_outputs(t = output)
+			Digest::SHA1.digest(t.map{|o| hash_output(o)}.join)
+		end
+		
+		def hash_self
+			Digest::SHA1.digest(hash_input+hash_outputs)
+		end
+		
+		# Build the inputs.
+		def build_dependancies
+			input.each{|i| R::get_target(i).build }
+		end
+		private :build_dependancies
+		
+		# Build this target.
+		#
+		# This should be overridden if {#build} itself is not overridden.
+		
+		# @return [void]
+		def build_self
+			raise "#build_self not implemented in #{self.class}."
+		end
+		private :build_self
+		
+		# Build.
+		#
+		# This is a simple build method.  It calls {#build_dependancies} then
+		# {#build_self}.  Either or both of these methods can be overwritten to
+		# customize the build or this function can be overwritten to have more
+		# control.
+		# 
+		# @return [void]
+		def build
+			build_dependancies
+			build_self
+			
+			nil
+		end
+	end
+	
+	# Target with additional functionality.
+	class TargetSmart < Target
+		attr_reader :input, :output
+	
+		def initialize
+			@input  = Set.new
+			@output = Set.new
+		end
+		
+		# Mark target as clean.
+		#
+		# @return [void]
+		def clean
+			output.all?{|f| !f.is_a?(Symbol) and f.exist?} or return
+			
+			 R::ppersistant["Rub.TargetSmart.#{@output.sort.join('\0')}"] = hash_self
+		end
+		
+		# Is this target clean?
+		#
+		# @return [true,false] True if this target is up-to-date.
+		def clean?
+			output.each do |f|
+				f.is_a?(Symbol) and return false # Tags are never clean.
+				f.exist?        or  return false # Output missing, rebuild.
+			end
+			
+			R::ppersistant["Rub.TargetSmart.#{@output.sort.join('\0')}"] == hash_self
+		end
+		
+		def build
+			build_dependancies
+			
+			clean? and return
+			
+			build_self
+			
+			clean
+		end
+	end
+	
+	# A target for existing sources.
+	class TargetSource < Target
+		attr_reader :output
+		
+		def initialize(p)
+			@src    = p
+			@output = Set[p]
+		end
+		
+		def hash_output(f)
+			@hashcache ||= Digest::SHA1.file(f).to_s
+		end
+		
+		def build
+			if not @src.exist?
+				#p self
+				$stderr.puts "Error: source file #{@src} does not exist!"
+				Sysexits.exit :noinput
+			end
+		end
+	end
+end