command_kit 0.1.0 → 0.2.0

data/lib/command_kit/inflector.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'strscan'
+
 module CommandKit
   #
   # A very simple inflector.
@@ -33,16 +35,37 @@ module CommandKit
     # @return [String]
     #   The resulting under_scored name.
     #
+    # @raise [ArgumentError]
+    #   The given string contained non-alpha-numeric characters.
+    #
     def self.underscore(name)
-      # sourced from: https://github.com/dry-rb/dry-inflector/blob/c918f967ff82611da374eb0847a77b7e012d3fa8/lib/dry/inflector.rb#L286-L287
-      name = name.to_s.dup
+      scanner    = StringScanner.new(name.to_s)
+      new_string = String.new
+
+      until scanner.eos?
+        if (separator = scanner.scan(/[_-]+/))
+          new_string << '_' * separator.length
+        else
+          if (capitalized = scanner.scan(/[A-Z][a-z\d]+/))
+            new_string << capitalized
+          elsif (uppercase = scanner.scan(/[A-Z][A-Z\d]*(?=[A-Z_-]|$)/))
+            new_string << uppercase
+          elsif (lowercase = scanner.scan(/[a-z][a-z\d]*/))
+            new_string << lowercase
+          else
+            raise(ArgumentError,"cannot convert string to underscored: #{scanner.string.inspect}")
+          end
 
-      name.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
-      name.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      name.tr!('-','_')
-      name.downcase!
+          if (separator = scanner.scan(/[_-]+/))
+            new_string << '_' * separator.length
+          elsif !scanner.eos?
+            new_string << '_'
+          end
+        end
+      end
 
-      name
+      new_string.downcase!
+      new_string
     end
 
     #
@@ -67,20 +90,27 @@ module CommandKit
     # @return [String]
     #   The CamelCased name.
     #
+    # @raise [ArgumentError]
+    #   The given under_scored string contained non-alpha-numeric characters.
+    #
     def self.camelize(name)
-      name = name.to_s.dup
-
-      # sourced from: https://github.com/dry-rb/dry-inflector/blob/c918f967ff82611da374eb0847a77b7e012d3fa8/lib/dry/inflector.rb#L329-L334
-      name.sub!(/^[a-z\d]*/,&:capitalize)
-      name.gsub!(%r{(?:[_-]|(/))([a-z\d]*)}i) do |match|
-        slash = Regexp.last_match(1)
-        word  = Regexp.last_match(2)
+      scanner    = StringScanner.new(name.to_s)
+      new_string = String.new
 
-        "#{slash}#{word.capitalize}"
+      until scanner.eos?
+        if (word = scanner.scan(/[A-Za-z\d]+/))
+          word.capitalize!
+          new_string << word
+        elsif scanner.scan(/[_-]+/)
+          # skip
+        elsif scanner.scan(/\//)
+          new_string << '::'
+        else
+          raise(ArgumentError,"cannot convert string to CamelCase: #{scanner.string.inspect}")
+        end
       end
 
-      name.gsub!('/','::')
-      name
+      new_string
     end
   end
 end

data/lib/command_kit/main.rb

@@ -49,15 +49,13 @@ module CommandKit
       # @api public
       #
       def start(argv=ARGV, **kwargs)
-        begin
-          exit main(argv, **kwargs)
-        rescue Interrupt
-          # https://tldp.org/LDP/abs/html/exitcodes.html
-          exit 130
-        rescue Errno::EPIPE
-          # STDOUT pipe broken
-          exit 0
-        end
+        exit main(argv, **kwargs)
+      rescue Interrupt
+        # https://tldp.org/LDP/abs/html/exitcodes.html
+        exit 130
+      rescue Errno::EPIPE
+        # STDOUT pipe broken
+        exit 0
       end
 
       #

data/lib/command_kit/man.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module CommandKit
+  #
+  # Allows displaying man pages.
+  #
+  # ## Examples
+  #
+  #     man "passwd"
+  #     man "passwd", section: 5
+  #
+  # @since 0.2.0
+  #
+  module Man
+    #
+    # Displays the given man page.
+    #
+    # @param [String] page
+    #   The man page file name.
+    #
+    # @param [Integer, String, nil] section
+    #   The optional section number to specify.
+    #
+    # @return [Boolean, nil]
+    #   Specifies whether the `man` command was successful or not.
+    #   Returns `nil` when the `man` command is not installed.
+    #
+    # @example
+    #   man "passwd"
+    #
+    # @example Display a man-page from a specific section:
+    #   man "passwd", section: 5
+    #
+    # @api public
+    #
+    def man(page, section: nil)
+      if section
+        system('man',section.to_s,page.to_s)
+      else
+        system('man',page.to_s)
+      end
+    end
+  end
+end

data/lib/command_kit/open_app.rb

@@ -0,0 +1,69 @@
+require 'command_kit/os'
+require 'command_kit/env/path'
+
+module CommandKit
+  #
+  # Allows opening a file or a URI with the system's preferred application for
+  # that file type or URI scheme.
+  #
+  # ## Examples
+  #
+  #     open_app_for "movie.avi"
+  #     open_app_for "https://github.com/postmodern/command_kit.rb"
+  #
+  # @since 0.2.0
+  #
+  module OpenApp
+    include OS
+    include Env::Path
+
+    #
+    # Initializes the command and determines which open command to use.
+    #
+    # @param [Hash{Symbol => Object}] kwargs
+    #   Additional keyword arguments.
+    #
+    # @api public
+    #
+    def initialize(**kwargs)
+      super(**kwargs)
+
+      @open_command = if macos?
+                        'open'
+                      elsif linux? || bsd?
+                        if command_installed?('xdg-open')
+                          'xdg-open'
+                        end
+                      elsif windows?
+                        if command_installed?('invoke-item')
+                          'invoke-item'
+                        else
+                          'start'
+                        end
+                      end
+    end
+
+    #
+    # Opens a file or URI using the system's preferred application for that
+    # file type or URI scheme.
+    #
+    # @param [String, URI] file_or_uri
+    #   The file path or URI to open.
+    #
+    # @return [Boolean, nil]
+    #   Specifies whether the file or URI was successfully opened or not.
+    #   If the open command could not be determined, `nil` is returned.
+    #
+    # @example Open a file:
+    #   open_app_for "movie.avi"
+    #
+    # @example Open a URI:
+    #   open_app_for "https://github.com/postmodern/command_kit.rb"
+    #
+    def open_app_for(file_or_uri)
+      if @open_command
+        system(@open_command,file_or_uri.to_s)
+      end
+    end
+  end
+end

data/lib/command_kit/options/option.rb

@@ -35,11 +35,6 @@ module CommandKit
       # @return [OptionValue, nil]
       attr_reader :value
 
-      # The option's description.
-      #
-      # @return [String]
-      attr_reader :desc
-
       # The optional block that will receive the parsed option value.
       #
       # @return [Proc, nil]
@@ -128,7 +123,7 @@ module CommandKit
       end
 
       #
-      # The separator characer between the option and option value.
+      # The separator character between the option and option value.
       #
       # @return ['=', ' ', nil]
       #

data/lib/command_kit/options/parser.rb

@@ -118,23 +118,21 @@ module CommandKit
       # @api semipublic
       #
       def parse_options(argv)
-        begin
-          option_parser.parse(argv)
-        rescue OptionParser::InvalidOption => error
-          on_invalid_option(error)
-        rescue OptionParser::AmbiguousOption => error
-          on_ambiguous_option(error)
-        rescue OptionParser::InvalidArgument => error
-          on_invalid_argument(error)
-        rescue OptionParser::MissingArgument => error
-          on_missing_argument(error)
-        rescue OptionParser::NeedlessArgument => error
-          on_needless_argument(error)
-        rescue OptionParser::AmbiguousArgument => error
-          on_ambiguous_argument(error)
-        rescue OptionParser::ParseError => error
-          on_parse_error(error)
-        end
+        option_parser.parse(argv)
+      rescue OptionParser::InvalidOption => error
+        on_invalid_option(error)
+      rescue OptionParser::AmbiguousOption => error
+        on_ambiguous_option(error)
+      rescue OptionParser::InvalidArgument => error
+        on_invalid_argument(error)
+      rescue OptionParser::MissingArgument => error
+        on_missing_argument(error)
+      rescue OptionParser::NeedlessArgument => error
+        on_needless_argument(error)
+      rescue OptionParser::AmbiguousArgument => error
+        on_ambiguous_argument(error)
+      rescue OptionParser::ParseError => error
+        on_parse_error(error)
       end
 
       #

data/lib/command_kit/options.rb

@@ -22,7 +22,7 @@ module CommandKit
   #       @bar = arg.split(':')
   #     end
   #
-  # ### initialize and using ivars
+  # ### initialize and using instance variables
   #     
   #     option :number, value: {type: Integer},
   #                     desc: 'Numbers' do |num|
@@ -197,7 +197,7 @@ module CommandKit
     # {Parser#option_parser option parser}.
     #
     # @param [Hash{Symbol => Object}] options
-    #   Optional pre-populated options hash.
+    #   Optional prepopulated options hash.
     #
     # @note
     #   The {#option_parser} will populate {#options} and also call any

data/lib/command_kit/os/linux.rb

@@ -0,0 +1,157 @@
+require 'command_kit/os'
+
+module CommandKit
+  module OS
+    #
+    # Provides methods for determining the specific type of Linux.
+    #
+    # ## Example
+    #
+    #     require 'command_kit/command'
+    #     require 'command_kit/os/linux'
+    #     
+    #     class Command < CommandKit::Command
+    #     
+    #       include CommandKit::OS::Linux
+    #     
+    #       def run
+    #         if debian_linux?
+    #           # ...
+    #         elsif redhat_linux?
+    #           # ...
+    #         elsif suse_linux?
+    #           # ...
+    #         elsif arch_linux?
+    #           # ...
+    #         end
+    #       end
+    #     end
+    #
+    # @since 0.2.0
+    #
+    module Linux
+      #
+      # @api private
+      #
+      module ModuleMethods
+        #
+        # Extends {ClassMethods} or {ModuleMethods}, depending on whether
+        # {OS} is being included into a class or a module..
+        #
+        # @param [Class, Module] context
+        #   The class or module which is including {OS}.
+        #
+        def included(context)
+          super(context)
+
+          if context.class == Module
+            context.extend ModuleMethods
+          else
+            context.extend ClassMethods
+          end
+        end
+      end
+
+      extend ModuleMethods
+
+      module ClassMethods
+        #
+        # Determines the specific Linux distro.
+        #
+        # @return [:fedora, :redhat, :debian, :suse, :arch, nil]
+        #   Returns the type of Linux distro or `nil` if the Linux distro could
+        #   not be determined.
+        #
+        # @api semipublic
+        #
+        def linux_distro
+          if    File.file?('/etc/fedora-release') then :fedora
+          elsif File.file?('/etc/redhat-release') then :redhat
+          elsif File.file?('/etc/debian_version') then :debian
+          elsif File.file?('/etc/SuSE-release')   then :suse
+          elsif File.file?('/etc/arch-release')   then :arch
+          end
+        end
+      end
+
+      # The Linux distro.
+      #
+      # @return [:fedora, :redhat, :debian, :suse, :arch, nil]
+      #
+      # @api public
+      attr_reader :linux_distro
+
+      #
+      # Initializes the command.
+      #
+      # @param [:fedora, :redhat, :debian, :suse, :arch, nil] linux_distro
+      #   Overrides the default detected Linux distro.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      # @api public
+      #
+      def initialize(linux_distro: self.class.linux_distro, **kwargs)
+        super(**kwargs)
+
+        @linux_distro = linux_distro
+      end
+
+      #
+      # Determines if the current OS is RedHat Linux based distro.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      #
+      def redhat_linux?
+        @linux_distro == :redhat
+      end
+
+      #
+      # Determines if the current OS is Fedora Linux based distro.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      #
+      def fedora_linux?
+        @linux_distro == :fedora
+      end
+
+      #
+      # Determines if the current OS is Debian Linux based distro.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      #
+      def debian_linux?
+        @linux_distro == :debian
+      end
+
+      #
+      # Determines if the current OS is SUSE Linux based distro.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      #
+      def suse_linux?
+        @linux_distro == :suse
+      end
+
+      #
+      # Determines if the current OS is Arch Linux based distro.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      #
+      def arch_linux?
+        @linux_distro == :arch
+      end
+    end
+  end
+end