RubyGems - choctop - Versions diffs - 0.9.2 → 0.9.3 - Mend

choctop 0.9.2 → 0.9.3

Files changed (15) hide show

data/History.txt +7 -0
data/Manifest.txt +2 -0
data/Rakefile +2 -1
data/app_generators/install_choctop/install_choctop_generator.rb +3 -1
data/app_generators/install_choctop/templates/ReleaseNotes.txt.erb +5 -0
data/app_generators/install_choctop/templates/release_notes_template.html.erb +13 -0
data/features/initial_generator.feature +10 -4
data/features/rake_tasks.feature +2 -2
data/features/sparkle_feed.feature +17 -3
data/features/steps/common.rb +6 -0
data/features/steps/env.rb +1 -0
data/features/steps/generator.rb +1 -1
data/lib/choctop.rb +22 -7
data/lib/choctop/appcast.rb +57 -28
metadata +13 -1

data/History.txt CHANGED Viewed

@@ -1,3 +1,10 @@
+== 0.9.3 2009-01-29
+* install_choctop generates a ReleaseNotes.txt file
+* 'rake feed' converts ReleaseNotes.txt into release_notes.html file for upload
+* #name is the project's folder name if info_plist['CFBundleExecutable'] == "${EXECUTABLE}"
+* 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

data/Manifest.txt CHANGED Viewed

@@ -4,6 +4,8 @@ README.rdoc
 Rakefile
 app_generators/install_choctop/install_choctop_generator.rb
 app_generators/install_choctop/templates/Rakefile.erb
+app_generators/install_choctop/templates/ReleaseNotes.txt.erb
+app_generators/install_choctop/templates/release_notes_template.html.erb
 assets/DefaultVolumeIcon.icns
 assets/sky.jpg
 assets/sky_background.jpg

data/Rakefile CHANGED Viewed

@@ -9,7 +9,8 @@ $hoe = Hoe.new('choctop', ChocTop::VERSION) do |p|
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.extra_deps         = [
     ['activesupport'],
-    ['builder','>= 2.1.2']
+    ['builder','>= 2.1.2'],
+    ['RedCloth', '>=4.1.1']
   ]
   p.extra_dev_deps = [
     ['newgem', ">= #{::Newgem::VERSION}"]

data/app_generators/install_choctop/install_choctop_generator.rb CHANGED Viewed

@@ -17,7 +17,9 @@ class InstallChoctopGenerator < RubiGen::Base
     record do |m|
       %w( appcast/build ).each { |path| m.directory path }
-      m.template "Rakefile.erb", "Rakefile", :collision => :skip
+      m.template "Rakefile.erb", "Rakefile"
+      m.template "ReleaseNotes.txt.erb", "ReleaseNotes.txt"
+      m.file "release_notes_template.html.erb", "release_notes_template.html.erb"
     end
   end

data/app_generators/install_choctop/templates/ReleaseNotes.txt.erb ADDED Viewed

@@ -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 ADDED Viewed

@@ -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/features/initial_generator.feature CHANGED Viewed

@@ -1,9 +1,9 @@
-Feature: Setup a Cocoa app with sparkle-ruby
+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 sparkle-ruby into an app that has no existing Rakefile
+  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
@@ -11,7 +11,7 @@ Feature: Setup a Cocoa app with sparkle-ruby
     And output does match /rake build/
     And output does match /rake upload/
-  Scenario: Install sparkle-ruby into an app that has an existing Rakefile
+  Scenario: Install choctop into an app that has an existing Rakefile
     Given a Cocoa app that does have an existing Rakefile
     When I run local executable 'install_choctop' with arguments '.'
     And Rakefile wired to use development code instead of installed RubyGem
@@ -23,4 +23,10 @@ Feature: Setup a Cocoa app with sparkle-ruby
     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/
+  Scenario: Install choctop and generate a ReleaseNotes file
+    Given a Cocoa app that does not have an existing Rakefile
+    When I run local executable 'install_choctop' with arguments '.'
+    Then file 'ReleaseNotes.txt' is created
+    And contents of file 'ReleaseNotes.txt' does match /Initial release/

data/features/rake_tasks.feature CHANGED Viewed

@@ -15,10 +15,10 @@ Feature: Rake tasks are available to build and deploy Cocoa apps with Sparkle
   Scenario: rake task to upload the appcast file to the server
     Given a Cocoa app with choctop installed
-    And task 'rake feed' is invoked
+    And task 'rake dmg feed' is invoked
     And ChocTop config is configured for local rsync
     When task 'rake upload' is invoked
-    Then remote file 'linker_appcast.xml' is created
+    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

data/features/sparkle_feed.feature CHANGED Viewed

@@ -6,7 +6,7 @@ Feature: Generate an XML file for Sparkle to use for updates
   Scenario: rake task to create/update the appcast file
     Given a Cocoa app with choctop installed
     And ChocTop config is configured for remote Sparkle
-    When task 'rake feed' is invoked
+    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>/
@@ -18,7 +18,21 @@ Feature: Generate an XML file for Sparkle to use for updates
     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>/
+  Scenario: generate default release notes if no ReleaseNotes.txt
+    Given a Cocoa app with choctop installed
+    And ChocTop config is configured for remote Sparkle
+    And file 'ReleaseNotes.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>/

data/features/steps/common.rb CHANGED Viewed

@@ -50,6 +50,12 @@ Given %r{'(.*)' folder is deleted} do |folder|
   end
 end
+Given %r{file '(.*)' is deleted} do |file|
+  in_project_folder do
+    FileUtils.rm_rf file
+  end
+end
 When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
   @stdout = StringIO.new
   FileUtils.chdir(@active_project_folder) do

data/features/steps/env.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + "/../../lib/choctop"
+require "rubygems"
 gem 'cucumber'
 require 'cucumber'
 gem 'rspec'

data/features/steps/generator.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 Given /^a Cocoa app that does not have an existing Rakefile$/ do
   Given "a safe folder"
-  setup_active_project_folder "sample_app"
+  setup_active_project_folder "SampleApp"
 end
 Given /^a Cocoa app that does have an existing Rakefile$/ do

data/lib/choctop.rb CHANGED Viewed

@@ -3,16 +3,17 @@ $:.unshift(File.dirname(__FILE__)) unless
 require "fileutils"
 require "yaml"
-require "rubygems"
 require "builder"
-require "active_support"
+require "erb"
 require "osx/cocoa"
+require "active_support"
+require "RedCloth"
 class ChocTop
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
   # The name of the Cocoa application
-  # Default: info_plist['CFBundleExecutable']
+  # Default: info_plist['CFBundleExecutable'] or project folder name if "${EXECUTABLE}"
   attr_accessor :name
   # The version of the Cocoa application
@@ -33,10 +34,21 @@ class ChocTop
     @base_url ||= "http://#{host}"
   end
-  # The url to display the release notes for the latest release
+  # The file name for generated release notes for the latest release
   # Default: release_notes.html
   attr_accessor :release_notes
+  # The path for an HTML template into which the ReleaseNotes.txt are inserted
+  # after conversion to HTML
+  #
+  # The template file is an ERb template, with <%= yield %> as the placeholder
+  # for the generated release notes.
+  #
+  # Currently, any CSS or JavaScript must be inline
+  #
+  # Default: release_notes_template.html.erb, which was generated by install_choctop into each project
+  attr_accessor :release_notes_template
   # The name of the local xml file containing the Sparkle item details
   # Default: info_plist['SUFeedURL'] or linker_appcast.xml
   attr_accessor :appcast_filename
@@ -119,11 +131,13 @@ class ChocTop
     # Defaults
     @name = info_plist['CFBundleExecutable']
+    @name = File.basename(File.expand_path(".")) if name == "${EXECUTABLE}"
     @version = info_plist['CFBundleVersion']
     @target = "#{name}.app"
     @appcast_filename = info_plist['SUFeedURL'] ? File.basename(info_plist['SUFeedURL']) : 'linker_appcast.xml'
     @release_notes = 'release_notes.html'
-    @rsync_args = '-aCv'
+    @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]
@@ -156,9 +170,10 @@ class ChocTop
     end
     desc "Create/update the appcast file"
-    task :feed => :dmg do
+    task :feed do
       make_appcast
       make_index_redirect
+      make_release_notes
     end
     desc "Upload the appcast file to the host"

data/lib/choctop/appcast.rb CHANGED Viewed

@@ -7,36 +7,36 @@ module ChocTop::Appcast
     app_name = File.basename(File.expand_path('.'))
     FileUtils.mkdir_p "#{build_path}"
-    appcast = File.open("#{build_path}/#{appcast_filename}", 'w')
+    appcast = File.open("#{build_path}/#{appcast_filename}", 'w') do |f|
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!
+      xml_string = 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 = 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", "#{base_url}/#{release_notes}"
-          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,
-                        :"sparkle:dsaSignature" => dsa_signature)
+          xml.item do
+            xml.title("#{name} #{version}")
+            xml.tag! "sparkle:releaseNotesLink", "#{base_url}/#{release_notes}"
+            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,
+                          :"sparkle:dsaSignature" => dsa_signature)
+          end
         end
       end
+      f << xml_string
     end
   end
@@ -45,10 +45,33 @@ module ChocTop::Appcast
       f << %Q{<?php header("Location: #{pkg_relative_url}"); ?>}
     end
   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)
+    end
+  end
+  def release_notes_content
+    if File.exists?("ReleaseNotes.txt")
+      File.read("ReleaseNotes.txt")
+    else
+      <<-TEXTILE.gsub(/^      /, '')
+      h1. #{version} #{Date.today}
+      h2. Another awesome release!
+      TEXTILE
+    end
+  end
+  def release_notes_html
+    RedCloth.new(release_notes_content).to_html
+  end
   def upload_appcast
     _host = host.blank? ? "" : "#{host}:"
-    sh %{rsync -aCv appcast/build/ #{_host}#{remote_dir}}
+    sh %{rsync #{rsync_args} #{build_path}/ #{_host}#{remote_dir}}
   end
   # Returns a file path to the dsa_priv.pem file
@@ -61,6 +84,12 @@ module ChocTop::Appcast
       `openssl gendsa dsaparam.pem -out dsa_priv.pem`
       `openssl dsa -in dsa_priv.pem -pubout -out dsa_pub.pem`
       `rm dsaparam.pem`
+      puts <<-EOS.gsub(/^      /, '')
+      WARNING: DO NOT PUT dsa_priv.pem IN YOUR SOURCE CONTROL
+               Remember to add it to your ignore list
+      EOS
     end
     File.expand_path('dsa_priv.pem')
   end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: choctop
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Dr Nic Williams
@@ -33,6 +33,16 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.2
     version:
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+    version:
 - !ruby/object:Gem::Dependency
   name: newgem
   type: :development
@@ -73,6 +83,8 @@ files:
 - Rakefile
 - app_generators/install_choctop/install_choctop_generator.rb
 - app_generators/install_choctop/templates/Rakefile.erb
+- app_generators/install_choctop/templates/ReleaseNotes.txt.erb
+- app_generators/install_choctop/templates/release_notes_template.html.erb
 - assets/DefaultVolumeIcon.icns
 - assets/sky.jpg
 - assets/sky_background.jpg