wijet-launchy 2.0.6

data/HISTORY

@@ -0,0 +1,111 @@
+= Launchy Changlog
+== Version 2.0.5 - 2011-07-24
+
+* Fix the case where $BROWSER is set and no *nix desktop was found (copiousfreetime/launchy#33)
+
+== Version 2.0.4 - 2011-07-23
+
+* Fix windows 'start' commandline (copiousfreetime/launchy#5)
+* Add capability to open local files with no file: scheme present (copiousfreetime/launchy#29)
+* Added 'rake how_to_contribute' task (copiousfreetime/launchy#30)
+* Make better decisions on when to do shell escaping (copiousfreetime/launchy#31)
+* Switch to Addressable::URI so UTF-8 urls may be parsed. (copiousfreetime/launchy#32)
+
+== Version 2.0.3 - 2011-07-17
+
+* Add in Deprecated API wrappers that warn the user
+
+== Version 2.0.2 - 2011-07-17
+
+* Typo fixes from @mtorrent
+* Documentation updates explicitly stating the Public API
+* Increase test coverage
+
+== Version 2.0.1 - 2011-07-16
+
+* Almost a complete rewrite
+* JRuby Support
+* Organization is such that it will be easier to add additional applications
+* Windows behavior possibly fixed, again
+
+== Version 1.0.0 - 2011-03-17
+
+* Add JRuby support (Stephen Judkins)
+* Remove unused Paths module
+* Switch to using bones
+* Switch to use minitest
+* NOTE, this version was never released.
+
+== Version 0.4.0 - 2011-01-27
+
+* Add support for file:/// schema (postmodern)
+
+== Version 0.3.7 - 2010-07-19
+
+* Fix launchy on windows (mikefarmer)
+
+== Version 0.3.6 - 2010-02-22
+
+* add a test:spec task to run tests without rcov support
+* added 'testing' os family for running tests
+
+== Version 0.3.5 - 2009-12-17
+
+* clarify that launchy is under ISC license
+* fix missing data file in released gem needed for running specs
+
+== Version 0.3.3 - 2009-02-19
+
+* pass command line as discrete items to system() to avoid string
+  interpretation by the system shell. (Suraj N. Kurapati)
+* rework project layout and tasks
+
+== Version 0.3.2 - 2008-05-21
+
+* detect aix and mingw as known operating systems.
+
+== 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
+* removed 'do_magic' method, changed it to 'open'
+* added override environment variable LAUNCHY_HOST_OS for testing
+* fix broken cygwin support [Bug #13472]
+
+== Version 0.2.1 - 2007-08-18
+
+* fix inability to find windows executables [Bug #13132]
+
+== 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
+
+== Version 0.1.1
+
+* fixed rubyforge task to release mswin32 gem also
+
+== Version 0.1.0 
+
+* Initial public release
+* switched to using fork to spawn process and require 'win32/process' if on windows
+
+== Version 0.0.2
+
+* First attempt at using systemu to spawn processes
+
+== Version 0.0.1
+
+* Initially working release

data/LICENSE

@@ -0,0 +1,16 @@
+ISC LICENSE - http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2007-2011 Jeremy Hinegardner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/NOTES

@@ -0,0 +1 @@
+* Allow for new tab/ new window for opening a browser

data/README

@@ -0,0 +1,100 @@
+== launchy
+
+* Homepage[http://www.copiousfreetime.org/projects/launchy/]
+* {Github Project}[http://github.com/copiousfreetime/launchy]
+* email jeremy at hinegardner dot org
+
+== 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.
+
+== FEATURES
+
+Currently only launching a browser is supported.
+
+== SYNOPSIS
+
+You can use launchy on the commandline, or via its API.
+
+=== Commandline
+
+    % launchy http://www.ruby-lang.org/
+
+There are additional commandline options, use 'launchy --help' to see them.
+
+=== Public API
+
+In the vein of {Semantic Versioning}[http://semver.org], starting with version 2.0.0, this is the
+sole supported public API.
+
+    Launchy.open( uri, options = {} )
+
+At the moment, the only available options are:
+
+    :debug        Turn on debugging output
+    :application  Explicitly state what application class is going to be used
+    :host_os      Explicitly state what host operating system to pretend to be
+    :ruby_engine  Explicitly state what ruby engine to pretend to be under
+    :dry_run      Do nothing and print the command that would be executed on $stdout
+
+An example of using the public API:
+
+    Launchy.open( "http://www.ruby-lang.org" )
+
+== UPGRADING
+
+The previously published version of Launchy was 0.4.0. There have been so many
+changes, and a mistaken tag at 1.0.0, that I have decided to bump all the way
+to 2.0.x.
+
+I have attempted to keep backward compatibility with the previous examples. The
+previous API examples of:
+
+    Launchy::Browser.run("http://www.ruby-lang.org/")
+
+and
+
+    Launchy::Browser.new.visit("http://www.ruby-lang.org/")
+
+will still work, and you will get a deprecation notice, along with the line
+of code you should probably update. For example, this is what would print out
+in the github gem if it was updated to use 2.0.x but not use the supported API.
+
+    % gh home
+    WARNING: You made a call to a deprecated Launchy API. This call should be changed to 'Launchy.open( uri )'
+    WARNING: I think I was able to find the location that needs to be fixed. Please go look at:
+    WARNING:
+    WARNING: /Users/jeremy/.rvm/gems/ruby-1.8.7-p334/gems/github-0.6.2/lib/commands/helpers.rb:275:in `open'
+    WARNING: helper :open do |url|
+    WARNING:   has_launchy? proc {
+    WARNING:     Launchy::Browser.new.visit url
+    WARNING:   }
+    WARNING: end
+    WARNING:
+    WARNING: If this is not the case, please file a bug. Please file a bug at https://github.com/copiousfreetime/launchy/issues/new
+
+== ISC LICENSE
+
+http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2007-2011 Jeremy Hinegardner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,70 @@
+#--
+# Copyright (c) 2007 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details.
+#++
+
+begin
+  USING_BONES_VERSION = '3.7.0'
+  require 'bones'
+rescue LoadError
+  load 'tasks/contribute.rake'
+  Rake.application.invoke_task( :help )
+end
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+$:.unshift( "lib" )
+require 'launchy/version'
+
+Bones {
+  name      "wijet-launchy"
+  authors   "Jeremy Hinegardner"
+  email     "jeremy@copiousfreetime.org"
+  url       'http://www.copiousfreetime.org/projects/launchy'
+  version   Launchy::VERSION
+
+  ruby_opts     %w[ -W0 -rubygems ]
+  readme_file   'README'
+  ignore_file   '.gitignore'
+  history_file  'HISTORY'
+
+  rdoc.include << "README" << "HISTORY" << "LICENSE"
+
+  summary 'Launchy is helper class for launching cross-platform applications in a fire and forget manner.'
+  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.
+_
+
+  if RUBY_PLATFORM == "java" then
+    depend_on "spoon"   , "~> 0.0.1"
+    depend_on 'ffi'     , "~> 1.0.9"
+    gem.extras = { :platform => Gem::Platform.new( "java" ) }
+  end
+
+  depend_on "addressable", "~> 2.2.6"
+
+  depend_on "rake"      , "~> 0.9.2", :development => true
+  depend_on "minitest"  , "~> 2.3.1", :development => true
+  depend_on 'bones'     , "~> #{USING_BONES_VERSION}", :development => true
+  depend_on 'bones-rcov', "~> 1.0.1", :development => true
+  depend_on 'rcov'      , "~> 0.9.9", :development => true
+  depend_on "spoon"     , "~> 0.0.1", :development => true
+  depend_on 'ffi'       , "~> 1.0.9", :development => true
+
+  test.files = FileList["spec/**/*_spec.rb"]
+  test.opts << "-w -Ilib:spec"
+
+  rcov.opts << "--exclude gems"
+}
+
+# Sorry Tim, I need to manage my own bones version
+::Bones.config.gem._spec.dependencies.delete_if do |d|
+  d.name == 'bones' and d.requirement.to_s =~ /^>=/
+end

data/bin/launchy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'launchy'
+Launchy::Cli.new.run( ARGV, ENV )

data/lib/launchy.rb

@@ -0,0 +1,115 @@
+require 'addressable/uri'
+
+#
+# The entry point into Launchy. This is the sole supported public API.
+#
+#   Launchy.open( uri, options = {} )
+#
+# The currently defined global options are:
+#
+#   :debug        Turn on debugging output
+#   :application  Explicitly state what application class is going to be used
+#   :host_os      Explicitly state what host operating system to pretend to be
+#   :ruby_engine  Explicitly state what ruby engine to pretend to be under
+#   :dry_run      Do nothing and print the command that would be executed on $stdout
+#
+# Other options may be used, and those will be passed directly to the
+# application class
+#
+module Launchy
+
+  class << self
+    #
+    # Convenience method to launch an item
+    #
+    def open(uri, options = {} )
+      begin
+        extract_global_options( options )
+        uri = Addressable::URI.parse(  uri )
+        app = Launchy::Application.handling( uri )
+        app.new.open( uri, options )
+      rescue Exception => e
+        msg = "Failure in opening #{uri} with options #{options.inspect}: #{e}"
+        Launchy.log "#{self.name} : #{msg}"
+        e.backtrace.each do |bt|
+          Launchy.log bt
+        end
+        $stderr.puts msg
+      end
+    end
+
+    def reset_global_options
+      Launchy.debug       = false
+      Launchy.application = nil
+      Launchy.host_os     = nil
+      Launchy.ruby_engine = nil
+      Launchy.dry_run     = false
+    end
+
+    def extract_global_options( options )
+      Launchy.debug        = options.delete( :debug       ) || ENV['LAUNCHY_DEBUG']
+      Launchy.application  = options.delete( :application ) || ENV['LAUNCHY_APPLICATION']
+      Launchy.host_os      = options.delete( :host_os     ) || ENV['LAUNCHY_HOST_OS']
+      Launchy.ruby_engine  = options.delete( :ruby_engine ) || ENV['LAUNCHY_RUBY_ENGINE']
+      Launchy.dry_run      = options.delete( :dry_run     ) || ENV['LAUNCHY_DRY_RUN']
+    end
+
+    def debug=( d )
+      @debug = (d == "true")
+    end
+
+    # we may do logging before a call to 'open', hence the need to check
+    # LAUNCHY_DEBUG here
+    def debug?
+      @debug || (ENV['LAUNCHY_DEBUG'] == 'true')
+    end
+
+    def application=( app )
+      @application = app
+    end
+
+    def application
+      @application || ENV['LAUNCHY_APPLICATION']
+    end
+
+    def host_os=( host_os )
+      @host_os = host_os
+    end
+
+    def host_os
+      @host_os || ENV['LAUNCHY_HOST_OS']
+    end
+
+    def ruby_engine=( ruby_engine )
+      @ruby_engine = ruby_engine
+    end
+
+    def ruby_engine
+      @ruby_engine || ENV['LAUNCHY_RUBY_ENGINE']
+    end
+
+    def dry_run=( dry_run )
+      @dry_run = dry_run
+    end
+
+    def dry_run?
+      @dry_run
+    end
+
+    def bug_report_message
+      "Please file a bug at https://github.com/copiousfreetime/launchy/issues/new"
+    end
+
+    def log(msg)
+      $stderr.puts "LAUNCHY_DEBUG: #{msg}" if Launchy.debug?
+    end
+  end
+end
+
+require 'launchy/version'
+require 'launchy/cli'
+require 'launchy/descendant_tracker'
+require 'launchy/error'
+require 'launchy/application'
+require 'launchy/detect'
+require 'launchy/deprecated'

data/lib/launchy/application.rb

@@ -0,0 +1,62 @@
+require 'set'
+module Launchy
+  #
+  # Application is the base class of all the application types that launchy may
+  # invoke. It essentially defines the public api of the launchy system.
+  #
+  # Every class that inherits from Application must define:
+  #
+  # 1. A constructor taking no parameters
+  # 2. An instance method 'open' taking a string or URI as the first parameter and a
+  #    hash as the second
+  # 3. A class method 'handles?' that takes a String and returns true if that
+  #    class can handle the input.
+  class Application
+    extend DescendantTracker
+
+    class << self
+      # Find the application that handles the given uri.
+      #
+      # returns the Class that can handle the uri
+      def handling( uri )
+        klass = find_child( :handles?, uri )
+        return klass if klass
+        raise ApplicationNotFoundError, "No application found to handle '#{uri}'"
+      end
+
+      #
+      # Find the given executable in the available paths
+      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 "#{self.name} : found executable #{file}"
+            return file
+          end
+        end
+        Launchy.log "#{self.name} : Unable to find `#{bin}' in #{paths.join(", ")}"
+        return nil
+      end
+    end
+
+    attr_reader :host_os_family
+    attr_reader :ruby_engine
+    attr_reader :runner
+
+    def initialize
+      @host_os_family = Launchy::Detect::HostOsFamily.detect
+      @ruby_engine    = Launchy::Detect::RubyEngine.detect
+      @runner         = Launchy::Detect::Runner.detect
+    end
+
+    def find_executable( bin, *paths )
+      Application.find_executable( bin, *paths )
+    end
+
+    def run( cmd, *args )
+      runner.run( cmd, *args )
+    end
+  end
+end
+require 'launchy/applications/browser'