wrapp 0.1.2 → 0.2.0

data/README.md

@@ -6,11 +6,11 @@ Wrap an App... in a disk image (DMG).
 ## Prologue
 
 Say you wanna put your nice Mac OS X application in a handy disk image
-(DMG) for download / deployment.
-Why not use `wrapp` for this?
+(DMG) for distribution.
+Why not use *wrapp* for this?
 It is even shorter to type then `hdiutil` ;-)
 
-**NOTE: This only runs on Mac OS X!**
+**NOTE: This runs on Mac OS X only!**
 
 
 ## Installation
@@ -30,32 +30,26 @@ Or install it yourself as:
 
 ## Usage
 
+Try `wrapp --help`!
+
 Some examples...
 
-Build a dmg from the locally installed 'Chunky Bacon.app':
+Wrap the *Chunky Bacon* App:
 
 ```
 wrapp /Applications/Chunky\ Bacon.app
-created chunky_bacon_1.2.3.dmg with SHA-1 deadbeef...
 ```
 
-**NOTE: Not yet implemented!**
-Build a dmg from the Chunky Bacon app (the one with the weird directory
-layout):
+Wrap the *Chunky Bacon* App and include the parent directory (some stuff
+like *TeamViewer* or *FileMaker* reside in sub-directories of
+`/Applications` rather then the top-level):
 
 ```
-wrapp --plist /Applications/Chunky/Bacon.app /Applications/Chunky
-created bacon_1.2.3.dmg with SHA-1 deadbeef...
+wrapp --include-parent-dir /Applications/why/Chunky Bacon.app
 ```
 
-**NOTE: Not yet implemented!**
-Build the dmg in a different directory (and create it first if missing):
-
-```
-wrapp --outdir /tmp/dmgs /Applications/Chunky\ Bacon.app
-...
-created chunky_bacon_1.2.3.dmg with SHA-1 deadbeef...
-```
+The commands create a DMG like `chunky_bacon_1.2.3.dmg` (named after the
+App + Version) that contains the given App.
 
 Thats it.
 

data/bin/wrapp

@@ -2,4 +2,4 @@
 
 require 'wrapp'
 
-Wrapp::DMGBuilder.run
+Wrapp::CLI.run

data/features/step_definitions/wrapp_steps.rb

@@ -1,58 +1,72 @@
-def create_app
-  FileUtils.rm_f(dmg_filename)
-  write_file(plist_path, plist_content)
+# Helpers
+
+def create_app(*opts)
+  app = App.new(*opts)
+  FileUtils.rm_f(app.dmg_filename)
+  write_file(app.plist_path, app.plist_content)
+  app
 end
 
-def plist_path
-  File.join(app_path, 'Contents', 'Info.plist')
+
+def attach_dmg
+  assert_dmg_exists
+  create_dir(volumes_dir)
+  cmd = "hdiutil attach '#{@app.dmg_filename}' -nobrowse -mountroot '#{volumes_dir}'"
+  run_simple(cmd, true)
 end
 
-def plist_content
-  %Q{<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-  <dict>
-    <key>CFBundleName</key>
-    <string>#{app_name}</string>
-    <key>CFBundleShortVersionString</key>
-    <string>#{app_version}</string>
-  </dict>
-</plist>
-}
+def detach_dmg
+  in_current_dir do
+    Dir.glob("#{volumes_dir}/*") do |dir|
+      system("hdiutil detach '#{dir}' -force >/dev/null")
+    end
+  end
 end
 
-def run_wrapp_command
-  cmd = "wrapp '#{app_path}'"
-  run_simple(unescape(cmd))
+def assert_dmg_exists
+  check_file_presence([@app.dmg_filename], true)
 end
 
-def dmg_filename
-  'chunky_bacon_1.2.3.dmg'
+def volumes_dir
+  'Volumes' # We don't want to attach to '/Volumes' in our tests.
 end
 
-def app_version
-  '1.2.3'
+
+# Hooks
+
+After do
+  detach_dmg
 end
 
-def app_name
-  'Chunky Bacon'
+
+# Step definitions
+
+Given(/^an App$/) do
+  @app = create_app
 end
 
-def app_path
-  "Applications/#{app_name}.app"
+Given(/^an App in a directory$/) do
+  @app = create_app(:prefix => 'Stuff')
 end
 
-Given(/^an App$/) do
-  create_app
+When(/^I wrap the App$/) do
+  cmd = "wrapp '#{@app.app_path}'"
+  run_simple(unescape(cmd))
+end
+
+When(/^I wrap the App including the parent directory$/) do
+  cmd = "wrapp --include-parent-dir '#{@app.app_path}'"
+  run_simple(unescape(cmd))
 end
 
-When(/^I run wrapp$/) do
-  run_wrapp_command
+Then(/^the App should be wrapped$/) do
+  attach_dmg
+  attached_app_path = File.join(volumes_dir, @app.app_name)
+  check_directory_presence([attached_app_path], true)
 end
 
-Then(/^the App should be wrapped in a DMG$/) do
-  check_file_presence([dmg_filename], true) # assert that dmg exists
-  # attach dmg
-    # assert that dmg contains the app dir (basedir w/o full path)
-  # detach dmg
+Then(/^the App should be wrapped including the parent directory$/) do
+  attach_dmg
+  attached_app_path = File.join(volumes_dir, @app.prefix)
+  check_directory_presence([attached_app_path], true)
 end

data/features/support/app.rb

@@ -0,0 +1,44 @@
+class App
+  def initialize(opts = {})
+    @opts = opts
+  end
+
+  def plist_path
+    File.join(app_path, 'Contents', 'Info.plist')
+  end
+
+  def plist_content
+    %Q{<?xml version="1.0" encoding="UTF-8"?>
+      <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+      <plist version="1.0">
+        <dict>
+          <key>CFBundleName</key>
+          <string>#{app_name}</string>
+          <key>CFBundleShortVersionString</key>
+          <string>#{app_version}</string>
+        </dict>
+      </plist>
+    }
+  end
+
+  def dmg_filename
+    'chunky_bacon_1.2.3.dmg'
+  end
+
+  def app_version
+    '1.2.3'
+  end
+
+  def app_name
+    'Chunky Bacon'
+  end
+
+  def prefix
+    @opts[:prefix]
+  end
+
+  def app_path
+    basedir = "#{app_name}.app"
+    (prefix && File.join(prefix, basedir)) || basedir
+  end
+end

data/features/wrap_app.feature

@@ -4,10 +4,12 @@ Feature: Wrap App
   As as user
   I want wrap my App in a DMG
 
-  Scenario: Create DMG
+  Scenario: Wrap App
     Given an App
-    When I run wrapp
-    Then the App should be wrapped in a DMG
+    When I wrap the App
+    Then the App should be wrapped
 
-  #Scenario: Create DMG with different output directory
-  #Scenario: Create DMG with differnt info plist
+  Scenario: Wrap App including the parent directory
+    Given an App in a directory
+    When I wrap the App including the parent directory
+    Then the App should be wrapped including the parent directory

data/lib/wrapp/cli.rb

@@ -0,0 +1,23 @@
+module Wrapp
+  class CLI
+    include Mixlib::CLI
+
+    option :include_parent_dir,
+      :long => '--include-parent-dir'
+
+    class << self
+      def run
+        new.run(ARGV)
+      end
+    end
+
+    def run(argv)
+      app_path = parse_options(argv).first
+      wrapp(app_path, config)
+    end
+
+    def wrapp(*opts)
+      DMGBuilder.new(*opts).create
+    end
+  end
+end

data/lib/wrapp/dmg_builder.rb

@@ -2,28 +2,19 @@ module Wrapp
   class DMGBuilder
     attr_reader :app_path
 
-    class << self
-      def run
-        new(ARGV.first).create #TODO: Test this!
-      end
-    end
-
-    def initialize(app_path)
+    def initialize(app_path, opts = {})
       @app_path = app_path
+      @opts = opts
     end
 
     def create
-      create_dmg
+      system("hdiutil create '#{dmg_filename}' -srcfolder '#{source_path}'")
     end
 
     private
 
-    def create_dmg
-      system("hdiutil create '#{dmg_path}' -srcfolder '#{app_path}'")
-    end
-
-    def dmg_path
-      dmg_filename
+    def source_path
+      @opts[:include_parent_dir] ? File.dirname(app_path) : app_path
     end
 
     def dmg_filename

data/lib/wrapp/version.rb

@@ -1,3 +1,3 @@
 module Wrapp
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/wrapp.rb

@@ -1,4 +1,6 @@
+require 'mixlib/cli'
 require 'plist'
 require 'wrapp/version'
 require 'wrapp/app_info'
 require 'wrapp/dmg_builder'
+require 'wrapp/cli'

data/spec/wrapp/cli_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Wrapp
+  describe CLI do
+    let(:cli) { CLI.new }
+    let(:app_path) { '/Applications/Chunky Bacon.app' }
+
+    describe '.run' do
+      it 'runs an instance with ARGV' do
+        cli.should_receive(:run).with(ARGV)
+        CLI.stub(:new).and_return(cli)
+        CLI.run
+      end
+    end
+
+    describe '#run' do
+      let(:argv) { [app_path] }
+
+      it 'wraps the app' do
+        cli.should_receive(:wrapp).with(app_path, {})
+        cli.run(argv)
+      end
+
+      %w(--include-parent-dir -i).each do |opt|
+        context "with #{opt}" do
+          let(:argv) { [app_path, opt] }
+
+          it 'wraps the app including the parent directory' do
+            cli.should_receive(:wrapp).
+              with(app_path, :include_parent_dir => true)
+            cli.run(argv)
+          end
+        end
+      end
+    end
+
+    describe '#wrapp' do
+      it 'creates the dmg via dmg builder' do
+        opts = %(some options and arguments)
+        dmg = double('dmg_builder')
+        dmg.should_receive(:create)
+        DMGBuilder.should_receive(:new).with(*opts).and_return(dmg)
+        cli.wrapp(*opts)
+      end
+    end
+  end
+end

data/spec/wrapp/dmg_builder_spec.rb

@@ -9,41 +9,37 @@ module Wrapp
       DMGBuilder.any_instance.stub(:system)
     end
 
-    describe '.run' do
-      it 'creates the dmg' do
-        DMGBuilder.stub(:new).and_return(dmg)
-        dmg.should_receive(:create) #TODO: Fix nil warning!
-        DMGBuilder.run
-      end
-    end
-
     describe '#create' do
-      it 'creates the dmg and directory' do
-        dmg.should_receive(:create_dmg)
-        dmg.create
-      end
-    end
-
-    describe '#create_dmg' do
       it 'creates the dmg by hdiutil' do
-        dmg.should_receive(:app_path).and_return('Chunky.app')
-        dmg.should_receive(:dmg_path).and_return('bacon.dmg')
+        dmg.should_receive(:source_path).and_return('Chunky.app')
+        dmg.should_receive(:dmg_filename).and_return('bacon.dmg')
         dmg.should_receive(:system).
           with("hdiutil create 'bacon.dmg' -srcfolder 'Chunky.app'")
-        dmg.send(:create_dmg)
+        dmg.create
       end
     end
 
     describe '#app_path' do
-      it 'returns the path to the app' do
+      it 'returns the app path' do
         expect(dmg.app_path).to eq('Chunky Bacon.app')
       end
     end
 
-    describe '#dmg_path' do
-      it 'returns the dmg_filename' do
-        dmg.should_receive(:dmg_filename).and_return('chunky_bacon.dmg')
-        expect(dmg.send(:dmg_path)).to eq('chunky_bacon.dmg')
+    describe '#source_path' do
+      before do
+        dmg.should_receive(:app_path).and_return('Chunky/Bacon.app')
+      end
+
+      it 'returns the path of the app dir' do
+        expect(dmg.send(:source_path)).to eq('Chunky/Bacon.app')
+      end
+
+      context 'with :include_parent_dir => true' do
+        let(:dmg) { DMGBuilder.new('...', :include_parent_dir => true) }
+
+        it 'returns the path of the app parent dir' do
+          expect(dmg.send(:source_path)).to eq('Chunky')
+        end
       end
     end
 

data/wrapp.gemspec

@@ -19,10 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'plist', '~> 3.1'
+  spec.add_dependency 'mixlib-cli', '~> 1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'guard', '~> 1.8'
+  spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-cucumber'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'aruba'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrapp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,17 +80,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -139,14 +155,17 @@ files:
 - Rakefile
 - bin/wrapp
 - features/step_definitions/wrapp_steps.rb
+- features/support/app.rb
 - features/support/env.rb
 - features/wrap_app.feature
 - lib/wrapp.rb
 - lib/wrapp/app_info.rb
+- lib/wrapp/cli.rb
 - lib/wrapp/dmg_builder.rb
 - lib/wrapp/version.rb
 - spec/spec_helper.rb
 - spec/wrapp/app_info_spec.rb
+- spec/wrapp/cli_spec.rb
 - spec/wrapp/dmg_builder_spec.rb
 - wrapp.gemspec
 homepage: https://github.com/bjoernalbers/wrapp
@@ -164,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1767770201264435998
+      hash: 983932024076404850
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,17 +192,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1767770201264435998
+      hash: 983932024076404850
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: wrapp-0.1.2
+summary: wrapp-0.2.0
 test_files:
 - features/step_definitions/wrapp_steps.rb
+- features/support/app.rb
 - features/support/env.rb
 - features/wrap_app.feature
 - spec/spec_helper.rb
 - spec/wrapp/app_info_spec.rb
+- spec/wrapp/cli_spec.rb
 - spec/wrapp/dmg_builder_spec.rb