sparkleology 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-09-17
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,34 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/sparkleology
+config/hoe.rb
+config/requirements.rb
+lib/sparkleology.rb
+lib/sparkleology/command.rb
+lib/sparkleology/exceptions.rb
+lib/sparkleology/find_application_command.rb
+lib/sparkleology/latest_version_command.rb
+lib/sparkleology/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/fixtures/Applications/NonSparkleApp.app/Contents/Info.plist
+test/fixtures/Applications/ValidSparkleApp.app/Contents/Info.plist
+test/test_command.rb
+test/test_find_application_command.rb
+test/test_helper.rb
+test/test_latest_version_command.rb
+test/test_sparkleology.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.rdoc

@@ -0,0 +1,73 @@
+= sparkleology
+
+* http://drnicutilities.rubyforge.org/sparkleology
+* http://github.com/drnic/sparkleology
+
+== DESCRIPTION:
+
+Takes a Mac OS X application name that uses Sparkle for auto-updates, and returns information about that application's Sparkle RSS feed or the latest download URL for that Application.
+
+The command-line app +sparkleology+ has two modes of operation depending on the argument/STDIN provided. If the last argument, or STDIN, is:
+
+* an application name => the Sparkle RSS feed URL is returned
+* a Sparkle RSS feed URL => the latest version download URL is returned
+
+That is, the result of sparkleology can be passed to itself.
+
+  sparkleology Skitch => http://update.plasq.com/skitch-appcast.xml
+  sparkleology http://update.plasq.com/skitch-appcast.xml => http://skitch.com/download/skitch-b6.2-v10678.zip
+  
+Therefore, since +sparkleology+ can take the argument as STDIN as well, you can pipe the results together:
+
+  sparkleology Skitch | sparkleology
+  sparkleology Skitch | xargs sparkleology
+
+both return http://skitch.com/download/skitch-b6.2-v10678.zip
+  
+The reason that +sparkleology+ returns the RSS feed URL if you give it an App Name is that this feed URL is permanently consistent, whereas the download URL possibly changes with each new application version. So, the feed URL could be stored and then used later (say on a machine that does not have the original app already installed) to fetch the latest version of the application, which may or may not be already installed.
+
+We're using this in the http://github.com/bjeanes/noober script for installing a list of apps on a fresh OS X machine.
+
+== FEATURES/PROBLEMS:
+
+* Can return the RSS feed for a given application that contains the "latest version" URL
+* Can return the "latest version" URL for a given application, either from the Application name or the RSS feed URL for an Application (say if the Application isn't yet installed)
+
+== SYNOPSIS:
+
+Allows for scripting of fetching and/or installing the latest version of a specific OS X application.
+
+== REQUIREMENTS:
+
+* RubyGems:
+  * libxml-ruby
+  * plist
+
+== INSTALL:
+
+* sudo gem install sparkleology
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Dr Nic Williams, Mocra
+
+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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/sparkleology

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-9-17.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+require File.dirname(__FILE__) + "/../lib/sparkleology"
+
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {
+  :path     => '~'
+}
+MANDATORY_OPTIONS = %w(  )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Takes a Mac OS X application name that uses Sparkle for auto-updates, and 
+returns information about that application's Sparkle RSS feed or the latest 
+download URL for that Application.
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  # opts.on("-p", "--path=PATH", String,
+  #         "The root path for selecting files",
+  #         "Default: ~") { |OPTIONS[:path]| }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+# path = OPTIONS[:path]
+
+app_name_or_feed_url = ARGV.last || STDIN.read
+
+print Sparkleology::Command.for(app_name_or_feed_url).run

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'sparkleology/version'
+
+AUTHOR = 'Dr Nic Williams'  # can also be an array of Authors
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = <<-EOS
+Takes a Mac OS X application name that uses Sparkle for auto-updates, and returns information about that application's Sparkle RSS feed or the latest download URL for that Application.
+EOS
+GEM_NAME = 'sparkleology' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'drnicutilities' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['plist', '>= 3.0.0'],
+  ['libxml-ruby', '>= 0.8.3']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Sparkleology::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'sparkleology documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/sparkleology.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Sparkleology
+end
+
+# core libs
+require "open-uri"
+require "tempfile"
+
+# external gems
+require "rubygems"
+gem 'plist'
+require 'plist'
+gem 'libxml-ruby'
+require "xml"
+
+require "sparkleology/exceptions"
+require "sparkleology/find_application_command"
+require 'sparkleology/latest_version_command'
+require 'sparkleology/command'

data/lib/sparkleology/command.rb

@@ -0,0 +1,11 @@
+class Sparkleology::Command
+  def self.for(app_name_or_feed_url)
+    feed_url?(app_name_or_feed_url) ?
+      Sparkleology::LatestVersionCommand.new(app_name_or_feed_url) :
+      Sparkleology::FindApplicationCommand.new(app_name_or_feed_url)
+  end
+  
+  def self.feed_url?(app_name_or_feed_url)
+    app_name_or_feed_url =~ /:/
+  end
+end

data/lib/sparkleology/exceptions.rb

@@ -0,0 +1,4 @@
+module Sparkleology
+  class InvalidApplicationNameException < Exception; end
+  class NonSparkleApplicationException < Exception; end
+end

data/lib/sparkleology/find_application_command.rb

@@ -0,0 +1,42 @@
+# This command class takes an OS X application name, such as 'Skitch',
+# and returns the Sparkle RSS feed URL containing the latest update
+# information.
+# Pass the application name to the initializer, and call +run+.
+#   +Sparkleology::FindApplicationCommand.new('Skitch').run+
+class Sparkleology::FindApplicationCommand
+  attr_reader :app_name
+
+  def initialize(app_name)
+    @app_name = app_name
+  end
+  
+  def run
+    url_for_latest_versions
+  end
+  
+  def plist_path
+    @plist_path ||= begin
+      full_app_name = app_name.gsub(/\.app$/,'') + ".app"
+      self.paths.
+           map { |root_path| File.join(root_path, full_app_name, "Contents/Info.plist") }.
+           find { |plist| File.exists?(plist) }
+    end || begin
+      raise Sparkleology::InvalidApplicationNameException, app_name
+    end
+  end
+  
+  def url_for_latest_versions
+    application_info = Plist::parse_xml(plist_path)
+    application_info['SUFeedURL'] || begin
+      raise Sparkleology::NonSparkleApplicationException, app_name
+    end
+  end
+  
+  def paths
+    ["#{home_path}/Applications", "/Applications"]
+  end
+  
+  def home_path
+    ENV['TEST_HOME'] || ENV['HOME'] || File.expand_path('~')
+  end
+end

data/lib/sparkleology/latest_version_command.rb

@@ -0,0 +1,29 @@
+class Sparkleology::LatestVersionCommand
+  attr_reader :rss_feed_url
+  
+  def initialize(rss_feed_url)
+    @rss_feed_url = rss_feed_url
+  end
+  
+  def run
+    fetch_feed_in_temp_file
+    feed_xml = XML::Document.file(tmp_file_path)
+    node = feed_xml.find_first "//rss/channel/item"
+    node = node.find_first "enclosure"
+    node["url"]
+  end
+  
+  def fetch_feed_in_temp_file
+    File.open(tmp_file_path, "w+") do |file|
+      file << self.fetch_feed
+    end
+  end
+  
+  def fetch_feed
+    open(rss_feed_url).read
+  end
+  
+  def tmp_file_path
+    File.join(Dir::tmpdir, "sparkleology.rss")
+  end
+end

data/lib/sparkleology/version.rb

@@ -0,0 +1,9 @@
+module Sparkleology
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sparkleology.rb'}"
+puts "Loading sparkleology gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'sparkleology' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'sparkleology'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Sparkleology::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)