builddir 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+ 
+## 0.1.0 (2014-08-05)
+
+Features:
+
+  - initial release as ruby gem
+  - `builddir_cmake` helper in ruby
+  - `builddir_configure` helper in ruby
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in builddir.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mario Werner
+
+MIT License
+
+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/README.md

@@ -0,0 +1,47 @@
+# Builddir
+
+**builddir** is a little helper tool for C/C++ programmers to manage
+out-of-source build directories. It manages mappings between build directories
+and the associated source directories and allows to switch between them.
+
+## Installation
+
+Installation consists out of multiple steps. The first is to install the
+builddir gem:
+
+    gem install builddir
+
+Second, a shell wrapper script (`builddir_source_script`) has to be placed in
+the PATH. The script can either be installed by hand (from `lib/data`) or can
+be generated using the `builddir_generate_source_script` command.
+
+    builddir_generate_source_script ~/bin/builddir_source_script
+
+Third, to make builddir intuitively usable it is recommended to define the
+following bash aliases.
+
+    alias builddir='source builddir_source_script'
+    alias bdir='builddir'
+    alias cds='builddir -s'
+    alias cdb='builddir -cb'
+    alias cmake='builddir_cmake'
+    alias configure='builddir_configure'
+
+Fourth, define the build directory root by exporting the `DEFAULT_BUILDDIR`
+environment variable. When `DEFAULT_BUILDDIR` is not defined then
+`/tmp/builddir` is used as default.
+
+    export DEFAULT_BUILDDIR="<path to the builddir>"
+
+It is highly recommended to add the alias definitions and the environment
+variable definition to the configuration file
+(`~/.bashrc`, `~/.zshrc.local`, ...) of the used shell to make them permanent. 
+
+## Usage
+
+TODO: Document the different operations
+
+## TODO:
+* add documentation
+* add unit tests
+* support multiple build directories?

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/builddir_cmake

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'builddir'
+
+# figure out if the src path is needed
+src_dir = nil
+append_src_dir = true
+
+# blacklist all flags where concatination of the src dir is not desired
+append_src_dir = false if ARGV.any? { |val| val =~ /(^-[hH]$)|(^\/\?$)|(^-help$)|(^-usage$)|(^--help)/ } 
+append_src_dir = false if ARGV.any? { |val| val =~ /(^\/V$)|(^--?version$)/ }
+append_src_dir = false if ARGV.any? { |val| val =~ /^--copyright$/ }
+append_src_dir = false if ARGV.any? { |val| val =~ /^--system-information$/ }
+append_src_dir = false if ARGV.any? { |val| val =~ /^--build$/ }
+append_src_dir = false if ARGV.any? { |val| val =~ /^-E$/ }
+
+if append_src_dir
+	# try to find a mapping
+	mapping = Builddir.loadMapping()
+	mapping ||= []
+	
+	currentDir = Dir.pwd
+	entry = Builddir.findExactMapping(mapping,currentDir)
+	src_dir = entry[:srcDir] unless entry.nil? || entry[:type] != :BUILD_DIR
+end
+
+unless src_dir.nil?
+	system 'cmake', *ARGV, src_dir
+else
+	system 'cmake', *ARGV
+end
+exit $?.exitstatus

data/bin/builddir_configure

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'builddir'
+
+# figure out if the src path is needed
+config_file = nil
+
+# try to find a mapping
+mapping = Builddir.loadMapping()
+mapping ||= []
+currentDir = Dir.pwd
+entry = Builddir.findExactMapping(mapping,currentDir)
+config_file = File.join(entry[:srcDir],"configure") unless entry.nil? || entry[:type] != :BUILD_DIR
+
+# execute the configure file in the source directory if on exists
+unless config_file.nil? || !File.exists?(config_file)
+	system config_file, *ARGV
+else
+	system 'configure', *ARGV
+end
+exit $?.exitstatus

data/bin/builddir_generate_source_script

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'trollop'
+
+require 'builddir'
+
+p = Trollop::Parser.new do
+	version "#{Builddir::NAME} Version #{Builddir::VERSION}"
+	banner <<-EOS
+Generates the script which has to be sourced to change change directories with builddir.
+
+Usage:
+		#{$0} [options] [TargetFile]
+
+where [options] are:
+EOS
+end
+
+opts = {}
+Trollop::with_standard_exception_handling p do
+	opts = p.parse ARGV
+	raise Trollop::HelpNeeded if ARGV.size() > 1 # show help screen
+end
+
+file_path = File.join(Builddir.gem_libdir, "data", "builddir_source_script")
+
+# write file content to stdout
+if ARGV.size == 0
+	puts File.read(file_path)
+
+# write file content to another file
+else
+	FileUtils.cp(file_path, ARGV[0])
+end
+
+exit 0
+

data/bin/builddir_impl

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'pathname'
+require 'trollop'
+
+require 'builddir'
+
+def createBuildDirPath(baseDir,baseName)
+   basePath = Pathname.new("#{baseDir}/#{baseName}")
+   return basePath.to_s unless File.exists?(basePath)
+   i = 1
+   while File.exists?(basePath.to_s + i.to_s) do i += 1 end
+   return basePath.to_s + i.to_s
+end
+
+# redirect stdout to stderr
+$stdout = $stderr
+
+p = Trollop::Parser.new do
+	version "#{Builddir::NAME} Version #{Builddir::VERSION}"
+	banner <<-EOS
+Usage:
+		builddir [options] [baseName]
+where [options] are:
+EOS
+	opt :build,         "Get the build directory"
+	opt :create,        "Create build directory if necessary"
+	opt :delete,        "remove + delete the build directory."
+	opt :help,          "Display this help message"
+	opt :purge,         "Delete all abandoned build directories without mapping"
+	opt :remove,        "Remove connection between the src and the build directory"
+	opt :source,        "Get the source directory"
+	opt :verbose,       "Verbose mode for debugging", :short => "V"
+end
+
+opts = {}
+Trollop::with_standard_exception_handling p do
+	opts = p.parse ARGV
+	raise Trollop::HelpNeeded if ARGV.size() > 1 # show help screen
+end
+currentDir = Dir.pwd
+
+mappingsFile = Builddir.getMappingsFilePath()
+buildBaseDir = Builddir.getBuildBasePath()
+baseName = File.basename(currentDir)
+baseName = File.basename(ARGV[0]) unless ARGV.empty?
+
+if opts[:verbose]
+	puts "Current Directory   : #{currentDir}"
+	puts "Build Base Directory: #{buildBaseDir}"
+	puts "Mappings File       : #{mappingsFile}"
+	puts "Basename            : #{baseName}"
+	puts ""
+end
+
+if opts[:build] && opts[:source]
+	puts "ERROR! Can not switch to source and build simultaneously."
+	exit -1
+end
+
+if (opts[:create] || opts[:build] || opts[:source]) && (opts[:delete] || opts[:remove])
+	puts "ERROR! This combination of options is not allowed!"
+	exit -1
+end
+
+mapping = Builddir.loadMapping(mappingsFile)
+puts "WARNING! Mappings could not be loaded." if mapping == nil && opts[:verbose]
+mapping ||= []
+
+entry = Builddir.findMapping(mapping, currentDir)
+if opts[:purge]
+	buildDirs = Dir[File.join(buildBaseDir, "*")].select{|file| File.directory?(file)}
+	buildDirs.each do |directory|
+		entry = Builddir.findMapping(mapping, directory)
+		if entry == nil
+			puts "Deleting: #{directory}"
+			FileUtils.rm_rf(directory)
+		end
+	end
+	exit 0
+elsif entry == nil && !opts[:create]
+	puts "ERROR! No SrcDir <-> BuildDir mapping could be found."
+	exit -1
+elsif opts[:delete] || opts[:remove]
+	puts "Removing mapping: #{entry[:srcDir]} <-> #{entry[:buildDir]}"
+	mapping.delete_at(entry[:index])
+	Builddir.saveMapping(mapping,mappingsFile)
+	if opts[:delete] && File.exists?(entry[:buildDir])
+		puts "Deleting build directory: #{entry[:buildDir]}"
+		FileUtils.rm_rf(entry[:buildDir])
+	end
+	exit 0
+elsif entry == nil
+	buildDir = createBuildDirPath(buildBaseDir,baseName)
+	mapping << [ currentDir, buildDir ]
+	puts "New Mapping: #{currentDir} <-> #{buildDir}" if opts[:verbose]
+	entry = { :srcDir => currentDir, :buildDir => buildDir, :index => mapping.size-1, :type => :SRC_DIR }
+	Builddir.saveMapping(mapping,mappingsFile)
+elsif opts[:verbose]
+	puts "Mapping Found: #{entry[:srcDir]} <-> #{entry[:buildDir]}"
+end
+
+# create the directory when needed
+unless File.exists?(entry[:buildDir])
+	puts "Creating build directory" if opts[:verbose]
+	FileUtils.mkdir_p(entry[:buildDir])
+end
+
+dstDir = entry[:srcDir]
+if opts[:build] || (!opts[:build] && !opts[:source] && entry[:type] == :SRC_DIR)
+	dstDir = entry[:buildDir]
+end
+puts "Change directory to: #{dstDir}" if opts[:verbose]
+STDOUT.puts dstDir
+exit 0

data/builddir.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'builddir/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = Builddir::NAME
+  spec.version       = Builddir::VERSION
+  spec.authors       = ["Mario Werner"]
+  spec.email         = ["mario.werner@iaik.tugraz.at"]
+  spec.summary       = %q{builddir is a little helper tool for C/C++ programmers to manage out-of-source build directories.}
+  spec.description   = %q{builddir manages mappings between build directories and the associated source directories.}
+  spec.homepage      = "https://github.com/niosHD/builddir.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.bindir        = "bin"
+
+  spec.post_install_message = "Thank you for installing builddir.\n\nPlease follow the remaining installation steps from the README (#{spec.homepage}) to finish the installation.\n\n"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "trollop", "~> 2.0"
+end

data/lib/builddir/data/builddir_source_script

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+COMMAND="builddir_impl"
+
+# Script from:
+# http://stackoverflow.com/questions/11027679/bash-store-stdout-and-stderr-in-different-variables
+unset t_std t_err t_ret
+eval "$( $COMMAND $@ 2> >(t_err="$(cat)"; typeset -p t_err) > >(t_std="$(cat)"; typeset -p t_std); t_ret=$?; typeset -p t_ret )"
+
+# print the stderr stream of the command
+echo "${t_err}"
+
+# change directory if there is no error
+if [ $t_ret -eq 0 ]; then
+  cd "${t_std}"
+fi
+
+# set the retun code
+(exit $t_ret)

data/lib/builddir/utils.rb

@@ -0,0 +1,16 @@
+require_relative 'version'
+
+module Builddir
+
+	# Return the directory with the project libraries
+	# http://stackoverflow.com/a/5805783
+	#
+	# @return [String] path to the library directory
+	def Builddir.gem_libdir
+		t = ["#{File.dirname(File.expand_path($0))}/../lib/#{NAME}",
+					"#{Gem.dir}/gems/#{NAME}-#{VERSION}/lib/#{NAME}"]
+		t.each {|i| return i if File.readable?(i) }
+		raise "both paths are invalid: #{t}"
+	end
+
+end 

data/lib/builddir/version.rb

@@ -0,0 +1,4 @@
+module Builddir
+	NAME = 'builddir'
+  VERSION = "0.1.0"
+end

data/lib/builddir.rb

@@ -0,0 +1,74 @@
+require "builddir/version"
+require "builddir/utils"
+
+require 'pathname'
+require 'yaml'
+
+module Builddir
+
+	# Loads the BuildDir <-> SourceDir mapping from the file
+	#
+	# @param file [String] path of the mapping file
+	# @return [nil, Array<Array(String, String)>] The loaded mapping. nil on error
+	def Builddir.loadMapping(file = nil)
+		file = getMappingsFilePath() if file.nil?
+		begin
+			mapping = YAML::load_file(file)
+		rescue
+			mapping = nil
+		end
+		return mapping
+	end
+
+	# Saves the BuildDir <-> SourceDir mapping to a file
+	#
+	# @param mapping [Array<Array(String, String)>] the mapping which should be saved
+	# @param file [String] path of the mapping file
+	def saveMapping(mapping, file)
+		File.open(file, 'w') do |f|
+			f.write mapping.to_yaml
+		end
+	end
+
+	# Searches through the mapping for a direct path match
+	#
+	# @param mapping [Array<Array(String, String)>] the mapping which should checked
+	# @param path [String] path of the searched directory
+	# @return [nil, { Symbol => String,Symbol}] the found mapping. nil on error
+	def Builddir.findExactMapping(mapping,path)
+		mapping.each_with_index do |entry,index|
+			if entry[0] == path
+				return { :srcDir => entry[0], :buildDir => entry[1], :index => index, :type => :SRC_DIR }
+			elsif  entry[1] == path
+				return { :srcDir => entry[0], :buildDir => entry[1], :index => index, :type => :BUILD_DIR }
+			end
+		end
+		return nil
+	end
+
+	# Searches through the mapping for a path match.
+	# Parent directories are considered for the matching as well.
+	#
+	# @param mapping [Array<Array(String, String)>] the mapping which should checked
+	# @param path [String] path of the searched directory
+	# @return [nil, { Symbol => String,Symbol}] the found mapping. nil on error
+	def Builddir.findMapping(mapping,path)
+		lastpn = nil
+		pn  = Pathname.new(path)
+		while pn != lastpn do
+			entry = findExactMapping(mapping,pn.to_s)
+			return entry if entry
+			lastpn = pn
+			pn = pn.parent()
+		end
+		return nil
+	end
+	
+	def Builddir.getBuildBasePath()
+		return ENV['DEFAULT_BUILDDIR'] || "/tmp/builddir"
+	end
+	
+	def Builddir.getMappingsFilePath()
+		return File.join(getBuildBasePath(),"builddir_mapping.yml")
+	end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: builddir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mario Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: builddir manages mappings between build directories and the associated
+  source directories.
+email:
+- mario.werner@iaik.tugraz.at
+executables:
+- builddir_cmake
+- builddir_configure
+- builddir_generate_source_script
+- builddir_impl
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/builddir_cmake
+- bin/builddir_configure
+- bin/builddir_generate_source_script
+- bin/builddir_impl
+- builddir.gemspec
+- lib/builddir.rb
+- lib/builddir/data/builddir_source_script
+- lib/builddir/utils.rb
+- lib/builddir/version.rb
+homepage: https://github.com/niosHD/builddir.git
+licenses:
+- MIT
+post_install_message: ! 'Thank you for installing builddir.
+
+
+  Please follow the remaining installation steps from the README (https://github.com/niosHD/builddir.git)
+  to finish the installation.
+
+
+'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: builddir is a little helper tool for C/C++ programmers to manage out-of-source
+  build directories.
+test_files: []