packager-dsl 0.0.1

data/spec/integration/context.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+require 'tmpdir'
+
+require './spec/shared_context/workdir.rb'
+RSpec.shared_context :integration do
+  include_context :workdir
+
+  before(:all) { Packager::DSL.default_type('test') }
+  after(:all) { Packager::DSL.default_type = nil }
+
+  # This is to get access to the 'test' FPM type in the FPM executable.
+  before(:all) {
+    Packager::Struct::Command.default_executable =
+      "ruby -I#{File.join(@dir,'spec/lib')} -rfpm/package/test `which fpm`"
+  }
+  after(:all) {
+    Packager::Struct::Command.default_executable = 'fpm'
+  }
+
+  before(:each) { $sourcedir = sourcedir }
+  before(:all) {
+    Packager::DSL.add_helper(:sourcedir) do |path|
+      File.join($sourcedir, path)
+    end
+  }
+  after(:all) {
+    Packager::DSL.remove_helper(:sourcedir)
+  }
+end
+
+RSpec.shared_context :test_package do
+  # This is used to verify the FPM/test package format is created properly.
+  def verify_test_package(name, metadata={}, files={})
+    expect(File).to exist(name)
+    expect(File).to exist(File.join(name, 'META.json'))
+    expect(JSON.parse(IO.read(File.join(name, 'META.json')))).to eq({
+      'requires' => [],
+      'provides' => [],
+    }.merge(metadata))
+    if files.empty?
+      expect(Dir[File.join(name, 'contents/*')].empty?).to be(true)
+    else
+      file_expectations = files.clone
+      Dir[File.join(name, 'contents/**/*')].each do |filename|
+        if File.file?(filename)
+          content = IO.read(filename)
+          filename.gsub! /#{File.join(name, 'contents', '')}/, ''
+
+          expect(file_expectations).to have_key(filename)
+          expect(file_expectations[filename]).to eq(content)
+          file_expectations.delete(filename)
+        end
+      end
+      expect(file_expectations).to be_empty
+    end
+  end
+end

data/spec/integration/dependency_spec.rb

@@ -0,0 +1,51 @@
+require './spec/integration/context.rb'
+describe "Packager integration" do
+  context "dependencies" do
+    include_context :integration
+    include_context :test_package
+
+    it "can create a package with 1 dependency" do
+      append_to_file('definition', "
+        package {
+          name 'foo'
+          version '0.0.1'
+          requires 'bar'
+        }
+      ")
+
+      FileUtils.chdir(workdir) do
+        capture(:stdout) {
+          Packager::CLI.start(['execute', './definition'])
+        }
+
+        verify_test_package('foo.test', {
+          'name' => 'foo',
+          'version' => '0.0.1',
+          'requires' => ['bar'],
+        })
+      end
+    end
+
+    it "can create a package with 1 provides" do
+      append_to_file('definition', "
+        package {
+          name 'foo'
+          version '0.0.1'
+          provides 'bar'
+        }
+      ")
+
+      FileUtils.chdir(workdir) do
+        capture(:stdout) {
+          Packager::CLI.start(['execute', './definition'])
+        }
+
+        verify_test_package('foo.test', {
+          'name' => 'foo',
+          'version' => '0.0.1',
+          'provides' => ['bar'],
+        })
+      end
+    end
+  end
+end

data/spec/integration/files_spec.rb

@@ -0,0 +1,104 @@
+# Because of the vagaries of producing OS-specific packages on varying platforms,
+# we will test command execution using a new output target for FPM called 'test.
+# This target is based on the 'dir' target and exists in spec/lib.
+#
+# Note: We assume that fpm produces good packages of other types, given a correct
+# invocations.
+
+require './spec/integration/context.rb'
+describe "Packager integration" do
+  context 'files' do
+    include_context :integration
+    include_context :test_package
+
+    it "can create a package with no files" do
+      append_to_file('definition', "
+        package {
+          name 'foo'
+          version '0.0.1'
+        }
+      ")
+
+      FileUtils.chdir(workdir) do
+        capture(:stdout) {
+          Packager::CLI.start(['execute', './definition'])
+        }
+
+        verify_test_package('foo.test', {
+          'name' => 'foo',
+          'version' => '0.0.1',
+        })
+      end
+    end
+
+    it "can create a package with one file" do
+      FileUtils.chdir(sourcedir) do
+        FileUtils.touch('file1')
+      end
+
+      append_to_file('definition', "
+        package {
+          name 'foo'
+          version '0.0.1'
+
+          file {
+            source sourcedir('file1')
+            dest '/foo/bar/file2'
+          }
+        }
+      ")
+
+      # Stub out execute_command
+      FileUtils.chdir(workdir) do
+        capture(:stdout) {
+          Packager::CLI.start(['execute', './definition'])
+        }
+
+        verify_test_package('foo.test', {
+          'name' => 'foo',
+          'version' => '0.0.1',
+        }, {
+          'foo/bar/file2' => '',
+        })
+      end
+    end
+
+    it "can create a package with two files" do
+      FileUtils.chdir(sourcedir) do
+        FileUtils.touch('file1')
+        append_to_file('file3', 'stuff')
+      end
+
+      append_to_file('definition', "
+        package {
+          name 'foo'
+          version '0.0.1'
+
+          file {
+            source sourcedir('file1')
+            dest '/foo/bar/file2'
+          }
+
+          file {
+            source sourcedir('file3')
+            dest '/bar/foo/file4'
+          }
+        }
+      ")
+
+      FileUtils.chdir(workdir) do
+        capture(:stdout) {
+          Packager::CLI.start(['execute', './definition'])
+        }
+
+        verify_test_package('foo.test', {
+          'name' => 'foo',
+          'version' => '0.0.1',
+        }, {
+          'foo/bar/file2' => '',
+          'bar/foo/file4' => 'stuff',
+        })
+      end
+    end
+  end
+end

data/spec/lib/fpm/package/test.rb

@@ -0,0 +1,27 @@
+require 'fpm/package/dir'
+
+require 'fileutils'
+
+class FPM::Package::Test < FPM::Package::Dir
+  # Trigger the inherited capture of subclasses.
+  FPM::Package.inherited(FPM::Package::Test)
+
+  def output(output_path)
+    output_check(output_path)
+
+    # We have to create the ouput_path so that the Dir type will write out to the
+    # contents subdirectory.
+    FileUtils.mkdir_p output_path
+    super(File.join(output_path, 'contents'))
+
+    # Write out the META.json file.
+    File.open(File.join(output_path, 'META.json'), 'w') do |f|
+      f.write({
+        :name => name,
+        :version => version,
+        :requires => dependencies.sort,
+        :provides => provides.sort,
+      }.to_json)
+    end
+  end
+end

data/spec/shared_context/workdir.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+require 'tmpdir'
+
+RSpec.shared_context :workdir do
+  before(:all) { @dir = Dir.pwd }
+
+  # Need to clean up because doing the let() doesn't trigger the automatic
+  # removal using the block form of Dir.mktmpdir would do.
+  let(:sourcedir) { Dir.mktmpdir }
+  let(:workdir)   { Dir.mktmpdir }
+  before(:each) { FileUtils.chdir(workdir) }
+  after(:each)  {
+    FileUtils.chdir @dir
+    [sourcedir, workdir].each do |dir|
+      FileUtils.remove_entry_secure(dir)
+    end
+  }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require File.expand_path('on_what', File.dirname(File.dirname(__FILE__)))
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+unless on_1_8?
+  begin
+    require 'simplecov'
+
+    SimpleCov.configure do
+      add_filter '/spec/'
+      add_filter '/vendor/'
+      minimum_coverage 100
+      refuse_coverage_drop
+    end
+
+    if on_travis?
+      require 'codecov'
+      SimpleCov.formatter = SimpleCov::Formatter::Codecov
+    end
+
+    SimpleCov.start
+  rescue LoadError
+    puts "Coverage is disabled - install simplecov to enable."
+  end
+end
+
+require 'packager'
+
+# This is taken from:
+# https://github.com/erikhuda/thor/blob/d634d240bdc0462fe677031e1dc6ed656e54f27e/spec/helper.rb#L49
+# Found via http://bokstuff.com/blog/testing-thor-command-lines-with-rspec/
+def capture(stream)
+  begin
+    stream = stream.to_s
+    eval "$#{stream} = StringIO.new"
+    yield
+    result = eval("$#{stream}").string
+  ensure
+    eval("$#{stream} = #{stream.upcase}")
+  end
+
+  result
+end
+
+require 'tempfile'
+def append_to_file(file, content)
+  File.open(file, 'a+') do |f|
+    f.write(content)
+    f.flush # VERY IMPORTANT
+  end
+end

data/spec/struct/command_spec.rb

@@ -0,0 +1,67 @@
+describe Packager::Struct::Command do
+  context '#to_system' do
+    it "handles empty packages" do
+      expect(Packager::Struct::Command.new(
+        :name => 'foo',
+        :version => '0.0.1',
+        :target  => 'test',
+      ).to_system).to eq([
+        'fpm',
+        '--name', 'foo',
+        '--version', '0.0.1',
+        '-s', 'empty', '-t', 'test',
+      ])
+    end
+
+    it "handles packages with files" do
+      cmd = Packager::Struct::Command.new(
+        :name => 'foo',
+        :version => '0.0.1',
+        :target  => 'test',
+      )
+      cmd.add_directory('foo')
+
+      expect(cmd.to_system).to eq([
+        'fpm',
+        '--name', 'foo',
+        '--version', '0.0.1',
+        '-s', 'dir', '-t', 'test',
+        'foo',
+      ])
+    end
+
+    it "handles dependencies" do
+      cmd = Packager::Struct::Command.new(
+        :name => 'foo',
+        :version => '0.0.1',
+        :target  => 'test',
+        :requires => ['foo'],
+      )
+
+      expect(cmd.to_system).to eq([
+        'fpm',
+        '--name', 'foo',
+        '--version', '0.0.1',
+        '--depends', 'foo',
+        '-s', 'empty', '-t', 'test',
+      ])
+    end
+
+    it "handles provides" do
+      cmd = Packager::Struct::Command.new(
+        :name => 'foo',
+        :version => '0.0.1',
+        :target  => 'test',
+        :provides => ['foo'],
+      )
+
+      expect(cmd.to_system).to eq([
+        'fpm',
+        '--name', 'foo',
+        '--version', '0.0.1',
+        '--provides', 'foo',
+        '-s', 'empty', '-t', 'test',
+      ])
+    end
+  end
+end

data/spec/struct/error_spec.rb

@@ -0,0 +1,12 @@
+class Packager::Struct::Testing < Packager::Struct.new(:foo, :bar)
+end
+
+describe Packager::Struct do
+  context "throws an error if" do
+    it "is passed an unknown parameter" do
+      expect {
+        Packager::Struct::Testing.new(:baz => 1)
+      }.to raise_error('Passed in unknown params: baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: packager-dsl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Kinyon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dsl_maker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: fpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: DSL for creating a package that is easy to work with.
+email: rob.kinyon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Changes
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/packager
+- lib/packager.rb
+- lib/packager/cli.rb
+- lib/packager/dsl.rb
+- lib/packager/executor.rb
+- lib/packager/struct.rb
+- lib/packager/version.rb
+- on_what.rb
+- packager.gemspec
+- spec/cli/context.rb
+- spec/cli/execute_spec.rb
+- spec/cli/validate_spec.rb
+- spec/cli/version_spec.rb
+- spec/dsl/args_spec.rb
+- spec/dsl/context.rb
+- spec/dsl/defaults_spec.rb
+- spec/dsl/dependency_spec.rb
+- spec/dsl/error_spec.rb
+- spec/dsl/files_spec.rb
+- spec/executor/basic_spec.rb
+- spec/executor/command_spec.rb
+- spec/executor/context.rb
+- spec/executor/dependency_spec.rb
+- spec/executor/execute_command_spec.rb
+- spec/executor/files_spec.rb
+- spec/fpm-test_spec.rb
+- spec/integration/context.rb
+- spec/integration/dependency_spec.rb
+- spec/integration/files_spec.rb
+- spec/lib/fpm/package/test.rb
+- spec/shared_context/workdir.rb
+- spec/spec_helper.rb
+- spec/struct/command_spec.rb
+- spec/struct/error_spec.rb
+homepage: https://github.com/robkinyon/ruby-packager
+licenses:
+- GPL2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: DSL for creating packages
+test_files: []
+has_rdoc: