choctop 0.13.1 → 0.14.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.14.0 2010-07-30
+
+* install_choctop: added --tmbundle/--textmate flag
+* Added s.defaults/s.project_type to allow alternate default backgrounds; e.g. for all TextMate bundles
+* Don't mention CocoaApp in usage; choctop can do more now
+
 == 0.13.1 2010-07-07
 
 * Can add URL .webloc files into DMG via #add_link/#link helper

data/Manifest.txt

@@ -8,12 +8,18 @@ Manifest.txt
 README.rdoc
 Rakefile
 app_generators/install_choctop/install_choctop_generator.rb
+app_generators/install_choctop/templates/README.normal
+app_generators/install_choctop/templates/README.textmate
 app_generators/install_choctop/templates/Rakefile.erb
+app_generators/install_choctop/templates/Rakefile.textmate.erb
 app_generators/install_choctop/templates/release_notes.txt.erb
 app_generators/install_choctop/templates/release_notes_template.html.erb
-assets/DefaultVolumeIcon.icns
+assets/default_background.jpg
+assets/default_volume.icns
 assets/sky.jpg
 assets/sky_background.jpg
+assets/textmate_background.jpg
+assets/textmate_volume.icns
 assets/vanillia_dmg_icon.png
 assets/wood.jpg
 bin/install_choctop

data/app_generators/install_choctop/install_choctop_generator.rb

@@ -1,7 +1,5 @@
 class InstallChoctopGenerator < RubiGen::Base
-  attr_reader :name, :module_name, :urlname, :version
-
-  default_options :version => "0.1.0"
+  attr_reader :name, :module_name, :urlname, :version, :github_user
 
   def initialize(runtime_args, runtime_options = {})
     super
@@ -17,20 +15,27 @@ class InstallChoctopGenerator < RubiGen::Base
     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"
+      case options[:project_type]
+      when :textmate
+        m.template "Rakefile.textmate.erb", "Rakefile"
+        m.readme "README.textmate"
+      else
+        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"
+        m.readme "README.normal"
+      end
     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.
+Installs choctop into your project/Cocoa application. This gives you
+rake tasks to build and deploy your project's latest version into a DMG
+and for release via Sparkle appcast mechanism.
 
-USAGE: #{spec.name} path/to/CocoaApp
+USAGE: #{spec.name} path/to/project
 EOS
     end
 
@@ -38,12 +43,23 @@ EOS
       opts.separator ''
       opts.separator 'Options:'
       opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("--textmate", "--tmbundle", 
+              "Target project is a TextMate bundle",
+              "Default: false") { |o| options[:project_type] = :textmate }
       opts.on("-V", "--initial-version", 
-              "Show the #{File.basename($0)} version number and quit.",
+              "Set initial version number.",
               "Default: 0.1.0") { |o| options[:version] = o }
     end
 
     def extract_options
-      @version = options[:version]
+      @version     = options[:version]
+      @github_user = options[:github_user]
+    end
+    
+    def self.default_github_user
+      `git config github.user || whoami`.strip
     end
-end
+
+  default_options :version => "0.1.0", :github_user => default_github_user
+
+end

data/app_generators/install_choctop/templates/README.normal

@@ -0,0 +1,5 @@
+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 dmg and appcast files to the host

data/app_generators/install_choctop/templates/README.textmate

@@ -0,0 +1,3 @@
+You use choctop with the following rake tasks:
+  rake dmg     # Create the dmg file for appcasting
+  rake upload  # Upload the dmg file to the host

data/app_generators/install_choctop/templates/Rakefile.textmate.erb

@@ -0,0 +1,15 @@
+require "rubygems"
+require "rake"
+
+require "choctop"
+
+ChocTop::Configuration.new do |s|
+  s.name = '<%= name %>'
+
+  s.add_root :position => [90, 70], :exclude => %w[build .bundle .git]
+  # s.add_link 'http://github.com/<%= github_user %>/<%= name %>', 'GitHub', :position => [220, 70]
+
+  s.defaults :textmate
+  # s.background_file = 'Support/dmg/dmg_background.png'
+  # s.volume_icon     = 'Support/dmg/dmg_volume_icon.icns'
+end

data/bin/install_choctop

@@ -15,10 +15,3 @@ source = RubiGen::PathSource.new(:application,
 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/initial_generator.feature

@@ -14,11 +14,22 @@ Feature: Setup a Cocoa app with choctop
   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/
+    Then I should see /USAGE: install_choctop path/to/project/
   
   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/
-    
+  
+  Scenario: Install into a tmbundle
+    Given a TextMate bundle project "MyBundle"
+    When I run local executable "install_choctop" with arguments ". --textmate"
+    Then file "Rakefile" is created
+    Then file "release_notes.txt" is not created
+    When I invoke task "rake dmg"
+    And dmg "appcast/build/MyBundle.tmbundle.dmg" is mounted as "MyBundle.tmbundle"
+    And file "MyBundle.tmbundle" in mounted volume is created
+    And file "Applications" in mounted volume is not created
+  
+  

data/lib/choctop.rb

@@ -18,7 +18,7 @@ module ChocTop
     include Dmg
     include RakeTasks
   
-    VERSION = '0.13.1'
+    VERSION = '0.14.0'
   
     attr_writer :build_opts
     def build_opts
@@ -297,6 +297,31 @@ module ChocTop
       files[options[:name]] = options
     end
     alias_method :add_link, :link
+    
+    # Specify which background + volume images to use by default
+    # Can also add default targets
+    # Supports
+    # * :normal (default)
+    # * :textmate
+    def defaults(project_type)
+      case @project_type = project_type.to_sym
+      when :normal
+        @background_file ||= File.dirname(__FILE__) + "/../assets/default_background.jpg"
+        @volume_icon     ||= File.dirname(__FILE__) + "/../assets/default_volume.icns"
+        @app_icon_position          ||= [175, 65]
+        @applications_icon_position ||= [347, 270]
+        @icon_size      ||= 104
+        @icon_text_size ||= 12
+        
+        add_file :target_bundle, :position => app_icon_position
+      when :textmate
+        @background_file ||= File.dirname(__FILE__) + "/../assets/textmate_background.jpg"
+        @volume_icon     ||= File.dirname(__FILE__) + "/../assets/textmate_volume.icns"
+        @icon_size       ||= 104
+        @icon_text_size  ||= 12
+      end
+    end
+    alias_method :project_type, :defaults
 
     def initialize
       $choctop = $sparkle = self # define a global variable for this object ($sparkle is legacy)
@@ -317,16 +342,9 @@ module ChocTop
       @readme        ||= 'README.txt'
       @release_notes_template ||= "release_notes_template.html.erb"
       @rsync_args ||= '-aCv --progress'
-    
-      @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 :target_bundle, :position => app_icon_position
-    
+      defaults :normal unless @project_type
+
       define_tasks
     end
   end

data/lib/choctop/appcast.rb

@@ -44,9 +44,11 @@ module ChocTop
     end
 
     def make_dmg_symlink
-      FileUtils.chdir(build_path) do
-        `rm '#{versionless_pkg_name}'`
-        `ln -s '#{pkg_name}' '#{versionless_pkg_name}'`
+      if pkg_name != versionless_pkg_name
+        FileUtils.chdir(build_path) do
+          `rm '#{versionless_pkg_name}'`
+          `ln -s '#{pkg_name}' '#{versionless_pkg_name}'`
+        end
       end
     end
 
@@ -63,9 +65,11 @@ module ChocTop
     end
 
     def make_release_notes
-      File.open("#{build_path}/#{release_notes}", "w") do |f|
-        template = File.read(release_notes_template)
-        f << ERB.new(template).result(binding)
+      if File.exist?(release_notes_template)
+        File.open("#{build_path}/#{release_notes}", "w") do |f|
+          template = File.read(release_notes_template)
+          f << ERB.new(template).result(binding)
+        end
       end
     end
 

data/lib/choctop/rake_tasks.rb

@@ -40,10 +40,6 @@ module ChocTop
         detach_dmg
       end
 
-      task :size do
-        puts configure_dmg_window
-      end
-
       namespace :version do
         desc "Display the current version"
         task :current do

data/lib/choctop/version_helper.rb

@@ -25,6 +25,11 @@ module ChocTop
         @minor = $2.to_i
         @patch = $3.to_i
         @build = $4
+      else
+        @major = 0
+        @minor = 0
+        @patch = 0
+        @build = nil
       end
     end
 

data/spec/choctop_spec.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe ChocTop::Configuration do
-  
   describe "default" do
     before(:each) do
       FileUtils.chdir(File.dirname(__FILE__) + "/../features/fixtures/SampleApp") do
@@ -93,4 +92,48 @@ describe ChocTop::Configuration do
       @choctop.set_position_of_shortcuts.should_not =~ /applications_folder/
     end
   end
+  
+  describe "defaults" do
+    before do
+      @my_project_path = File.dirname(__FILE__) + "/../tmp/MyProject"
+      FileUtils.rm_rf(@my_project_path)
+      FileUtils.mkdir_p(@my_project_path)
+    end
+
+    describe ":textmate" do
+      before do
+        FileUtils.chdir(@my_project_path) do
+          @choctop = ChocTop::Configuration.new do |s|
+            s.defaults :textmate
+          end
+          @choctop.prepare_files
+        end
+      end
+
+      it "should have textmate background" do
+        @choctop.background_file.should =~ /textmate_background.jpg$/
+      end
+
+      it "should have textmate volume icon" do
+        @choctop.volume_icon.should =~ /textmate_volume.icns$/
+      end
+    end
+
+    describe "normal" do
+      before do
+        FileUtils.chdir(@my_project_path) do
+          @choctop = ChocTop::Configuration.new
+          @choctop.prepare_files
+        end
+      end
+
+      it "should have default background" do
+        @choctop.background_file.should =~ /default_background.jpg$/
+      end
+
+      it "should have default volume icon" do
+        @choctop.volume_icon.should =~ /default_volume.icns$/
+      end
+    end
+  end
 end

data/spec/dmg_spec.rb

@@ -10,7 +10,7 @@ describe ChocTop::Dmg do
   end
 
   context "#prepare_files" do
-    it "should process :target_bundle into a path" do
+    it "should process :readme into a path" do
       FileUtils.chdir(@project_path) do
         @choctop.file :readme, :position=>[175, 65]
         @choctop.prepare_files

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: choctop
 version: !ruby/object:Gem::Version 
-  hash: 41
+  hash: 39
   prerelease: false
   segments: 
   - 0
-  - 13
-  - 1
-  version: 0.13.1
+  - 14
+  - 0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 +10:00
+date: 2010-07-30 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -163,12 +163,18 @@ files:
 - README.rdoc
 - Rakefile
 - app_generators/install_choctop/install_choctop_generator.rb
+- app_generators/install_choctop/templates/README.normal
+- app_generators/install_choctop/templates/README.textmate
 - app_generators/install_choctop/templates/Rakefile.erb
+- app_generators/install_choctop/templates/Rakefile.textmate.erb
 - app_generators/install_choctop/templates/release_notes.txt.erb
 - app_generators/install_choctop/templates/release_notes_template.html.erb
-- assets/DefaultVolumeIcon.icns
+- assets/default_background.jpg
+- assets/default_volume.icns
 - assets/sky.jpg
 - assets/sky_background.jpg
+- assets/textmate_background.jpg
+- assets/textmate_volume.icns
 - assets/vanillia_dmg_icon.png
 - assets/wood.jpg
 - bin/install_choctop