billymeltdown-choctop 0.11.0

data/History.txt

@@ -0,0 +1,59 @@
+
+* 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]+
+
+== 0.9.7 2009-05-17
+
+* New config option: s.build_type = ENV['BUILD_TYPE'] || 'Release' [kdbdallas]
+* permit SUFeedURL to not be specified (cleanly exit from deploy rake tasks)
+* removed unused 'appcast' rake task
+
+== 0.9.6 2009-02-10
+
+* Custom Applications Icons!!!
+* New config option: s.application_icon = "xxx.png"
+* New config option: s.icon_text_size = 12
+* rake dmg NO_BUILD=1 will skip the build step
+* The background image no longer appears in the "real time" design of the DMG as its in .background folder
+
+== 0.9.5 2009-02-03
+
+* Fixed whitespace in project names bug
+
+== 0.9.4 2009-01-31
+
+* ReleaseNotes.txt renamed to release_notes.txt in applications
+
+== 0.9.3 2009-01-29
+
+* install_choctop generates a release_notes.txt file
+* 'rake feed' converts release_notes.txt into release_notes.html file for upload
+* #name is the project's folder name if info_plist['CFBundleExecutable'] == "${EXECUTABLE_NAME}"
+* builder of xml feed flushes immediately now so no more 0 length xml feeds
+
+== 0.9.2 2009-01-29
+
+* fixed instances of "SUFeedURLKey" to "SUFeedURL" due to f@#$-up error message in Sparkle code that led me astray
+
+== 0.9.1 2009-01-29
+
+* default DMG theme is a sky background and plain volume icon
+* sparkle xml feed includes a DSA signature
+* explicit release_notes property
+
+== 0.9.0 2009-01-28
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,39 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+app_generators/install_choctop/install_choctop_generator.rb
+app_generators/install_choctop/templates/Rakefile.erb
+app_generators/install_choctop/templates/release_notes.txt.erb
+app_generators/install_choctop/templates/release_notes_template.html.erb
+assets/DefaultVolumeIcon.icns
+assets/sky.jpg
+assets/sky_background.jpg
+assets/vanillia_dmg_icon.png
+assets/wood.jpg
+bin/install_choctop
+features/development.feature
+features/dmg.feature
+features/fixtures/custom_assets/appicon.icns
+features/initial_generator.feature
+features/rake_tasks.feature
+features/sparkle_feed.feature
+features/step_definitions/common_steps.rb
+features/step_definitions/dmg_steps.rb
+features/step_definitions/file_attribute_steps.rb
+features/step_definitions/generator_steps.rb
+features/step_definitions/remote_steps.rb
+features/step_definitions/xcode_steps.rb
+features/support/common.rb
+features/support/env.rb
+features/support/matchers.rb
+lib/choctop.rb
+lib/choctop/appcast.rb
+lib/choctop/dmg.rb
+script/console
+script/destroy
+script/generate
+spec/choctop_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,155 @@
+= choctop
+
+* http://drnic.github.com/choctop
+
+== Modifications by billymeltdown:
+
+Just some real basic stuff for our internal use here at Zetetic. I'd ignore the :scp business, 
+in the end it turned out to be whack, but I'll preserve it here in case anyone really needs it. 
+Rsync is definitely more appropriate.
+
+The thing I needed in particular was to be able to pass build settings to xcodebuild that I 
+have set in the XCode project and that we use in dependent projects (e.g. -sdk macosx10.5, etc).
+
+Added a gemspec so I can publish it from github, allowing us here at zetetic to use it specifically.
+
+== 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.
+
+Build and deploy tools for Cocoa apps using Sparkle for distributions and upgrades; it's
+like Hoe but for Cocoa apps.
+
+The main feature is a powerful rake task "rake appcast" which builds a release of your
+application, creates a DMG package, generates a Sparkle XML file, and posts the package
+and XML file to your remote host via rsync.
+
+All rake tasks:
+
+    rake appcast         # Create dmg, update appcast file, and upload to host
+    rake build   # Build Xcode Release
+    rake dmg     # Create the dmg file for appcasting
+    rake feed    # Create/update the appcast file
+    rake upload  # Upload the appcast file to the host
+
+== Why is it called 'ChocTop'? 
+
+In Australia, Choc-Tops are ice cream cones, with hardened chocolate on top, 
+normally served at the movie cinemas. When we (http://mocra.com) were brainstorming a name for this
+project we combined "Sparkle" + "Cocoa" + "it's almost lunch time and we're hungry" to remember 
+the wonderful Choc-Top ice creams. MMmmm.
+
+Wikipedia: http://en.wikipedia.org/wiki/Choc-Top
+
+== FEATURES/PROBLEMS:
+
+ChocTop comes with rake tasks to instantly deploy your latest Cocoa app's version
+to a remote host, instantly activating all your users' Sparkle auto-updates.
+
+* builds a Release of your project from your Xcode project (via xcodebuild tool)
+* packages a DMG of your released app using Info.plist configuration (rake dmg)
+* generates Sparkle-formatted XML file
+* uploads the DMG and XML files to a remote host
+
+== SYNOPSIS:
+
+  cd to/my/cocoa/app
+  install_choctop .
+  
+Alternately, if you already have a Rakefile in your Xcode project, then add the following
+to the end:
+
+    require "choctop"
+
+    ChocTop.new do |s|
+      s.remote_dir = '/path/to/upload/root/of/app'
+      
+      # Optional, showing defaults
+      s.host          = host from Info.plist['SUFeedURL']
+      s.base_url      = "http://#{s.host}"
+      s.release_notes = "release_notes.html"
+      
+      # Custom DMG
+      s.background_file = "background.jpg"
+      s.app_icon_position = [100, 90]
+      s.applications_icon_position =  [400, 90]
+      s.applications_icon =  "applications.icns"
+      
+      # 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"
+      s.icon_size = 104
+    end
+
+In your Rakefile, update the ChocTop configuration with the host and remote_dir details.
+The rake tasks use rsync to upload the files, so ensure that you have ssh access to the
+remote server, with a password/ssh keys.
+
+Also, in your project's Info.plist, remember to update/add the following keys:
+
+    CFBundleExecutable - name of your project
+    CFBundleVersion - version for next release, using X.Y.Z format
+    SUFeedURL - url to Sparkle URL (future: insert this automatically)
+
+The create the distribution, Sparkle XML file, and upload it to the remote host:
+
+  rake appcast
+
+The build process uses your Xcode project file, via the xcodebuild command. If this fails,
+you may need to run the build process manually via Xcode. Set Configuration to Release (normally
+its set to Debug for development) and then Build. The "rake appcast" task should finish to completion.
+
+== REQUIREMENTS:
+
+* RubyCocoa (installed with OS X 10.5 Leopard)
+* Xcode 3+
+
+== INSTALL:
+
+    sudo gem install choctop
+
+== ORIGINAL CODE IDEAS:
+
+* Chris Bailey at http://codeintensity.blogspot.com/2008/03/creating-sparkle-appcast-via-rake-tasks.html
+* Eloy Duran's Rucola at http://github.com/alloy/rucola
+* Emanuele Vicentini's rake_dmg at http://github.com/baldowl/rake_dmg
+* AppleScript ideas from http://svn.tribler.org/abc/branches/old-mainbranch-till-4.1.7plus/mac/Makefile-from-vlc-ready
+
+    
+== SPONSORED BY:
+
+http://mocra.com - Mocra - the premier Rails/iPhone consultancy
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Dr Nic Williams, drnicwilliams@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+gem 'hoe', '>= 2.3.2'
+require 'hoe'
+gem 'newgem', '>= 1.5.0'
+require 'newgem'
+require './lib/choctop'
+
+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 }
+
+task :default => [:features]

data/app_generators/install_choctop/install_choctop_generator.rb

@@ -0,0 +1,49 @@
+class InstallChoctopGenerator < RubiGen::Base
+  attr_reader :name, :module_name, :urlname, :version
+
+  default_options :version => "0.1.0"
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name        = base_name
+    @module_name = name.gsub(/[-]+/, '_').camelcase
+    @urlname     = name.gsub(/[-_]+/, '').downcase
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      %w( appcast/build ).each { |path| m.directory path }
+
+      m.template "Rakefile.erb", "Rakefile"
+      m.template "release_notes.txt.erb", "release_notes.txt"
+      m.file "release_notes_template.html.erb", "release_notes_template.html.erb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Installs choctop into your Cocoa application. This gives you
+rake tasks to build and deploy your Cocoa app's latest version for
+Sparkle appcast mechanism.
+
+USAGE: #{spec.name} path/to/CocoaApp
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("-V", "--initial-version", 
+              "Show the #{File.basename($0)} version number and quit.",
+              "Default: 0.1.0") { |o| options[:version] = o }
+    end
+
+    def extract_options
+      @version = options[:version]
+    end
+end

data/app_generators/install_choctop/templates/Rakefile.erb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "rake"
+
+require "choctop"
+
+ChocTop.new do |s|
+  # Remote upload target (set host if not same as Info.plist['SUFeedURL'])
+  # s.host     = '<%= urlname %>.com'
+  s.remote_dir = '/path/to/upload/root/of/app'
+
+  # Custom DMG
+  # s.background_file = "background.jpg"
+  # s.app_icon_position = [100, 90]
+  # s.applications_icon_position =  [400, 90]
+  # s.volume_icon = "dmg.icns"
+  # s.applications_icon = "appicon.icns" # or "appicon.png"
+end

data/app_generators/install_choctop/templates/release_notes.txt.erb

@@ -0,0 +1,5 @@
+h1. <span><%= Date.today %></span> Release <%= version %>
+
+h2. Initial release
+
+Yay! First release.

data/app_generators/install_choctop/templates/release_notes_template.html.erb

@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <title>Release Notes</title>
+    <style>
+    * { font-family: serif;}
+    h1 { font-family: sans-serif; background-color: #ABABFF; padding: 10px;}
+    h1 span { font-size: 75%; font-weight: normal; float: right;}
+    </style>
+  </head>
+  <body>
+    <%= release_notes_html %>
+  </body>
+</html>

data/bin/install_choctop

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'install_choctop/version'
+  puts "#{File.basename($0)} #{InstallChocTop::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'install_choctop')
+puts <<-EOS
+You use choctop with the following rake tasks:
+  rake appcast         # Create dmg, update appcast file, and upload to host
+  rake build   # Create/update the appcast file
+  rake dmg     # Create the dmg file for appcasting
+  rake upload  # Upload the appcast file to the host
+EOS

data/features/development.feature

@@ -0,0 +1,13 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And "pkg" folder is deleted
+    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|\[\"--main\", \"README.rdoc\"\])/

data/features/dmg.feature

@@ -0,0 +1,53 @@
+Feature: Can build a customised DMG image from application build
+  In order to reduce cost of building DMG images for each release of an application
+  As a Cocoa developer or release manager
+  I want a rake task to generate a DMG based on custom settings
+
+  Scenario: Build a DMG with default custom DMG config
+    Given a Cocoa app with choctop installed called "SampleApp"
+    When I invoke task "rake dmg"
+    Then file "appcast/build/SampleApp-0.1.0.dmg" is created
+    When dmg "appcast/build/SampleApp-0.1.0.dmg" is mounted as "SampleApp"
+    Then folder "SampleApp.app" in mounted volume is created
+    And file "Applications" in mounted volume is created
+    And file ".background/background.jpg" in mounted volume is created
+    And file ".background/background.jpg" in mounted volume is invisible
+    And file ".VolumeIcon.icns" in mounted volume is created
+
+  Scenario: Build a DMG with a whitespace name
+    Given a Cocoa app with choctop installed called "App With Whitespace"
+    When I invoke task "rake dmg"
+    Then file "appcast/build/App With Whitespace-1.0.dmg" is created
+    When dmg "appcast/build/App With Whitespace-1.0.dmg" is mounted as "App With Whitespace"
+    Then folder "App With Whitespace.app" in mounted volume is created
+    And file "Applications" in mounted volume is created
+    And file ".background/background.jpg" in mounted volume is created
+    And file ".background/background.jpg" in mounted volume is invisible
+    And file ".VolumeIcon.icns" in mounted volume is created
+
+  Scenario: Build a DMG with custom Applications symlink icon
+    Given a Cocoa app with choctop installed called "SampleApp"
+    And is configured for custom Applications icon
+    When I invoke task "rake dmg"
+    And dmg "appcast/build/SampleApp-0.1.0.dmg" is mounted as "SampleApp"
+    Then file "Applications" in mounted volume is created
+    And file "Applications" in mounted volume has GetFileInfo type ""fdrp""
+    And file "Applications" in mounted volume has GetFileInfo alias "1"
+    And file "Applications" in mounted volume has GetFileInfo custom icon "1"
+    And file "Applications" in mounted volume is aliased to "/Applications"
+  
+  Scenario: Build a DMG with extra included file such as README in the project folder
+    Given a Cocoa app with choctop installed called "SampleApp"
+    And is configured for an asset file "README.txt" to be included in dmg
+    When I invoke task "rake dmg"
+    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/initial_generator.feature

@@ -0,0 +1,24 @@
+Feature: Setup a Cocoa app with choctop
+  In order to reduce cost of using Sparkle to generate appcasts
+  As a Cocoa developer or Cocoa application deployer
+  I want a generator to install rake tasks that make using Sparkle easy-peasy
+  
+  Scenario: Install choctop into an app that has no existing Rakefile
+    Given a Cocoa app that does not have an existing Rakefile
+    When I run local executable "install_choctop" with arguments "."
+    And Rakefile wired to use development code instead of installed RubyGem
+    Then file "Rakefile" is created
+    And I should see /rake build/
+    And I should see /rake upload/
+  
+  Scenario: Run "install_choctop" without arguments shows an error
+    Given a Cocoa app that does not have an existing Rakefile
+    When I run local executable "install_choctop" with arguments ""
+    Then I should see /USAGE: install_choctop path/to/CocoaApp/
+  
+  Scenario: Install choctop and generate a release_notes file
+    Given a Cocoa app that does not have an existing Rakefile
+    When I run local executable "install_choctop" with arguments "."
+    Then file "release_notes.txt" is created
+    And file "release_notes.txt" contents does match /Initial release/
+    

data/features/rake_tasks.feature

@@ -0,0 +1,31 @@
+Feature: Rake tasks are available to build and deploy Cocoa apps with Sparkle
+  In order to reduce time and cost of deploying Sparkle-enabled Cocoa apps
+  As a Cocoa developer or Cocoa application deployer
+  I want rake tasks to build and deploy my Cocoa app
+
+  Scenario: rake task to build Release of app
+    Given a Cocoa app with choctop installed called "SampleApp"
+    When I invoke task "rake build"
+    Then folder "build/Release/SampleApp.app" is created
+
+  Scenario: rake task to create dmg file of build
+    Given a Cocoa app with choctop installed called "SampleApp"
+    When I invoke task "rake dmg"
+    Then file "appcast/build/SampleApp-0.1.0.dmg" is created
+
+  Scenario: rake task to upload the appcast file to the server
+    Given a Cocoa app with choctop installed called "SampleApp"
+    And I invoke task "rake dmg feed"
+    And ChocTop config is configured for local rsync
+    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
+    Given a Cocoa app with choctop installed called "SampleApp"
+    When I invoke task "rake version:set VERSION="1.2.3"" 
+    Then current xcode project version is "1.2.3"
+  
+  

data/features/sparkle_feed.feature

@@ -0,0 +1,38 @@
+Feature: Generate an XML file for Sparkle to use for updates
+  In order to reduce cost of distributing apps to users
+  As a developer/release manager
+  I want to generate an XML file for the Sparkle framework
+  
+  Scenario: rake task to create/update the appcast file
+    Given a Cocoa app with choctop installed called "SampleApp"
+    And ChocTop config is configured for remote Sparkle
+    When I invoke task "rake dmg feed"
+    Then file "appcast/build/my_feed.xml" is created
+    And file "appcast/build/my_feed.xml" contents does match /<channel>/
+    And file "appcast/build/my_feed.xml" contents does match /</channel>/
+    And file "appcast/build/my_feed.xml" contents does match /<pubDate>/
+    And file "appcast/build/my_feed.xml" contents does match /<item>/
+    And file "appcast/build/my_feed.xml" contents does match /<title>SampleApp 0.1.0</title>/
+    And file "appcast/build/my_feed.xml" contents does match /href="http://mocra.com/sample_app/my_feed.xml"/
+    And file "appcast/build/my_feed.xml" contents does match /<sparkle:releaseNotesLink>http://mocra.com/sample_app/release_notes.html</sparkle:releaseNotesLink>/
+    And file "appcast/build/index.php" is created
+    And file "appcast/build/index.php" contents does match /Location/
+    And file "appcast/build/index.php" contents does match /SampleApp-0.1.0.dmg/
+    And file "appcast/build/release_notes.html" is created
+    And file "appcast/build/release_notes.html" contents does match /0.1.0/
+    And file "appcast/build/release_notes.html" contents does match /<h2>Initial release</h2>/
+    And file "appcast/build/release_notes.html" contents does match /<p>Yay! First release.</p>/
+    And file "appcast/build/release_notes.html" contents does match /<html>/
+  
+  Scenario: generate default release notes if no release_notes.txt
+    Given a Cocoa app with choctop installed called "SampleApp"
+    And ChocTop config is configured for remote Sparkle
+    And "release_notes.txt" file is deleted
+    When I invoke task "rake dmg feed"
+    Then file "appcast/build/release_notes.html" is created
+    And file "appcast/build/release_notes.html" contents does match /0.1.0/
+    And file "appcast/build/release_notes.html" contents does match /<h2>Initial release</h2>/
+    And file "appcast/build/release_notes.html" contents does match /<html>/
+
+
+