pyer-options 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0bd1e1b3c7c4e854b8f1060c4ae6ce23a2a831
-  data.tar.gz: 27a2dde14744f669bb0cc8e26dc7abbe9805fd4d
+  metadata.gz: e93a13c4796ad6001e9df121e775e0a699173c0c
+  data.tar.gz: 1f6a3a8d2993c450e690689028623941d5957bb2
 SHA512:
-  metadata.gz: 94bc9a131d424a43577bc08aa08fb140df8101ec93c54604d0e7fddcf2af5130d4de0bbf8c530a11ed2561a24161f2793b8c83897fdfb9dce9e9bc765add383d
-  data.tar.gz: 081cfb6ba5bf3f5279f0e08787b7acc83d73ebd80e2a66062573754c0c92870086da7c4bbb1ee4495d745b3b9a87daa987452c52175d7dce02db46286b01b7aa
+  metadata.gz: 1a0eea84d1d081e24dabf025d409a0c1942e7f836085b4e942555ce3d5c491af85d041ab6f537336d357080fada4b09172bf5aed6d591413b160d80cc2fc58ac
+  data.tar.gz: 94abaf3ae34cd81f45ee94996f4c0e884ce81325b7fb3a90b0f465ffceae6b47ca1930be582e61d541e9c7ae7fcd0b6ae819f503039cf98632804ccdb5414b7d

data/lib/pyer/options.rb

@@ -1,30 +1,28 @@
+# encoding: UTF-8
 module Pyer
-  class Options
-    include Enumerable
-
-    # Raised when the command starts whith '-', or is not given
-    class InvalidCommandError < StandardError
-    end
+  # Raised when the command starts whith '-', or is not given
+  class InvalidCommandError < StandardError
+  end
 
-    # Raised when the command is not defined
-    class UnknownCommandError < StandardError
-    end
+  # Raised when the command is not defined
+  class UnknownCommandError < StandardError
+  end
 
-    # Raised when an invalid option is found.
-    class InvalidOptionError < StandardError
-    end
+  # Raised when an invalid option is found.
+  class InvalidOptionError < StandardError
+  end
 
-    # Raised when an unknown option is found.
-    class UnknownOptionError < StandardError
-    end
+  # Raised when an unknown option is found.
+  class UnknownOptionError < StandardError
+  end
 
-    # Raised when an option argument is expected but none are given.
-    class MissingArgumentError < StandardError
-    end
+  # Raised when an option argument is expected but none are given.
+  class MissingArgumentError < StandardError
+  end
 
-    # Raised when an option argument starts whith '-'
-    class InvalidArgumentError < StandardError
-    end
+  # Options class
+  class Options
+    include Enumerable
 
     # items  - The Array of items to extract options from (default: ARGV).
     # block  - An optional block used to add options.
@@ -39,32 +37,23 @@ module Pyer
     # short option is the first letter of long option
     # Returns a new instance of Options.
     def self.parse(items = ARGV, &block)
-      new( &block ).parse items
+      new(&block).parse items
     end
 
-    # The Array of Options::Command objects tied to this Options instance.
     attr_reader :commands
-
-    # The Array of Options::Option objects tied to this Options instance.
     attr_reader :options
 
     # Create a new instance of Options and optionally build options via a block.
     #
     # block  - An optional block used to specify options.
     def initialize(&block)
-      @banner = ""
-      @runner = nil
+      @banner = ''
       @commands = []
-      @command_name = nil
-      @command_callback = nil
-      @options  = []
+      @triggered_command = nil
+      @options = []
       @triggered_options = []
       @longest_cmd = 0
-      @longest_flag = 0
-
-  #    if block_given?
-  #      block.arity == 1 ? yield(self) : instance_eval(&block)
-  #    end
+      @longest_opt = 0
       instance_eval(&block) if block_given?
     end
 
@@ -74,91 +63,94 @@ module Pyer
     # block - An optional block which when used will yield non options.
     #
     # Returns an Array of original items with options removed.
-    def parse(items = ARGV, &block)
-      item=items.shift
+    def parse(items = ARGV)
+      item = items.shift
       # need some help ?
-      if item == '?' || item == '-h' || item == '--help' || item == 'help' || item.nil?
-        puts self.help
-        exit
-      end
+      show_help if item == '?' || item == '-h' || item == '--help' || item == 'help' || item.nil?
       # parsing command
-      if !@commands.empty?
-        cmd = commands.find { |cmd| cmd.name == item }
-        raise UnknownCommandError if cmd.nil?
-        @command_name = cmd.name
-        @command_call = cmd.callback
-        item=items.shift
+      unless commands.empty?
+        parse_command(item)
+        item = items.shift
       end
       # parsing options
       until item.nil?
-        #break if item == '--'
-        if item.match(/^--[^-]+$/).nil? && item.match(/^-[^-]$/).nil?
-          raise InvalidOptionError, "invalid #{item} option"
-        end
-        key = item.sub(/\A--?/, '')
-        option = options.find { |opt| opt.name == key || opt.short == key }
-        if option
-          @triggered_options << option
-          if option.expects_argument?
-            option.value = items.shift
-            raise MissingArgumentError, "missing #{item} argument" if option.value.nil?
-            raise InvalidArgumentError, "(#{item}=#{option.value}) argument can't start with '-'" if option.value.start_with?('-')
-          else
-            option.value = true
-          end
+        option = parse_option(item)
+        if option.expects_argument
+          option.value = items.shift
+          fail MissingArgumentError, "missing #{item} argument" if option.value.nil? || option.value.start_with?('-')
         else
-          raise UnknownOptionError, "unknown #{item} option"
+          option.value = true
         end
-        item=items.shift
-      end
-      if @runner.respond_to?(:call)
-        @runner.call(self, items)
+        item = items.shift
       end
       # return the Options instance
       self
     end
 
-    # Print a handy Options help string.
-    #
-    # Returns the banner followed by available option help strings.
-    def help
-      if @commands.empty?
-        helpstr = "Usage: #{File.basename($0)} [options]\n"
-      else
-        helpstr = "Usage: #{File.basename($0)} command [options]\n"
+    def parse_command(command)
+      cmd = commands.find { |c| c.name == command }
+      fail UnknownCommandError if cmd.nil?
+      @triggered_command = cmd
+    end
+
+    def parse_option(option)
+      if option.match(/^--[^-]+$/).nil? && option.match(/^-[^-]$/).nil?
+        fail InvalidOptionError, "invalid #{option} option"
       end
-      helpstr << @banner if !@banner.empty?
-      if !@commands.empty?
-        helpstr << "Commands:\n"
-        commands.each { |cmd|
-          tab = ' ' * ( @longest_cmd + 1 - cmd.name.size )
-          helpstr << '    ' + cmd.name + tab + ': ' + cmd.description + "\n"
-        }
+      key = option.sub(/\A--?/, '')
+      triggered_option = options.find { |opt| opt.name == key || opt.short == key }
+      fail UnknownOptionError, "unknown #{option} option" if triggered_option.nil?
+      @triggered_options << triggered_option
+      triggered_option
+    end
+
+    private :parse_command, :parse_option
+
+    # Print a handy Options help string and exit.
+    def help
+      helpstr = "Usage: #{File.basename($PROGRAM_NAME)} "
+      helpstr << 'command ' unless commands.empty?
+      helpstr << "[options]\n"
+      helpstr << '  ' + banner unless banner.empty?
+      helpstr << help_commands unless commands.empty?
+      helpstr << help_options
+      helpstr
+    end
+
+    def help_commands
+      helpstr = "Commands:\n"
+      @commands.each do |cmd|
+        tab = ' ' * (@longest_cmd + 1 - cmd.name.size)
+        helpstr << '    ' + cmd.name + tab + ': ' + cmd.description + "\n"
       end
-      helpstr << "Options:\n"
-      options.each { |opt|
-        tab = ' ' * ( @longest_flag + 1 - opt.name.size )
-        if opt.expects_argument?
-          arg = ' <arg>'
-        else
-          arg = '      '
-        end
+      helpstr
+    end
+
+    def help_options
+      helpstr = "Options:\n"
+      @options.each do |opt|
+        tab = ' ' * (@longest_opt + 1 - opt.name.size)
+        arg = opt.expects_argument ? ' <arg>' : '      '
         helpstr << '    -' + opt.short + '|--' + opt.name + arg + tab + ': ' + opt.description + "\n"
-      }
+      end
       helpstr
     end
 
+    def show_help
+      puts help
+      exit
+    end
+
+    private :help_commands, :help_options, :show_help
+
     # Banner
     #
     # Example:
     #   banner 'This is the banner'
     #
-    def banner( desc = nil )
-      if desc.nil?
-        @banner
-      else
-        @banner += desc +"\n"
-      end
+    def banner(desc = nil)
+      @banner += desc + "\n" unless desc.nil?
+      @banner
     end
 
     # Command
@@ -167,30 +159,20 @@ module Pyer
     #   command 'run', 'Running'
     #   command :test, 'Testing'
     #
-    # Returns the created instance of Options::Command.
+    # Returns the created instance of Command.
     # or returns the command given in argument
     #
     def command(name = nil, desc = nil, &block)
-      if !name.nil?
+      if name.nil?
+        @triggered_command.callback.call if !@triggered_command.nil? && @triggered_command.callback.respond_to?(:call)
+        @triggered_command.nil? ? nil : @triggered_command.name
+      else
         @longest_cmd = name.size if name.size > @longest_cmd
         cmd = Command.new(name, desc, &block)
         @commands << cmd
       end
-      @command_name
-    end
-    alias cmd command
-
-    # Call the command callback of the command given in ARGV
-    #
-    # Example:
-    #   # show messahe when command is executed (not during parsing)
-    #   command 'run', 'Running' do
-    #     puts "run in progress"
-    #   end
-    #
-    def callback
-      @command_call.call if @command_call.respond_to?(:call)
     end
+    alias_method :cmd, :command
 
     # Add a value to options
     #
@@ -198,10 +180,10 @@ module Pyer
     #   value 'user', 'Your username'
     #   value :pass,  'Your password'
     #
-    # Returns the created instance of Options::Value.
+    # Returns the created instance of Value.
     #
     def value(name, desc, &block)
-      @longest_flag = name.size if name.size > @longest_flag
+      @longest_opt = name.size if name.size > @longest_opt
       option = Value.new(name, desc, &block)
       @options << option
       option
@@ -213,31 +195,15 @@ module Pyer
     #   flag :verbose, 'Enable verbose mode'
     #   flag 'debug',  'Enable debug mode'
     #
-    # Returns the created instance of Options::Flag.
+    # Returns the created instance of Flag.
     #
     def flag(name, desc, &block)
-      @longest_flag = name.size if name.size > @longest_flag
+      @longest_opt = name.size if name.size > @longest_opt
       option = Flag.new(name, desc, &block)
       @options << option
       option
     end
 
-    # Specify code to be executed when these options are parsed.
-    #
-    # Example:
-    #
-    #   opts = Options.parse do
-    #     flag :v, :verbose
-    #
-    #     run do |opts, args|
-    #       puts "Arguments: #{args.inspect}" if opts.verbose?
-    #     end
-    #   end
-    #def run(callable = nil, &block)
-    def run(&block)
-      @runner = block if block_given?
-    end
-
     # Fetch an options argument value.
     #
     # key - The Symbol or String option short or long flag.
@@ -249,7 +215,7 @@ module Pyer
       option.value if option
     end
 
-    # Enumerable interface. Yields each Options::Option.
+    # Enumerable interface. Yields each Option.
     def each(&block)
       options.each(&block)
     end
@@ -260,124 +226,92 @@ module Pyer
     def to_hash
       Hash[options.map { |opt| [opt.name.to_sym, opt.value] }]
     end
-    alias to_h to_hash
 
-    # Fetch a list of options which were missing from the parsed list.
-    #
-    # Examples:
-    #
-    #   opts = Options.new do
-    #     value :n, :name
-    #     value :p, :password
-    #   end
-    #
-    #   opts.parse %w[ --name Lee ]
-    #   opts.missing #=> ['password']
-    #
+    alias_method :to_h, :to_hash
+
+    private
+
     # Returns an Array of Strings representing missing options.
-    def missing
-      (options - @triggered_options).map(&:name)
+    def find_option(name)
+      @triggered_options.find { |opt| opt.name == name }
     end
 
-    private
     # Returns true if this option is present.
     # If this method does not end with a ? character it will instead
     # return the value of the option or nil
     #
     # Examples:
-    #   opts.parse %( --verbose )
+    #   opts.parse %(--verbose)
     #   opts.verbose? #=> true
     #   opts.other?   #=> false
     #
     def method_missing(method)
       meth = method.to_s
       if meth.end_with?('?')
-        meth.chop!
-        !(@triggered_options.find { |opt| opt.name == meth }).nil?
+        !find_option(meth.chop!).nil?
       else
-        o = @triggered_options.find { |opt| opt.name == meth }
-  #      o.nil? ? super : o.value
-        if o.nil?
-          nil
-        else
-          o.callback.call if o.callback.respond_to?(:call)
-          o.nil? ? nil : o.value
-        end
+        o = find_option(meth)
+        o.callback.call if !o.nil? && o.callback.respond_to?(:call)
+        o.nil? ? nil : o.value
       end
     end
+  end
 
-    class Command
-      attr_reader :name, :description, :callback
-
-      # Incapsulate internal command.
-      #
-      # name        - The String or Symbol command name.
-      # description - The String description text.
-      # block       - An optional block.
-      def initialize(name, description, &block)
-        @name = name.to_s
-        raise InvalidCommandError, "Command #{@name} is invalid" if @name.start_with?('-')
-        @description = description
-        @callback = (block_given? ? block : nil)
-      end
-    end
+  # Command class
+  class Command
+    attr_reader :name, :description, :callback
 
-    class Flag
-      attr_reader :short, :name, :description, :callback
-      attr_accessor :value
-
-      # Incapsulate internal option information, mainly used to store
-      # option specific configuration data, most of the meat of this
-      # class is found in the #value method.
-      #
-      # name        - The String or Symbol option name.
-      # description - The String description text.
-      # block       - An optional block.
-      def initialize(name, description, &block)
-        # Remove leading '-' from name if any
-        @name = name.to_s.gsub(/^--?/, '')
-        raise InvalidOptionError, "Option #{@name} is invalid" if @name.size < 2
-        @expects_argument = false
-        @value = false
-        @short = @name[0]
-        @description = description
-        @callback = (block_given? ? block : nil)
-      end
-
-      # Returns true if this option expects an argument.
-      def expects_argument?
-        @expects_argument
-      end
+    # Incapsulate internal command.
+    #
+    # name        - The String or Symbol command name.
+    # description - The String description text.
+    # block       - An optional block.
+    def initialize(name, description, &block)
+      @name = name.to_s
+      fail InvalidCommandError, "Command #{@name} is invalid" if @name.start_with?('-')
+      @description = description
+      @callback = (block_given? ? block : nil)
     end
+  end
 
-    class Value
-      attr_reader :short, :name, :description, :callback
-      attr_accessor :value
-
-      # Incapsulate internal option information, mainly used to store
-      # option specific configuration data, most of the meat of this
-      # class is found in the #value method.
-      #
-      # name        - The String or Symbol option name.
-      # description - The String description text.
-      # block       - An optional block.
-      def initialize(name, description, &block)
-        # Remove leading '-' from name if any
-        @name = name.to_s.gsub(/^--?/, '')
-        raise InvalidOptionError, "Option #{@name} is invalid" if @name.size < 2
-        @expects_argument = true
-        @value = nil
-        @short = @name[0]
-        @description = description
-        @callback = (block_given? ? block : nil)
-      end
+  # Option class
+  class Option
+    attr_reader :short, :name, :description, :callback
+    attr_reader :expects_argument
+    attr_accessor :value
+
+    # Incapsulate internal option information, mainly used to store
+    # option specific configuration data.
+    #
+    # name        - The String or Symbol option name.
+    # description - The String description text.
+    # block       - An optional block.
+    def initialize(name, description, &block)
+      # Remove leading '-' from name if any
+      @name = name.to_s.gsub(/^--?/, '')
+      fail InvalidOptionError, "Option #{@name} is invalid" if @name.size < 2
+      @expects_argument = false
+      @value = nil
+      @short = @name[0]
+      @description = description
+      @callback = (block_given? ? block : nil)
+    end
+  end
 
-      # Returns true if this option expects an argument.
-      def expects_argument?
-        @expects_argument
-      end
+  # Flag class
+  class Flag < Option
+    def initialize(name, description, &block)
+      super
+      @value = false
     end
+  end
 
+  # Value class
+  class Value < Option
+    def initialize(name, description, &block)
+      super
+      @expects_argument = true
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pyer-options
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Pierre BAZONNARD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake