metarake 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*~
+*.gem
+*.rbc
+\#*
+.#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metarake.gemspec
+gemspec
+
+group :development do
+  gem "pry"
+  gem "yard"
+  gem "redcarpet"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Maciej Pasternacki
+
+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,46 @@
+# Metarake
+
+Metarake is a Rake extension to build multiple separate projects,
+which are published outside the repository.
+
+Usually, Metarake's Rakefile lives in the directory that contains
+subdirectories with separate projects, each with their own build
+script (`Rakefile`, `Makefile`, `build.xml`, you name it). What
+metarake does, is:
+
+ - Discover the projects,
+ - Discover their build targets,
+ - Verify whether those targets are already published,
+ - Build all unpublished targets and publish them.
+
+Each of these steps can be customized. A sample custom class is
+provided for building Debian packages and publishing them in an Apt
+repository.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metarake'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metarake
+
+## Usage
+
+Sample rakefiles are included in the `examples/` directory, and
+detailed API documentation can be found at
+http://rdoc.info/github/3ofcoins/metarake/.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => :features

data/examples/Rakefile.basic

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'metarake'
+
+class MetaTask < MetaRake::Task
+  include MetaRake::Builder::Rake
+  include MetaRake::Publisher::Directory
+  self.publish_path = "_published"
+end
+
+task :default => MetaTask.discover!

data/features/basic.feature

@@ -0,0 +1,67 @@
+Feature: basic features
+
+Background:
+  Given subdirectories "foo", "bar", "baz"
+  And following files:
+    | path         | source                                |
+    | Rakefile     | examples/Rakefile.basic               |
+    | foo/Rakefile | features/files/Rakefile.one_two_three |
+    | bar/Rakefile | features/files/Rakefile.one_two_three |
+    | baz/Rakefile | features/files/Rakefile.one_two_three |
+
+Scenario: a simple run
+  When I run "rake --trace"
+  Then the command succeeds
+  And following files exist:
+    | path                 | content |
+    | foo/one              | ONE     |
+    | foo/two              | TWO     |
+    | foo/three            | THREE   |
+    | bar/one              | ONE     |
+    | bar/two              | TWO     |
+    | bar/three            | THREE   |
+    | baz/one              | ONE     |
+    | baz/two              | TWO     |
+    | baz/three            | THREE   |
+    | _published/foo/one   | ONE     |
+    | _published/foo/two   | TWO     |
+    | _published/foo/three | THREE   |
+    | _published/bar/one   | ONE     |
+    | _published/bar/two   | TWO     |
+    | _published/bar/three | THREE   |
+    | _published/baz/one   | ONE     |
+    | _published/baz/two   | TWO     |
+    | _published/baz/three | THREE   |
+
+Scenario: one of the directories are published
+  Given subdirectory "_published"
+  And following files:
+    | path                 | content |
+    | _published/baz/one   | JEDEN   |
+    | _published/baz/two   | DWA     |
+    | _published/baz/three | TRZY    |
+  When I run "rake"
+  Then the command succeeds
+  And following files exist:
+    | path                 | content |
+    | foo/one              | ONE     |
+    | foo/two              | TWO     |
+    | foo/three            | THREE   |
+    | bar/one              | ONE     |
+    | bar/two              | TWO     |
+    | bar/three            | THREE   |
+    | _published/foo/one   | ONE     |
+    | _published/foo/two   | TWO     |
+    | _published/foo/three | THREE   |
+    | _published/bar/one   | ONE     |
+    | _published/bar/two   | TWO     |
+    | _published/bar/three | THREE   |
+    | _published/baz/one   | JEDEN   |
+    | _published/baz/two   | DWA     |
+    | _published/baz/three | TRZY    |
+  And following files do not exist:
+    | path      |
+    | baz/one   |
+    | baz/two   |
+    | baz/three |
+

data/features/files/Rakefile.one_two_three

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+%w(one two three).each do |tgt|
+  desc "Create file '#{tgt}'"
+  file tgt do |t|
+    File.open(t.to_s, 'w') { |f| f.puts(tgt.upcase) }
+  end
+end

data/features/step_definitions/basic.rb

@@ -0,0 +1,42 @@
+Given(/^subdirector(?:y|ies) ("[^"]*"(?:, "[^"]*")*)$/) do |subdirectories|
+  subdirectories.
+    split(/,\s*/).
+    map { |sd| sd.gsub(/^"|"$/, '') }.
+    each { |sd| FileUtils::mkdir_p(sd) }
+end
+
+Given /^following files:$/ do |table|
+  table.hashes.each do |ff|
+    FileUtils::mkdir_p(File.dirname(ff[:path]))
+    if ff[:source]
+      FileUtils::cp(File.join(@orig_wd, ff[:source]), ff[:path])
+    elsif ff[:content]
+      File.open(ff[:path], 'w') { |f| f.puts(ff[:content]) }
+    else
+      FileUtils::touch(ff[:path])
+    end
+  end
+end
+
+When /^I run "(.*?)"$/ do |command|
+  @shellout = Mixlib::ShellOut.new(command)
+  @shellout.run_command
+end
+
+Then /^the command succeeds$/ do
+  @shellout.error!
+end
+
+Then /^following files exist:$/ do |table|
+  table.hashes.each do |ff|
+    File.exist?(ff[:path]).should be true
+    File.read(ff[:path]).should include ff[:content] if ff[:content]
+  end
+end
+
+Then /^following files do not exist:$/ do |table|
+  table.hashes.each do |ff|
+    File.exist?(ff[:path]).should be false
+  end
+end
+

data/features/support/env.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+require 'tmpdir'
+
+require 'rspec/expectations'
+require 'mixlib/shellout'
+
+
+# Run each test in a temporary directory, initialized as a git repository
+FileUtils::mkdir_p 'tmp'
+
+Before do
+  @orig_wd = Dir.getwd
+  @tmp_wd = Dir.mktmpdir(nil, 'tmp')
+  Dir.chdir(@tmp_wd)
+end
+
+After do
+  Dir::chdir(@orig_wd)
+  if ENV['DEBUG']
+    puts "Keeping working directory #{@tmp_wd} for debugging"
+  else
+    FileUtils::rm_rf(@tmp_wd)
+  end
+  @tmp_wd = nil
+end

data/lib/metarake/builder/rake.rb

@@ -0,0 +1,78 @@
+require 'mixlib/shellout'
+
+module MetaRake::Builder::Rake
+  extend MetaRake::Magic
+
+  module ClassMethods
+    # Command that should be used to run Rake for projects (default: `'rake'`)
+    attr_accessor :rake_command
+
+    # Filter for discovered target names.
+    # @see Metarake::Builder::Rake#project_target?
+    attr_accessor :target_filter
+
+    # Projects are subdirectories that have a Rakefile.
+    def projects
+      Dir['*/Rakefile'].map { |rakefile| File.dirname(rakefile) }
+    end
+  end
+
+  # Create a sub-task for each of project targets.
+  def initialize(*args)
+    super
+
+    self.targets.each do |tgt|
+      tgt_f = application.define_task(Rake::FileTask, File.join(self.to_s, tgt))
+      tgt_f.comment = "Build #{tgt} in #{self}"
+      tgt_f.enhance([self])
+    end
+  end
+
+  # Decide, whether a target listed by `rake -T` is a project target.
+  #
+  # Default implementation decides based on
+  # {MetaRake::Builder::Rake.target_filter}, based on its
+  # type. When target_filter is a:
+  # 
+  # [nil] All targets returned by `rake -T` are project targets (default)
+  # [Regex] Targets whose names match the regular expression are
+  #         project targets
+  # [String] Targets whose names include the string are project targets
+  # [Proc] It is called with a target name as an argument; if it returns
+  #        true, the target is a project target.
+  def project_target?(target_name)
+    case self.class.target_filter
+    when nil    ; true
+    when Regexp ; dir_targets_filter =~ target
+    when Proc   ; dir_targets_filter.call(target)
+    when String ; target.include?(dir_targets_filter)
+    end
+  end
+
+  # @return [Array] Project target names, as returned by `rake -T`
+  #                 and filtered by {#project_target?}
+  def targets
+    @targets ||= 
+      begin
+        cmd = Mixlib::ShellOut.new(rake_command+['-T'], :cwd => self.to_s)
+        cmd.run_command.error!
+        cmd.stdout.lines.
+          map { |ln| tgt=ln.split[1] ; tgt if self.project_target?(tgt) }.
+          compact
+      end
+  end
+
+  def build
+    Dir.chdir(self.to_s) do
+      print "[#{self}/] "
+      sh *(rake_command+targets)
+    end
+  end
+
+  private
+  def rake_command
+    cmd = self.class.rake_command || 'rake'
+    cmd = cmd.split if cmd.respond_to?(:split)
+    cmd
+  end
+end # MetaRake::Builder::Rake

data/lib/metarake/publisher/directory.rb

@@ -0,0 +1,31 @@
+require 'rake/file_utils'
+
+module MetaRake::Publisher::Directory
+  extend MetaRake::Magic
+  include FileUtils
+
+  module ClassMethods
+    # Path, in which the targets are published.
+    attr_accessor :publish_path
+  end
+
+  # @return class attribute @publish_path
+  # @raises @ValueError if `publish_path` is unset
+  def publish_path
+    self.class.publish_path or raise ValueError, "#{self.class}.publish_path is not set"
+  end
+
+  # True if all project targets are copied to the publish path
+  def published?
+    self.targets.map { |tgt| File.exist?(File.join(
+          self.publish_path, self.to_s, tgt)) }.all?
+  end
+
+  # Copy all the project targets to the publish path
+  def publish!
+    mkdir_p File.join(self.publish_path, self.to_s)
+    self.targets.each do |tgt|
+      install File.join(self.to_s, tgt), File.join(self.publish_path, self.to_s, tgt)
+    end
+  end
+end

data/lib/metarake/publisher/freight.rb

@@ -0,0 +1,53 @@
+require 'mixlib/shellout'
+
+# Metarake publisher that pushes `.deb` Debian packages to a Freight
+# apt repository (https://github.com/rcrowley/freight).
+module MetaRake::Publisher::Directory
+  extend MetaRake::Magic
+
+  module ClassMethods
+    # Path of Freight configuration file
+    attr_accessor :freight_conf_path
+
+    # Distribution to use when publishing to / searching in the Freight repository
+    attr_accessor :freight_distro
+
+    # Command to run Freight (default: "freight")
+    attr_accessor :freight_command
+
+    # @return [Hash] freight config, plus some random shell environment.
+    def freight_conf
+      @freight_conf ||=
+        begin
+          raise ValueError, "#{self}.freight_conf_path is not set" unless freight_conf_path
+          conf = Mixlib::ShellOut.new('env', '-i', '/bin/sh', '-c', ". #{freight_conf_path} ; set")
+          conf.run_command.error!
+          Hash[ conf.stdout.lines.map { |ln| ln.strip.split('=', 2) } ]
+        end
+    end
+  end
+
+  # True if all project targets are added to the repository
+  def published?
+    raise ValueError, "#{self.class}.freight_distro is not set" unless self.class.freight_distro
+    self.targets.map { |tgt| File.exist?(File.join(
+          self.class.freight_conf['VARLIB'], self.class.freight_distro, tgt)) }.all?
+  end
+
+  # Add files to the freight repo and publish them
+  def publish!
+    self.targets.each do |tgt|
+      sh *(self.freight_command('add') + [
+          File.join(self.to_s, tgt),
+          "apt/#{self.class.freight_distro}" ])
+    end
+    sh *(self.freight_command('cache'))
+  end
+
+  private
+  def freight_command(cmd)
+    cmd = self.class.freight_command || 'freight'
+    cmd = cmd.split if cmd.respond_to?(:split)
+    cmd + [ cmd, '-c' self.class.freight_conf_path ]
+  end
+end

data/lib/metarake/task.rb

@@ -0,0 +1,72 @@
+require 'rake/task'
+require 'rake/file_utils'
+
+module MetaRake
+  # An abstract Rake task that builds a project if it is not
+  # published.  The individual methods need to be implemented in
+  # a subclass. Concrete implementation are provided in
+  # {MetaRake::Builder} and {MetaRake::Publisher} modules. Complete
+  # sample Rakefiles are included in the {file:examples examples
+  # directory}.
+  class Task < Rake::Task
+    include FileUtils
+
+    class << self
+      # @abstract Discover projects to build.
+      # @return [Enumerable] discovered project names
+      def projects
+        raise NotImplementedError
+      end
+
+      # Discover projects and build tasks for them.
+      #
+      # @return [Enumerable] tasks defined for each of projects returned by {#projects}
+      # @see #projects
+      def discover!
+        projects.map do |prj|
+          t = Rake.application.define_task(self, prj)
+          t.comment = "Build #{prj}"
+          t
+        end
+      end
+    end
+
+    # @abstract Check whether the project has been published
+    # @return [TrueClass, FalseClass] True if project is already published and doesn't need to be rebuilt.
+    def published?
+      raise NotImplementedError
+    end
+
+    # @abstract Publishes the project
+    # Runs after the project has been built in order to publish the build artifacts.
+    def publish!
+      raise NotImplementedError
+    end
+
+    # @abstract Array of project's targets
+    def targets
+      raise NotImplementedError
+    end
+
+    # Automatically add action calling the {#build} method if it's dtefined.
+    def initialize(*args)
+      super
+      @actions << lambda { |t| t.build } if self.respond_to?(:build)
+    end
+
+    # Project is "needed" only if it's not published.
+    def needed?
+      !self.published?
+    end
+
+    # Publish the project after executing the task.
+    def execute(*args)
+      super
+      if application.options.dryrun
+        $stderr.puts "** Publish (dry run) #{name}"
+      else
+        self.publish!
+      end
+    end
+  end
+end

data/lib/metarake/version.rb

@@ -0,0 +1,3 @@
+module MetaRake
+  VERSION = "0.1.0"
+end

data/lib/metarake.rb

@@ -0,0 +1,23 @@
+require "metarake/version"
+
+# A Rake extension to build multiple separate projects, which are
+# published outside the repository.
+module MetaRake
+  # Builder mixin modules for {MetaRake::Task}
+  module Builder ; end
+
+  # Publisher mixin modules for {MetaRake::Task}
+  module Publisher ; end
+
+  # Magic glue to be included in Publisher and Builder classes via extend.
+  module Magic
+    # Add modules' ClassMethods submodule to the class it's being included in.
+    def included(base)
+      base.extend(self::ClassMethods) if defined?(self::ClassMethods)
+    end
+  end
+end
+
+require 'metarake/task'
+require 'metarake/builder/rake'
+require 'metarake/publisher/directory'

data/metarake.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/metarake/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Maciej Pasternacki"]
+  gem.email         = ["maciej@pasternacki.net"]
+  gem.description   = "A Rake extension to build multiple separate projects, published outside the repository"
+  gem.summary       = "Rake extension to manage multiple builds"
+  gem.homepage      = "https://github.com/3ofcoins/metarake/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "metarake"
+  gem.require_paths = ["lib"]
+  gem.version       = MetaRake::VERSION
+
+  gem.add_dependency "rake", ">= 0.9.2"
+  gem.add_dependency "mixlib-shellout"
+
+  gem.add_development_dependency "cucumber"
+  gem.add_development_dependency 'rspec-expectations'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: metarake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Maciej Pasternacki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-23 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.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: rspec-expectations
+  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'
+description: A Rake extension to build multiple separate projects, published outside
+  the repository
+email:
+- maciej@pasternacki.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/Rakefile.basic
+- features/basic.feature
+- features/files/Rakefile.one_two_three
+- features/step_definitions/basic.rb
+- features/support/env.rb
+- lib/metarake.rb
+- lib/metarake/builder/rake.rb
+- lib/metarake/publisher/directory.rb
+- lib/metarake/publisher/freight.rb
+- lib/metarake/task.rb
+- lib/metarake/version.rb
+- metarake.gemspec
+homepage: https://github.com/3ofcoins/metarake/
+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'
+      segments:
+      - 0
+      hash: 2320268432724083561
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2320268432724083561
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rake extension to manage multiple builds
+test_files:
+- features/basic.feature
+- features/files/Rakefile.one_two_three
+- features/step_definitions/basic.rb
+- features/support/env.rb
+has_rdoc: