launchy 2.5.2 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d9c66ec0c8dcc2892bc46267fe37f7f1c82d14dad78d62c8adbd869a0d8a0f
-  data.tar.gz: ecf5f8096d6f3ef2a4d9118b18086eba83ed62f50362c1964938faba8d53d624
+  metadata.gz: 147fa0dafa116ae097364aab290ffdb2f508ff44b87019dc266aeaccf1963ab7
+  data.tar.gz: aad595ea32b9a1b1027c0650fd23b1a19865dda3f60c76890e6b0bb1be9e6c0d
 SHA512:
-  metadata.gz: 4abd13c2b9c600a9e2a50d07a2a8bfbe6ae21de1972063520669f558b5b7f3eca6dc5e4a2de63d1a19c6dcdeb43a53bddc22da210556a2a6c64ba263afed92ec
-  data.tar.gz: 53feae60f4355edcddaa16497c5606f35eaccabd81d21f35d91ac3188314affd43f722970fe4c31249a89fbfadf7afc74579ee7d97f4740f1d339b0007a577e5
+  metadata.gz: b8193061c42405778b539067521999e9ff2776c0317ba8fae47ce300d901e55473abccad60486b93952e101a32c15a8d462205880c1ceaf7a1a6fe04833b6404
+  data.tar.gz: 57b74c3a254e4437b04b4baa367abb384e733bef508f8f746a22c13997ce13b063208fe6c5c9b16bb8e6963aad2d59367d1aea1188e3326c7aaac69f1e53cae9

data/HISTORY.md

@@ -1,4 +1,26 @@
 # Launchy Changelog
+## Version 3.1.1 - 2025-02-21
+* Fix the quoted parameter for windows launching - <https://github.com/copiousfreetime/launchy/issues/164>
+
+## Version 3.1.0 - 2025-01-23
+* Fix the argv array when passing to ChildProcess on windows - <https://github.com/copiousfreetime/launchy/issues/159>
+* Update the ruby test matrix for 3.4
+* Update the ruby test matrix to drop 3.0
+
+## Version 3.0.1 - 2024-05-03
+* Added rubocop and fix all the warnings
+* Fix rubygem changelog_uri - Spone
+* Update the semaphore flow
+* Update the ruby test matrix
+* Change to Gemfile for development
+
+## Version 3.0.0 - 2024-03-03
+* Remove unused `deprecated.rb` file - <https://github.com/copiousfreetime/launchy/issues/148>
+* Update supported ruby version to be 3.x
+* use the `:application` parameter - <https://github.com/copiousfreetime/launchy/issues/121>
+* adjust the semaphore configuration to allow better caching
+* replace the homegrown process runner with [`childprocess`](https://rubygems.org/gems/childprocess)
+
 ## Version 2.5.2 - 2022-12-27
 * Update Addressable - <https://github.com/copiousfreetime/launchy/pull/145> - JamieKDonnelly
 * Fix deprecated usage of `Object#=~` - <https://github.com/copiousfreetime/launchy/pull/138> - marcrohloff

data/Manifest.txt

@@ -1,38 +1,21 @@
 CONTRIBUTING.md
 HISTORY.md
-LICENSE
+LICENSE.txt
 Manifest.txt
 README.md
-Rakefile
-bin/launchy
+exe/launchy
+launchy.gemspec
 lib/launchy.rb
 lib/launchy/application.rb
 lib/launchy/applications/browser.rb
 lib/launchy/argv.rb
 lib/launchy/cli.rb
-lib/launchy/deprecated.rb
 lib/launchy/descendant_tracker.rb
 lib/launchy/detect.rb
 lib/launchy/detect/host_os.rb
 lib/launchy/detect/host_os_family.rb
 lib/launchy/detect/nix_desktop_environment.rb
-lib/launchy/detect/ruby_engine.rb
-lib/launchy/detect/runner.rb
 lib/launchy/error.rb
 lib/launchy/os_family.rb
+lib/launchy/runner.rb
 lib/launchy/version.rb
-spec/application_spec.rb
-spec/applications/browser_spec.rb
-spec/cli_spec.rb
-spec/detect/host_os_family_spec.rb
-spec/detect/host_os_spec.rb
-spec/detect/nix_desktop_environment_spec.rb
-spec/detect/ruby_engine_spec.rb
-spec/detect/runner_spec.rb
-spec/launchy_spec.rb
-spec/mock_application.rb
-spec/spec_helper.rb
-spec/tattle-host-os.yaml
-spec/version_spec.rb
-tasks/default.rake
-tasks/this.rb

data/README.md

@@ -92,7 +92,6 @@ 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
 
 If `Launchy.open` is invoked with a block, then no exception will be thrown, and
@@ -110,41 +109,6 @@ exception that was raised.
       puts "Attempted to open #{uri} and failed because #{exception}"
     end
 
-## UPGRADING from versions before 2.0.0
-
-The previously published version of Launchy before the 2.0.0 series 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.x.y.
-
-I have attempted to keep backward compatibility with the previous examples. The
-previous API examples of:
-
-    Launchy::Browser.run("https://www.ruby-lang.org/")
-
-and
-
-    Launchy::Browser.new.visit("https://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
-
-These deprecation notices will go away with version 3.0 and the only available
-API will be the documented one.
-
 ## ISC LICENSE
 
 https://opensource.org/licenses/isc-license.txt

data/exe/launchy

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

data/launchy.gemspec

@@ -0,0 +1,33 @@
+# DO NOT EDIT - This file is automatically generated
+# Make changes to Manifest.txt and/or Rakefile and regenerate
+# -*- encoding: utf-8 -*-
+# stub: launchy 3.1.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "launchy".freeze
+  s.version = "3.1.1".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.metadata = { "bug_tracker_uri" => "https://github.com/copiousfreetime/launchy/issues", "changelog_uri" => "https://github.com/copiousfreetime/launchy/blob/master/HISTORY.md", "homepage_uri" => "https://github.com/copiousfreetime/launchy", "source_code_uri" => "https://github.com/copiousfreetime/launchy" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Jeremy Hinegardner".freeze]
+  s.bindir = "exe".freeze
+  s.date = "2025-02-21"
+  s.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 applications from within ruby programs.".freeze
+  s.email = "jeremy@copiousfreetime.org".freeze
+  s.executables = ["launchy".freeze]
+  s.extra_rdoc_files = ["CONTRIBUTING.md".freeze, "HISTORY.md".freeze, "LICENSE.txt".freeze, "Manifest.txt".freeze, "README.md".freeze]
+  s.files = ["CONTRIBUTING.md".freeze, "HISTORY.md".freeze, "LICENSE.txt".freeze, "Manifest.txt".freeze, "README.md".freeze, "exe/launchy".freeze, "launchy.gemspec".freeze, "lib/launchy.rb".freeze, "lib/launchy/application.rb".freeze, "lib/launchy/applications/browser.rb".freeze, "lib/launchy/argv.rb".freeze, "lib/launchy/cli.rb".freeze, "lib/launchy/descendant_tracker.rb".freeze, "lib/launchy/detect.rb".freeze, "lib/launchy/detect/host_os.rb".freeze, "lib/launchy/detect/host_os_family.rb".freeze, "lib/launchy/detect/nix_desktop_environment.rb".freeze, "lib/launchy/error.rb".freeze, "lib/launchy/os_family.rb".freeze, "lib/launchy/runner.rb".freeze, "lib/launchy/version.rb".freeze]
+  s.homepage = "https://github.com/copiousfreetime/launchy".freeze
+  s.licenses = ["ISC".freeze]
+  s.rdoc_options = ["--main".freeze, "README.md".freeze, "--markup".freeze, "tomdoc".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
+  s.rubygems_version = "3.6.3".freeze
+  s.summary = "Launchy is helper class for launching cross-platform applications in a fire and forget manner.".freeze
+
+  s.specification_version = 4
+
+  s.add_runtime_dependency(%q<addressable>.freeze, ["~> 2.8".freeze])
+  s.add_runtime_dependency(%q<childprocess>.freeze, ["~> 5.0".freeze])
+  s.add_runtime_dependency(%q<logger>.freeze, ["~> 1.6".freeze])
+end

data/lib/launchy/application.rb

@@ -1,4 +1,6 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 module Launchy
   #
   # Application is the base class of all the application types that launchy may
@@ -18,45 +20,61 @@ module Launchy
       # Find the application that handles the given uri.
       #
       # returns the Class that can handle the uri
-      def handling( uri )
-        klass = find_child( :handles?, uri )
+      def handling(uri)
+        klass = find_child(:handles?, uri)
         return klass if klass
+
         raise ApplicationNotFoundError, "No application found to handle '#{uri}'"
       end
 
+      # Find the application with the given name
       #
+      # returns the Class that has the given name
+      def for_name(name)
+        klass = find_child(:has_name?, name)
+        return klass if klass
+
+        raise ApplicationNotFoundError, "No application found named '#{name}'"
+      end
+
       # Find the given executable in the available paths
-      def find_executable( bin, *paths )
-        paths = Launchy.path.split( File::PATH_SEPARATOR ) if paths.empty?
+      #
+      # returns the path to the executable or nil if not found
+      def find_executable(bin, *paths)
+        paths = Launchy.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}"
+          file = File.join(path, bin)
+          if File.executable?(file)
+            Launchy.log "#{name} : found executable #{file}"
             return file
           end
         end
-        Launchy.log "#{self.name} : Unable to find `#{bin}' in #{paths.join(", ")}"
-        return nil
+        Launchy.log "#{name} : Unable to find `#{bin}' in #{paths.join(', ')}"
+        nil
+      end
+
+      # Does this class have the given name-like string?
+      #
+      # returns true if the class has the given name
+      def has_name?(qname)
+        qname.to_s.downcase == name.split("::").last.downcase
       end
     end
 
-    attr_reader :host_os_family
-    attr_reader :ruby_engine
-    attr_reader :runner
+    attr_reader :host_os_family, :runner
 
     def initialize
       @host_os_family = Launchy::Detect::HostOsFamily.detect
-      @ruby_engine    = Launchy::Detect::RubyEngine.detect
-      @runner         = Launchy::Detect::Runner.detect
+      @runner         = Launchy::Runner.new
     end
 
-    def find_executable( bin, *paths )
-      Application.find_executable( bin, *paths )
+    def find_executable(bin, *paths)
+      Application.find_executable(bin, *paths)
     end
 
-    def run( cmd, *args )
-      runner.run( cmd, *args )
+    def run(cmd, *args)
+      runner.run(cmd, *args)
     end
   end
 end
-require 'launchy/applications/browser'
+require "launchy/applications/browser"

data/lib/launchy/applications/browser.rb

@@ -1,82 +1,89 @@
-class Launchy::Application
-  #
-  # The class handling the browser application and all of its schemes
-  #
-  class Browser < Launchy::Application
-    def self.schemes
-      %w[ http https ftp file ]
-    end
+# frozen_string_literal: true
 
-    def self.handles?( uri )
-      return true if schemes.include?( uri.scheme )
-      return true if File.exist?( uri.path )
-    end
+module Launchy
+  class Application
+    #
+    # The class handling the browser application and all of its schemes
+    #
+    class Browser < Launchy::Application
+      def self.schemes
+        %w[http https ftp file]
+      end
 
-    def windows_app_list
-      [ 'start "launchy" /b' ]
-    end
+      def self.handles?(uri)
+        return true if schemes.include?(uri.scheme)
 
-    def cygwin_app_list
-      [ 'cmd /C start "launchy" /b' ]
-    end
+        true if File.exist?(uri.path)
+      end
 
-    # hardcode this to open?
-    def darwin_app_list
-      [ find_executable( "open" ) ]
-    end
+      # The escaped \\ is necessary so that when shellsplit is done later,
+      # the "launchy", with quotes, goes through to the commandline, since that
+      def windows_app_list
+        ['start \\"launchy\\" /b']
+      end
 
-    def nix_app_list
-      nix_de = Launchy::Detect::NixDesktopEnvironment.detect
-      list   = nix_de.browsers
-      list.find_all { |argv| argv.valid? }
-    end
+      def cygwin_app_list
+        ['cmd /C start \\"launchy\\" /b']
+      end
 
-    # use a call back mechanism to get the right app_list that is decided by the 
-    # host_os_family class.
-    def app_list
-      host_os_family.app_list( self )
-    end
+      # hardcode this to open?
+      def darwin_app_list
+        [find_executable("open")]
+      end
 
-    def browser_env
-      return [] unless ENV['BROWSER']
-      browser_env = ENV['BROWSER'].split( File::PATH_SEPARATOR )
-      browser_env.flatten!
-      browser_env.delete_if { |b| b.nil? || (b.strip.size == 0) }
-      return browser_env
-    end
+      def nix_app_list
+        nix_de = Launchy::Detect::NixDesktopEnvironment.detect
+        list   = nix_de.browsers
+        list.find_all(&:valid?)
+      end
 
-    # Get the full commandline of what we are going to add the uri to
-    def browser_cmdline
-      browser_env.each do |p|
-        Launchy.log "#{self.class.name} : possibility from BROWSER environment variable : #{p}"
+      # use a call back mechanism to get the right app_list that is decided by the
+      # host_os_family class.
+      def app_list
+        host_os_family.app_list(self)
       end
-      app_list.each do |p|
-        Launchy.log "#{self.class.name} : possibility from app_list : #{p}"
+
+      def browser_env
+        return [] unless ENV["BROWSER"]
+
+        browser_env = ENV["BROWSER"].split(File::PATH_SEPARATOR)
+        browser_env.flatten!
+        browser_env.delete_if { |b| b.nil? || b.strip.empty? }
+        browser_env
       end
 
-      possibilities = (browser_env + app_list).flatten
+      # Get the full commandline of what we are going to add the uri to
+      def browser_cmdline
+        browser_env.each do |p|
+          Launchy.log "#{self.class.name} : possibility from BROWSER environment variable : #{p}"
+        end
+        app_list.each do |p|
+          Launchy.log "#{self.class.name} : possibility from app_list : #{p}"
+        end
+
+        possibilities = (browser_env + app_list).flatten
 
-      if browser = possibilities.shift then
-        Launchy.log "#{self.class.name} : Using browser value '#{browser}'"
-        return browser
+        if (browser = possibilities.shift)
+          Launchy.log "#{self.class.name} : Using browser value '#{browser}'"
+          return browser
+        end
+        raise Launchy::CommandNotFoundError,
+              "Unable to find a browser command. If this is unexpected, #{Launchy.bug_report_message}"
       end
-      raise Launchy::CommandNotFoundError, "Unable to find a browser command. If this is unexpected, #{Launchy.bug_report_message}"
-    end
 
-    def cmd_and_args( uri, options = {} )
-      cmd = browser_cmdline.to_s
-      args = [ uri.to_s ]
-      if cmd =~ /%s/ then
-        cmd.gsub!( /%s/, args.shift )
+      def cmd_and_args(uri, _options = {})
+        cmd = browser_cmdline.to_s
+        args = [uri.to_s]
+        cmd.gsub!("%s", args.shift) if cmd.include?("%s")
+        [cmd, args]
       end
-      [cmd, args]
-    end
 
-    # final assembly of the command and do %s substitution 
-    # http://www.catb.org/~esr/BROWSER/index.html
-    def open( uri, options = {} )
-      cmd, args = cmd_and_args( uri, options )
-      run( cmd, args )
+      # final assembly of the command and do %s substitution
+      # http://www.catb.org/~esr/BROWSER/index.html
+      def open(uri, options = {})
+        cmd, args = cmd_and_args(uri, options)
+        run(cmd, args)
+      end
     end
   end
 end

data/lib/launchy/argv.rb

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 module Launchy
+  # Internal: Ecapsulate the commandline argumens passed to Launchy
+  #
   class Argv
     attr_reader :argv
-    def initialize( *args )
+
+    def initialize(*args)
       @argv = args.flatten
     end
 
     def to_s
-      @argv.join(' ')
+      @argv.join(" ")
     end
 
     def to_str
@@ -18,18 +23,18 @@ module Launchy
     end
 
     def valid?
-      (not blank?) && executable?
+      !blank? && executable?
     end
 
     def blank?
-      @argv.empty? || (@argv.first.strip.size == 0)
+      @argv.empty? || @argv.first.strip.empty?
     end
 
     def executable?
-      ::Launchy::Application.find_executable( @argv.first )
+      ::Launchy::Application.find_executable(@argv.first)
     end
 
-    def ==( other )
+    def ==(other)
       @argv == other.argv
     end
   end

data/lib/launchy/cli.rb

@@ -1,9 +1,13 @@
-require 'optparse'
+# frozen_string_literal: true
+
+require "optparse"
 
 module Launchy
+  # Internal: Command line interface for Launchy
+  #
   class Cli
-
     attr_reader :options
+
     def initialize
       @options = {}
     end
@@ -15,75 +19,66 @@ module Launchy
         op.separator ""
         op.separator "Launch Options:"
 
-        op.on( "-a", "--application APPLICATION", 
-               "Explicitly specify the application class to use in the launch") do |app|
+        op.on("-a", "--application APPLICATION",
+              "Explicitly specify the application class to use in the launch") do |app|
           @options[:application] = app
         end
 
-        op.on( "-d", "--debug", 
-               "Force debug. Output lots of information.") do |d|
+        op.on("-d", "--debug",
+              "Force debug. Output lots of information.") do |_d|
           @options[:debug] = true
         end
 
-        op.on( "-e", "--engine RUBY_ENGINE",
-               "Force launchy to behave as if it was on a particular ruby engine.") do |e|
-          @options[:ruby_engine] = e
-        end
-
-        op.on( "-n", "--dry-run", "Don't launchy, print the command to be executed on stdout" ) do |x|
+        op.on("-n", "--dry-run", "Don't launchy, print the command to be executed on stdout") do |_x|
           @options[:dry_run] = true
         end
 
-        op.on( "-o", "--host-os HOST_OS", 
-               "Force launchy to behave as if it was on a particular host os.") do |os|
+        op.on("-o", "--host-os HOST_OS",
+              "Force launchy to behave as if it was on a particular host os.") do |os|
           @options[:host_os] = os
         end
 
-
         op.separator ""
         op.separator "Standard Options:"
 
-        op.on( "-h", "--help", "Print this message.") do |h|
+        op.on("-h", "--help", "Print this message.") do |_h|
           $stdout.puts op.to_s
           exit 0
         end
 
-        op.on( "-v", "--version", "Output the version of Launchy") do |v|
+        op.on("-v", "--version", "Output the version of Launchy") do |_v|
           $stdout.puts "Launchy version #{Launchy::VERSION}"
           exit 0
         end
-
       end
     end
 
-    def parse( argv, env )
-      parser.parse!( argv )
-      return true
-    rescue ::OptionParser::ParseError => pe
-      error_output( pe )
+    def parse(argv, _env)
+      parser.parse!(argv)
+      true
+    rescue ::OptionParser::ParseError => e
+      error_output(e)
     end
 
-    def good_run( argv, env )
-      if parse( argv, env ) then
-        Launchy.open( argv.shift, options ) { |e| error_output( e ) }
-        return true
-      else
-        return false
-      end
+    def good_run(argv, env)
+      return false unless parse(argv, env)
+
+      Launchy.open(argv.shift, options) { |e| error_output(e) }
+      true
     end
 
-    def error_output( error )
+    def error_output(error)
       $stderr.puts "ERROR: #{error}"
       Launchy.log "ERROR: #{error}"
       error.backtrace.each do |bt|
         Launchy.log bt
       end
       $stderr.puts "Try `#{parser.program_name} --help' for more information."
-      return false
+      false
     end
 
-    def run( argv = ARGV, env = ENV )
-      exit 1 unless good_run( argv, env )
+    def run(argv = ARGV, env = ENV)
+      exit 1 unless good_run(argv, env)
     end
   end
 end

data/lib/launchy/descendant_tracker.rb

@@ -1,4 +1,6 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 module Launchy
   #
@@ -9,7 +11,7 @@ module Launchy
   #   end
   #
   # or
-  #   
+  #
   #   class Foo
   #     class << self
   #       include DescendantTracker
@@ -20,29 +22,29 @@ module Launchy
   # them in a Set that is available via the 'children' method.
   #
   module DescendantTracker
-    def inherited( klass )
-      return unless klass.instance_of?( Class )
-      self.children << klass
+    def inherited(klass)
+      super
+      return unless klass.instance_of?(Class)
+
+      children << klass
     end
 
     #
     # The list of children that are registered
     #
     def children
-      unless defined? @children
-        @children = Array.new
-      end
-      return @children
+      @children = [] unless defined? @children
+      @children
     end
 
     #
     # Find one of the child classes by calling the given method
-    # and passing all the rest of the parameters to that method in 
+    # and passing all the rest of the parameters to that method in
     # each child
-    def find_child( method, *args )
+    def find_child(method, *args)
       children.find do |child|
         Launchy.log "Checking if class #{child} is the one for #{method}(#{args.join(', ')})}"
-        child.send( method, *args )
+        child.send(method, *args)
       end
     end
   end