launchy 0.1.2 → 0.2.0

data/CHANGES

@@ -1,5 +1,14 @@
 == Changelog
 
+=== Version 0.2.0 - 2007-08-11
+
+* rework browser finding
+** manual override with LAUNCHY_BROWSER environment variable
+** on *nix use desktop application launcher with fallback to list of browsers
+* On windows, switch to 'start' command and remove dependency on win32-process
+* removed win32 gem
+* Add debug output by setting LAUNCHY_DEBUG environment variable to 'true'
+
 === Version 0.1.2 - 2007-08-11
 
 * forked child exits without calling at_exit handlers

data/README

@@ -1,17 +1,18 @@
 == launchy
 
-* Homepage[http://copiousfreetime.rubyforge.org/launcy/]
+* Homepage[http://copiousfreetime.rubyforge.org/launchy/]
 * {Rubyforge Project}[http://rubyforge.org/projects/copiousfreetime]
 * email jeremy at hinegardner dot org
 
 == DESCRIPTION
 
-Launchy is helper class for launching +cross-platform+ applications.
+Launchy is helper class for launching cross-platform applications in a
+fire and forget manner.  
 
-There are application concepts (browser, email client, etc) that are
-common across all platforms, and they may be launched in different
-manners.  Launchy is here to assist in launching the appropriate
-application on the appropriate platform from within your ruby projects.
+There are application concepts (browser, email client, etc) that are common
+across all platforms, and they may be launched differently on each
+platform.  Launchy is here to make a common approach to launching
+external application from within ruby programs.
 
 == FEATURES
 

data/lib/launchy.rb

@@ -29,6 +29,14 @@ module Launchy
                 $stderr.puts "Unable to launch #{params.join(' ')}"
             end
         end
+        
+        # Setting the LAUNCHY_DEBUG environment variable to 'true' will spew 
+        # debug information to $stderr
+        def log(msg)
+            if ENV['LAUNCHY_DEBUG'] == 'true' then
+                $stderr.puts "LAUNCHY_DEBUG: #{msg}"
+            end
+        end
     end
 end
 

data/lib/launchy/gemspec.rb

@@ -11,18 +11,18 @@ module Launchy
                 spec.rubyforge_project  = "copiousfreetime"
                 spec.author             = "Jeremy Hinegardner"
                 spec.email              = "jeremy@hinegardner.org"
-                spec.homepage           = "http://launchy.rubyforge.org/"
+                spec.homepage           = "http://copiousfreetime.rubyforge.org/launchy/"
 
                 spec.summary            = "A helper to launch apps from within ruby programs."
                 spec.description        = <<-DESC
-                Launchy is helper class for launching +cross-platform+
-                applications.
-
-                There are application concepts (browser, email client,
-                etc) that are common across all platforms, and they may
-                be launched in different manners.  Launchy is here to
-                assist in launching the appropriate application on the
-                appropriate platform from within your ruby projects.
+                Launchy is helper class for launching cross-platform applications in a
+                fire and forget manner.  
+
+                There are application concepts (browser, email client, etc) that are common
+                across all platforms, and they may be launched differently on each
+                platform.  Launchy is here to make a common approach to launching
+                external application from within ruby programs.
+                
                 DESC
 
                 spec.extra_rdoc_files   = FileList["CHANGES", "LICENSE", "README"]
@@ -48,10 +48,6 @@ module Launchy
                 spec.remote_site_dir    = "#{spec.name}/"
 
            end
-
-    SPEC_WIN32 = SPEC.dup
-    SPEC_WIN32.add_dependency("win32-process")
-    SPEC_WIN32.platform = Gem::Platform::WIN32
 end
 
 

data/lib/launchy/spawnable/application.rb

@@ -16,65 +16,113 @@ module Launchy
                 end                
                 
                 def find_application_class_for(*args)
-                    application_classes.find { |klass| klass.handle?(*args) }
+                    Launchy.log "finding application classes for [#{args.join(' ')}]"
+                    application_classes.find do |klass| 
+                        if klass.handle?(*args) then
+                            Launchy.log "  #{klass.name}"
+                            true
+                        else
+                            false
+                        end
+                    end
+                end
+                
+                # Determine the appropriate desktop environment for *nix machine.  Currently this is
+                # linux centric.  The detection is based upon the detection used by xdg-open from 
+                # http://portland.freedesktop.org/wiki/XdgUtils
+                def nix_desktop_environment
+                    de = :generic
+                    if ENV["KDE_FULL_SESSION"] || ENV["KDE_SESSION_UID"] then
+                        de = :kde
+                    elsif ENV["GNOME_DESKTOP_SESSION_ID"] then
+                        de = :gnome
+                    elsif find_executable("xprop") then
+                        if %x[ xprop -root _DT_SAVE_MODE | grep ' = \"xfce\"$' ].strip.size > 0 then
+                            de = :xfce
+                        end
+                    end
+                    Launchy.log "nix_desktop_environment => #{de}"
+                    return de
+                end
+                
+                # find an executable in the available paths
+                # mkrf did such a good job on this I had to borrow it.
+                def find_executable(bin,*paths)
+                    paths = ENV['PATH'].split(File::PATH_SEPARATOR) if paths.empty?
+                    paths.each do |path|
+                        file = File.join(path,bin)
+                        if File.executable?(file) then
+                            Launchy.log "found executable #{file}"
+                            return file
+                        end
+                    end
+                    Launchy.log "Unable to find `#{bin}' in paths #{paths.join(', ')}"
+                    return nil
+                end
+                
+                # return the current 'host_os' string from ruby's configuration
+                def my_os
+                    ::Config::CONFIG['host_os']
+                end
+            
+                # detect what the current os is and return :windows, :darwin or :nix
+                def my_os_family(test_os = my_os)
+                    case test_os
+                    when /mswin/i
+                        family = :windows
+                    when /windows/i
+                        family = :windows
+                    when /darwin/i
+                        family = :darwin
+                    when /mac os/i
+                        family = :darwin
+                    when /solaris/i
+                        family = :nix
+                    when /bsd/i
+                        family = :nix
+                    when /linux/i
+                        family = :nix
+                    when /cygwin/i
+                        family = :nix
+                    else
+                        $stderr.puts "Unknown OS familiy for '#{test_os}'.  Please report this bug to #{Launchy::SPEC.email}"
+                        family = :unknown
+                    end
                 end
             end
             
             # find an executable in the available paths
-            # mkrf did such a good job on this I had to borrow it.
             def find_executable(bin,*paths)
-                paths = ENV['PATH'].split(File::PATH_SEPARATOR) if paths.empty?
-                paths.each do |path|
-                    file = File.join(path,bin)
-                    return file if File.executable?(file)
-                end
-                return nil
+                Application.find_executable(bin,*paths)
             end
             
             # return the current 'host_os' string from ruby's configuration
             def my_os
-                ::Config::CONFIG['host_os']
+                Application.my_os
             end
             
-            # detect what the current os is and return :windows, :darwin, :nix or :java
+            # detect what the current os is and return :windows, :darwin or :nix
             def my_os_family(test_os = my_os)
-                case test_os
-                when /mswin/i
-                    family = :windows
-                when /windows/i
-                    family = :windows
-                when /darwin/i
-                    family = :darwin
-                when /mac os/i
-                    family = :darwin
-                when /solaris/i
-                    family = :nix
-                when /bsd/i
-                    family = :nix
-                when /linux/i
-                    family = :nix
-                when /cygwin/i
-                    family = :nix
-                else
-                    $stderr.puts "Unknown OS familiy for '#{test_os}'.  Please report this bug."
-                    family = :unknown
-                end
+                Application.my_os_family(test_os)
             end
             
             # run the command
             def run(cmd,*args)
                 args.unshift(cmd)
+                cmd_line = args.join(' ')
+                Launchy.log "Spawning on #{my_os_family} : #{cmd_line}"
                 if my_os_family == :windows then
-                    require 'win32/process'
+                    system cmd_line
+                else
+                    # fork and the child process should NOT run any exit handlers
+                    child_pid = fork do 
+                                    cmd_line += " > /dev/null 2>&1"
+                                    system cmd_line
+                                    exit! 
+                                end
+                    Process.detach(child_pid)
                 end
-                # fork and the child process should NOT run any exit handlers
-                child_pid = fork do 
-                                system args.join(' ') 
-                                exit! 
-                            end
-                Process.detach(child_pid)
             end
         end
     end
 end
-

data/lib/launchy/spawnable/browser.rb

@@ -4,12 +4,16 @@ require 'uri'
 module Launchy
     module Spawnable
         class Browser < Application
-            APP_LIST = { 
-                :windows => %w[ firefox iexplore ],
-                :darwin  => %w[ open ],
-                :nix     => %w[ firefox ],
-                :unknown => [],
-                }
+            
+            DESKTOP_ENVIRONMENT_BROWSER_LAUNCHERS = {
+                :kde     => "kfmclient",
+                :gnome   => "gnome-open",
+                :xfce    => "exo-open",
+                :generic => "htmlview"
+            }
+            
+            FALLBACK_BROWSERS = %w[ firefox seamonkey opera mozilla netscape galeon ]
+            
             class << self
                 def run(*args)
                     Browser.new.visit(args[0]) 
@@ -24,12 +28,36 @@ module Launchy
                         return false
                     end
                 end
+                
+                # Find a list of potential browser applications to run on *nix machines.  
+                # The order is:
+                #     1) What is in ENV['LAUNCHY_BROWSER'] or ENV['BROWSER']
+                #     2) xdg-open
+                #     3) desktop environment launcher program
+                #     4) a list of fallback browsers
+                def nix_app_list
+                    browser_cmds = ['xdg-open']
+                    browser_cmds << DESKTOP_ENVIRONMENT_BROWSER_LAUNCHERS[nix_desktop_environment]
+                    browser_cmds << FALLBACK_BROWSERS
+                    browser_cmds.flatten!
+                    browser_cmds.delete_if { |b| b.nil? || (b.strip.size == 0) }
+                    Launchy.log "*Nix Browser List: #{browser_cmds.join(', ')}"
+                    browser_cmds
+                end
+                                    
             end
             
+            APP_LIST = { 
+                :windows => %w[ start ],
+                :darwin  => %w[ open ],
+                :nix     => nix_app_list,
+                :unknown => [],
+                }
+            
             def initialize
                 raise "Unable to find browser to launch for os family '#{my_os_family}'." unless browser
             end
-            
+                        
             # returns the list of command line application names for the current os
             def app_list
                 APP_LIST[my_os_family]
@@ -37,7 +65,19 @@ module Launchy
             
             # return the full command line path to the browser or nil
             def browser
-                @browser ||= app_list.collect { |bin| find_executable(bin) }.reject { |x| x.nil? }.first
+                if not @browser then
+                    if ENV['LAUNCHY_BROWSER'] and File.exists?(ENV['LAUNCHY_BROWSER']) then
+                        Launchy.log "Using LAUNCHY_BROWSER environment variable : #{ENV['LAUNCHY_BROWSER']}"
+                        @browser = ENV['LAUNCHY_BROWSER']
+                    elsif ENV['BROWSER'] and File.exists?(ENV['BROWSER']) then
+                        Launchy.log "Using BROWSER environment variable : #{ENV['BROWSER']}"
+                        @browser = ENV['BROWSER']
+                    else
+                        @browser = app_list.collect { |bin| find_executable(bin) }.find { |x| not x.nil? }
+                        Launchy.log "Using application list : #{@browser}"
+                    end
+                end
+                return @browser
             end
             
             # launch the browser at the appointed url
@@ -47,4 +87,4 @@ module Launchy
             
         end
     end
-end
+end

data/lib/launchy/version.rb

@@ -1,8 +1,8 @@
 module Launchy
     class Version
         MAJOR   = 0
-        MINOR   = 1
-        BUILD   = 2
+        MINOR   = 2
+        BUILD   = 0
 
         class << self
             def to_a

data/spec/spawnable_application_spec.rb

@@ -33,6 +33,6 @@ describe Launchy::Spawnable::Application do
     end
     
     it "should find the correct class to launch an ftp url" do
-        Launchy::Spawnable::Application.find_application_class_for("ftp://download.fedora.redhat.com").should == Launchy::Spawnable::Browser
+        Launchy::Spawnable::Application.find_application_class_for("ftp://ftp.ruby-lang.org/pub/ruby/").should == Launchy::Spawnable::Browser
     end
 end

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: launchy
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 date: 2007-08-12 00:00:00 -06:00
 summary: A helper to launch apps from within ruby programs.
 require_paths: 
 - lib
 email: jeremy@hinegardner.org
-homepage: http://launchy.rubyforge.org/
+homepage: http://copiousfreetime.rubyforge.org/launchy/
 rubyforge_project: copiousfreetime
-description: Launchy is helper class for launching +cross-platform+ applications.  There are application concepts (browser, email client, etc) that are common across all platforms, and they may be launched in different manners.  Launchy is here to assist in launching the appropriate application on the appropriate platform from within your ruby projects.
+description: Launchy is helper class for launching cross-platform applications in a fire and forget manner.    There are application concepts (browser, email client, etc) that are common across all platforms, and they may be launched differently on each platform.  Launchy is here to make a common approach to launching external application from within ruby programs.
 autorequire: 
 default_executable: launchy
 bindir: bin