choctop 0.10.0 → 0.11.0

data/History.txt

@@ -1,3 +1,15 @@
+
+* ChocTop no longer solely for Cocoa applications
+* Applications shortcut only included if the primary target is a .app bundle
+* Creates a non-versioned symlink to latest released DMG
+* Files to be included can be specified by relative path, method helper (as a symbol) or a proc that returns a string path. 
+  Examples:
+    file 'build/Release/SampleApp.app', :position => [50, 100]
+    file :target_bundle, :position => [50, 100]
+    file proc { 'README.txt' }, :position => [50, 100]
+    file :position => [50, 100] { 'README.txt' }
+
+
 == 0.10.0 2009-06-11
 
 * Extra files supported: +add_file 'project/path/to/file_or_folder_or_bundle', :position => [x, y]+

data/Manifest.txt

@@ -14,37 +14,6 @@ assets/wood.jpg
 bin/install_choctop
 features/development.feature
 features/dmg.feature
-features/fixtures/App With Whitespace/App With Whitespace.xcodeproj/TemplateIcon.icns
-features/fixtures/App With Whitespace/App With Whitespace.xcodeproj/drnic.mode1v3
-features/fixtures/App With Whitespace/App With Whitespace.xcodeproj/drnic.pbxuser
-features/fixtures/App With Whitespace/App With Whitespace.xcodeproj/project.pbxproj
-features/fixtures/App With Whitespace/App With Whitespace_Prefix.pch
-features/fixtures/App With Whitespace/English.lproj/InfoPlist.strings
-features/fixtures/App With Whitespace/English.lproj/MainMenu.xib
-features/fixtures/App With Whitespace/Info.plist
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/categories.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/cdecls.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/decls.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/files.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/imports.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/pbxindex.header
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/protocols.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/refs.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/strings.pbxstrings/control
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/strings.pbxstrings/strings
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/subclasses.pbxbtree
-features/fixtures/App With Whitespace/build/App With Whitespace.build/App With Whitespace.pbxindex/symbols0.pbxsymbols
-features/fixtures/App With Whitespace/main.m
-features/fixtures/SampleApp/English.lproj/InfoPlist.strings
-features/fixtures/SampleApp/English.lproj/MainMenu.xib
-features/fixtures/SampleApp/Info.plist
-features/fixtures/SampleApp/README.txt
-features/fixtures/SampleApp/SampleApp.xcodeproj/TemplateIcon.icns
-features/fixtures/SampleApp/SampleApp.xcodeproj/project.pbxproj
-features/fixtures/SampleApp/SampleApp_Prefix.pch
-features/fixtures/SampleApp/build/Release/README.txt
-features/fixtures/SampleApp/build/Release/dmg/README.txt
-features/fixtures/SampleApp/main.m
 features/fixtures/custom_assets/appicon.icns
 features/initial_generator.feature
 features/rake_tasks.feature
@@ -68,29 +37,3 @@ spec/choctop_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 tasks/rspec.rake
-website/_layouts/default.html
-website/_layouts/post.html
-website/_posts/2009-02-02-first-post.markdown
-website/_site/2009/02/02/first-post.html
-website/_site/atom.xml
-website/_site/config.yml
-website/_site/css/stylesheet.css
-website/_site/images/logo.gif
-website/_site/images/logo.jpg
-website/_site/images/logo.png
-website/_site/images/love-16.gif
-website/_site/images/love.gif
-website/_site/images/mocra-keynote-bg.jpg
-website/_site/images/title slide.jpg
-website/_site/images/title-slide.png
-website/_site/index.html
-website/atom.xml
-website/config.yml
-website/css/stylesheet.css
-website/images/logo.gif
-website/images/logo.png
-website/images/love-16.gif
-website/images/love.gif
-website/images/mocra-keynote-bg.jpg
-website/images/title-slide.png
-website/index.markdown

data/README.rdoc

@@ -4,6 +4,9 @@
 
 == DESCRIPTION:
 
+Build and deploy tools for Cocoa apps using Sparkle for distributions and upgrades; 
+it’s like Hoe but for Cocoa apps.
+
 Package up your OS X/Cocoa applications into Custom DMGs, generate Sparkle XML, and
 upload. Instead of hours, its only 30 seconds to release each new version of an application.
 
@@ -67,6 +70,9 @@ to the end:
       
       # Extra files
       s.add_file 'path/to/README.txt', :position => [250, 90]
+      s.file :target_bundle, :position => [50, 100]
+      s.file proc { 'README.txt' }, :position => [50, 100]
+      s.file :position => [50, 100] { 'README.txt' }
       
       # Custom DMG options
       s.volume_icon = "dmg.icns"

data/Rakefile

@@ -1,29 +1,25 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/choctop'
+gem 'hoe', '>= 2.3.2'
+require 'hoe'
+gem 'newgem', '>= 1.5.0'
+require 'newgem'
+require './lib/choctop'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('choctop', ChocTop::VERSION) do |p|
-  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
-  p.developer('Chris Bailey', 'chris@cobaltedge.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps         = [
-    ['activesupport'],
-    ['builder','>= 2.1.2'],
-    ['RedCloth', '>=4.1.1']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'choctop' do
+  developer 'Dr Nic Williams', 'drnicwilliams@gmail.com'
+  developer 'Chris Bailey', 'chris@cobaltedge.com'
+
+  extra_deps << ['activesupport']
+  extra_deps << ['builder','>= 2.1.2']
+  extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
+end
+
+task :release do
+  sh "gem push pkg/#{$hoe.name}-#{$hoe.version}.gem"
 end
 
 require 'newgem/tasks' # load /tasks/*.rake
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-# TODO - want other tests/tasks run by default? Add them to the list
 task :default => [:features]

data/features/development.feature

@@ -10,4 +10,4 @@ Feature: Development processes of newgem itself (rake tasks)
     When I invoke task "rake gem"
     Then folder "pkg" is created
     And file with name matching "pkg/*.gem" is created else you should run "rake manifest" to fix this
-    And gem spec key "rdoc_options" contains /--mainREADME.rdoc/
+    And gem spec key "rdoc_options" contains /(--mainREADME.rdoc|\[\"--main\", \"README.rdoc\"\])/

data/features/dmg.feature

@@ -43,3 +43,11 @@ Feature: Can build a customised DMG image from application build
     And dmg "appcast/build/SampleApp-0.1.0.dmg" is mounted as "SampleApp"
     And file "README.txt" in mounted volume is created
     And file "SampleApp.app.dSYM" in mounted volume is not created
+
+  Scenario: Build a DMG for non-Xcode project
+    Given a non-Xcode chcotop project "MyProject" with files: README.txt, SomeBundle.thingy
+    When I invoke task "rake dmg"
+    And dmg "appcast/build/MyProject.dmg" is mounted as "MyProject"
+    And file "README.txt" in mounted volume is created
+    And file "SomeBundle.thingy" in mounted volume is created
+    And file "Applications" in mounted volume is not created

data/features/rake_tasks.feature

@@ -20,6 +20,7 @@ Feature: Rake tasks are available to build and deploy Cocoa apps with Sparkle
     When I invoke task "rake upload"
     Then remote file "my_feed.xml" is created
     Then remote file "SampleApp-0.1.0.dmg" is created
+    Then remote file "SampleApp.dmg" is created
     Then remote file "index.php" is created
     
   Scenario: change the version number in the Info.plist

data/features/step_definitions/common_steps.rb

@@ -1,13 +1,4 @@
-Given /^a safe folder/ do
-  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  FileUtils.mkdir_p @tmp_root
-  FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
-  @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
-  Given %Q{env variable $HOME set to "#{@home_path}"}
-end
-
 Given /^this project is active project folder/ do
-  Given "a safe folder"
   @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
 end
 

data/features/step_definitions/dmg_steps.rb

@@ -2,18 +2,14 @@ Given /is configured for custom Applications icon$/ do
   appicon = File.expand_path(File.dirname(__FILE__) + "/../fixtures/custom_assets/appicon.icns")
   in_project_folder do
     append_to_file "Rakefile", <<-RUBY.gsub(/^    /, '')
-    $sparkle.applications_icon = "appicon.icns"
+    $choctop.applications_icon = "appicon.icns"
     RUBY
     FileUtils.cp(appicon, "appicon.icns")
   end
 end
 
 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
+  choctop_add_file(file)
 end
 
 When /^dmg "(.*)" is mounted as "(.*)"$/ do |dmg, name|

data/features/step_definitions/generator_steps.rb

@@ -1,5 +1,4 @@
 Given /^a Cocoa app that does not have an existing Rakefile$/ do
-  Given "a safe folder"
   setup_active_project_folder "SampleApp"
 end
 
@@ -25,7 +24,6 @@ Given /Rakefile constants rewired for local rsync/ do
 end
 
 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
   FileUtils.mkdir_p @remote_folder
@@ -38,3 +36,16 @@ Given /^a Cocoa app with choctop installed called "(.*)"$/ do |name|
   Given "Rakefile constants rewired for local rsync"
   ENV['NO_FINDER'] = 'YES' # disable Finder during tests
 end
+
+Given /^a non\-Xcode chcotop project "([^\"]*)" with files: (.*)$/ do |name, files|
+  files = files.strip.split(/\s*,\s*/)
+  setup_active_project_folder name
+  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
+  in_project_folder do
+    files.each { |file| `touch #{file}` }
+  end
+  files.each { |file| choctop_add_file(file) }
+end

data/features/step_definitions/remote_steps.rb

@@ -13,8 +13,8 @@ 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}
+    $choctop.host = ""
+    $choctop.remote_dir = #{@remote_folder.inspect}
     RUBY
   end
 end
@@ -22,9 +22,9 @@ end
 Given /^ChocTop config is configured for remote Sparkle$/ do
   in_project_folder do
     append_to_file "Rakefile", <<-RUBY.gsub(/^    /, '')
-    $sparkle.host = "mocra.com"
-    $sparkle.base_url = "http://mocra.com/sample_app"
-    $sparkle.remote_dir = "/opt/apps/mocra/downloads/sample_app"
+    $choctop.host = "mocra.com"
+    $choctop.base_url = "http://mocra.com/sample_app"
+    $choctop.remote_dir = "/opt/apps/mocra/downloads/sample_app"
     RUBY
   end
 end

data/features/support/env.rb

@@ -1,9 +1,16 @@
 require File.dirname(__FILE__) + "/../../lib/choctop"
 
 require "rubygems"
-gem 'cucumber'
 require 'cucumber'
-gem 'rspec'
 require 'spec'
 
-require "activesupport"
+require "activesupport"
+
+Before do
+  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  FileUtils.rm_rf   @tmp_root
+  FileUtils.mkdir_p @home_path
+  ENV['HOME'] = @home_path
+  @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+end

data/lib/choctop.rb

@@ -11,7 +11,7 @@ require "active_support"
 require "RedCloth"
 
 class ChocTop
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
   
   # Path to the Info.plist
   # Default: "Info.plist"
@@ -28,6 +28,13 @@ class ChocTop
   # The target name of the distributed DMG file
   # Default: #{name}.app
   attr_accessor :target
+  def target
+    @target ||= File.basename(target_bundle) if target_bundle
+  end
+
+  def target_bundle
+    @target_bundle ||= Dir["build/#{build_type}/#{name}.*"].first
+  end
 
   # The build type of the distributed DMG file
   # Default: Release
@@ -39,7 +46,11 @@ class ChocTop
   
   # The host name, e.g. some-domain.com
   # Default: host from base_url
-  attr_accessor :host
+  attr_accessor :host 
+  
+  # The user to log in on the remote server.
+  # Default: empty
+  attr_accessor :user
   
   # The url from where the xml + dmg files will be downloaded
   # Default: dir path from appcast_filename
@@ -49,6 +60,10 @@ class ChocTop
   # Default: release_notes.html
   attr_accessor :release_notes
   
+  # The file name for the project readme file
+  # Default: README.txt
+  attr_accessor :readme
+  
   # List of files/bundles to be packaged into the DMG
   attr_accessor :files
 
@@ -84,7 +99,13 @@ class ChocTop
   # Generated filename for a distribution, from name, version and .dmg
   # e.g. MyApp-1.0.0.dmg
   def pkg_name
-    "#{name}-#{version}.dmg"
+    version ? "#{name}-#{version}.dmg" : versionless_pkg_name
+  end
+  
+  # Version-less generated filename for a distribution, from name and .dmg
+  # e.g. MyApp.dmg
+  def versionless_pkg_name
+    "#{name}.dmg"
   end
   
   # Path to generated package DMG
@@ -161,25 +182,31 @@ class ChocTop
   end
   
   # Add an explicit file/bundle/folder into the DMG
+  # Examples:
+  #   file 'build/Release/SampleApp.app', :position => [50, 100]
+  #   file :target_bundle, :position => [50, 100]
+  #   file proc { 'README.txt' }, :position => [50, 100]
+  #   file :position => [50, 100] { 'README.txt' }
   # 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]
+  def file(*args, &block)
+    path_or_helper, options = args.first.is_a?(Hash) ? [block, args.first] : [args.first, args.last]
+    throw "add_files #{path_or_helper}, :position => [x,y] option is missing" unless options[:position]
     self.files ||= {}
-    files[path] = options
+    files[path_or_helper] = options
   end
-  
+  alias_method :add_file, :file
+
   def initialize
-    $sparkle = self # define a global variable for this object
+    $choctop = $sparkle = self # define a global variable for this object ($sparkle is legacy)
     
     yield self if block_given?
     
     # Defaults
     @info_plist_path ||= 'Info.plist'
-    @name ||= info_plist['CFBundleExecutable']
-    @name = File.basename(File.expand_path(".")) if name.to_s == "${EXECUTABLE_NAME}"
+    @name ||= info_plist['CFBundleExecutable'] || File.basename(File.expand_path("."))
+    @name = File.basename(File.expand_path(".")) if @name == '${EXECUTABLE_NAME}'
     @version ||= info_plist['CFBundleVersion']
-    @target ||= "#{name}.app"
     @build_type = ENV['BUILD_TYPE'] || 'Release'
     
     if @su_feed_url = info_plist['SUFeedURL']
@@ -190,6 +217,7 @@ class ChocTop
       @host ||= URI.parse(base_url).host
     end
     @release_notes ||= 'release_notes.html'
+    @readme        ||= 'README.txt'
     @release_notes_template ||= "release_notes_template.html.erb"
     @rsync_args ||= '-aCv --progress'
     
@@ -200,7 +228,7 @@ class ChocTop
     @icon_size ||= 104
     @icon_text_size ||= 12
 
-    add_file "build/#{build_type}/#{target}", :position => app_icon_position
+    add_file :target_bundle, :position => app_icon_position
     
     define_tasks
   end
@@ -227,6 +255,7 @@ class ChocTop
     desc "Create/update the appcast file"
     task :feed do
       make_appcast
+      make_dmg_symlink
       make_index_redirect
       make_release_notes
     end

data/lib/choctop/appcast.rb

@@ -1,6 +1,6 @@
 module ChocTop::Appcast
   def make_build
-    if ENV['NO_BUILD']
+    if skip_build
       puts "Skipping build task..."
     else
       sh "xcodebuild -configuration #{build_type}"
@@ -9,8 +9,7 @@ module ChocTop::Appcast
   
   def make_appcast
     app_name = File.basename(File.expand_path('.'))
-    
-    FileUtils.mkdir_p "#{build_path}"
+    FileUtils.mkdir_p(build_path)
     appcast = File.open("#{build_path}/#{appcast_filename}", 'w') do |f|
       xml = Builder::XmlMarkup.new(:indent => 2)
       xml.instruct!
@@ -44,12 +43,25 @@ module ChocTop::Appcast
     end
   end
   
+  def make_dmg_symlink
+    FileUtils.chdir(build_path) do
+      `ln -s #{pkg_name} #{versionless_pkg_name}`
+    end
+  end
+  
   def make_index_redirect
     File.open("#{build_path}/index.php", 'w') do |f|
       f << %Q{<?php header("Location: #{pkg_relative_url}"); ?>}
     end
   end
   
+  def skip_build
+    return true if ENV['NO_BUILD']
+    return false if File.exists?('Info.plist')
+    return false if Dir['*.xcodeproj'].size > 0
+    true
+  end
+  
   def make_release_notes
     File.open("#{build_path}/#{release_notes}", "w") do |f|
       template = File.read(release_notes_template)
@@ -75,7 +87,8 @@ module ChocTop::Appcast
 
   def upload_appcast
     _host = host.blank? ? "" : "#{host}:"
-    sh %{rsync #{rsync_args} #{build_path}/ #{_host}#{remote_dir}}
+    _user = user.blank? ? "" : "#{user}@"
+    sh %{rsync #{rsync_args} #{build_path}/ #{_user}#{_host}#{remote_dir}}
   end
   
   # Returns a file path to the dsa_priv.pem file