Contents

require 'command_kit/options'

module CommandKit
  module Options
    #
    # Defines a `-q`,`--quiet` option.
    #
    # ## Examples
    #
    #     include CommandKit::Options::Quiet
    #     
    #     def main(*argv)
    #       # ...
    #       puts "verbose output" unless quiet?
    #       # ...
    #     end
    #
    module Quiet
      include Options

      #
      # @api private
      #
      module ModuleMethods
        #
        # Defines a `-q, --quiet` option.
        #
        # @param [Class, Module] context
        #   The class or module including {Quiet}.
        #
        def included(context)
          super(context)

          if context.class == Module
            context.extend ModuleMethods
          else
            context.option :quiet, short: '-q', desc: 'Enables quiet output' do
              @quiet = true
            end
          end
        end
      end

      extend ModuleMethods

      #
      # Determines if quiet mode is enabled.
      #
      # @return [Boolean]
      #
      def quiet?
        @quiet
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
command_kit-0.3.0	lib/command_kit/options/quiet.rb
command_kit-0.2.2	lib/command_kit/options/quiet.rb
command_kit-0.2.1	lib/command_kit/options/quiet.rb
command_kit-0.2.0	lib/command_kit/options/quiet.rb
command_kit-0.1.0	lib/command_kit/options/quiet.rb