packager-dsl 0.0.1

data/bin/packager

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems' unless defined? Gem
+require 'packager/cli'
+
+Packager::CLI.start

data/lib/packager.rb

@@ -0,0 +1,5 @@
+require 'packager/version'
+
+require 'packager/cli'
+require 'packager/dsl'
+require 'packager/executor'

data/lib/packager/cli.rb

@@ -0,0 +1,72 @@
+require 'thor'
+
+require 'packager'
+
+class Packager::CLI < Thor
+  # Make sure to exit(1) on failure. This isn't covered in the specs.
+  # :nocov:
+  def self.exit_on_failure?
+    true
+  end
+  # :nocov:
+
+  # Taken from http://stackoverflow.com/a/27804972/1732954
+  map %w[--version] => :__print_version
+  desc "--version", "Print the version"
+  def __print_version
+    puts Packager::VERSION
+  end
+
+  desc :execute, "Execute one or more package DSL definition(s)"
+  default_task :execute
+  def execute(*args)
+    if args.empty?
+      raise Thor::Error, "No filenames provided for execute"
+    end
+
+    args.each do |filename|
+      unless File.exists? filename
+        raise Thor::Error, "'#{filename}' cannot be found"
+      end
+
+      begin
+        items = Packager::DSL.parse_dsl(IO.read(filename))
+      rescue Exception => e
+        raise Thor::Error, "'#{filename}' has the following errors:\n#{e}"
+      end
+
+      if items.empty?
+        raise Thor::Error, "'#{filename}' produces nothing"
+      end
+
+      packages = Packager::Executor.new.execute_on(items)
+
+      puts "'#{filename}' executed #{packages.join(', ')}"
+    end
+  end
+
+  desc :validate, "Validate one or more package DSL definition(s)"
+  def validate(*args)
+    if args.empty?
+      raise Thor::Error, "No filenames provided for validate"
+    end
+
+    args.each do |filename|
+      unless File.exists? filename
+        raise Thor::Error, "'#{filename}' cannot be found"
+      end
+
+      begin
+        items = Packager::DSL.parse_dsl(IO.read(filename))
+      rescue Exception => e
+        raise Thor::Error, "'#{filename}' has the following errors:\n#{e}"
+      end
+
+      if items.empty?
+        raise Thor::Error, "'#{filename}' produces nothing"
+      end
+
+      puts "'#{filename}' parses cleanly"
+    end
+  end
+end

data/lib/packager/dsl.rb

@@ -0,0 +1,55 @@
+require 'packager/version'
+require 'packager/struct'
+
+require 'dsl/maker'
+
+class Packager::DSL < DSL::Maker
+  class << self
+    attr_writer :default_type
+    def default_type(*args)
+      @default_type = args[0] unless args.empty?
+      @default_type
+    end
+  end
+
+  add_type(VersionString = {}) do |attr, *args|
+    unless args.empty?
+      begin
+        ___set(attr, Gem::Version.new(args[0]).to_s)
+      rescue ArgumentError
+        raise "'#{args[0]}' is not a legal version string" 
+      end
+    end
+    ___get(attr)
+  end
+
+  copy_file_dsl = generate_dsl({
+    :source => String,
+    :dest   => String,
+  }) do
+    Packager::Struct::File.new(source, dest)
+  end
+
+  add_entrypoint(:package, {
+    :name => String,
+    :version => VersionString,
+    :type => Any,
+    :files => ArrayOf[copy_file_dsl],
+    :file => AliasOf(:files),
+    :requires => ArrayOf[String],
+    :provides => ArrayOf[String],
+  }) do |*args|
+    type(Packager::DSL.default_type) unless type
+    default(:name, args, 0)
+
+    Packager::Struct::Package.new(
+      name, version, type, files, requires, provides,
+    )
+  end
+  add_verification(:package) do |item|
+    return 'Every package must have a name' unless item.name
+    return 'Every package must have a version' unless item.version
+    return 'Every package must have a type' unless item.type
+    return
+  end
+end

data/lib/packager/executor.rb

@@ -0,0 +1,63 @@
+require 'packager/version'
+
+require 'tmpdir'
+
+class Packager
+  class Executor
+    attr_accessor :commands, :dryrun
+
+    def initialize(opts={})
+      self.dryrun = !!opts[:dryrun]
+      self.commands = []
+    end
+
+    def execute_on(items)
+      curdir = Dir.pwd
+      items.collect do |item|
+        Dir.mktmpdir do |tempdir|
+          Dir.chdir(tempdir) do
+            path = create_package_for(item)
+            FileUtils.mv(path, curdir) if path
+          end
+        end
+      end
+    end
+
+    def create_package_for(item)
+      unless item.files.empty?
+        item.files.each do |file|
+          dest = (file.dest || '').gsub /^\//, ''
+          FileUtils.mkdir_p File.dirname(dest)
+          FileUtils.cp_r(file.source, dest)
+        end
+      end
+
+      cmd = Packager::Struct::Command.new(
+        :name     => item.name,
+        :version  => item.version,
+        :target   => item.type,
+        :requires => item.requires,
+        :provides => item.provides,
+      )
+
+      Dir.glob('*') do |entry|
+        if File.directory?(entry)
+          cmd.add_directory(entry)
+        end
+      end
+
+      commands.push(cmd)
+
+      execute_command(cmd)
+    end
+
+    def execute_command(cmd)
+      return if dryrun
+
+      x = `#{cmd.to_system.join(' ')}`
+      rv = eval(x)
+      raise rv[:error] if rv[:error]
+      return rv[:path]
+    end
+  end
+end

data/lib/packager/struct.rb

@@ -0,0 +1,80 @@
+require 'packager/version'
+
+# This exists so that you can pass in a Hash or an Array. While passing an Array
+# can be useful, passing in a Hash is far more self-documenting.
+class Packager::Struct < Struct
+  def initialize(*args)
+    if args.length == 1 and args[0].instance_of?(Hash)
+      difference = Set.new(args[0].keys) - Set.new(self.class.members)
+      unless difference.empty?
+        raise 'Passed in unknown params: ' + difference.to_a.sort.join(', ')
+      end
+      super(*args[0].values_at(*self.class.members))
+    else
+      super(*args)
+    end
+  end
+
+  class Package < Packager::Struct.new(
+    :name, :version, :type, :files, :requires, :provides,
+  )
+    def initialize(*args)
+      super(*args)
+      self.files ||= []
+      self.requires ||= []
+      self.provides ||= []
+    end
+  end
+
+  class File < Packager::Struct.new(
+    :source, :dest,
+  )
+  end
+
+  class Command < Packager::Struct.new(
+    :executable, :name, :version,
+    :source, :target, :directories, :requires, :provides,
+  )
+    class << self
+      attr_accessor :default_executable
+    end
+
+    def initialize(*args)
+      super(*args)
+      self.source ||= 'empty'
+      self.executable ||= self.class.default_executable || 'fpm'
+      self.directories ||= {}
+      self.requires ||= []
+      self.provides ||= []
+    end
+
+    def add_directory(*items)
+      self.source = 'dir'
+      items.each do |item|
+        directories[item] = true
+      end
+    end
+
+    def to_system
+      cmd = [
+        executable,
+        '--name', name,
+        '--version', version,
+      ]
+
+      self.requires.uniq.each do |req|
+        cmd.concat(['--depends', req])
+      end
+
+      self.provides.uniq.each do |req|
+        cmd.concat(['--provides', req])
+      end
+
+      cmd.concat(['-s', source, '-t', target])
+      cmd.concat(directories.keys)
+
+      return cmd
+    end
+  end
+end
+

data/lib/packager/version.rb

@@ -0,0 +1,3 @@
+class Packager
+  VERSION = '0.0.1'
+end

data/on_what.rb

@@ -0,0 +1,15 @@
+# NOTE: Very simple tests for what system we are on, extracted for sharing
+#   between Rakefile, gemspec, and spec_helper. Not for use in actual library.
+# This is copied from https://github.com/ms-ati/docile/blob/master/on_what.rb
+
+def on_travis?
+  ENV['CI'] == 'true'
+end
+
+def on_jruby?
+  defined?(RUBY_ENGINE) && 'jruby' == RUBY_ENGINE
+end
+
+def on_1_8?
+  RUBY_VERSION.start_with? '1.8'
+end

data/packager.gemspec

@@ -0,0 +1,44 @@
+require File.expand_path('on_what', File.dirname(__FILE__))
+$:.push File.expand_path('../lib', __FILE__)
+require 'packager/version'
+
+Gem::Specification.new do |s|
+  s.name    = 'packager-dsl'
+  s.version = Packager::VERSION
+  s.author  = 'Rob Kinyon'
+  s.email   = 'rob.kinyon@gmail.com'
+  s.summary = 'DSL for creating packages'
+  s.description = 'DSL for creating a package that is easy to work with.'
+  s.license = 'GPL2'
+  s.homepage = 'https://github.com/robkinyon/ruby-packager'
+
+  # Don't tramp along our dot-files, except for .rspec
+  s.files         = `git ls-files`.split("\n").select { |filename|
+    !filename.match(/^\./) || filename == '.rspec'
+  }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- {bin}/*`.split("\n")
+  s.require_paths = %w(lib)
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'dsl_maker', '~> 0.1', '>= 0.1.1'
+  s.add_dependency 'fpm', '~> 1.4', '>= 1.1.0'
+  s.add_dependency 'thor', '~> 0.0', '>= 0.19.0'
+
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'rspec', '~> 3.0.0', '>= 3.0.0'
+  s.add_development_dependency 'simplecov', '~> 0'
+  s.add_development_dependency 'rubygems-tasks', '~> 0'
+  s.add_development_dependency 'json', '~> 1', '>=1.7.7'
+
+  # To limit needed compatibility with versions of dependencies, only configure
+  #   yard doc generation when *not* on Travis, JRuby, or 1.8
+  if !on_travis? && !on_jruby? && !on_1_8?
+    # Github flavored markdown in YARD documentation
+    # http://blog.nikosd.com/2011/11/github-flavored-markdown-in-yard.html
+    s.add_development_dependency 'yard', '~> 0.8'
+    s.add_development_dependency 'redcarpet', '~> 3'
+    s.add_development_dependency 'github-markup', '~> 1.3'
+  end
+end

data/spec/cli/context.rb

@@ -0,0 +1,17 @@
+# Examine:
+# https://gabebw.wordpress.com/2011/03/21/temp-files-in-rspec/
+
+require 'fileutils'
+require 'tmpdir'
+
+RSpec.shared_context :cli do
+  subject(:cli) { Packager::CLI.new }
+
+  let(:workdir) { Dir.mktmpdir }
+  before(:all)  { @dir = Dir.pwd }
+  before(:each) { FileUtils.chdir(workdir) }
+  after(:each)  {
+    FileUtils.chdir @dir
+    FileUtils.remove_entry_secure(workdir)
+  }
+end

data/spec/cli/execute_spec.rb

@@ -0,0 +1,79 @@
+require './spec/cli/context.rb'
+describe Packager::CLI do
+  context '#execute' do
+    include_context :cli
+
+    it "handles nothing passed" do
+      expect {
+        cli.execute
+      }.to raise_error(Thor::Error, "No filenames provided for execute")
+    end
+
+    it "handles a non-existent filename" do
+      expect {
+        cli.execute('foo')
+      }.to raise_error(Thor::Error, "'foo' cannot be found")
+    end
+
+    it "handles an empty file" do
+      FileUtils.touch('definition')
+      expect {
+        cli.execute('definition')
+      }.to raise_error(Thor::Error, "'definition' produces nothing")
+    end
+
+    it "handles a bad file" do
+      append_to_file('definition', 'package {}')
+
+      expect {
+        cli.execute('definition')
+      }.to raise_error(Thor::Error, "'definition' has the following errors:\nEvery package must have a name")
+    end
+
+    context "handles a file that works" do
+      before {
+        expect(Packager::DSL).to(
+          receive(:parse_dsl).
+          with('contents').
+          and_return(:stuff)
+        )
+
+        expect_any_instance_of(Packager::Executor).to(
+          receive(:execute_on).
+          with(:stuff).
+          and_return(['foo'])
+        )
+      }
+
+      it {
+        append_to_file('definition', 'contents')
+        expect(
+          capture(:stdout) { cli.execute('definition') }
+        ).to eq("'definition' executed foo\n")
+      }
+    end
+
+    context "handles a file that works with two packages" do
+      before {
+        expect(Packager::DSL).to(
+          receive(:parse_dsl).
+          with('contents').
+          and_return(:stuff)
+        )
+
+        expect_any_instance_of(Packager::Executor).to(
+          receive(:execute_on).
+          with(:stuff).
+          and_return(['foo', 'bar'])
+        )
+      }
+
+      it {
+        append_to_file('definition', 'contents')
+        expect(
+          capture(:stdout) { cli.execute('definition') }
+        ).to eq("'definition' executed foo, bar\n")
+      }
+    end
+  end
+end