command_kit 0.1.0 → 0.3.0

data/lib/command_kit/options/parser.rb

@@ -78,9 +78,6 @@ module CommandKit
         @option_parser = OptionParser.new do |opts|
           opts.banner = "Usage: #{usage}"
 
-          opts.separator ''
-          opts.separator 'Options:'
-
           opts.on_tail('-h','--help','Print help information') do
             help
             exit(0)
@@ -118,23 +115,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
 
       #
@@ -146,8 +141,8 @@ module CommandKit
       # @api semipublic
       #
       def on_parse_error(error)
-        print_error("#{command_name}: #{error.message}")
-        print_error("Try '#{command_name} --help' for more information.")
+        print_error(error.message)
+        stderr.puts("Try '#{command_name} --help' for more information.")
         exit(1)
       end
 

data/lib/command_kit/options.rb

@@ -1,3 +1,4 @@
+require 'command_kit/arguments'
 require 'command_kit/options/option'
 require 'command_kit/options/parser'
 
@@ -22,7 +23,26 @@ module CommandKit
   #       @bar = arg.split(':')
   #     end
   #
-  # ### initialize and using ivars
+  # ### Multi-line Descriptions
+  #
+  #     option :opt, value: {type: String},
+  #                  desc: [
+  #                          'line1',
+  #                          'line2',
+  #                          '...'
+  #                        ]
+  #
+  # ### Option Categories
+  #
+  #     option :opt1, value: {type: String},
+  #                   category: 'Foo Category',
+  #                   desc: 'Option 1'
+  #
+  #     option :opt2, value: {type: String},
+  #                   category: 'Foo Category',
+  #                   desc: 'Option 2'
+  #
+  # ### initialize and using instance variables
   #     
   #     option :number, value: {type: Integer},
   #                     desc: 'Numbers' do |num|
@@ -36,6 +56,7 @@ module CommandKit
   #     end
   #
   module Options
+    include Arguments
     include Parser
 
     #
@@ -109,9 +130,12 @@ module CommandKit
       # @option value [String, nil] usage
       #   The usage string for the option's value.
       #
-      # @option kwargs [String] desc
+      # @option kwargs [String, Array<String>] desc
       #   The description for the option.
       #
+      # @option kwargs [String, nil] category
+      #   The optional category to group the option under.
+      #
       # @yield [(value)]
       #   If a block is given, it will be passed the parsed option value.
       #
@@ -127,6 +151,19 @@ module CommandKit
       # @example Define an option:
       #     option :foo, desc: "Foo option"
       #
+      # @example Define an option with a multi-line description:
+      #     option :foo, desc: [
+      #                          "Line 1",
+      #                          "Line 2"
+      #                        ]
+      #
+      # @example Defines multiple options within a category:
+      #     option :foo, desc: "Foo option",
+      #                  category: 'Other Options'
+      #     
+      #     option :bar, desc: "Bar option",
+      #                  category: 'Other Options'
+      #
       # @example With a custom short option:
       #     option :foo, short: '-f',
       #                  desc: "Foo option"
@@ -197,7 +234,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
@@ -210,17 +247,68 @@ module CommandKit
 
       super(**kwargs)
 
-      self.class.options.each_value do |option|
-        option_parser.on(*option.usage,option.type,option.desc) do |arg,*captures|
-          @options[option.name] = if arg.nil?
-                                    option.default_value
-                                  else
-                                    arg
-                                  end
-
-          if option.block
-            instance_exec(*arg,*captures,&option.block)
-          end
+      define_option_categories
+    end
+
+    #
+    # Overrides the default {Usage#help help} method and calls {#help_options}
+    # and {#help_arguments}.
+    #
+    # @api public
+    #
+    def help
+      help_options
+      help_arguments
+    end
+
+    private
+
+    #
+    # Defines all of the options, grouped by category.
+    #
+    def define_option_categories
+      categories = self.class.options.values.group_by(&:category)
+
+      categories.each do |category,options|
+        if category
+          define_options_category(category,options)
+        end
+      end
+
+      define_options_category('Options',categories.fetch(nil,[]))
+    end
+
+    #
+    # Defines a new category of options with a header.
+    #
+    # @param [String] category
+    #   The category name.
+    #
+    # @param [Array<Option>, nil] options
+    #   The options to define.
+    #
+    def define_options_category(category,options)
+      option_parser.separator ''
+      option_parser.separator "#{category}:"
+
+      options.each(&method(:define_option))
+    end
+
+    #
+    # Defines an individual option.
+    #
+    # @param [Option] option
+    #
+    def define_option(option)
+      default_value = option.default_value
+
+      @options[option.name] = default_value unless default_value.nil?
+
+      option_parser.on(*option.usage,option.type,option.desc) do |arg,*captures|
+        @options[option.name] = arg
+
+        if option.block
+          instance_exec(*arg,*captures,&option.block)
         end
       end
     end

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

data/lib/command_kit/os.rb

@@ -4,19 +4,102 @@ module CommandKit
   #
   # ## Examples
   #
-  #     include CommandKit::OS
+  #     require 'command_kit/command'
+  #     require 'command_kit/os'
   #     
-  #     def main(*argv)
-  #       if linux?
-  #         # ...
-  #       elsif macos?
-  #         # ...
-  #       elsif windows?
-  #         # ...
+  #     class Command < CommandKit::Command
+  #     
+  #       include CommandKit::OS
+  #     
+  #       def main(*argv)
+  #         if linux?
+  #           # ...
+  #         elsif macos?
+  #           # ...
+  #         elsif freebsd?
+  #           # ...
+  #         elsif windows?
+  #           # ...
+  #         end
   #       end
+  #     
   #     end
   #
   module OS
+    #
+    # @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 current OS.
+      #
+      # @return [:linux, :macos, :freebsd, :openbsd, :netbsd, :windows, nil]
+      #   The OS type or `nil` if the OS could not be determined.
+      #
+      # @api semipublic
+      #
+      # @since 0.2.0
+      #
+      def os
+        if    RUBY_PLATFORM.include?('linux')   then :linux
+        elsif RUBY_PLATFORM.include?('darwin')  then :macos
+        elsif RUBY_PLATFORM.include?('freebsd') then :freebsd
+        elsif RUBY_PLATFORM.include?('openbsd') then :openbsd
+        elsif RUBY_PLATFORM.include?('netbsd')  then :netbsd
+        elsif Gem.win_platform?                 then :windows
+        end
+      end
+    end
+
+    # The current OS.
+    #
+    # @return [:linux, :macos, :freebsd, :openbsd, :netbsd, :windows, nil]
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    attr_reader :os
+
+    #
+    # Initializes the command.
+    #
+    # @param [:linux, :macos, :freebsd, :openbsd, :netbsd, :windows, nil] os
+    #   Overrides the default OS.
+    #   
+    # @param [Hash{Symbol => Object}] kwargs
+    #   Additional keyword arguments.
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    #
+    def initialize(os: self.class.os, **kwargs)
+      super(**kwargs)
+
+      @os = os
+    end
+
     #
     # Determines if the current OS is Linux.
     #
@@ -25,7 +108,7 @@ module CommandKit
     # @api public
     #
     def linux?
-      RUBY_PLATFORM.include?('linux')
+      @os == :linux
     end
 
     #
@@ -36,7 +119,72 @@ module CommandKit
     # @api public
     #
     def macos?
-      RUBY_PLATFORM.include?('darwin')
+      @os == :macos
+    end
+
+    #
+    # Determines if the current OS is FreeBSD.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    #
+    def freebsd?
+      @os == :freebsd
+    end
+
+    #
+    # Determines if the current OS is OpenBSD.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    #
+    def openbsd?
+      @os == :openbsd
+    end
+
+    #
+    # Determines if the current OS is NetBSD.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    #
+    # @since 0.2.0
+    #
+    def netbsd?
+      @os == :netbsd
+    end
+
+    #
+    # Determines if the current OS is BSD based.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    #
+    # @api public
+    #
+    def bsd?
+      freebsd? || openbsd? || netbsd?
+    end
+
+    #
+    # Determines if the current OS is UNIX based.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    #
+    # @api public
+    #
+    def unix?
+      linux? || macos? || bsd?
     end
 
     #
@@ -47,7 +195,7 @@ module CommandKit
     # @api public
     #
     def windows?
-      Gem.win_platform?
+      @os == :windows
     end
   end
 end