rakish 0.9.01.beta

data/lib/rakish/ArchiveBuilder.rb

@@ -0,0 +1,216 @@
+myPath = File.dirname(File.expand_path(__FILE__));
+require "#{myPath}/RakishProject.rb"
+require 'tmpdir'
+
+
+module Rakish
+
+    class ArchiveBuilder < BuildConfig
+
+    public
+
+        # archiveContents has these "fields"
+        # :files   - list of file paths (can use wild cards)
+        # :baseDir - base directory of file list as "source root dir" to be truncated from resolved paths
+        # :destDir - destination folder in jar file to have truncated files paths added to in jar file.
+        # :cacheList - cache the file list and auto-add dependencies only defined if true
+        # requres that utility 'unzip' is in the path
+
+        attr_reader :archiveContents_ # :nodoc:
+
+        addInitBlock do |pnt,opts|
+            @archiveContents_ = [];
+        end
+
+        def unzipPath # :nodoc:
+            @@unzipPath_ ||= Rakish::Util.findInBinPath('unzip');
+        end
+
+        # Adds all the files from a subtree into the destdir
+        # the subtree will have it's leading "basedir" removed from the file path
+        # and replaced with the "basedir" before adding to the archive.
+        # note: all "destdir" paths are relative to the root of the archive
+        #  ie:
+        #     file = '/a/b/c/d/e/file.txt'
+        #     basedir = '/a/b/c'
+        #     destdir = './archive/dir'
+        #
+        #     added to archive = 'archive/dir/file.txt'
+        #
+        # Note: the file list not resolved until configured archive task is
+        # checked for being "needed?" or invoked.
+
+        def addFileTree(destdir, basedir, *files)
+
+            # ensure all destdirs are relative to an implicit folder
+            if(destdir =~ /^\//)
+                destdir="./#{$'}"
+            end
+
+            entry = {};
+            entry[:destDir]=(destdir);
+
+            (basedir=File.expand_path(basedir)) unless basedir=='#';
+
+            entry[:baseDir]=basedir;
+
+            filePaths = [];
+            files.flatten.each do |file|
+                filePaths << File.expand_path(file);
+            end
+
+            entry[:files]=filePaths;
+            @archiveContents_ << entry;
+        end
+
+
+
+        # Add files in the *files list into the 'destdir' in the archive
+        # note: all "destdir" paths are relative to the root of the archive
+        def addFiles(destdir,*files)
+            addFileTree(destdir,'#',*files); # note '#' is flag to do addFiles
+        end
+
+        # Sets up a task to load contents from a directory to the root of the archive file recursively.
+        # filters - if filters are specified, they select files within the directory to put in the jar
+        # with the wildcard path relative to the source directory in the format of a Rake::FileList
+        # the default if unspecified is to select all files in the directory.
+        # The list of files is resolved when the builder task is invoked.
+
+        def addDirectory(dir,*filters)
+            if(filters.length < 1)
+               filters=['**/*'];
+            end
+            filters.map! do |filter|
+                File.join(dir,filter);
+            end
+            addFileTree('.',dir,*filters);
+        end
+
+
+        # Add task to extract contents from the given zip file, will apply filters
+        # and add the extracted files/folders to the root of the
+        # new archive recursively, the extraction is done when the
+        # builder task is invoked.
+        # filters - if filters are specified, they select files within the source to put in the jar
+        # with the wildcard path relative to the source root in the format of a Rake::FileList
+        # the default if unspecified is to select all files in the source.
+        # The list of files is resolved when the builder task is invoked.
+
+        def addZipContents(archivePath,*filters)
+
+            if(filters.length < 1)
+               filters=['*'];
+            end
+            entry = {};
+            entry[:destDir]=('.');
+            entry[:baseDir]=("#{File.expand_path(archivePath)}###"); # note "###" is flag to indicate source is an archive
+            entry[:files]=filters;
+            @archiveContents_ << entry;
+        end
+
+        def loadTempDir(dir) # :nodoc: TODO "the "####" and '#' flag thing is messy maybe :type in entry ??
+
+
+            archiveContents_.each do |entry|
+
+                # copy or extract all the files for the jar to a temporary folder
+                # then create a jar containing the contents
+                # and delete the directory
+
+                baseDir = entry[:baseDir];
+
+                spl = baseDir.split('###',2)
+                if(spl.length > 1)
+
+                    # from unzip man page
+                    #         "*.c" matches "foo.c" but not "mydir/foo.c"
+                    #           "**.c" matches both "foo.c" and "mydir/foo.c"
+                    #           "*/*.c" matches "bar/foo.c" but not "baz/bar/foo.c"
+                    #           "??*/*" matches "ab/foo" and "abc/foo"
+                    #                   but not "a/foo" or "a/b/foo"
+
+                    cmd = "\"#{unzipPath}\" -q \"#{spl[0]}\" \"#{entry[:files].join("\" \"")}\" -x \"META-INF/*\" -d \"#{dir}\"";
+
+                    execLogged(cmd, :verbose=>verbose?);
+
+                else
+                    contents = entry[:files];
+                    unless(FileCopySet === contents)
+                        contents = FileCopySet.new; # a new set for each entry.
+                        # for each entry add files to a copy set
+                        if(baseDir=="#")
+                            contents.addFiles(entry[:destDir],entry[:files]);
+                        else
+                            contents.addFileTree(entry[:destDir],baseDir,entry[:files]);
+                        end
+                    end
+                    # copy the file set to the temp folder
+                    contents.filesByDir do |destDir,files|
+                        FileUtils.mkdir_p destDir;
+                        files.each do |file|
+                            FileUtils.cp(file,destDir)
+                        end
+                    end
+                end
+            end
+        end
+
+
+        class ArchiveTask < Rake::FileTask
+
+            # I wonder if there is a better way in rake.
+            # This will auto generate source prerequisites
+            # from the specified FileSets when
+            # they are demanded
+
+        protected
+
+            def resolvePrerequisites
+                # TODO "the "####" and '#' flag thing is messy maybe :type in entry ??
+                unless defined? @filesResolved_
+                    @filesResolved_ = true;
+                    contents = config.archiveContents_;
+
+                    contents.each do |entry|
+                        baseDir = entry[:baseDir];
+                        spl = baseDir.split('###',2)
+                        if(spl.length > 1)
+                            @prerequisites << spl[0]
+                        else
+                            copySet = FileCopySet.new;
+                            # for each entry add files to the copy set
+                            if(baseDir=='#')
+                                copySet.addFiles(entry[:destDir],entry[:files]);
+                            else
+                                copySet.addFileTree(entry[:destDir],baseDir,entry[:files]);
+                            end
+                            @prerequisites |= copySet.sources;
+                            # replace file list in entry with the resolved copy set
+                            entry[:files] = copySet if entry[:cacheList]
+                        end
+                    end
+                end
+            end
+
+        public
+
+            # Override of Rake::Task::prerequisite_tasks to return list of prerequisite tasks,
+            # generated and cached upon first access.
+            def prerequisite_tasks
+                resolvePrerequisites unless defined? @filesResolved_
+                prerequisites.collect { |pre| lookup_prerequisite(pre) }
+            end
+
+            # Override of Rake::FileTask::needed? this resolves all the specified source file lists
+            # and adds them all as prerequisites to the task for which the purpose is to copy the sources into
+            # a destination archive.
+            def needed?
+                resolvePrerequisites unless defined? @filesResolved_
+                !File.exist?(name) || out_of_date?(timestamp);
+            end
+        end
+    end
+
+end # Rakish
+

data/lib/rakish/BuildConfig.rb

@@ -0,0 +1,254 @@
+myDir = File.dirname(File.expand_path(__FILE__));
+require "#{myDir}/Rakish.rb"
+
+module Rakish
+
+class InvalidConfigError < Exception # :nodoc:
+	def initialize(cfg, msg)
+		super("Invalid Configuration \"#{cfg}\": #{msg}.");
+	end
+end
+
+module BuildConfigModule
+	include PropertyBagMod
+	include Rake::DSL
+
+ 	addInitBlock do |pnt,opts|
+
+ 		init_PropertyBag(pnt);
+ 	#	log.debug("initializing BuildConfig #{pnt}")
+ 		enableNewFields do |cfg|
+			if(pnt)
+ 				cfg.nativeConfigName = getAnyAbove(:nativeConfigName);
+ 			end
+ 		end
+ 	end
+
+
+	# constants
+	SUPPORTED_HOST_TYPES = [ 'Win64', 'Win32', 'Linux32', 'Linux64', 'Macosx64' ];
+
+	begin
+		# get per process/machine constants
+		USERNAME = (ENV['USERNAME']||ENV['LOGNAME']);
+		def USERNAME
+			USERNAME
+		end
+
+		os = ENV['OS'];
+		if(os =~ /Windows/)
+			arch = ENV['PROCESSOR_ARCHITEW6432']
+			if(arch =~ /AMD64/)
+				HOSTTYPE = 'Win64';
+			else
+				HOSTTYPE = 'Win32';
+			end
+			BASEHOSTTYPE = 'Windows';
+		else
+			uname = %x[uname]
+			if(uname =~ /Darwin/)
+				htype = 'Macosx'
+			else
+				htype = 'Linux'
+			end
+			arch = %x[arch]
+			if(arch =~ /x86_64/)
+				HOSTTYPE = "#{htype}64"
+			else
+				HOSTTYPE = "#{htype}32"
+			end
+			BASEHOSTTYPE = 'Linux'
+		end
+		def HOSTTYPE
+			HOSTTYPE
+		end
+		def BASEHOSTTYPE
+			BASEHOSTTYPE
+		end
+	end
+
+    # folder to output native libraries and "linkref" files
+    # pointing to the actual libraries if not there ( windows DLL libs )
+	attr_property 	:nativeLibDir
+
+    # folder to output native object and intermediate files to
+	attr_property 	:nativeObjDir
+
+    # folder to output native binary dll and so files to
+	attr_property 	:binDir
+
+ 	# parsable native configuration name as configuration and
+ 	# used as a reference to which librarys to link with for a particular
+ 	# compiler and processor configuration
+	attr_property   :nativeConfigName
+
+    # suffix to append to native output binary and library files
+    # defaults to the nativeConfigName
+	attr_property   :nativeOutputSuffix
+
+    # root folder for build output files
+	def buildDir
+		@buildDir||=getAnyAbove(:buildDir);
+	end
+
+    # folder to output native executable and dll files to.
+    # defaults to (buildDir)/bin
+	def binDir
+        @binDir||=getAnyAbove(:binDir)||"#{buildDir()}/bin";
+	end
+
+    # folder to output native library files and link references to.
+    # defaults to (buildDir)/lib
+	def nativeLibDir
+		@nativeLibDir||=getAnyAbove(:nativeLibDir)||"#{buildDir()}/lib";
+	end
+
+    # folder to output native intermedite and object files to.
+    # config defaults to (buildDir)/obj
+    # in a project module defaults to the value set in th (configValue)/(moduleName)
+	def nativeObjDir
+		@nativeObjDir||=getAnyAbove(:nativeObjDir)||"#{buildDir()}/obj";
+	end
+
+    # suffix to add to native output files
+    # defaults to nativeConfigName
+	def nativeOutputSuffix
+		@nativeOutputSuffix||=nativeConfigName();
+	end
+
+	attr_accessor 	:verbose
+
+	def verbose?
+		@verbose ||= getAnyAbove(:verbose);
+	end
+
+end
+
+
+class BuildConfig
+	include Util
+
+    # this may need to be changed as rake evolves
+    def self.task(*args,&block)
+        Rake::Task.define_task(*args, &block)
+    end
+
+    def initialize(pnt=nil,opts=nil)
+        self.class.initializeIncluded(self,pnt,opts);
+		yield self if block_given?
+    end
+    include BuildConfigModule
+
+end
+
+protected
+
+# global singleton default Rakish.Project configuration
+class GlobalConfig < BuildConfig
+
+	@@gcfg = nil
+
+	def globalPaths(&b)
+		@initGlobalPaths = b;
+	end
+
+	def self.includeConfigType(mod)
+		unless GlobalConfig.include? mod	
+			include(mod);
+		end
+	end
+
+   	def buildDir=(val)
+   	    @buildDir=val;
+   	end
+
+	def initialize(*args, &b)
+
+		if @@gcfg
+			raise("Exeption !! You can only initialize one GlobalConfig !!!")
+		end
+
+		@@gcfg = self
+
+		opts = (Hash === args.last) ? args.pop : {}
+
+		ensureIncluded = opts[:include];
+		if(ensureIncluded != nil) 
+			ensureIncluded.each do |ei|
+				GlobalConfig.includeConfigType(ei);
+			end
+		end
+
+		super(nil,{}) {}
+
+		enableNewFields() do |cfg|
+
+			enableNewFields(&b);
+
+			enableNewFields(&@initGlobalPaths) if @initGlobalPaths;
+
+			@buildDir ||= ENV['RakishBuildRoot']||"#{Rake.original_dir}/build";
+			@buildDir = File.expand_path(@buildDir);
+
+			config = nil;
+			if(HOSTTYPE =~ /Macosx/)
+				defaultConfig = "iOS-gcc-fat-Debug";
+			else
+				defaultConfig = "Win32-VC10-MD-Debug";
+			end
+
+
+			# set defaults if not set above
+			@nativeLibDir ||= "#{@buildDir}/lib"
+			@binDir ||= "#{@buildDir}/bin"
+			@INCDIR ||= "#{@buildDir}/include"
+
+			# get config from command line
+			cfg.nativeConfigName ||= ENV['nativeConfigName'];
+			cfg.nativeConfigName ||= defaultConfig
+
+		end
+
+		puts("host is #{HOSTTYPE()}") if self.verbose?
+
+        ensureDirectoryTask(@buildDir);
+
+		RakeFileUtils.verbose(@@gcfg.verbose?)
+		if(@@gcfg.verbose?)
+			puts("Global configuration initialized")
+		end
+	end
+
+	# return the instance of the GlobalConfig nil if not initialized
+	def GlobalConfig.instance
+		@@gcfg
+	end
+end
+
+public
+
+# Declare (create) a new named configuration
+#
+#  named arguments:
+#     :name         => Name for this configuration. This must be unique for all loaded projects,
+#                      defaults to 'root'.
+#     :include      => [ Array of configuration modules to include ]
+#     :inheritsFrom => Parent configuration's name.
+#                      Defaults to 'root' if name != 'root'
+
+def self.Configuration(opts={},&block)
+    name = opts[:name]||='root'
+    me = nil;
+    if(name == 'root')
+        me = GlobalConfig.new(opts,&block);
+    else
+        return(nil); # for now.
+    end
+    me.name=name;
+    build.registerConfiguration(me);
+    me
+end
+
+
+end # module Rakish
+