launchy 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d637a77afa69826953a3226c55fc20334c6fa90e268912bcf9a208bc9b448e2
-  data.tar.gz: 2f5ff5e1401319e3a97655848f4f61b9bb33e786cd1b22b76aa20a7729e0b885
+  metadata.gz: 7001cb9d1f872b482b6356d68289a022fdc12d57a128b1efe264e598d794d2a8
+  data.tar.gz: 0a76868c2abfc6da776b6d62c2d5be2ef1e872a37ffc244207030653aa16da9d
 SHA512:
-  metadata.gz: bb02ca4bd30a8394ca2a6c8e86518eb4f403d5b56c574f7730d1581a19ca686c94a001c641a09620b799b620f9d8e6be54ad39c27bb980e67268d01f68d8eae1
-  data.tar.gz: ba3bc128ef33d39c87b50e187ca71e0f39a2382cdf3513122ec1a108b71a55d2e2a8e0f81f138a27b8c9b1f74b8df183fe0b626d9718236efb3cb6a653fd1e62
+  metadata.gz: 34bb32f9dcedf678f7d22ac4dbb3febfb565609738f4150efb0000ca4b1867bdadd12b76cb1441c49d25015cfa43a9a651aa5f2a5bd2929468bb63822f4bf741
+  data.tar.gz: 462cce3f0d4c1239e16a3667428d0e54aedb7b5d0bcad9762ae8c3e65020882c45da1614882893af16b6db2dcf467782abc62a503d3d8ed6818c288aba6fdaea

data/HISTORY.md

@@ -1,7 +1,14 @@
 # Launchy Changelog
+## 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 versin to be 3.x
+* 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)

data/Manifest.txt

@@ -1,10 +1,10 @@
 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
@@ -19,16 +19,3 @@ 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/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/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,32 @@
+# DO NOT EDIT - This file is automatically generated
+# Make changes to Manifest.txt and/or Rakefile and regenerate
+# -*- encoding: utf-8 -*-
+# stub: launchy 3.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "launchy".freeze
+  s.version = "3.0.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 = "2024-05-03"
+  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.5.9".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])
+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,60 +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 )
+      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
       #
       # 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?
+      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 == self.name.split("::").last.downcase
+      def has_name?(qname)
+        qname.to_s.downcase == name.split("::").last.downcase
       end
     end
 
-    attr_reader :host_os_family
-    attr_reader :runner
+    attr_reader :host_os_family, :runner
 
     def initialize
       @host_os_family = Launchy::Detect::HostOsFamily.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,87 @@
-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
+      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,70 +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( "-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

data/lib/launchy/detect/host_os.rb

@@ -1,32 +1,35 @@
-require 'rbconfig'
+# frozen_string_literal: true
 
-module Launchy::Detect
-  class HostOs
+require "rbconfig"
 
-    attr_reader :host_os
-    alias to_s host_os
-    alias to_str host_os
+module Launchy
+  module Detect
+    # Internal: Determine the host operating system that Launchy is running on
+    #
+    class HostOs
+      attr_reader :host_os
+      alias to_s host_os
+      alias to_str host_os
 
-    def initialize( host_os = nil )
-      @host_os = host_os
+      def initialize(host_os = nil)
+        @host_os = host_os
 
-      if not @host_os then
-        if @host_os = override_host_os then
+        return if @host_os
+
+        if (@host_os = override_host_os)
           Launchy.log "Using LAUNCHY_HOST_OS override value of '#{Launchy.host_os}'"
         else
           @host_os = default_host_os
         end
       end
-    end
 
-    def default_host_os
-      ::RbConfig::CONFIG['host_os'].downcase
-    end
+      def default_host_os
+        ::RbConfig::CONFIG["host_os"].downcase
+      end
 
-    def override_host_os
-      Launchy.host_os
+      def override_host_os
+        Launchy.host_os
+      end
     end
-
   end
-
 end