choctop 0.9.0

data/features/steps/dmg_steps.rb

@@ -0,0 +1,31 @@
+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
+    FileUtils.mkdir_p @mountpoint
+    @volume_path = "#{@mountpoint}/#{name}"
+    `hdiutil attach '#{dmg}' -mountpoint '#{@volume_path}' -noautoopen > #{@stdout}`
+  end
+end
+
+def in_mounted_volume(&block)
+  FileUtils.chdir(@volume_path, &block)
+end
+
+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|
+  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|
+  in_mounted_volume do
+    `GetFileInfo -aV '#{@volume_path}/#{file}'`.to_i.should_not == (is == 'is' ? 0 : 1)
+  end
+end

data/features/steps/env.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + "/../../lib/choctop"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'
+
+require "activesupport"

data/features/steps/generator.rb

@@ -0,0 +1,39 @@
+Given /^a Cocoa app that does not have an existing Rakefile$/ do
+  Given "a safe folder"
+  setup_active_project_folder "sample_app"
+end
+
+Given /^a Cocoa app that does have an existing Rakefile$/ do
+  Given "a Cocoa app that does not have an existing Rakefile"
+  in_project_folder do
+    File.open("Rakefile", "w") do |f|
+      f << <<-RUBY.gsub(/^      /, '')
+      require "rubygems"
+      require "rake"
+      RUBY
+    end
+  end
+end
+
+Given /Rakefile wired to use development code instead of installed RubyGem/ do
+  in_project_folder do
+    prepend_to_file "Rakefile", "$:.unshift('#{@lib_path}')"
+  end
+end
+
+Given /Rakefile constants rewired for local rsync/ do
+end
+
+Given /^a Cocoa app with choctop installed$/ do
+  Given "a safe folder"
+  @remote_folder = File.expand_path(File.join(@tmp_root, 'website'))
+  FileUtils.rm_rf   @remote_folder
+  FileUtils.mkdir_p @remote_folder
+  `cp -r #{File.dirname(__FILE__) + "/../fixtures/SampleApp"} #{@tmp_root}/ 2> /dev/null`
+  `rm -rf #{@tmp_root}/SampleApp/build`
+  setup_active_project_folder "SampleApp"
+  Given "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
+end

data/features/steps/remote.rb

@@ -0,0 +1,20 @@
+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|
+  FileUtils.chdir @remote_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Given /^ChocTop config is configured for local rsync$/ do
+  in_project_folder do
+    append_to_file "Rakefile", <<-RUBY.gsub(/^    /, '')
+    $sparkle.host = ""
+    $sparkle.remote_dir = #{@remote_folder.inspect}
+    RUBY
+  end
+end

data/lib/choctop.rb

@@ -0,0 +1,185 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "fileutils"
+require "yaml"
+require "rubygems"
+require "builder"
+require "active_support"
+require "osx/cocoa"
+
+class ChocTop
+  VERSION = '0.9.0'
+  
+  # The name of the Cocoa application
+  # Default: info_plist['CFBundleExecutable']
+  attr_accessor :name
+  
+  # The version of the Cocoa application
+  # Default: info_plist['CFBundleVersion']
+  attr_accessor :version
+  
+  # The target name of the distributed DMG file
+  # Default: #{name}.app
+  attr_accessor :target
+  
+  # The host name, e.g. some-domain.com
+  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
+  
+  # The url to display the release notes for the latest release
+  # Default: base_url
+  attr_writer :release_notes_link
+  def release_notes_link
+    @release_notes_link ||= base_url
+  end
+
+  # The name of the local xml file containing the Sparkle item details
+  # Default: info_plist['SUFeedURL'] or linker_appcast.xml
+  attr_accessor :appcast_filename
+  
+  # The remote directory where the xml + dmg files will be rsync'd
+  attr_accessor :remote_dir
+  
+  # The argument flags passed to rsync
+  # Default: -aCv
+  attr_accessor :rsync_args
+  
+  # Generated filename for a distribution, from name, version and .dmg
+  # e.g. MyApp-1.0.0.dmg
+  def pkg_name
+    "#{name}-#{version}.dmg"
+  end
+  
+  # Path to generated package DMG
+  def pkg
+    "appcast/build/#{pkg_name}"
+  end
+  
+  # Path to designed DMG and frozen assets for reuse in generated DMGs
+  def design_path
+    "appcast/design"
+  end
+  
+  def mountpoint
+    # @mountpoint ||= "/tmp/build/mountpoint#{rand(10000000)}"
+    @mountpoint ||= "/Volumes"
+  end
+  
+  # Path to Volume when DMG is mounted
+  def volume_path
+    "#{mountpoint}/#{name}"
+  end
+  
+  #
+  # Custom DMG properties
+  #
+  
+  # Path to background .icns image file for custom DMG
+  # Value should be file path relative to root of project
+  # Default: a choctop supplied background image
+  # that matches to default app_icon_position + applications_icon_position
+  # To have no custom background, set value to +nil+
+  attr_accessor :background_file
+  
+  # x, y position of this project's icon on the custom DMG
+  # Default: a useful position for the icon against the default background
+  attr_accessor :app_icon_position
+  
+  # x, y position of the Applications symlink icon on the custom DMG
+  # Default: a useful position for the icon against the default background
+  attr_accessor :applications_icon_position
+  
+  # Path to an .icns file for the DMG's volume icon (looks like a disk or drive)
+  # Default: a DMG icon provided within choctop
+  # To get default, boring blank DMG volume icon, set value to +nil+
+  attr_accessor :volume_icon
+  
+  # Size of icons, in pixels, within custom DMG (between 16 and 128)
+  # Default: 104 - this is nice and big
+  attr_accessor :icon_size
+  
+  # The url for the remote package, without the protocol + host
+  # e.g. if absolute url is http://mydomain.com/downloads/MyApp-1.0.dmg
+  # then pkg_relative_url is /downloads/MyApp-1.0.dmg
+  def pkg_relative_url
+    _base_url = base_url.gsub(%r{/$}, '')
+    "#{_base_url}/#{pkg_name}".gsub(%r{^.*#{host}}, '')
+  end
+  
+  def info_plist
+    @info_plist ||= OSX::NSDictionary.dictionaryWithContentsOfFile(File.expand_path('Info.plist')) || {}
+  end
+  
+  def initialize
+    $sparkle = self # define a global variable for this object
+    
+    # Defaults
+    @name = info_plist['CFBundleExecutable']
+    @version = info_plist['CFBundleVersion']
+    @target = "#{name}.app"
+    @appcast_filename = info_plist['SUFeedURL'] ? File.basename(info_plist['SUFeedURL']) : 'linker_appcast.xml'
+    @rsync_args = '-aCv'
+    
+    @background_file = File.dirname(__FILE__) + "/../assets/default_background.jpg"
+    @app_icon_position = [50, 90]
+    @applications_icon_position = [150, 90]
+    @volume_icon = File.dirname(__FILE__) + "/../assets/DefaultVolumeIcon.icns"
+    @icon_size = 104
+    
+    yield self if block_given?
+
+    define_tasks
+  end
+  
+  def define_tasks
+    return unless Object.const_defined?("Rake")
+    
+    desc "Build Xcode Release"
+    task :build => "build/Release/#{target}/Contents/Info.plist"
+    
+    task "build/Release/#{target}/Contents/Info.plist" do
+      make_build
+    end
+    
+    desc "Create the dmg file for appcasting"
+    task :dmg => :build do
+      detach_dmg
+      make_dmg
+      detach_dmg
+      convert_dmg_readonly
+      add_eula
+    end
+    
+    desc "Create/update the appcast file"
+    task :feed => :dmg do
+      make_appcast
+      make_index_redirect
+    end
+    
+    desc "Upload the appcast file to the host"
+    task :upload => :feed do
+      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
+    
+    task :size do
+      puts configure_dmg_window
+    end
+  end
+end
+require "choctop/appcast"
+require "choctop/dmg"
+

data/lib/choctop/appcast.rb

@@ -0,0 +1,54 @@
+module ChocTop::Appcast
+  def make_build
+    sh "xcodebuild -configuration Release"
+  end
+  
+  def make_appcast
+    app_name = File.basename(File.expand_path('.'))
+    
+    FileUtils.mkdir_p "appcast/build"
+    appcast = File.open("appcast/build/#{appcast_filename}", 'w')
+
+    xml = Builder::XmlMarkup.new(:target => appcast, :indent => 2)
+
+    xml.instruct!
+    xml.rss('xmlns:atom' => "http://www.w3.org/2005/Atom",
+            'xmlns:sparkle' => "http://www.andymatuschak.org/xml-namespaces/sparkle", 
+            :version => "2.0") do
+      xml.channel do
+        xml.title(app_name)
+        xml.description("#{app_name} updates")
+        xml.link(base_url)
+        xml.language('en')
+        xml.pubDate Time.now.to_s(:rfc822)
+        # xml.lastBuildDate(Time.now.rfc822)
+        xml.atom(:link, :href => "#{base_url}/#{appcast_filename}", 
+                 :rel => "self", :type => "application/rss+xml")
+
+        xml.item do
+          xml.title("#{name} #{version}")
+          xml.tag! "sparkle:releaseNotesLink", release_notes_link
+          xml.pubDate Time.now.to_s(:rfc822) #(File.mtime(pkg))
+          xml.guid("#{name}-#{version}", :isPermaLink => "false")
+          xml.enclosure(:url => "#{base_url}/#{pkg_name}", 
+                        :length => "#{File.size(pkg)}", 
+                        :type => "application/dmg",
+                        :"sparkle:version" => version)
+        end
+      end
+    end
+  end
+  
+  def make_index_redirect
+    File.open("appcast/build/index.php", 'w') do |f|
+      f << %Q{<?php header("Location: #{pkg_relative_url}"); ?>}
+    end
+  end
+
+  def upload_appcast
+    _host = host.blank? ? "" : "#{host}:"
+    sh %{rsync -aCv appcast/build/ #{_host}#{remote_dir}}
+  end
+  
+end
+ChocTop.send(:include, ChocTop::Appcast)

data/lib/choctop/dmg.rb

@@ -0,0 +1,112 @@
+module ChocTop::Dmg
+  def make_dmg
+    FileUtils.rm_rf pkg
+    FileUtils.mkdir_p(File.dirname(pkg))
+    FileUtils.mkdir_p(mountpoint)
+    sh "hdiutil create -format UDRW -quiet -volname '#{name}' -srcfolder 'build/Release/#{target}' '#{pkg}'"
+    sh "hdiutil attach '#{pkg}' -mountpoint '#{volume_path}' -noautoopen -quiet"
+    sh "bless --folder #{volume_path} --openfolder #{volume_path}"
+    sh "ln -s /Applications '#{volume_path}/Applications'"
+    sh "sleep 1"
+    if volume_icon
+      FileUtils.cp(volume_icon, "#{volume_path}/.VolumeIcon.icns")
+      sh "SetFile -a C #{volume_path}"
+    end
+    target_background = "#{volume_path}/#{volume_background}"
+    FileUtils.cp(background_file, target_background) if background_file
+    configure_dmg_window
+    sh "SetFile -a V #{target_background}" if background_file
+  end
+  
+  def volume_background
+    "background#{File.extname(background_file)}"
+  end
+  
+  def window_position
+    [50, 100]
+  end
+  
+  def window_bounds
+    window_position + 
+    window_position.zip(background_bounds).map { |w, b| w + b }
+  end
+  
+  def background_bounds
+    return [400, 300] unless background_file
+    background = OSX::NSImage.alloc.initByReferencingFile(background_file).size.to_a
+    [background.first, background.last + statusbar_height]
+  end
+  
+  def statusbar_height
+    20
+  end
+  
+  def configure_dmg_window
+    applescript = <<-SCRIPT
+    tell application "Finder"
+       set mountpoint to POSIX file ("#{volume_path}" as string) as alias
+       tell folder mountpoint
+           open
+           tell container window
+              set toolbar visible to false
+              set statusbar visible to false -- doesn't do anything at DMG open time
+              set current view to icon view
+              delay 1 -- Sync
+              set the bounds to {#{window_bounds.join(", ")}}
+           end tell
+           delay 1 -- Sync
+           set icon size of the icon view options of container window to #{icon_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 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 "#{File.basename volume_background}"
+           update without registering applications
+           delay 5 -- Sync
+           close
+       end tell
+       -- Sync
+       delay 5
+    end tell
+    SCRIPT
+    File.open(scriptfile = "/tmp/choctop-script", "w") do |f|
+      f << applescript
+    end
+    sh("osascript #{scriptfile}") do |ok, res|
+      if ! ok
+        p res
+        puts volume_path
+        exit 1
+      end
+    end
+    applescript
+  end
+  
+  def detach_dmg
+    mounted_paths = `hdiutil info | grep '#{volume_path}' | grep "Apple_HFS"`.split("\n").map { |e| e.split(" ").first }
+    mounted_paths.each do |path|
+      begin
+        sh "hdiutil detach '#{path}' -quiet -force"
+      rescue StandardError => e
+        p e
+      end
+    end
+  end
+  
+  def convert_dmg_readonly
+    tmp_path = "/tmp/rw.dmg"
+    FileUtils.mv(pkg, tmp_path)
+    sh "hdiutil convert '#{tmp_path}' -format UDZO -imagekey zlib-level=9 -o '#{pkg}'"
+  end
+  
+  def add_eula
+    # TODO support EULA
+    # hdiutil unflatten $@
+  	# /Developer/Tools/DeRez -useDF SLAResources.rsrc > build/temp/sla.r
+  	# /Developer/Tools/Rez -a build/temp/sla.r -o $@
+  	# hdiutil flatten $@
+  	
+  end
+end
+ChocTop.send(:include, ChocTop::Dmg)
+