choctop 0.9.6 → 0.10.0

data/features/{steps → step_definitions}/dmg_steps.rb

@@ -8,7 +8,15 @@ Given /is configured for custom Applications icon$/ do
   end
 end
 
-When /^dmg '(.*)' is mounted as '(.*)'$/ do |dmg, name|
+Given /^is configured for an asset file "([^\"]*)" to be included in dmg$/ do |file|
+  in_project_folder do
+    append_to_file "Rakefile", <<-RUBY.gsub(/^    /, '')
+    $sparkle.add_file "#{file}", :position=> [347, 65]
+    RUBY
+  end
+end
+
+When /^dmg "(.*)" is mounted as "(.*)"$/ do |dmg, name|
   @stdout = File.expand_path(File.join(@tmp_root, "hdiutil.out"))
   in_project_folder do
     @mountpoint = ChocTop.new.mountpoint
@@ -22,19 +30,19 @@ def in_mounted_volume(&block)
   FileUtils.chdir(@volume_path, &block)
 end
 
-Then %r{^folder '(.*)' in mounted volume (is|is not) created} do |folder, is|
+Then %r{^folder "(.*)" in mounted volume (is|is not) created} do |folder, is|
   in_mounted_volume do
     File.exists?(folder).should(is == 'is' ? be_true : be_false)
   end
 end
 
-Then %r{^file '(.*)' in mounted volume (is|is not) created} do |file, is|
+Then %r{^file "(.*)" in mounted volume (is|is not) created} do |file, is|
   in_mounted_volume do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end
 end
 
-Then /^file '(.*)' in mounted volume (is|is not) invisible$/ do |file, is|
+Then /^file "(.*)" in mounted volume (is|is not) invisible$/ do |file, is|
   in_mounted_volume do
     `GetFileInfo -aV '#{@volume_path}/#{file}'`.to_i.should_not == (is == 'is' ? 0 : 1)
   end

data/features/{steps → step_definitions}/file_attribute_steps.rb

@@ -1,4 +1,4 @@
-Then /^file '(.*)' in mounted volume has GetFileInfo (.*) '(.*)'/ do |file, file_info_type, value|
+Then /^file "(.*)" in mounted volume has GetFileInfo (.*) "(.*)"/ do |file, file_info_type, value|
   flags = case file_info_type.to_sym
   when :type; "-t"
   when :alias; "-aa"
@@ -9,7 +9,7 @@ Then /^file '(.*)' in mounted volume has GetFileInfo (.*) '(.*)'/ do |file, file
   end
 end
 
-Then /^file '(.*)' in mounted volume is aliased to '(.*)'/ do |file, target|
+Then /^file "(.*)" in mounted volume is aliased to "(.*)"/ do |file, target|
   in_mounted_volume do
     puts "TODO - how to get applescript to test this?"
   end

data/features/{steps/generator.rb → step_definitions/generator_steps.rb}

@@ -24,7 +24,7 @@ end
 Given /Rakefile constants rewired for local rsync/ do
 end
 
-Given /^a Cocoa app with choctop installed called '(.*)'$/ do |name|
+Given /^a Cocoa app with choctop installed called "(.*)"$/ do |name|
   Given "a safe folder"
   @remote_folder = File.expand_path(File.join(@tmp_root, 'website'))
   FileUtils.rm_rf   @remote_folder
@@ -33,7 +33,7 @@ Given /^a Cocoa app with choctop installed called '(.*)'$/ do |name|
   `cp -r '#{app_path}' #{@tmp_root}/ 2> /dev/null`
   `rm -rf '#{@tmp_root}/#{name}/build'`
   setup_active_project_folder name
-  Given "I run local executable 'install_choctop' with arguments '.'"
+  Given %Q{I run local executable "install_choctop" with arguments "."}
   Given "Rakefile wired to use development code instead of installed RubyGem"
   Given "Rakefile constants rewired for local rsync"
   ENV['NO_FINDER'] = 'YES' # disable Finder during tests

data/features/{steps/remote.rb → step_definitions/remote_steps.rb}

@@ -1,10 +1,10 @@
-Then %r{^remote folder '(.*)' is created} do |folder|
+Then %r{^remote folder "(.*)" is created} do |folder|
   FileUtils.chdir @remote_folder do
     File.exists?(folder).should be_true
   end
 end
 
-Then %r{^remote file '(.*)' (is|is not) created} do |file, is|
+Then %r{^remote file "(.*)" (is|is not) created} do |file, is|
   FileUtils.chdir @remote_folder do
     File.exists?(file).should(is == 'is' ? be_true : be_false)
   end

data/features/{steps → step_definitions}/xcode_steps.rb

@@ -1,4 +1,4 @@
-Then /^current xcode project version is '(.*)'$/ do |version|
+Then /^current xcode project version is "(.*)"$/ do |version|
   in_project_folder do
     ChocTop.new.version.to_s.should == version
   end

data/features/support/common.rb

@@ -0,0 +1,44 @@
+module CommonHelpers
+  def in_tmp_folder(&block)
+    FileUtils.chdir(@tmp_root, &block)
+  end
+
+  def in_project_folder(&block)
+    project_folder = @active_project_folder || @tmp_root
+    FileUtils.chdir(project_folder, &block)
+  end
+
+  def in_home_folder(&block)
+    FileUtils.chdir(@home_path, &block)
+  end
+
+  def force_local_lib_override(project_name = @project_name)
+    rakefile = File.read(File.join(project_name, 'Rakefile'))
+    File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+      f << "$:.unshift('#{@lib_path}')\n"
+      f << rakefile
+    end
+  end
+
+  def setup_active_project_folder project_name
+    @active_project_folder = File.join(@tmp_root, project_name)
+    FileUtils.mkdir_p(@active_project_folder)
+    @project_name = project_name
+  end
+
+  def prepend_to_file(filename, text)
+    file = File.read(filename)
+    File.open(filename, "w+") do |f|
+      f << text + "\n"
+      f << file
+    end
+  end
+
+  def append_to_file(filename, text)
+    File.open(filename, "a") do |f|
+      f << text + "\n"
+    end
+  end
+end
+
+World(CommonHelpers)

data/features/support/matchers.rb

@@ -0,0 +1,11 @@
+module Matchers
+  def contain(expected)
+    simple_matcher("contain #{expected.inspect}") do |given, matcher|
+      matcher.failure_message = "expected #{given.inspect} to contain #{expected.inspect}"
+      matcher.negative_failure_message = "expected #{given.inspect} not to contain #{expected.inspect}"
+      given.index expected
+    end
+  end
+end
+
+World(Matchers)

data/lib/choctop.rb

@@ -5,12 +5,17 @@ require "fileutils"
 require "yaml"
 require "builder"
 require "erb"
+require "uri"
 require "osx/cocoa"
 require "active_support"
 require "RedCloth"
 
 class ChocTop
-  VERSION = '0.9.6'
+  VERSION = '0.10.0'
+  
+  # Path to the Info.plist
+  # Default: "Info.plist"
+  attr_accessor :info_plist_path
   
   # The name of the Cocoa application
   # Default: info_plist['CFBundleExecutable'] or project folder name if "${EXECUTABLE_NAME}"
@@ -23,20 +28,29 @@ class ChocTop
   # The target name of the distributed DMG file
   # Default: #{name}.app
   attr_accessor :target
+
+  # The build type of the distributed DMG file
+  # Default: Release
+  attr_accessor :build_type
+
+  # The Sparkle feed URL
+  # Default: info_plist['SUFeedURL']
+  attr_accessor :su_feed_url
   
   # The host name, e.g. some-domain.com
+  # Default: host from base_url
   attr_accessor :host
   
   # The url from where the xml + dmg files will be downloaded
-  # Default: http://#{host}
-  attr_writer :base_url
-  def base_url
-    @base_url ||= "http://#{host}"
-  end
+  # Default: dir path from appcast_filename
+  attr_accessor :base_url
   
   # The file name for generated release notes for the latest release
   # Default: release_notes.html
   attr_accessor :release_notes
+  
+  # List of files/bundles to be packaged into the DMG
+  attr_accessor :files
 
   # The path for an HTML template into which the release_notes.txt are inserted
   # after conversion to HTML
@@ -60,6 +74,13 @@ class ChocTop
   # Default: -aCv
   attr_accessor :rsync_args
   
+  # Folder from where all files will be copied into the DMG
+  # Files are copied here if specified with +add_file+ before DMG creation
+  attr_accessor :src_folder
+  def src_folder
+    @src_folder ||= "build/#{build_type}/dmg"
+  end
+  
   # Generated filename for a distribution, from name, version and .dmg
   # e.g. MyApp-1.0.0.dmg
   def pkg_name
@@ -136,41 +157,61 @@ class ChocTop
   end
   
   def info_plist
-    @info_plist ||= OSX::NSDictionary.dictionaryWithContentsOfFile(File.expand_path('Info.plist')) || {}
+    @info_plist ||= OSX::NSDictionary.dictionaryWithContentsOfFile(File.expand_path(info_plist_path)) || {}
+  end
+  
+  # Add an explicit file/bundle/folder into the DMG
+  # Required option:
+  #  +:position+ - two item array [x, y] window position
+  def add_file(path, options)
+    throw "add_files #{path}, :position => [x,y] option is missing" unless options[:position]
+    self.files ||= {}
+    files[path] = options
   end
   
   def initialize
     $sparkle = self # define a global variable for this object
     
+    yield self if block_given?
+    
     # Defaults
-    @name = info_plist['CFBundleExecutable']
-    @name = File.basename(File.expand_path(".")) if name == "${EXECUTABLE_NAME}"
-    @version = info_plist['CFBundleVersion']
-    @target = "#{name}.app"
-    @appcast_filename = info_plist['SUFeedURL'] ? File.basename(info_plist['SUFeedURL']) : 'linker_appcast.xml'
-    @release_notes = 'release_notes.html'
-    @release_notes_template = "release_notes_template.html.erb"
-    @rsync_args = '-aCv --progress'
+    @info_plist_path ||= 'Info.plist'
+    @name ||= info_plist['CFBundleExecutable']
+    @name = File.basename(File.expand_path(".")) if name.to_s == "${EXECUTABLE_NAME}"
+    @version ||= info_plist['CFBundleVersion']
+    @target ||= "#{name}.app"
+    @build_type = ENV['BUILD_TYPE'] || 'Release'
     
-    @background_file = File.dirname(__FILE__) + "/../assets/sky_background.jpg"
-    @app_icon_position = [175, 65]
-    @applications_icon_position = [347, 270]
-    @volume_icon = File.dirname(__FILE__) + "/../assets/DefaultVolumeIcon.icns"
-    @icon_size = 104
-    @icon_text_size = 12
+    if @su_feed_url = info_plist['SUFeedURL']
+      @appcast_filename ||= File.basename(su_feed_url)
+      @base_url ||= File.dirname(su_feed_url)
+    end
+    if @base_url
+      @host ||= URI.parse(base_url).host
+    end
+    @release_notes ||= 'release_notes.html'
+    @release_notes_template ||= "release_notes_template.html.erb"
+    @rsync_args ||= '-aCv --progress'
     
-    yield self if block_given?
+    @background_file ||= File.dirname(__FILE__) + "/../assets/sky_background.jpg"
+    @app_icon_position ||= [175, 65]
+    @applications_icon_position ||= [347, 270]
+    @volume_icon ||= File.dirname(__FILE__) + "/../assets/DefaultVolumeIcon.icns"
+    @icon_size ||= 104
+    @icon_text_size ||= 12
 
+    add_file "build/#{build_type}/#{target}", :position => app_icon_position
+    
     define_tasks
   end
   
   def define_tasks
     return unless Object.const_defined?("Rake")
     
-    desc "Build Xcode Release"
-    task :build => "build/Release/#{target}/Contents/Info.plist"
+    desc "Build Xcode #{build_type}"
+    task :build => "build/#{build_type}/#{target}/Contents/Info.plist"
     
-    task "build/Release/#{target}/Contents/Info.plist" do
+    task "build/#{build_type}/#{target}/Contents/Info.plist" do
       make_build
     end
     
@@ -195,9 +236,6 @@ class ChocTop
       upload_appcast
     end
 
-    desc "Create dmg, update appcast file, and upload to host"
-    task :appcast => %w[force_build dmg force_feed upload]
-    
     task :detach_dmg do
       detach_dmg
     end

data/lib/choctop/appcast.rb

@@ -3,7 +3,7 @@ module ChocTop::Appcast
     if ENV['NO_BUILD']
       puts "Skipping build task..."
     else
-      sh "xcodebuild -configuration Release"
+      sh "xcodebuild -configuration #{build_type}"
     end
   end
   

data/lib/choctop/dmg.rb

@@ -1,9 +1,18 @@
 module ChocTop::Dmg
+  def prepare_files
+    FileUtils.mkdir_p(src_folder)
+    files.each do |file|
+      path, options = file
+      FileUtils.cp_r(path, src_folder)
+    end
+  end
+  
   def make_dmg
+    prepare_files
     FileUtils.rm_rf build_path
     FileUtils.mkdir_p build_path
     FileUtils.mkdir_p mountpoint # TODO can we remove random mountpoints?
-    sh "hdiutil create -format UDRW -quiet -volname '#{name}' -srcfolder 'build/Release/#{target}' '#{pkg}'"
+    sh "hdiutil create -format UDRW -quiet -volname '#{name}' -srcfolder '#{src_folder}' '#{pkg}'"
     sh "hdiutil attach '#{pkg}' -mountpoint '#{volume_path}' -noautoopen -quiet"
     sh "bless --folder '#{volume_path}' --openfolder '#{volume_path}'"
     sh "sleep 1"
@@ -47,7 +56,7 @@ module ChocTop::Dmg
       FileUtils.mkdir_p(File.dirname(target_background))
       FileUtils.cp(background_file, target_background) 
     end
-    run_applescript <<-SCRIPT.gsub(/^      /, '')
+    script = <<-SCRIPT.gsub(/^      /, '')
       tell application "Finder"
          set mountpoint to POSIX file ("#{volume_path}" as string) as alias
          tell folder mountpoint
@@ -63,7 +72,7 @@ module ChocTop::Dmg
              set icon size of the icon view options of container window to #{icon_size}
              set text size of the icon view options of container window to #{icon_text_size}
              set arrangement of the icon view options of container window to not arranged
-             set position of item "#{target}" to {#{app_icon_position.join(", ")}}
+             #{set_position_of_files}
              set position of item "Applications" to {#{applications_icon_position.join(", ")}}
              set the bounds of the container window to {#{window_bounds.join(", ")}}
              set background picture of the icon view options of container window to file "#{volume_background.gsub(/\//,':')}"
@@ -75,9 +84,19 @@ module ChocTop::Dmg
          delay 5
       end tell
     SCRIPT
+    run_applescript(script)
     sh "SetFile -a V '#{target_background}'" if background_file
   end
   
+  def set_position_of_files
+    files.map do |file_options|
+      path, options = file_options
+      target        = File.basename(path)
+      position      = options[:position].join(", ")
+      %Q{set position of item "#{target}" to {#{position}}}
+    end.join("\n")
+  end
+  
   def configure_applications_icon
     run_applescript <<-SCRIPT.gsub(/^      /, ''), "apps_icon_script"
       tell application "Finder"

data/spec/choctop_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe ChocTop do
+  attr_reader :choctop
+  
+  describe "default" do
+    before(:each) do
+      FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
+        @choctop = ChocTop.new
+      end
+    end
+
+    it "should get name from Info.plist['CFBundleExecutable']" do
+      choctop.name.should == 'SampleApp'
+    end
+
+    it "should get version from Info.plist['CFBundleVersion']" do
+      choctop.version.should == '0.1.0'
+    end
+
+    it "should derive host from Info.plist['SUFeedURL']" do
+      choctop.host.should == 'mocra.com'
+    end
+
+    it "should derive base_url from Info.plist['SUFeedURL']" do
+      choctop.base_url.should == 'http://mocra.com/sample_app'
+    end
+
+    it "should derive appcast_filename from Info.plist['SUFeedURL']" do
+      choctop.appcast_filename.should == 'my_feed.xml'
+    end
+  end
+  
+  describe "add_files" do
+    before(:each) do
+      FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
+        @choctop = ChocTop.new
+        @choctop.add_file "README.txt", :position => [50, 100]
+      end
+    end
+    
+    it "should have build/Release/SampleApp.app as a file/bundle" do
+      @choctop.files.keys.should be_include('build/Release/SampleApp.app')
+    end
+
+    it "should have README.txt as a file" do
+      @choctop.files.keys.include?('README.txt')
+    end
+
+    it "should have README.txt position" do
+      @choctop.files['README.txt'][:position].should == [50, 100]
+    end
+
+    describe "+ prepare_files" do
+      before(:each) do
+        FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
+          @choctop.prepare_files
+        end
+      end
+
+      it "should have SampleApp.app in build/Release/dmg ready for inclusion in DMG" do
+        FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
+          File.should be_exists('build/Release/dmg/SampleApp.app')
+        end
+      end
+      
+      it "should position SampleApp.app at [175, 65]" do
+        @choctop.set_position_of_files.should =~ /set position of item "SampleApp.app" to \{175, 65\}/
+      end
+
+      it "should have README.txt in build/Release ready for inclusion in DMG" do
+        FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
+          File.should be_exists('build/Release/dmg/README.txt')
+        end
+      end
+      
+      it "should position README.txt at [50, 100]" do
+        @choctop.set_position_of_files.should =~ /set position of item "README.txt" to \{50, 100\}/
+      end
+    end
+
+  end
+end