command_kit 0.1.0.pre1 → 0.2.0

data/lib/command_kit/options/quiet.rb

@@ -18,6 +18,9 @@ module CommandKit
     module Quiet
       include Options
 
+      #
+      # @api private
+      #
       module ModuleMethods
         #
         # Defines a `-q, --quiet` option.

data/lib/command_kit/options/verbose.rb

@@ -18,6 +18,9 @@ module CommandKit
     module Verbose
       include Options
 
+      #
+      # @api private
+      #
       module ModuleMethods
         #
         # Defines a `-v, --verbose` option or extends {ModuleMethods}, depending
@@ -47,6 +50,8 @@ module CommandKit
       #
       # @return [Boolean]
       #
+      # @api public
+      #
       def verbose?
         @verbose
       end

data/lib/command_kit/options/version.rb

@@ -35,6 +35,8 @@ module CommandKit
         # @return [String, nil]
         #   The classes version string.
         #
+        # @api public
+        #
         def version(new_version=nil)
           if new_version
             @version = new_version
@@ -47,6 +49,8 @@ module CommandKit
       #
       # @see ClassMethods#version
       #
+      # @api public
+      #
       def version
         self.class.version
       end
@@ -54,6 +58,8 @@ module CommandKit
       #
       # Prints the version.
       #
+      # @api public
+      #
       def print_version
         puts "#{command_name} #{version}"
       end

data/lib/command_kit/options.rb

@@ -9,24 +9,28 @@ module CommandKit
   #
   #     include CommandKit::Options
   #     
-  #     option :foo, type: String,
-  #                  short: '-f',
-  #                  desc: "Foo option"
+  #     option :foo, short: '-f',
+  #                  value: {type: String},
+  #                  desc:  "Foo option"
   #     
-  #     option :bar, type: String,
-  #                  short: '-b',
-  #                  usage: 'STR:STR:...',
+  #     option :bar, short: '-b',
+  #                  value: {
+  #                    type:  String,
+  #                    usage: 'STR:STR:...'
+  #                  },
   #                  desc: "Bar option" do |arg|
   #       @bar = arg.split(':')
   #     end
+  #
+  # ### initialize and using instance variables
   #     
-  #     option :number, type: Integer,
+  #     option :number, value: {type: Integer},
   #                     desc: 'Numbers' do |num|
   #       @numbers << num
   #     end
   #     
-  #     def initialize
-  #       super
+  #     def initialize(**kwargs)
+  #       super(**kwargs)
   #     
   #       @numbers = []
   #     end
@@ -34,6 +38,9 @@ module CommandKit
   module Options
     include Parser
 
+    #
+    # @api private
+    #
     module ModuleMethods
       #
       # Extends {ClassMethods} or {ModuleMethods}, depending on whether
@@ -64,6 +71,8 @@ module CommandKit
       #
       # @return [Hash{Symbol => Option}]
       #
+      # @api semipublic
+      #
       def options
         @options ||= if superclass.kind_of?(ClassMethods)
                        superclass.options.dup
@@ -78,6 +87,31 @@ module CommandKit
       # @param [Symbol] name
       #   The option name.
       #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Keyword arguments.
+      #
+      # @option kwargs [String, nil] short
+      #   Optional short-flag for the option.
+      #
+      # @option kwargs [String, nil] long
+      #   Optional explicit long-flag for the option.
+      #
+      # @option kwargs [Boolean] equals
+      #   Specifies whether the option is of the form (`--opt=value`).
+      #
+      # @option kwargs [Hash{Symbol => Object}, true, false, nil] value
+      #   Keyword arguments for {OptionValue#initialize}, or `nil` if the option
+      #   has no additional value.
+      #
+      # @option value [Class, Hash, Array, Regexp] type
+      #   The type of the option's value.
+      #
+      # @option value [String, nil] usage
+      #   The usage string for the option's value.
+      #
+      # @option kwargs [String] desc
+      #   The description for the option.
+      #
       # @yield [(value)]
       #   If a block is given, it will be passed the parsed option value.
       #
@@ -86,6 +120,10 @@ module CommandKit
       #
       # @return [Option]
       #
+      # @raise [TypeError]
+      #   The `value` keyword argument was not a `Hash`, `true`, `false`, or
+      #   `nil`.
+      #
       # @example Define an option:
       #     option :foo, desc: "Foo option"
       #
@@ -139,6 +177,8 @@ module CommandKit
       #       # ...
       #     end
       #
+      # @api public
+      #
       def option(name,**kwargs,&block)
         options[name] = Option.new(name,**kwargs,&block)
       end
@@ -147,6 +187,9 @@ module CommandKit
     # Hash of parsed option values.
     #
     # @return [Hash{Symbol => Object}]
+    #
+    # @api semipublic
+    #
     attr_reader :options
 
     #
@@ -154,7 +197,13 @@ 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
+    #   {ClassMethods#option option} blocks with the parsed option values.
+    #
+    # @api public
     #
     def initialize(options: {}, **kwargs)
       @options = options

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,26 +4,111 @@ 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.
     #
     # @return [Boolean]
     #
+    # @api public
+    #
     def linux?
-      RUBY_PLATFORM.include?('linux')
+      @os == :linux
     end
 
     #
@@ -31,8 +116,75 @@ module CommandKit
     #
     # @return [Boolean]
     #
+    # @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
 
     #
@@ -40,8 +192,10 @@ module CommandKit
     #
     # @return [Boolean]
     #
+    # @api public
+    #
     def windows?
-      Gem.win_platform?
+      @os == :windows
     end
   end
 end