launchy 2.0.3 → 2.0.4

data/HISTORY

@@ -1,4 +1,11 @@
 = Launchy Changlog
+== 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
 

data/README

@@ -47,6 +47,38 @@ 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

data/Rakefile

@@ -4,9 +4,11 @@
 #++
 
 begin
+  USING_BONES_VERSION = '3.7.0'
   require 'bones'
 rescue LoadError
-  abort '### Please install the "bones" gem ###'
+  load 'tasks/contribute.rake'
+  Rake.application.invoke_task( :help )
 end
 
 task :default => 'test:run'
@@ -42,18 +44,27 @@ _
 
   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'     , "~> 3.7.0", :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/lib/launchy.rb

@@ -1,4 +1,4 @@
-require 'uri'
+require 'addressable/uri'
 
 #
 # The entry point into Launchy. This is the sole supported public API.
@@ -25,8 +25,8 @@ module Launchy
     def open(uri, options = {} )
       begin
         extract_global_options( options )
-        uri = URI.parse( uri )
-        app = Launchy::Application.for_scheme( uri )
+        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}"

data/lib/launchy/application.rb

@@ -9,39 +9,19 @@ module Launchy
   # 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 'schemes' that returns an array of Strings containing the
-  #    schemes that the Application will handle
+  # 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.
       #
-      # The list of all the schemes all the applications know
-      #
-      def scheme_list
-        children.collect { |a| a.schemes }.flatten.sort
-      end
-
-      #
-      # if this application handles the given scheme
-      #
-      def handles?( scheme )
-        schemes.include?( scheme )
-      end
-
-      #
-      # Find the application that handles the given scheme.  May take either a
-      # String or something that responds_to?( :scheme )
-      #
-      def for_scheme( scheme )
-        if scheme.respond_to?( :scheme ) then
-          scheme = scheme.scheme
-        end
-
-        klass = find_child( :handles?, scheme )
+      # returns the Class that can handle the uri
+      def handling( uri )
+        klass = find_child( :handles?, uri )
         return klass if klass
-
-        raise SchemeNotFoundError, "No application found to handle scheme '#{scheme}'. Known schemes: #{scheme_list.join(", ")}"
+        raise ApplicationNotFoundError, "No application found to handle '#{uri}'"
       end
 
       #

data/lib/launchy/applications/browser.rb

@@ -7,12 +7,17 @@ class Launchy::Application
       %w[ http https ftp file ]
     end
 
+    def self.handles?( uri )
+      return true if schemes.include?( uri.scheme )
+      return true if File.exist?( uri.path )
+    end
+
     def windows_app_list
-      [  'start "Launchy" /d']
+      [ 'start /b' ]
     end
 
     def cygwin_app_list
-      [ 'cmd /C start "Launchy" /d' ]
+      [ 'cmd /C start /b' ]
     end
 
     def darwin_app_list

data/lib/launchy/detect/runner.rb

@@ -34,18 +34,19 @@ module Launchy::Detect
     #
     # cut it down to just the shell commands that will be passed to exec or
     # posix_spawn. The cmd argument is split according to shell rules and the
-    # args are escaped according to shell rules.
+    # args are not escaped because they whole set is passed to system as *args
+    # and in that case system shell escaping rules are not done.
     #
     def shell_commands( cmd, args )
       cmdline = [ cmd.shellsplit ]
-      cmdline << args.flatten.collect{ |a| a.to_s.shellescape }
+      cmdline << args.flatten.collect{ |a| a.to_s }
       return commandline_normalize( cmdline )
     end
 
     def commandline_normalize( cmdline )
       c = cmdline.flatten!
       c = c.find_all { |a| (not a.nil?) and ( a.size > 0 ) }
-      Launchy.log "ARGV => #{c.inspect}"
+      Launchy.log "commandline_normalized => #{c.join(' ')}"
       return c
     end
 
@@ -69,16 +70,20 @@ module Launchy::Detect
     class Windows < Runner
 
       def all_args( cmd, *args )
-        [ 'cmd', '/c', *shell_commands( cmd, *args ) ]
+        args = [ 'cmd', '/c', *shell_commands( cmd, *args ) ]
+        Launchy.log "Windows: all_args => #{args.inspect}"
+        return args
       end
 
       def dry_run( cmd, *args )
         all_args( cmd, *args ).join(" ")
       end
 
+      # escape the reserved shell characters in windows command shell
+      # http://technet.microsoft.com/en-us/library/cc723564.aspx
       def shell_commands( cmd, *args )
-        cmdline = [ cmd ]
-        cmdline << args.flatten.collect { |a| a.to_s.gsub("&", "^&") }
+        cmdline = [ cmd.shellsplit ]
+        cmdline << args.flatten.collect { |a| a.to_s.gsub(/([&|()<>^])/, "^\\1") }
         return commandline_normalize( cmdline )
       end
 

data/lib/launchy/error.rb

@@ -1,4 +1,4 @@
 module Launchy
   class Error < ::StandardError; end
-  class SchemeNotFoundError < Error; end
+  class ApplicationNotFoundError < Error; end
 end

data/lib/launchy/version.rb

@@ -1,5 +1,5 @@
 module Launchy
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 
   module Version
 

data/spec/application_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
-require 'mock_scheme'
+require 'mock_application'
 
 class JunkApp < Launchy::Application
-  def self.schemes
-    %w[ junk ]
+  def self.handles?( uri )
+    uri.scheme == "junk"
   end
 end
 
 describe Launchy::Application do
   it 'registers inherited classes' do
     class Junk2App < Launchy::Application
-      def self.schemes
-        %w[ junk2 ]
+      def self.handles?( uri )
+        uri.scheme == "junk2"
       end
     end
     Launchy::Application.children.must_include( Junk2App )
@@ -20,12 +20,14 @@ describe Launchy::Application do
 
   it "can find an app" do
     Launchy::Application.children.must_include( JunkApp )
-    Launchy::Application.scheme_list.size.must_equal 7
-    Launchy::Application.for_scheme( "junk" ).must_equal( JunkApp  )
+    Launchy::Application.children.size.must_equal 3
+    uri = Addressable::URI.parse( "junk:///foo" )
+    Launchy::Application.handling( uri ).must_equal( JunkApp  )
   end
 
   it "raises an error if an application cannot be found for the given scheme" do
-    lambda { Launchy::Application.for_scheme( "foo" ) }.must_raise( Launchy::SchemeNotFoundError )
+    uri = Addressable::URI.parse( "foo:///bar" )
+    lambda { Launchy::Application.handling( uri ) }.must_raise( Launchy::ApplicationNotFoundError )
   end
 
   it "can find open or curl" do

data/spec/applications/browser_spec.rb

@@ -12,9 +12,9 @@ describe Launchy::Application::Browser do
     ENV.delete( 'KDE_FULL_SESSION' )
   end
 
-  { 'windows' => 'start "Launchy" /d' ,
+  { 'windows' => 'start /b' ,
     'darwin'  => '/usr/bin/open',
-    'cygwin'  => 'cmd /C start "Launchy" /d',
+    'cygwin'  => 'cmd /C start /b',
 
     # when running these tests on a linux box, this test will fail
     'linux'   => nil                 }.each  do |host_os, cmdline|
@@ -35,5 +35,10 @@ describe Launchy::Application::Browser do
       args.must_equal []
     end
   end
+
+  it "handles a file on the file system when there is no file:// scheme" do
+    uri = Addressable::URI.parse( __FILE__ )
+    Launchy::Application::Browser.handles?( uri ).must_equal true
+  end
 end
 

data/spec/detect/runner_spec.rb

@@ -62,18 +62,37 @@ describe Launchy::Detect::Runner do
     cmd.must_equal 'cmd /c not-really http://example.com'
   end
 
-  it "Windows escapes '&' in urls" do
-    win = Launchy::Detect::Runner::Windows.new
-    win.all_args( "not-really", [ @test_url ] ).must_equal [ 'cmd', '/c', 'not-really', 'http://example.com/?foo=bar^&baz=wibble' ]
+  %w[ & | ( ) < > ^ ].each do |reserved_char|
+    it "Windows escapes '#{reserved_char}' in urls" do
+      win = Launchy::Detect::Runner::Windows.new
+      parts = [ 'http://example.com/?foo=bar', 'baz=wibble' ]
+      url = parts.join( reserved_char )
+      output_url = parts.join( "^#{reserved_char}" )
+
+      win.all_args( "not-really", [ url ] ).must_equal [ 'cmd', '/c', 'not-really', output_url ]
 
-    cmd = win.dry_run( "not-really", [ @test_url ] )
-    cmd.must_equal 'cmd /c not-really http://example.com/?foo=bar^&baz=wibble'
+      cmd = win.dry_run( "not-really", [ url ] )
+      cmd.must_equal "cmd /c not-really #{output_url}"
+    end
   end
 
-  it "Jruby escapes '&' in urls" do
+  it "Jruby doesnot escapes '&' in urls" do
     jruby = Launchy::Detect::Runner::Jruby.new
     cmd = jruby.dry_run( "not-really", [ @test_url ])
-    cmd.must_equal 'not-really http://example.com/\\?foo\\=bar\\&baz\\=wibble'
+    cmd.must_equal 'not-really http://example.com/?foo=bar&baz=wibble'
+  end
+
+  it "does not escape %38 items in urls" do
+    l = Launchy::Detect::Runner::Forkable.new
+    cmd = l.dry_run( "not-really", [ "http://ja.wikipedia.org/wiki/%E3%81%82" ] )
+    cmd.must_equal( 'not-really http://ja.wikipedia.org/wiki/%E3%81%82'  )
+  end
+
+  it "can launch a utf8 url" do
+    url = "http://ja.wikipedia.org/wiki/あ"
+    l = Launchy::Detect::Runner::Forkable.new
+    cmd = l.dry_run( "not-really", [ url ] )
+    cmd.must_equal( "not-really #{url}" )
   end
 
 end

data/spec/mock_application.rb

@@ -0,0 +1,9 @@
+class MockApplication < Launchy::Application
+  def self.schemes
+    %w[ mock mockother ]
+  end
+
+  def self.handles?( uri )
+    schemes.include?( uri.scheme )
+  end
+end

data/tasks/bundler.rake

@@ -0,0 +1,13 @@
+namespace :bundle do
+
+  file 'Gemfile' => [ 'gem:spec' ] do
+    File.open( 'Gemfile', 'w+' ) do |f|
+      f.puts 'source "http://rubygems.org"'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :gemfile => 'Gemfile'
+
+end

data/tasks/contribute.rake

@@ -0,0 +1,36 @@
+desc "Instructions on how to contribute to launchy"
+task :help do
+  abort <<-_banner
+-----------------------------------------------------------------------
+  I see you are wanting to do some development on launchy. You will 
+  need to install the 'bones' gem first.
+
+     % gem install bones -v #{USING_BONES_VERSION}
+
+  The easiest way to start after that is with the 
+  'install:dependencies' task:
+
+     % rake gem:install_dependencies
+
+  If you use bundler, then you will need to first create the Gemfile 
+  and then run 'bundle install':
+
+     % rake bundle:gemfile
+     % bundle install
+
+  Now you are ready to work on launchy.  Please submit bugs and pull 
+  requests to:
+
+    https://github.com/copiousfreetime/launchy
+
+  Thanks!
+
+     -jeremy
+-----------------------------------------------------------------------
+_banner
+end
+
+desc "(Alias for 'help') Instructions on how to contribute to launchy"
+task 'how_to_contribute' => :help
+desc "(Alias for 'help') Instructions on how to contribute to launchy"
+task '==> I WANT TO CONTRIBUTE <==' => :help

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: launchy
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 2
   - 0
-  - 3
-  version: 2.0.3
+  - 4
+  version: 2.0.4
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -15,13 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-17 00:00:00 -06:00
+date: 2011-07-23 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: addressable
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 2
+        - 6
+        version: 2.2.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,11 +49,11 @@ dependencies:
         - 2
         version: 0.9.2
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,11 +65,11 @@ dependencies:
         - 1
         version: 2.3.1
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bones
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,11 +81,11 @@ dependencies:
         - 0
         version: 3.7.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: bones-rcov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,11 +97,11 @@ dependencies:
         - 1
         version: 1.0.1
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -97,11 +113,11 @@ dependencies:
         - 9
         version: 0.9.9
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: spoon
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -113,23 +129,23 @@ dependencies:
         - 1
         version: 0.0.1
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: bones
+  name: ffi
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 5
         segments: 
-        - 3
-        - 7
+        - 1
         - 0
-        version: 3.7.0
+        - 9
+        version: 1.0.9
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: |
   Launchy is helper class for launching cross-platform applications in a
   fire and forget manner.
@@ -180,10 +196,12 @@ files:
 - spec/detect/ruby_engine_spec.rb
 - spec/detect/runner_spec.rb
 - spec/launchy_spec.rb
-- spec/mock_scheme.rb
+- spec/mock_application.rb
 - spec/spec_helper.rb
 - spec/tattle-host-os.yaml
 - spec/version_spec.rb
+- tasks/bundler.rake
+- tasks/contribute.rake
 has_rdoc: true
 homepage: http://www.copiousfreetime.org/projects/launchy
 licenses: []

data/spec/mock_scheme.rb

@@ -1,5 +0,0 @@
-class MockScheme < Launchy::Application
-  def self.schemes
-    %w[ mock mockother ]
-  end
-end