launchy 0.3.0 → 0.3.1

data/CHANGES

@@ -1,5 +1,10 @@
 == Changes
 
+=== Version 0.3.1 - 2007-09-08
+
+* finalize the command line wrapper around the launchy library.
+* added more tests
+
 === Version 0.3.0 - 2007-08-30
 
 * reorganize the code structure, removing Spawnable namespace

data/bin/launchy

@@ -9,4 +9,4 @@ rescue LoadError
     retry
 end
 
-Launchy.open(*ARGV)
+Launchy.command_line.run(ARGV)

data/lib/launchy.rb

@@ -22,11 +22,19 @@ module Launchy
     
     class << self
         def open(*params)
-            klass = Launchy::Application.find_application_class_for(*params)
-            if klass then 
-                klass.run(*params)
-            else
-                $stderr.puts "Unable to launch #{params.join(' ')}"
+            begin
+                klass = Launchy::Application.find_application_class_for(*params)
+                if klass then 
+                    klass.run(*params)
+                else
+                    msg = "Unable to launch #{params.join(' ')}"
+                    Launchy.log "#{self.name} : #{msg}"
+                    $stderr.puts msg
+                end
+            rescue Exception => e
+                msg = "Failure in opening #{params.join(' ')} : #{e}"
+                Launchy.log "#{self.name} : #{msg}"
+                $stderr.puts msg
             end
         end
         
@@ -37,7 +45,14 @@ module Launchy
                 $stderr.puts "LAUNCHY_DEBUG: #{msg}"
             end
         end
+        
+        # Create an instance of the commandline application of launchy
+        def command_line
+            Launchy::CommandLine.new
+        end
     end
+    
+    
 end
 
 Launchy.require_all_libs_relative_to(__FILE__)

data/lib/launchy/application.rb

@@ -14,10 +14,10 @@ module Launchy
             end                
             
             def find_application_class_for(*args)
-                Launchy.log "finding application classes for [#{args.join(' ')}]"
+                Launchy.log "#{self.name} : finding application classes for [#{args.join(' ')}]"
                 application_classes.find do |klass| 
+                    Launchy.log "#{self.name} : Trying #{klass.name}"
                     if klass.handle?(*args) then
-                        Launchy.log "  #{klass.name}"
                         true
                     else
                         false
@@ -32,18 +32,18 @@ module Launchy
                 paths.each do |path|
                     file = File.join(path,bin)
                     if File.executable?(file) then
-                        Launchy.log "found executable #{file}"
+                        Launchy.log "#{self.name} : found executable #{file}"
                         return file
                     end
                 end
-                Launchy.log "Unable to find `#{bin}' in paths #{paths.join(', ')}"
+                Launchy.log "#{self.name} : Unable to find `#{bin}' in #{paths.join(', ')}"
                 return nil
             end
             
             # return the current 'host_os' string from ruby's configuration
             def my_os
                 if ENV['LAUNCHY_HOST_OS'] then 
-                    Launchy.log "Using LAUNCHY_HOST_OS override of '#{ENV['LAUNCHY_HOST_OS']}'"
+                    Launchy.log "#{self.name} : Using LAUNCHY_HOST_OS override of '#{ENV['LAUNCHY_HOST_OS']}'"
                     return ENV['LAUNCHY_HOST_OS']
                 else
                     ::Config::CONFIG['host_os']
@@ -92,7 +92,7 @@ module Launchy
                         @nix_desktop_environment = :xfce
                     end
                 end
-                Launchy.log "nix_desktop_environment => #{@nix_dekstop_environment}"
+                Launchy.log "#{self.class.name} : nix_desktop_environment => '#{@nix_desktop_environment}'"
             end
             return @nix_desktop_environment
         end
@@ -118,22 +118,22 @@ module Launchy
         def app_list
             @app_list ||= self.send("#{my_os_family}_app_list")
         end
-        
+                
         # On darwin a good general default is the 'open' executable.
         def darwin_app_list
-            Launchy.log "Using 'open' application on darwin."
+            Launchy.log "#{self.class.name} : Using 'open' application on darwin."
             [ find_executable('open') ]
         end
         
         # On windows a good general default is the 'start' Command Shell command
         def windows_app_list
-            Launchy.log "Using 'start' command on windows."
+            Launchy.log "#{self.class.name} : Using 'start' command on windows."
             %w[ start ]
         end
         
         # Cygwin uses the windows start but through an explicit execution of the cmd shell
         def cygwin_app_list
-            Launchy.log "Using 'cmd /C start' on windows."
+            Launchy.log "#{self.class.name} : Using 'cmd /C start' on windows."
             [ "cmd /C start" ]
         end
         
@@ -141,11 +141,12 @@ module Launchy
         def run(cmd,*args)
             args.unshift(cmd)
             cmd_line = args.join(' ')
-            Launchy.log "Spawning on #{my_os_family} : #{cmd_line}"
+            Launchy.log "#{self.class.name} : Spawning on #{my_os_family} : #{cmd_line}"
+            
             if my_os_family == :windows then
                 system cmd_line
             else
-                # fork and the child process should NOT run any exit handlers
+                # fork, and the child process should NOT run any exit handlers
                 child_pid = fork do 
                                 cmd_line += " > /dev/null 2>&1"
                                 system cmd_line

data/lib/launchy/browser.rb

@@ -21,9 +21,12 @@ module Launchy
             # return true if this class can handle the given parameter(s)
             def handle?(*args)
                 begin 
+                    Launchy.log "#{self.name} : testing if [#{args[0]}] (#{args[0].class}) is a url."
                     uri = URI.parse(args[0])
-                    return [URI::HTTP, URI::HTTPS, URI::FTP].include?(uri.class)
-                rescue Exception 
+                    result =  [URI::HTTP, URI::HTTPS, URI::FTP].include?(uri.class)
+                rescue Exception => e
+                    # hmm... why does rcov not see that this is executed ?
+                    Launchy.log "#{self.name} : not a url, #{e}" 
                     return false
                 end
             end
@@ -46,9 +49,9 @@ module Launchy
                 browser_cmds << FALLBACK_BROWSERS
                 browser_cmds.flatten!
                 browser_cmds.delete_if { |b| b.nil? || (b.strip.size == 0) }
-                Launchy.log "Initial *Nix Browser List: #{browser_cmds.join(', ')}"
+                Launchy.log "#{self.class.name} : Initial *Nix Browser List: #{browser_cmds.join(', ')}"
                 @nix_app_list = browser_cmds.collect { |bin| find_executable(bin) }.find_all { |x| not x.nil? }
-                Launchy.log "Filtered *Nix Browser List: #{@nix_app_list.join(', ')}"
+                Launchy.log "#{self.class.name} : Filtered *Nix Browser List: #{@nix_app_list.join(', ')}"
             end
             @nix_app_list
         end
@@ -57,16 +60,18 @@ module Launchy
         def browser
             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']}"
+                    Launchy.log "#{self.class.name} : 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']}"
+                    Launchy.log "#{self.class.name} : Using BROWSER environment variable : #{ENV['BROWSER']}"
                     @browser = ENV['BROWSER']
                 elsif app_list.size > 0 then
                     @browser = app_list.first
-                    Launchy.log "Using application list : #{@browser}"
+                    Launchy.log "#{self.class.name} : Using application list : #{@browser}"
                 else
-                    $stderr.puts "Unable to launch. No Browser application found."
+                    msg = "Unable to launch. No Browser application found."
+                    Launchy.log "#{self.class.name} : #{msg}"
+                    $stderr.puts msg
                 end
             end
             return @browser

data/lib/launchy/command_line.rb

@@ -0,0 +1,48 @@
+require 'optparse'
+
+module Launchy
+    class CommandLine
+
+        def parser
+            @parser ||= OptionParser.new do |op|
+                            op.banner = "Usage: launchy [options] url"
+                            op.separator ""
+                            op.on("-d", "--debug", "Force debug, output lots of information.",
+                                        "This sets the LAUNCHY_DEBUG environment variable to 'true'.") do |d|
+                                ENV["LAUNCHY_DEBUG"] = 'true'
+                            end
+                        
+                            op.on("-h", "--help", "Print this message") do |h|
+                                puts op.to_s
+                                exit 0
+                            end
+
+                            op.on("-v", "--version", "Output the version of Launchy") do |v|
+                                puts "Launchy version #{Launchy::VERSION}"
+                                exit 0
+                            end
+                        
+                            op.on("-o", "--host-os HOST_OS","Force the behavior of a particular host os.",
+                                    "This sets the LAUNCHY_HOST_OS environment variable.") do |os|
+                                ENV["LAUNCHY_HOST_OS"] = os
+                            end
+                            
+                            op.on("-b", "--browser BROWSER", "Force launchy to use a particular browser.",
+                                   "This sets the LAUNCHY_BROWSER environment variable.") do |browser|
+                                ENV["LAUNCHY_BROWSER"] = browser
+                            end
+                      end
+        end
+        
+        def run(argv = ARGV)
+            begin 
+                parser.parse!(argv)
+                Launchy.open(*argv)
+            rescue ::OptionParser::ParseError => pe
+                $stderr.puts "#{parser.programn_name}: #{pe}"
+                $stderr.puts "Try `#{parser.program_name} --help' for more information."
+                exit 1
+            end
+        end
+    end
+end

data/lib/launchy/version.rb

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

data/spec/application_spec.rb

@@ -6,7 +6,6 @@ describe Launchy::Application do
         yml = YAML::load(IO.read(File.join(File.dirname(__FILE__),"tattle-host-os.yml")))
         @host_os = yml['host_os']
         @app = Launchy::Application.new
-        
     end
 
     it "should find all tattled os" do
@@ -35,4 +34,26 @@ describe Launchy::Application do
     it "should find the correct class to launch an ftp url" do
         Launchy::Application.find_application_class_for("ftp://ftp.ruby-lang.org/pub/ruby/").should == Launchy::Browser
     end
+    
+    it "knows when it cannot find an application class" do
+        Launchy::Application.find_application_class_for("xyzzy:stuff,things").should == nil
+    end
+    
+    it "allows for environmental override of host_os" do
+        ENV["LAUNCHY_HOST_OS"] = "hal-9000"
+        Launchy::Application.my_os.should == "hal-9000"
+        ENV["LAUNCHY_HOST_OS"] = nil
+    end
+    
+    it "can detect the desktop environment of a *nix machien" do
+        @app.nix_desktop_environment.should == :generic
+
+        { "KDE_FULL_SESSION" => :kde,
+          "KDE_SESSION_UID"  => :kde,
+          "GNOME_DESKTOP_SESSION_ID" => :gnome }.each_pair do |k,v|
+            ENV[k] = "launchy-test"
+            Launchy::Application.new.nix_desktop_environment.should == v
+            ENV[k] = nil
+        end
+    end
 end

data/spec/browser_spec.rb

@@ -1,23 +1,50 @@
 require File.join(File.dirname(__FILE__),"spec_helper.rb")
-
+require 'stringio'
 describe Launchy::Browser do
     it "should find a path to a executable" do
         File.executable?(Launchy::Browser.new.browser).should == true
     end
     
     it "should handle an http url" do
-        Launchy::Browser.handle?("http://www.example.com") == true
+        Launchy::Browser.handle?("http://www.example.com").should == true
     end
     
     it "should handle an https url" do
-        Launchy::Browser.handle?("https://www.example.com") == true
+        Launchy::Browser.handle?("https://www.example.com").should == true
     end
     
     it "should handle an ftp url" do
-        Launchy::Browser.handle?("ftp://download.example.com") == true
+        Launchy::Browser.handle?("ftp://download.example.com").should == true
     end
     
     it "should not handle a mailto url" do
-        Launchy::Browser.handle?("mailto:jeremy@example.com") == false
+        Launchy::Browser.handle?("mailto:jeremy@example.com").should == false
     end
-end
+    
+    it "creates a default unix application list" do
+        Launchy::Browser.new.nix_app_list.class.should == Array
+    end
+    
+    it "can use environmental variable overrides for the browser" do
+        { "BROWSER" => "/usr/bin/true",
+           "LAUNCHY_BROWSER" => "/usr/bin/true"}.each_pair do |e,v|
+               ENV[e] = v
+               Launchy::Browser.new.browser.should == v
+               ENV[e] = nil
+           end
+    end
+    
+    it "reports when it cannot find an browser" do
+        old_error = $stderr
+        $stderr = StringIO.new
+        ENV["LAUNCHY_HOST_OS"] = "linux"
+        begin 
+            browser = Launchy::Browser.new
+        rescue => e
+            e.message.should =~ /Unable to find browser to launch for os family/m
+        end
+        ENV["LAUNCHY_HOST_OS"] = nil
+        $stderr.string.should =~ /Unable to launch. No Browser application found./m
+        $stderr = old_error
+    end
+end

data/spec/launchy_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__),"spec_helper.rb")
+require 'stringio'
+
+describe Launchy do
+    it "instantiates an insteadn of Launchy::CommandLine for commandline" do
+        Launchy.command_line.class.should == Launchy::CommandLine
+    end
+    
+    it "logs to stderr when LAUNCHY_DEBUG environment variable is set" do
+        ENV["LAUNCHY_DEBUG"] = 'true'
+        old_stderr = $stderr
+        $stderr = StringIO.new
+        Launchy.log "This is a test log message"
+        $stderr.string.strip.should == "LAUNCHY_DEBUG: This is a test log message"
+        $stderr = old_stderr
+        ENV["LAUNCHY_DEBUG"] = nil
+    end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: launchy
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-08-30 00:00:00 -06:00
+  version: 0.3.1
+date: 2007-09-08 00:00:00 -06:00
 summary: A helper to launch apps from within ruby programs.
 require_paths: 
 - lib
@@ -31,6 +31,7 @@ authors:
 files: 
 - spec/application_spec.rb
 - spec/browser_spec.rb
+- spec/launchy_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
 - CHANGES
@@ -38,6 +39,7 @@ files:
 - README
 - lib/launchy/application.rb
 - lib/launchy/browser.rb
+- lib/launchy/command_line.rb
 - lib/launchy/gemspec.rb
 - lib/launchy/specification.rb
 - lib/launchy/version.rb
@@ -46,6 +48,7 @@ files:
 test_files: 
 - spec/application_spec.rb
 - spec/browser_spec.rb
+- spec/launchy_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
 rdoc_options: