choctop 0.9.6 → 0.10.0

data/History.txt

@@ -1,3 +1,13 @@
+== 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!!!

data/Manifest.txt

@@ -38,27 +38,36 @@ 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
 features/sparkle_feed.feature
-features/steps/common.rb
-features/steps/dmg_steps.rb
-features/steps/env.rb
-features/steps/file_attribute_steps.rb
-features/steps/generator.rb
-features/steps/remote.rb
-features/steps/xcode_steps.rb
+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
 website/_layouts/default.html
 website/_layouts/post.html
 website/_posts/2009-02-02-first-post.markdown

data/README.rdoc

@@ -52,17 +52,21 @@ to the end:
     require "choctop"
 
     ChocTop.new do |s|
-      s.host     = 'project.com'
       s.remote_dir = '/path/to/upload/root/of/app'
       
       # Optional, showing defaults
-      s.base_url   = "http://#{s.host}"
+      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]
       
       # Custom DMG options
       s.volume_icon = "dmg.icns"
@@ -131,4 +135,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app_generators/install_choctop/templates/Rakefile.erb

@@ -4,9 +4,8 @@ require "rake"
 require "choctop"
 
 ChocTop.new do |s|
-  # Remote upload target
-  s.host     = '<%= urlname %>.com'
-  # s.base_url   = "http://#{s.host}"
+  # 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

data/features/development.feature

@@ -6,8 +6,8 @@ Feature: Development processes of newgem itself (rake tasks)
     
   Scenario: Generate RubyGem
     Given this project is active project folder
-    And 'pkg' folder is deleted
-    When task 'rake gem' is invoked
-    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 "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/

data/features/dmg.feature

@@ -4,36 +4,42 @@ Feature: Can build a customised DMG image from application build
   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 task 'rake dmg' is invoked
-    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
+    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 task 'rake dmg' is invoked
-    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
+    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'
+    Given a Cocoa app with choctop installed called "SampleApp"
     And is configured for custom Applications icon
-    When task 'rake dmg' is invoked
-    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'
-
-
+    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

data/features/fixtures/SampleApp/README.txt

@@ -0,0 +1 @@
+This is the README for the SampleApp

data/features/fixtures/SampleApp/build/Release/README.txt

@@ -0,0 +1 @@
+This is the README for the SampleApp

data/features/fixtures/SampleApp/build/Release/dmg/README.txt

@@ -0,0 +1 @@
+This is the README for the SampleApp

data/features/initial_generator.feature

@@ -5,20 +5,20 @@ Feature: Setup a Cocoa app with choctop
   
   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 '.'
+    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 output does match /rake build/
-    And output does match /rake upload/
+    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
+  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 output does match /USAGE: install_choctop path\/to\/CocoaApp/
+    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 contents of file 'release_notes.txt' does match /Initial release/
+    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

@@ -4,27 +4,27 @@ Feature: Rake tasks are available to build and deploy Cocoa apps with Sparkle
   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 task 'rake build' is invoked
-    Then folder 'build/Release/SampleApp.app' is created
+    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 task 'rake dmg' is invoked
-    Then file 'appcast/build/SampleApp-0.1.0.dmg' is created
+    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 task 'rake dmg feed' is invoked
+    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 task 'rake upload' is invoked
-    Then remote file 'my_feed.xml' is created
-    Then remote file 'SampleApp-0.1.0.dmg' is created
-    Then remote file 'index.php' is created
+    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 "index.php" is created
     
   Scenario: change the version number in the Info.plist
-    Given a Cocoa app with choctop installed called 'SampleApp'
-    When task 'rake version:set VERSION="1.2.3"' is invoked 
-    Then current xcode project version is '1.2.3'
+    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

@@ -4,35 +4,35 @@ Feature: Generate an XML file for Sparkle to use for updates
   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'
+    Given a Cocoa app with choctop installed called "SampleApp"
     And ChocTop config is configured for remote Sparkle
-    When task 'rake dmg feed' is invoked
-    Then file 'appcast/build/my_feed.xml' is created
-    And contents of file 'appcast/build/my_feed.xml' does match /<channel>/
-    And contents of file 'appcast/build/my_feed.xml' does match /</channel>/
-    And contents of file 'appcast/build/my_feed.xml' does match /<pubDate>/
-    And contents of file 'appcast/build/my_feed.xml' does match /<item>/
-    And contents of file 'appcast/build/my_feed.xml' does match /<title>SampleApp 0.1.0</title>/
-    And contents of file 'appcast/build/my_feed.xml' does match /href="http://mocra.com/sample_app/my_feed.xml"/
-    And contents of file 'appcast/build/my_feed.xml' does match /<sparkle:releaseNotesLink>http://mocra.com/sample_app/release_notes.html</sparkle:releaseNotesLink>/
-    And file 'appcast/build/index.php' is created
-    And contents of file 'appcast/build/index.php' does match /Location/
-    And contents of file 'appcast/build/index.php' does match /SampleApp-0.1.0.dmg/
-    And file 'appcast/build/release_notes.html' is created
-    And contents of file 'appcast/build/release_notes.html' does match /0.1.0/
-    And contents of file 'appcast/build/release_notes.html' does match /<h2>Initial release</h2>/
-    And contents of file 'appcast/build/release_notes.html' does match /<p>Yay! First release.</p>/
-    And contents of file 'appcast/build/release_notes.html' does match /<html>/
+    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'
+    Given a Cocoa app with choctop installed called "SampleApp"
     And ChocTop config is configured for remote Sparkle
-    And file 'release_notes.txt' is deleted
-    When task 'rake dmg feed' is invoked
-    Then file 'appcast/build/release_notes.html' is created
-    And contents of file 'appcast/build/release_notes.html' does match /0.1.0/
-    And contents of file 'appcast/build/release_notes.html' does match /<h2>Another awesome release!</h2>/
-    And contents of file 'appcast/build/release_notes.html' does match /<html>/
+    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>/
 
 
 

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,177 @@
+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
+
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+Given /"(.*)" (folder|file) is deleted/ do |type, file|
+  in_project_folder { FileUtils.rm_rf file }
+end
+
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+  @stdout = StringIO.new
+  in_project_folder do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I invoke task "rake (.*)"/ do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file "(.*)" (is|is not) created/ do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file with name matching "(.*)" is created/ do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then /^I should see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then %r{^I should see /(.*)/$} do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
+end
+
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then /^Rakefile can display tasks successfully/ do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  in_project_folder do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then /^task "rake (.*)" is executed successfully/ do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end