rub 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b101f8d3dc57411ac38315bbac0d36045585a1c0
+  data.tar.gz: 2b81673c121797dc7cc56e3b01667f3d3b3f39b2
+SHA512:
+  metadata.gz: 3c088de47f8f8fb3e2509d5931db5b0692443e14d25bb3101c00286d839b0ed68dcc5e4106eaf95d0bf83e31a52f0cfbf82a73931ddd507dc51d7a3f75ad4c03
+  data.tar.gz: ae33cc23df67aff256c24c0a0787c675bab9e4cc1f20c509792993e3f53a57a70ec0ab1c6d475c36a456ee79ac9e36c9187d057df30cef03a2f92a0287c21c3a

data/lib/rub/c.rb

@@ -0,0 +1,276 @@
+# 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 'date'
+
+# Core Module
+module C
+	# Expand a path.
+	#
+	# @return [Pathname]
+	def self.path(p)
+		p.is_a? Symbol   and return p
+		p.is_a? Pathname and return p.expand_path
+		p = p.to_s
+		
+		#p = case p[0]
+		#	when '!'
+		#		Pathname.new(p[1..-1])
+		#	when '>'
+		#		R::Env.out_dir + p[1..-1]
+		#	when '<'
+		#		R::Env.src_dir + p[1..-1]
+		#	else
+		#		Pathname.new(p)
+		#end
+		
+		Pathname.new(p).expand_path
+	end
+	
+	# Glob pathnames.
+	#
+	# @see Dir.glob
+	#
+	# @param glob [String]
+	# @return [Set<Pathname>]
+	def self.glob(glob)
+		Set.new Dir.glob(glob).map{|e| C.path(e) }
+	end
+	
+	# Get a consistant hash of an object.
+	def self.chash(o)
+		if o.is_a? Array
+			return o.map{|i| chash i}.join
+		end
+		
+		# Super hacky, strip out object-ids, because they change every
+		# invocation, but use inspect.  It works alright.
+		r = o.inspect.gsub(/(?<!:):0x[0-9a-f]*/, '')
+		
+		# Modules don't print themselfs meaningfully.
+		if o.is_a? Module
+			r << o.pretty_print_instance_variables.map{|k| [k, o.instance_variable_get(k)] }.inspect
+		end
+	
+		r	
+	end
+	
+	# Create a probably unique path segment.
+	#
+	# Creates a string in the form '$stuff/' that will probably be unique.
+	#
+	# @param seed [Object] A value to use for the folder name, keeping this the
+	#                      same across invocations allows predictable names,
+	#                      preventing unnecessary rebuilds.
+	def self.unique_segment(*seed)
+		seed ||= caller_locations(1,1)
+		
+		return Digest::SHA1.hexdigest(chash(seed))
+	end
+	
+	# Return a probably unique file name.
+	#
+	# This file can be used as a build target.
+	#
+	# @param base [String] The basename of the file.
+	# @param seed [Object] A value to use for the folder name, keeping this the
+	#                      same across invocations allows predictable names,
+	#                      preventing unnecessary rebuilds.
+	def self.unique_path(base, seed)
+		R::Env.out_dir + 'c/unique/' + unique_segment(seed) + base
+	end
+	
+	# Tag Target
+	#
+	# This is the target used for tags.
+	class TargetTag < R::Target
+		attr_reader :output, :input
+		attr_reader :tag
+		
+		attr_accessor :description
+		
+		# Create a TargetTag
+		#
+		# @param t [Symbol] the name of the tag.
+		def initialize(t)
+			t.is_a? Symbol or raise 'Targets can be created with symbols only.'
+		
+			@tag = t
+			@output = Set[t]
+			@input  = Set[]
+		end
+		
+		# Add a target to this tag.
+		#
+		# @param f [Pathname,String] The path of the target.
+		def require(f)
+			f = R::Tool.make_set f
+			f.map!{|e| C.path(e)}
+			
+			input.merge(f)
+		end
+		
+		def build
+			input.each{|i| R::get_target(i).build }
+		end
+	end
+	
+	# Tag class
+	#
+	# Manages a tag.  This should not be created buy the user but retrieved from
+	# {C.tag}.
+	class Tag
+		# The tag's name.
+		# @return [Symbol]
+		attr_accessor :name
+		
+		def description
+			@target.description
+		end
+		def description=(d)
+			@target.description = d
+		end
+		
+		# Create a Tag
+		#
+		# @param t [Symbol] the name of the tag.
+		def initialize(t)
+			@name = t
+			@target = TargetTag.new(t)
+			@target.register
+		end
+		
+		# Add a target to this tag.
+		#
+		# @param f [Pathname,String] The path of the target.
+		def require(f)
+			@target.require f
+		end
+	end
+	
+	# Get a tag.
+	#
+	# If the tag already exists it returns the existing {Tag} object otherwise
+	# it creates and returns a new {Tag} instance.
+	#
+	# @param t [Symbol] The tag name.
+	# @return [Tag]     The tag object.
+	def self.tag(t)
+		R.find_target(t) || Tag.new(t)
+	end
+	
+	##### Create default tags.
+	tag(:all)    .description = 'All targets.'
+	tag(:install).description = 'Install the project.'
+	tag(:none)   .description = 'Do nothing.'
+	
+	# Add a generator to the build
+	#
+	# This function provides a simple api for creating {R::TargetGenerator}
+	# targets.  It creates a target that simply runs one or more commands to
+	# transform it's inputs into outputs.  This interface handles all build
+	# caching and parallelization.
+	#
+	# @param src [Array<Pathname,String>,Pathname,String]
+	#            The source file or list of source files.
+	# @param cmd [Array<Array<Pathname,String>>,Array<Pathname,String>]
+	#            The command or list of commands to run.  Commands will run in
+	#            order.
+	# @param out [Array<Pathname,String>,Pathname,String]
+	#            The output files of the command.
+	# @param desc The verb for this step in the process. (See
+	#             {R::TargetGenerator#action})
+	# @return [Array<Pathname>] The output files.  This will represent the same
+	#                           values passed in to the +out+ parameter but it
+	#                           will be a new Array and all the values will be
+	#                           Pathnames.
+	def self.generator(src, cmd, out, desc: nil)
+		t = R::TargetGenerator.new
+		
+		desc and t.action = desc
+		
+		src = R::Tool.make_set_paths(src)
+		out = R::Tool.make_set_paths(out)
+		cmd[0].is_a?(Array) or cmd = [cmd]
+		
+		t.input .merge(src)
+		t.output.merge(out)
+		t.add_cmds cmd
+		
+		t.register
+		
+		out
+	end
+	
+	# Find an executable on the system.
+	#
+	# This searches the system for execrable in the appropriate locations
+	# (example $PATH on UNIX).
+	#
+	# This function caches its result both in memory and between Rub runs.  Feel
+	# free to call it often.
+	#
+	# @param cmd [String]    The name of the command (basename only).
+	# @return [Pathname,nil] Pathname, or nil if not found.
+	#
+	# @example
+	#   C::find_command 'true'    #=> #<Pathname:/usr/bin/true>
+	#   C::find_command 'cc'      #=> #<Pathname:/home/kevincox/.local/bin/cc>
+	#   C::find_command 'sl'      #=> #<Pathname:/usr/bin/sl>
+	#   C::find_command 'python'  #=> #<Pathname:/usr/bin/python>
+	#   C::find_command 'explode' #=> nil
+	def self.find_command(cmd)
+		pn = Pathname.new(cmd)
+		if pn.absolute?
+			#return pn.executable? ? pn : nil
+			return pn
+		end
+		
+		exe = R.spersistant["C.find_command.#{cmd}"]
+		
+		exe and exe.executable? and return exe
+		
+		exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+		names = exts.map{|e| cmd+e}
+		ENV['PATH'].split(File::PATH_SEPARATOR)
+		           .map{|d|Pathname.new(d)}
+		           .each do |d|
+			names.each do |n|
+				e = d + n
+				#p e
+				
+				if e.executable?
+					exe = e
+					break
+				end
+			end
+			
+			exe and break
+		end
+		
+		R.spersistant["C.find_command.#{cmd}"] = exe
+	end
+end
+
+D.resolve_path(:prefix, "/usr/local/")

data/lib/rub/d.rb

@@ -0,0 +1,252 @@
+# 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.  #
+#                                                                              #
+################################################################################
+
+# Definitions Namespace.
+module D
+	@@map = {}
+	
+	# Define a configuration option.
+	#
+	# @param k [String] The key, or if +v+ is nil a string to parse.
+	# @param v [String,nil] The value
+	# @return [String] The value.
+	#
+	# If +v+ is non-nil +k+ is the key and +v+ is the value.  If +v+ is nil
+	# k must be a string and it is parsed to find the key and value.
+	#
+	# - If there is an '=' in +k+ the first one is used.
+	#   - If the '=' is proceeded by a '+' everything before the "+=" is used as
+	#     the key and everything after is used as the value.  These are then
+	#     passed are passed onto #push.
+	#   - Otherwise everything before the '=' is used as the key and everything
+	#     after as the value.
+	#   - If there is no '=' all of +k+ is used as the key and the value is
+	#     +true+.
+	#
+	# The key will be converted into a symbol and the k/v pair will be added to
+	# the configuration options.
+	#
+	# @example
+	#   D.define('k1', 'v1')
+	#   D[:k1] #=> "v1"
+	#   D.define('k2=v2')
+	#   D[:k2] #=> "v2"
+	#   D.define('k3')
+	#   D[:k3] #=> true
+	#   D.define('k4')
+	#   D[:k4] #=> true
+	#   D.define('k4=')
+	#   D[:k4] #=> ""
+	#   D.define('k5+=v5')
+	#   D.define('k5+=v6')
+	#   D[:k5] #=> ["v5", "v6"]
+	#   
+	#   D.define('w1=v1=v2')
+	#   D[:w1] #=> "v1=v2"
+	#   D.define('w2=v2+=v3')
+	#   D[:w2] #=> "v2+=v3"
+	def self.define(k, v=nil)
+		if v == nil
+		
+			k, f, v = k.partition '='
+			
+			if    k.end_with?('+') and not f.empty?
+				return append(k[0..-2], v)
+			elsif k.end_with?('^') and not f.empty?
+				return prepend(k[0..-2], v)
+			end
+		end
+		
+		k = k.to_sym
+		
+		if f == ""
+			v = true
+		end
+		
+		@@map[k] = v
+	end
+	class << self
+		alias_method '[]=', :define
+	end
+	
+	# Append a configuration option onto a value.
+	#
+	# @param k [String] The key, or if +v+ is nil a string to parse.
+	# @param v [String,nil] The value
+	# @return [String] The value.
+	#
+	# If +v+ is non-nil +k+ is the key and +v+ is the value.  If +v+ is nil
+	# k must be a string and it is parsed to find the key and value.
+	#
+	# If there is a '=' in the string everything before the first '=' is used as
+	# the key and everything after the value.  If the key ends is '+' it is
+	# dropped.  If there is no '=' +k+ is used as the key and +true+ as the
+	# value.
+	#
+	# @example
+	#   D.append('k1', 'v1')
+	#   D[:k1] #=> ["v1"]
+	#   D.append('k1', 'v2')
+	#   D[:k1] #=> ["v1", "v2"]
+	#   D.append('k2=v3')
+	#   D.append('k2+=v4')
+	#   D.append('k2+=')
+	#   D[:k2] #=> ["v3", "v4", ""]
+	#   
+	#   D.append('w1+')
+	#   D[:w1]   #=> nil
+	#   D['w1+'] #=> [true]
+	def self.append(k, v=nil)
+		if v == nil
+			k, f, v = k.partition '='
+			
+			if k.end_with?('+') and not f.empty?
+				k = k[0..-2]
+			end
+		end
+		
+		k = k.to_sym
+		
+		if f == ''
+			v = true
+		end
+		
+		@@map[k].is_a?(Array) or @@map[k] = []
+		
+		@@map[k].push(v)
+	end
+	
+	# Prepend a configuration option onto a value.
+	#
+	# @param k [String] The key, or if +v+ is nil a string to parse.
+	# @param v [String,nil] The value
+	# @return [String] The value.
+	#
+	# If +v+ is non-nil +k+ is the key and +v+ is the value.  If +v+ is nil
+	# k must be a string and it is parsed to find the key and value.
+	#
+	# If there is a '=' in the string everything before the first '=' is used as
+	# the key and everything after the value.  If the key ends is '^' it is
+	# dropped.  If there is no '=' +k+ is used as the key and +true+ as the
+	# value.
+	#
+	# @example
+	#   D.prepend('k1', 'v1')
+	#   D[:k1] #=> ["v1"]
+	#   D.prepend('k1', 'v2')
+	#   D[:k1] #=> ["v2", "v1"]
+	#   D.prepend('k2=v3')
+	#   D.prepend('k2^=v4')
+	#   D.prepend('k2+=')
+	#   D[:k2] #=> ["", "v4", "v3",]
+	#   
+	#   D.prepend('w1^')
+	#   D[:w1]   #=> nil
+	#   D['w1^'] #=> [true]
+	def self.prepend(k, v=nil)
+		if v == nil
+			k, f, v = k.partition '='
+			
+			if k.end_with?('^') and not f.empty?
+				k = k[0..-2]
+			end
+		end
+		
+		k = k.to_sym
+		
+		if f == ''
+			v = true
+		end
+		
+		@@map[k].is_a?(Array) or @@map[k] = []
+		
+		@@map[k].unshift(v)
+	end
+	
+	# Retrieve a defined value.
+	#
+	# @param k [Symbol,String] The key.
+	def self.[] (k)
+		@@map[k.to_sym]
+	end
+	
+	# Return the configuration map.
+	#
+	# This is intended for debugging only and may be removed/made private any
+	# time.
+	#
+	# See: #pp
+	def self.map
+		return @@map
+	end
+	
+	# Pretty Print the configuration options.
+	#
+	# Useful for debugging.
+	def self.pp
+		pp map
+	end
+	
+	# Read definitions from a file.
+	#
+	# @deprecated
+	#
+	# These are read one-per-line and passed to #define (as one argument).
+	def self.fromFile(fn)
+		File.open(fn) {|f| f.each_line {|l| define(l.chomp) } }
+	end
+	
+	# Resolve a path.
+	#
+	# This makes a passed in path proper.  This function must be used in order
+	# to make paths passed in on the command line proper.  This makes all paths
+	# relative to the directory where the command was executed.  If the
+	# definition was not provided it is set to default, no path resolution is
+	# done on the default value.
+	#
+	# @param k [Symbol,String] The key of the option.
+	# @param default [Object] The value to use if +k+ is not set.
+	def self.resolve_path(k, default=nil)
+		k = k.to_sym
+		
+		@@map[k] = if @@map[k] != nil
+			Pathname.new(@@map[k]).expand_path(R::Env.cmd_dir)
+		else
+			default
+		end
+	end
+end
+
+# Alias for D.[]
+#
+# @see D.[]
+#
+# @example
+#   D.define 'k1=v1'
+#   D.define 'k2=v2'
+#   D :k1 #=> "v1"
+#   D:k2  #=> "v2"
+def D(k)
+	D[k]
+end