rake-plus 0.5

data/README.md

@@ -0,0 +1,13 @@
+Rake ext
+========
+
+A couple of rake extensions that are useful for building stuff.
+
+I always end up needing these things so here they are, neatly packaged
+together.
+
+One of the differenciating approach here is that new kind of tasks are
+implemented a new "types" of tasks instead as being exposed like
+class derivatives.
+
+Check out the example to see what I mean.

data/lib/rake-plus/bdep.rb

@@ -0,0 +1,49 @@
+require 'rake-plus/sudo'
+require 'rake/task'
+
+module Rake
+  # TODO: abstract dependencies from the package system
+  class BuildDependency < Rake::Task
+    include Rake::DSL
+    ON_OSX = (`uname` == "Darwin\n")
+
+    def needed?
+      return if ON_OSX
+      # dpkg-query also returns old packages, so '^ii ' guarantees only installed
+      sh("dpkg-query -l \"#{basename}\" | grep -e '^ii ' > /dev/null 2>&1") do |ok, res|
+        return :package_missing unless ok
+      end
+      return
+    end
+
+    def timestamp
+      Rake::EARLY
+    end
+
+    def execute(args=nil)
+      sudo "apt-get install -qy \"#{basename}\""
+      super
+    end
+
+    def basename
+      name.sub(':bdep:','')
+    end
+
+    class << self
+      # Apply the scope to the task name according to the rules for this kind
+      # of task.  File based tasks ignore the scope when creating the name.
+      def scope_name(scope, task_name)
+        ":bdep:#{task_name}"
+      end
+    end
+  end
+end
+
+def bdep(args, &block)
+  t = Rake::BuildDependency.define_task(args, &block)
+  Rake::Task["bdeps"].prerequisites.push(t.name).uniq!
+  t
+end
+
+desc "Installs all bdeps"
+task "bdeps"

data/lib/rake-plus/git_dep.rb

@@ -0,0 +1,97 @@
+require 'uri'
+
+module Rake
+  class GitDependency < Rake::Task
+    include Rake::DSL if defined? Rake::DSL
+    attr_accessor :branch, :commit_id
+
+    def branch(val = nil)
+      @branch = val if val
+      @branch
+    end
+
+    def commit_id(val = nil)
+      @commit_id = val if val
+      @commit_id
+    end
+
+    def commit_or_branch
+      @commit_id || @branch
+    end
+
+    def needed?
+      return :checkout_missing unless File.directory?(local_path)
+      # check if that revision exists
+      if commit_or_branch
+        Dir.chdir(local_path) do
+          sh("git log #{commit_or_branch} -- >/dev/null 2>&1") do |ok, res|
+            return "commit_missing: #{commit_or_branch}" unless ok
+          end
+        end
+      end
+      return
+    end
+
+    def timestamp
+      if File.exist?(local_path / 'HEAD')
+        File.mtime(local_path / 'HEAD')
+      else
+        Rake::EARLY
+      end
+    end
+
+    def local_path
+      RakePlus.cache_dir / "git" / basename
+    end
+
+    def basename
+      base = File.basename(name)
+      unless File.extname(base) == ".git"
+        base + ".git"
+      else
+        base
+      end
+    end
+
+    def execute(args=nil)
+      if File.directory?(local_path)
+        Dir.chdir(local_path) do
+          sh "git remote update"
+        end
+      else
+        FileUtils.mkdir_p File.dirname(local_path)
+        sh "git clone --mirror #{name} #{local_path}"
+      end
+      super
+    end
+
+    # Utility
+    def clone_to(dir, branch=nil)
+      sh "git clone #{local_path} #{dir}"
+      if commit_or_branch
+        Dir.chdir(dir) do
+          sh "git checkout #{commit_or_branch}"
+        end
+      end
+    end
+
+    # Like .tar archives, creates a folder beneath it
+    def unpack_to(dir)
+      clone_to(File.join(dir, basename))
+    end
+
+    class << self
+      # Git based tasks ignore the scope when creating the name.
+      def scope_name(scope, task_name); task_name end
+    end
+  end
+end
+
+# Usage: git("git@github.com:zimbatm/direnv.git")
+#
+
+
+def git(*args, &block)
+  Rake::GitDependency.define_task(*args, &block)
+end
+alias git_dep git

data/lib/rake-plus/gitver.rb

@@ -0,0 +1,10 @@
+require 'time'
+
+def gitver(branch_or_file=nil)
+  ret = `git log -n 1 --oneline #{branch_or_file}`
+  raise ArgumentError, "could not find #{branch_or_file}" if $?.exitstatus > 0
+  raise "parse error" unless (ret =~ /^([^\s]+)/)
+  commit_id = $1
+  commit_num = `git log --oneline #{branch_or_file} | wc -l`.chomp.to_i
+  "#{commit_num}-#{commit_id}"
+end

data/lib/rake-plus/path.rb

@@ -0,0 +1,90 @@
+require 'pathname'
+
+# Patching Pathame to return self.class.new objects instead of Pathname.new
+class Pathname
+  def +(other)
+    other = self.class.new(other) unless other.kind_of?(Pathname)
+    self.class.new(plus(@path, other.to_s))
+  end
+
+  def join(*args)
+    args.unshift self
+    result = args.pop
+    result = self.class.new(result) unless result.kind_of?(Pathname)
+    return result if result.absolute?
+    args.reverse_each {|arg|
+      arg = self.class.new(arg) unless arg.kind_of?(Pathname)
+      result = arg + result
+      return result if result.absolute?
+    }
+    result
+  end
+
+  def relative_path_from(base_directory)
+    dest_directory = self.cleanpath.to_s
+    base_directory = base_directory.cleanpath.to_s
+    dest_prefix = dest_directory
+    dest_names = []
+    while r = chop_basename(dest_prefix)
+      dest_prefix, basename = r
+      dest_names.unshift basename if basename != '.'
+    end
+    base_prefix = base_directory
+    base_names = []
+    while r = chop_basename(base_prefix)
+      base_prefix, basename = r
+      base_names.unshift basename if basename != '.'
+    end
+    unless SAME_PATHS[dest_prefix, base_prefix]
+      raise ArgumentError, "different prefix: #{dest_prefix.inspect} and #{base_directory.inspect}"
+    end
+    while !dest_names.empty? &&
+          !base_names.empty? &&
+          SAME_PATHS[dest_names.first, base_names.first]
+      dest_names.shift
+      base_names.shift
+    end
+    if base_names.include? '..'
+      raise ArgumentError, "base_directory has ..: #{base_directory.inspect}"
+    end
+    base_names.fill('..')
+    relpath_names = base_names + dest_names
+    if relpath_names.empty?
+      self.class.new('.')
+    else
+      self.class.new(File.join(*relpath_names))
+    end
+  end
+end
+
+# Like a Pathname but behaves more like a string
+class Path < Pathname
+  alias / +
+  def =~(regex); to_s =~ regex end
+  def <=>(other); to_s <=> other.to_s end
+  def length; to_s.length end
+  alias size length
+
+  def method_missing(m, *a, &b)
+    s = to_s
+    if s.respond_to? m
+      s.send(m, *a, &b)
+    else
+      super
+    end
+  end
+
+  def respond_to?(m)
+    super || to_s.respond_to?(m)
+  end
+
+  alias expand expand_path
+
+  def self.[](*args)
+    new File.join(*args.map(&:to_s))
+  end
+end
+
+def path(*args)
+  Path[ *args ]
+end

data/lib/rake-plus/rake_ext.rb

@@ -0,0 +1,12 @@
+module Rake
+  class Task
+    # Are there any prerequisites with a later time than the given time stamp?
+    def out_of_date?(stamp)
+      @prerequisites.any? { |n| application[n, @scope].timestamp > stamp}
+    end
+
+    def file_missing?(path)
+      File.exist?(path) ? nil : :file_missing
+    end
+  end
+end

data/lib/rake-plus/recipe.rb

@@ -0,0 +1,221 @@
+require 'rake-plus'
+require 'rake-plus/rake_ext'
+
+class Recipe < Rake::Task
+  include Rake::DSL if defined? Rake::DSL
+  BUILD_SYSTEM  = `uname -sm`.strip.gsub(' ', '-').downcase
+
+  @@defaults = {}
+
+  class << self
+    def var(name, &default)
+      if block_given?
+        @@defaults[name.to_s] = default
+
+        class_eval <<-CODE
+        def #{name}(val=nil)
+          if !val.nil?
+            @#{name} = val
+          elsif @#{name}.nil?
+            @#{name} = instance_eval(&@@defaults["#{name}"])
+          end
+          @#{name}
+        end
+        CODE
+      else
+        class_eval <<-CODE
+        def #{name}(val=nil)
+          @#{name} = val unless val.nil?
+          @#{name}
+        end
+        CODE
+      end
+      self
+    end
+  end
+
+  # Variables for the DSL
+  def url_or_git
+    @url || @git || @svn
+  end
+
+  var :unpack_dir do
+    url_or_git.basename.sub('.tar.gz','').sub('.tar.bz2','')
+  end
+  var :build_dir do
+    # : causes trouble in PATH
+    sub = name.split(':')
+    sub[0] = sub[0] + '-' + BUILD_SYSTEM
+    RakePlus.build_dir / sub.join('/')
+  end
+  var :src_dir do
+    build_dir / 'src'
+  end
+  var :dep_dir do
+    build_dir / 'dep'
+  end
+  var :prefix do
+    build_dir / 'install'
+  end
+  def bdeps(val=nil)
+    unless val.nil?
+      val = [val] unless val.kind_of? Array
+      @bdeps = val.map{|x| x.kind_of?(Recipe) ? x : recipe(x)}
+    end
+    @bdeps || []
+  end
+  var :static_install
+  def install(&block)
+    @install ||= block
+    @install ||= proc do
+      mkdir_p(prefix)
+      sh "./configure --prefix=#{prefix}#{static_install ? " --enable-static --disable-shared" : ''}"
+      sh "make"
+      sh "make install"
+    end
+    @install
+  end
+  def url(val=nil)
+    unless val.nil?
+      @url = remote_package(val)
+    end
+    @url
+  end
+  def git(val=nil)
+    unless val.nil?
+      @git = git_dep(val)
+    end
+    @git
+  end
+  
+  def svn(val=nil)
+    unless val.nil?
+      @svn = svn_dep(val)
+    end
+    @svn
+  end
+  
+  def patches
+    @patches ||= []
+  end
+  def patch(val)
+    patches.push(val)
+  end
+
+  def install_to(dir)
+    sh "cp -r #{prefix}/* #{dir}"
+  end
+
+  def needed?
+    file_missing?(build_dir / "install.done") || out_of_date?(timestamp)
+  end
+
+  def timestamp
+    if File.exist?(build_dir / "install.done")
+      File.mtime(build_dir / "install.done")
+    else
+      Rake::EARLY
+    end
+  end
+
+  def opts_to_string(opts)
+    ary = []
+    opts.each_pair do |k,v|
+      ary << "--#{k}=#{v}"
+    end
+    ary.join(' ')
+  end
+
+  def flags_to_features(*flags)
+    flags.flatten.map do |x|
+      case x
+      when /^\+/
+        x.gsub(/^\+/,'--enable-')
+      when /^-/
+        x.gsub(/^-/,'--disable-')
+      when /^\/\//, /^\s*$/
+        nil
+      else
+        raise ArgumentError, "unknown flag: #{x}"
+      end
+    end.compact.join(' ')
+  end
+
+  def define(&block)
+    raise "Already defined" if @defined
+    instance_eval(&block)
+    raise "Missing @url or @git" unless url_or_git
+
+    directory build_dir
+    directory src_dir
+
+    patches.each{|p| file(p) }
+
+
+    file(build_dir / "src.done" => [url_or_git, build_dir, src_dir] + patches) do |t|
+      sh "rm -rf #{src_dir}/*"
+      url_or_git.unpack_to src_dir
+
+      # Apply patches
+      Dir.chdir(src_dir / unpack_dir) do
+        patches.each do |p|
+          sh "patch -b -f -N -p0 < #{RakePlus.top / p}"
+        end
+      end
+
+      touch t.name
+    end
+
+    self.class.define_task(self.name.sub(/.*:/,'') => bdeps + [build_dir / "src.done"] + Dir[src_dir/'**/*'] )
+
+    @defined = true
+    self
+  end
+
+  def execute(args=nil)
+    raise "Not defined" unless @defined
+
+    # Make build-dependencies available
+    if bdeps.any?
+      rm_rf dep_dir
+      mkdir_p dep_dir
+      bdeps.each{|dep| recipe(dep).install_to(dep_dir) }
+    end
+
+    with_env(
+      :LDFLAGS => "-L#{dep_dir}/lib",
+      :CFLAGS  => "-I#{dep_dir}/include",
+      :PKG_CONFIG_PATH => "#{dep_dir}/lib/pkgconfig",
+      :PATH    => "#{dep_dir}/bin:#{ENV['PATH']}"
+    ) do
+      Dir.chdir(src_dir / unpack_dir, &install)
+    end
+
+    # remove unused stuff
+    rm_rf prefix / "man"
+    rm_rf prefix / "share" / "man"
+    sh "find #{prefix} -type d -empty -delete"
+
+    # done
+    touch build_dir / "install.done"
+    super
+  end
+
+protected
+
+  def with_env(new_env={}, &block)
+    bak = new_env.keys.inject({}) do |h,k|
+      h[k.to_s] = ENV[k.to_s]
+      h
+    end
+    new_env.each{|k,v| ENV[k.to_s] = v.to_s }
+    yield
+  ensure
+    bak.each{|k,v| ENV[k] = v }
+  end
+
+end
+
+def recipe(*args, &block)
+  Recipe.define_task(*args, &block)
+end

data/lib/rake-plus/remote_package.rb

@@ -0,0 +1,79 @@
+module Rake
+  class RemotePackage < Rake::Task
+    include Rake::DSL if defined? Rake::DSL
+
+    # Example: https://github.com/vivienschilis/segmenter/zipball/v0.0.1
+    GITHUB_MATCH = %r[^https?://github\.com/([^/]+)/([^/]+)/(zip|tar)ball/(.*)]
+    SF_MATCH = %r[^https?://sourceforge.net/.*/([^/]+)/download$]
+
+    def needed?
+      :package_missing unless File.exist?(local_path)
+    end
+
+    def local_path
+      RakePlus.cache_dir / "pkg" / basename
+    end
+
+    def basename
+      if name =~ GITHUB_MATCH
+        "#{$1}-#{$2}-#{$4}#{$3 == "zip" ? ".zip" : ".tar.gz"}"
+      elsif name =~ SF_MATCH
+        $1
+      else
+        File.basename(name.sub(/\?.*/,''))
+      end
+    end
+
+    def execute(args=nil)
+      if needed?
+        FileUtils.mkdir_p File.dirname(local_path)
+        sh "curl -L -o \"#{local_path}.tmp\" \"#{name}\""
+        mv "#{local_path}.tmp", local_path
+      end
+      super
+    end
+
+    # Utility
+    def unpack_to(dir)
+      abs_local_path = RakePlus.top_dir.expand(local_path)
+      Dir.chdir(dir) do
+        case abs_local_path
+        when /\.tar\.gz$/, /\.tgz$/
+          sh "tar xzvf \"#{abs_local_path}\""
+        when /\.tar\.bz2$/
+          sh "tar xjvf \"#{abs_local_path}\""
+        when /\.tar$/
+          sh "tar xvf \"#{abs_local_path}\""
+        else
+          raise "Unsupported file extensions of #{basename}"
+        end
+      end
+    end
+
+    # Time stamp for file task.
+    def timestamp
+      if File.exist?(local_path)
+        File.mtime(local_path)
+      else
+        Rake::EARLY
+      end
+    end
+
+    class << self
+      # Apply the scope to the task name according to the rules for this kind
+      # of task.  File based tasks ignore the scope when creating the name.
+      def scope_name(scope, task_name)
+        task_name
+      end
+    end
+  end
+end
+
+def remote_package(*args, &block)
+  t = Rake::RemotePackage.define_task(*args, &block)
+  Rake::Task["remote_packages"].prerequisites.push(t.name).uniq!
+  t
+end
+
+desc "Downloads all remote packages"
+task :remote_packages

data/lib/rake-plus/sudo.rb

@@ -0,0 +1,8 @@
+def sudo(*command)
+  raise ArgumentError, "command missing" if command.empty?
+  if command.length == 1
+    sh "sudo #{command.first}"
+  else
+    sh "sudo", *command
+  end
+end

data/lib/rake-plus/svn_dep.rb

@@ -0,0 +1,63 @@
+require 'uri'
+
+module Rake
+  class SvnDependency < Rake::Task
+    include Rake::DSL if defined? Rake::DSL
+
+    def branch(val = nil)
+      @branch = val if val
+      @branch || "trunk"
+    end
+
+    def needed?
+      return :checkout_missing unless File.directory?(local_path)
+    end
+
+    def timestamp
+      if File.exist?(local_path / 'svn')
+        File.mtime(local_path / 'svn')
+      else
+        Rake::EARLY
+      end
+    end
+    
+    def local_path
+      RakePlus.cache_dir / "svn" / basename
+    end
+
+    def basename
+      base = File.basename(name)
+    end
+
+    def execute(args=nil)
+      if File.directory?(local_path)
+        Dir.chdir(local_path) do
+          sh "svn update"
+        end
+      else
+        FileUtils.mkdir_p File.dirname(local_path)
+        sh "svn checkout #{name}/#{branch} #{local_path}"
+      end
+      super
+    end
+
+    # Like .tar archives, creates a folder beneath it
+    def unpack_to(dir)
+      sh "cp -R #{local_path} #{dir}"
+    end
+
+    class << self
+      # Git based tasks ignore the scope when creating the name.
+      def scope_name(scope, task_name); task_name end
+    end
+  end
+end
+
+# Usage: git("git@github.com:zimbatm/direnv.git")
+#
+
+
+def svn(*args, &block)
+  Rake::SvnDependency.define_task(*args, &block)
+end
+alias svn_dep svn

data/lib/rake-plus/tpl.rb

@@ -0,0 +1,11 @@
+require 'ostruct'
+require 'erb'
+
+def tpl(name, target, variables={})
+  ctx = OpenStruct.new(variables)
+  tpl_str = File.read(RakePlus.template_dir / "#{name}.erb")
+  tpl = ERB.new(tpl_str)
+  out = tpl.result ctx.send(:binding)
+  FileUtils.mkdir_p File.dirname(target)
+  File.open(target, 'w') do |f| f.write out end
+end

data/lib/rake-plus/trace.rb

@@ -0,0 +1,4 @@
+# Tired of re-running your rake task with -t because it throwed an exception ?
+#
+# This will turn on the trace by default so that you don't have to do it again.
+Rake.application.options.trace = true

data/lib/rake-plus.rb

@@ -0,0 +1,16 @@
+require 'rake-plus/trace'
+require 'rake-plus/path'
+
+module RakePlus
+  @top = path(Dir.pwd)
+  @cache_dir = @top / '.cache'
+  @build_dir = @top / 'build'
+  @template_dir = @top / 'tpl'
+
+  class << self
+    attr_reader :top
+    attr_accessor :cache_dir
+    attr_accessor :build_dir
+    attr_accessor :template_dir
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rake-plus
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
+platform: ruby
+authors:
+- Jonas Pfenniger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A collection of rake extensions that are useful all around
+email: jonas@pfenniger.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rake-plus/bdep.rb
+- lib/rake-plus/git_dep.rb
+- lib/rake-plus/gitver.rb
+- lib/rake-plus/path.rb
+- lib/rake-plus/rake_ext.rb
+- lib/rake-plus/recipe.rb
+- lib/rake-plus/remote_package.rb
+- lib/rake-plus/sudo.rb
+- lib/rake-plus/svn_dep.rb
+- lib/rake-plus/tpl.rb
+- lib/rake-plus/trace.rb
+- lib/rake-plus.rb
+homepage: https://github.com/zimbatm/rake-plus
+licenses: []
+post_install_message: 
+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.19
+signing_key: 
+specification_version: 3
+summary: A shiny rake extensions collection
+test_files: []