xpcomcore-rubygem 0.0.0 → 0.1.0

data/Rakefile

@@ -3,14 +3,31 @@ require 'rake'
 
 begin
   require 'jeweler'
+  require 'colored'
+  
   Jeweler::Tasks.new do |gem|
     gem.name = "xpcomcore-rubygem"
+    gem.executables = %w[xpcomcore-rubygem-install xpcomcore-firefox]
     gem.summary = %Q{Gem to allow for using XPCOMCore via RubyGems}
     gem.description = %Q{Gem to allow for using XPCOMCore via RubyGems}
-    gem.email = "gabriel.gironda@centro.net"
+    gem.email = "gabriel.gironda@gmail.com"
     gem.homepage = "http://github.com/gabrielg/xpcomcore-rubygem"
     gem.authors = ["ggironda"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    
+    gem.post_install_message = <<-EOF;
+
+#{"".ljust(80).red_on_blue.bold}
+#{"PAY HEED TO THIS ANNOYING MESSAGE".center(80).red_on_blue.bold}
+#{"".ljust(80).red_on_blue.bold}
+
+The XPCOMCore gem has been installed but you still need to complete installation
+by hand. Run the command #{'xpcomcore-rubygem-install'.underline.bold} without options to get
+usage information on using it to install the bootstrapper code for this gem.
+
+EOF
+
+    gem.add_dependency "sys-uname"
+    gem.add_development_dependency "colored"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -54,3 +71,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/bin/xpcomcore-firefox

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sys/uname'

data/bin/xpcomcore-rubygem-install

@@ -0,0 +1,205 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sys/uname'
+require 'pathname'
+require 'optparse'
+require 'rexml/document'
+require 'fileutils'
+
+class XPCOMCoreRubyGemInstaller
+  attr_accessor :no_dry_run, :install_global, :install_local, :fix_path
+  
+  KnownAppIds = {'Firefox' => '{ec8030f7-c20a-464f-9b0e-13a3a9e97384}'}
+  KnownVendors = %w[Mozilla]
+  ScriptName = Pathname(__FILE__).basename
+  SysName = Sys::Uname.sysname.downcase.to_sym
+  InstallPathBuilders = {:linux => {}, :darwin => {}}
+  GeckoCommands = %w[firefox-bin firefox xulrunner-bin]
+  ProfilePath = Pathname("~/.profile").expand_path
+  
+  # Linux install path builders
+  InstallPathBuilders[:linux][:global] = [
+    lambda {|vendor,app,extension| Pathname("/usr/lib") + vendor + "extensions" + app + extension },
+    lambda {|vendor,app,extension| Pathname("/usr/lib64") + vendor + "extensions" + app + extension },
+    lambda {|vendor,app,extension| Pathname("/usr/share") + vendor + "extensions" + app + extension }
+  ]
+  InstallPathBuilders[:linux][:local] = [
+    lambda {|vendor,app,extension| Pathname("~/.#{vendor}") + "extensions" + app + extension }
+  ]
+  
+  # Mac OS X install path builders
+  InstallPathBuilders[:darwin][:global] = [
+    lambda {|vendor,app,extension| Pathname("/Library/Application Support") + vendor + "Extensions" + app + extension }
+  ]
+  InstallPathBuilders[:darwin][:local] = [
+    lambda {|vendor,app,extension| Pathname("~/Library/Application Support") + vendor + "Extensions" + app + extension }
+  ]
+
+  GeckoLocations = {:linux => [], :darwin => []}
+  GeckoLocations[:darwin] << Pathname("/Applications/Firefox.app/Contents/MacOS/firefox-bin")
+  GeckoLocations[:darwin] << Pathname("/Library/Frameworks/XUL.framework/xulrunner-bin")
+  
+  def initialize(args, options = {})
+    @args = args
+    @options = options
+    @option_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{ScriptName} [options]"
+      opts.on("--install-global", "Install the XPCOMCore gem bootstrap code globally.", method(:install_global=))
+      opts.on("--install-local", "Install the XPCOMCore gem bootstrap code for the current user only.", method(:install_local=))
+      opts.on("--fix-path", "Checks the path for an executable Gecko installation and fixes it if necessary.", method(:fix_path=))
+      opts.on("--do-it", "By default, we do a dry run and show the user what would happen. This forces the actual install.", method(:no_dry_run=))
+    end
+  end
+
+  def dry_run?
+    !no_dry_run
+  end
+  
+  def go!
+    @option_parser.parse(@args)
+    install_opts = {:install_global => install_global, :install_local => install_local}
+    if !install_opts.values.any?
+      puts @option_parser
+      exit(1)
+    end
+    read_install_manifest
+    install_opts.each do |opt_name,value|
+      send(:"do_#{opt_name}") if value
+      log("All done!.")
+    end
+  rescue OptionParser::InvalidOption => e
+    invalid_option(e)
+  end
+
+private
+
+  def invalid_option(exception)
+    puts exception.message
+    puts @option_parser
+    exit(1)
+  end
+  
+  def do_install_global
+    do_install(:global) && rewrite_path
+  end
+  
+  def do_install_local
+    do_install(:local) && rewrite_path
+  end
+  
+  def do_install(scope)
+    each_vendor_and_app_name_and_app_id do |vendor, app_name, app_id|
+      if install_extension(scope, vendor, app_id)
+        next(true)
+      else
+        log("No app install location for application '#{app_name}' by vendor '#{vendor}' exists. Skipping.")
+        next(false)
+      end
+    end.any?
+  end
+  
+  def each_vendor_and_app_name_and_app_id
+    KnownVendors.each do |vendor_name|
+      KnownAppIds.each do |app_name, app_id|
+        yield(vendor_name, app_name, app_id)
+      end
+    end
+  end
+  
+  def install_extension(scope, vendor, app_id)
+    raise "Couldn't read extension id from install manifest" if extension_id.empty?
+    InstallPathBuilders[SysName][scope].select do |path_builder|
+      log("Performing a #{scope} install...")
+      install_path = path_builder[vendor, app_id, extension_id].expand_path
+      if !install_path.parent.exist?
+        log("Directory '#{install_path.parent}' doesn't exist - skipping installation to this location.")
+        next(false)
+      else
+        copy_extension_to(install_path)
+        next(true)
+      end
+    end.any?
+  end
+  
+  def read_install_manifest
+    manifest_contents = (@options[:extension_path] + "install.rdf").read
+    @install_manifest = REXML::Document.new(manifest_contents)
+  end
+  
+  def extension_path
+    @options[:extension_path]
+  end
+  
+  def extension_id
+    @extension_id ||= @install_manifest.root.elements["Description/em:id"].text
+  end
+  
+  def copy_extension_to(install_path)
+    if install_path.parent.writable?
+      log("Copying '#{extension_path}' to '#{install_path}'")
+      copy_dir(extension_path, install_path)
+    else
+      log("Path '#{install_path}' isn't writable. Maybe you need to run this as root and try again if installing globally?")
+    end
+  end
+  
+  def log(str)
+    puts("#{dry_run? ? "[DRY RUN]" : "[INSTALLER]"} #{str}")
+  end
+  
+  def copy_dir(src_path, install_path)
+    return false if dry_run?
+    FileUtils.cp_r(src_path.expand_path.to_s + "/.", install_path.to_s)
+  end
+  
+  def rewrite_path
+    return false unless fix_path
+    gecko_available = check_path
+    rewrite_profile unless gecko_available
+  end
+  
+  def check_path
+    GeckoCommands.collect do |cmd|
+      `#{cmd} -v 2>/dev/null`
+      $? == 0
+    end.any?
+  end
+  
+  def rewrite_profile
+    log("I couldn't find any of '#{GeckoCommands.join(", ")}'. Doing my best attempt to rectify this.")
+    send(:"rewrite_profile_for_#{SysName}")
+  end
+  
+  def rewrite_profile_for_linux
+    log("Sorry. You're on your own here. Check your distribution's documentation for details - for example, Firefox may be installed under a different name.")
+  end
+  
+  def rewrite_profile_for_darwin
+    loc = GeckoLocations[:darwin].detect {|p| p.exist?}
+    unless loc
+      log("I can't find Firefox installed on your system. Sorry.")
+      exit(1)
+    end
+    log("Awesome. I found a Gecko installation at '#{loc}'. Rewriting your .profile to include this in the $PATH.")
+    rewrite_path_with_location(loc.parent)
+  end
+  
+  def rewrite_path_with_location(path_entry)
+    profile_entry = %Q[PATH="#{path_entry}:$PATH"]
+    log("Adding .profile entry: #{profile_entry}")
+    if dry_run?
+      log("Not adding an entry due to running in dry run mode.")
+    else
+      ProfilePath.open("a") do |io|
+        io << "\n"
+        io.puts("# This and the following lines automatically added by xpcomcore-rubygem on #{Time.now}.")
+        io.puts(profile_entry)
+      end
+      log(".profile entry added. You may need to source your .profile again or log in and out for it to take effect.")
+    end
+  end
+  
+end
+
+installer = XPCOMCoreRubyGemInstaller.new(ARGV, :extension_path => (Pathname(__FILE__).parent.parent + "extension").expand_path)
+installer.go!

data/extension/install.rdf

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+
+<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:em="http://www.mozilla.org/2004/em-rdf#">
+  <Description about="urn:mozilla:install-manifest">
+    <em:id>xpcomcorebootstrapper@conflagrationjs.org</em:id>
+    <em:version>0.1.0</em:version>
+    <em:type>2</em:type>
+    <em:targetApplication>
+      <Description>
+        <em:id>toolkit@mozilla.org</em:id> 
+        <em:minVersion>1.9.0</em:minVersion>
+      </Description>
+    </em:targetApplication>
+    <em:name>XPCOMCore Bootstrapper Extension</em:name>
+  </Description>
+</RDF>

data/xpcomcore-rubygem.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xpcomcore-rubygem}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ggironda"]
+  s.date = %q{2009-10-07}
+  s.description = %q{Gem to allow for using XPCOMCore via RubyGems}
+  s.email = %q{gabriel.gironda@gmail.com}
+  s.executables = ["xpcomcore-rubygem-install", "xpcomcore-firefox"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/xpcomcore-firefox",
+     "bin/xpcomcore-rubygem-install",
+     "extension/install.rdf",
+     "lib/xpcomcore-rubygem.rb",
+     "test/test_helper.rb",
+     "test/xpcomcore-rubygem_test.rb",
+     "xpcomcore-rubygem.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gabrielg/xpcomcore-rubygem}
+  s.post_install_message = %q{
+                                                                                
+                       PAY HEED TO THIS ANNOYING MESSAGE                        
+                                                                                
+
+The XPCOMCore gem has been installed but you still need to complete installation
+by hand. Run the command xpcomcore-rubygem-install without options to get
+usage information on using it to install the bootstrapper code for this gem.
+
+}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Gem to allow for using XPCOMCore via RubyGems}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/xpcomcore-rubygem_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sys-uname>, [">= 0"])
+      s.add_development_dependency(%q<colored>, [">= 0"])
+    else
+      s.add_dependency(%q<sys-uname>, [">= 0"])
+      s.add_dependency(%q<colored>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sys-uname>, [">= 0"])
+    s.add_dependency(%q<colored>, [">= 0"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xpcomcore-rubygem
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - ggironda
@@ -9,14 +9,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 -05:00
+date: 2009-10-07 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sys-uname
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: colored
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Gem to allow for using XPCOMCore via RubyGems
-email: gabriel.gironda@centro.net
-executables: []
-
+email: gabriel.gironda@gmail.com
+executables: 
+- xpcomcore-rubygem-install
+- xpcomcore-firefox
 extensions: []
 
 extra_rdoc_files: 
@@ -29,14 +49,24 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/xpcomcore-firefox
+- bin/xpcomcore-rubygem-install
+- extension/install.rdf
 - lib/xpcomcore-rubygem.rb
 - test/test_helper.rb
 - test/xpcomcore-rubygem_test.rb
+- xpcomcore-rubygem.gemspec
 has_rdoc: true
 homepage: http://github.com/gabrielg/xpcomcore-rubygem
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\
+  \e[1m\e[31m\e[44m                                                                                \e[0m\e[0m\n\
+  \e[1m\e[31m\e[44m                       PAY HEED TO THIS ANNOYING MESSAGE                        \e[0m\e[0m\n\
+  \e[1m\e[31m\e[44m                                                                                \e[0m\e[0m\n\n\
+  The XPCOMCore gem has been installed but you still need to complete installation\n\
+  by hand. Run the command \e[1m\e[4mxpcomcore-rubygem-install\e[0m\e[0m without options to get\n\
+  usage information on using it to install the bootstrapper code for this gem.\n\n"
 rdoc_options: 
 - --charset=UTF-8
 require_paths: