pablo 1.0.3

data/lib/pablo/helpers.rb

@@ -0,0 +1,46 @@
+###### DON'T PANIC License 1.1 ###########
+#
+# Don't panic, this piece of software is
+# free, i.e. you can do with it whatever
+# you like, including, but not limited to:
+# 
+#   * using it
+#   * copying it
+#   * (re)distributing it
+#   * burning/burying/shredding it
+#   * eating it
+#   * using it to obtain world domination
+#   * and ignoring it
+# 
+# Under the sole condition that you
+# 
+#   * CONSIDER buying the author a strong
+#     brownian motion producer, say a nice
+#     hot cup of tea, should you ever meet
+#     him in person.
+#
+##########################################
+
+class Pablo
+
+    #
+    # General purpose helpers.
+    module Helpers
+        private
+
+        #
+        # Indent text by n spaces.
+        def indent text, n
+            (' ' * n) + text.split(/\n/, -1).join("\n" + (' ' * n))
+        end
+
+        #
+        # Little rails-style helper.
+        def returning val
+            yield val
+            val
+        end
+    end
+
+end
+

data/lib/pablo/option.rb

@@ -0,0 +1,89 @@
+###### DON'T PANIC License 1.1 ###########
+#
+# Don't panic, this piece of software is
+# free, i.e. you can do with it whatever
+# you like, including, but not limited to:
+# 
+#   * using it
+#   * copying it
+#   * (re)distributing it
+#   * burning/burying/shredding it
+#   * eating it
+#   * using it to obtain world domination
+#   * and ignoring it
+# 
+# Under the sole condition that you
+# 
+#   * CONSIDER buying the author a strong
+#     brownian motion producer, say a nice
+#     hot cup of tea, should you ever meet
+#     him in person.
+#
+##########################################
+
+class Pablo
+
+    class Option < Pablo::Parser
+
+        include Pablo::Helpers
+
+        def initialize *args, &block
+            super(*args, &block)
+        end
+
+        def parse args
+            name = nil
+            idx = args.zip((0...args.length).to_a).find_index { |(a,i)|
+                verifies?(a,i) and (name = matches?(a))
+            }
+
+            unless idx.nil?
+                args.consume idx
+                args.slice idx
+
+                unless @opts[:negates].nil?
+                    @pablo.options[@opts[:negates].to_sym] = false
+                else
+                    @pablo.options[name] = true
+                end
+
+                consume?(name, args)
+                run?(args)
+
+                args.unslice
+                true
+            else
+                false
+            end
+        end
+
+        #
+        # Format an option's names to be displayed to the user.
+        def names_to_user
+            @names.collect { |n| format(n) }.join('|')
+        end
+
+        #
+        # Format an option's names to be used in a Regexp
+        def names_to_rex
+            Regexp.new(@names.collect { |n| format(n) }.join('|'))
+        end
+
+        private
+
+        def format name
+            @toplevel ?
+                '--' + name.to_s :
+                '-' + name.to_s
+        end
+
+        def check_options
+            super()
+            raise ":negates expected to be a Symbol" unless
+                @opts[:negates].respond_to? :to_sym or @opts[:negates].nil?
+        end
+
+    end
+
+end
+

data/lib/pablo/parser.rb

@@ -0,0 +1,192 @@
+###### DON'T PANIC License 1.1 ###########
+#
+# Don't panic, this piece of software is
+# free, i.e. you can do with it whatever
+# you like, including, but not limited to:
+# 
+#   * using it
+#   * copying it
+#   * (re)distributing it
+#   * burning/burying/shredding it
+#   * eating it
+#   * using it to obtain world domination
+#   * and ignoring it
+# 
+# Under the sole condition that you
+# 
+#   * CONSIDER buying the author a strong
+#     brownian motion producer, say a nice
+#     hot cup of tea, should you ever meet
+#     him in person.
+#
+##########################################
+
+class Pablo
+
+    #
+    # Superclass for Command, Option, Token etc.
+    # Handles common initialization tasks and provides helpers.
+    class Parser
+
+        include Pablo::Helpers
+
+        attr_accessor :names, :desc, :longdesc, :usage, :last_match
+
+        def initialize pablo, *args, &block
+            # set names, opts
+            @pablo, @toplevel, @block = pablo, pablo.toplevel?, block
+            @opts = Hash.new
+            @opts.merge!(args.delete_at(-1).to_hash) if args[-1].respond_to?(:to_hash)
+            check_options()
+
+            @file_methods =
+                %w{file? directory? exists? exist? executable? readable? writable?}.
+                collect(&:to_sym)
+            @verify, args = args.partition { |x|
+                [String, Array, Regexp, Proc, Fixnum, Range, Proc].include? x.class or @file_methods.include? x
+            }
+
+            [:position, :matches, :is].each do |sym|
+                @verify << @opts.delete(sym) unless @opts[sym].nil?
+            end
+
+            @names = args
+            check_names()
+
+            # build expansion table
+            names.each do |name|
+                name = format(name)
+                @pablo.expand << name unless @pablo.expand.include? name
+            end if @pablo.expands?(klass_to_sym())
+
+            # get desc, longdesc, usage
+            @desc, @longdesc, @usage = @opts[:desc], @opts[:longdesc], @opts[:usage]
+            %w{desc longdesc usage}.each { |sym| @opts.delete(sym.to_sym) }
+
+            # register
+            @pablo.registered << self
+            # set default
+            @names.each { |n| @pablo.send(klass_to_sym())[n] = @opts[:default] } unless @opts[:default].nil?
+        end
+
+        def klass_to_sym
+            case self
+            when Pablo::Command then :commands
+            when Pablo::Option then :options
+            when Pablo::Token then :tokens
+            end
+        end
+
+        private
+
+        def format name
+            name.to_s
+        end
+
+        #
+        # If a block was given, this executes it.
+        # If a run object is specified, this executes the corresponding
+        # instance method.
+        def run? args
+            unless @block.nil?
+                @block.call(args, @pablo)
+            end
+
+            if @opts[:run] != false and not @pablo.run_object.nil?
+                meth = @names.find { |n|
+                    @pablo.run_object.public_methods.any? { |m|
+                        n == m.to_sym
+                    }
+                }
+
+                unless meth.nil?
+                    @pablo.run_object.send(meth, args, @pablo)
+                end
+            end
+        end
+
+        #
+        # Tests all the +@verify+ parameters against the given argument
+        # and index and returns +true+ if they all match and +false+ otherwise.
+        def verifies? arg, idx
+            @verify.all? do |ver|
+                case ver
+                when Array then ver.include? arg
+                when Regexp then ver =~ arg
+                when String then ver == arg
+                when Proc then ver.call(arg)
+                when Fixnum then ver == idx
+                when Range then ver.include? idx
+                when Proc then ver.call(arg, idx)
+                else # File methods
+                    @file_methods.include?(ver) ?
+                        File.send(ver, arg) :
+                        true
+                end
+            end
+        end
+
+        #
+        # Returns true if +@opts[:consume]+ is not +nil+ and
+        # consumes whatever was specified in that case.
+        def consume? name, args
+            unless @opts[:consume].nil?
+                @pablo.send(klass_to_sym())[name] =
+                    case @opts[:consume]
+                    when String
+                        args[0] == @opts[:consume] ?
+                            returning(args[0]) { args.consume 0 } :
+                            nil
+                    when Array
+                        returning(ret = @opts[:consume].find { |c| c == args[0] }) {
+                            args.consume 0 unless ret.nil? }
+                    when Regexp
+                        args[0] =~ @opts[:consume] ?
+                            returning(args[0]) { args.consume 0 } :
+                            nil
+                    when 1
+                        returning(args[0]) { args.consume 0 }
+                    when Fixnum
+                        @opts[:consume] > 1 ?
+                            returning(args[0...@opts[:consume]]) { args.consume 0 } :
+                            nil
+                    end
+
+                true
+            else false
+            end
+        end
+
+        #
+        # Expands the given +name+ if expansion is turned on for this
+        # type of Parser and the +name+ matches one of this parser's
+        # names - optionally with a prefix assigned.
+        # If not, the name is matched unexpanded.
+        # If no match is found, nil is returned.
+        def matches? arg
+            arg = @pablo.expand!(arg)
+
+            @last_match = @names.find do |n|
+                format(n.to_s) == arg
+            end
+        end
+
+        def check_names
+            raise ArgumentError.new("names must be Symbols") if @names.any? { |n| !n.is_a?(Symbol) }
+        end
+
+        def check_options
+            raise ":consume expected to be any of Fixnum, Array, String, Regexp" unless
+                [Fixnum, Array, String, Regexp].include? @opts[:consume].class or @opts[:consume].nil?
+            raise ":position expected to be any of Fixnum, Range" unless
+                [Fixnum, Range].include? @opts[:position].class or @opts[:position].nil?
+            raise ":is expected to be any of Array, String" unless
+                [Array, String].include? @opts[:is].class or @opts[:is].nil?
+            raise ":matches expected to be a Regexp" unless
+                @opts[:matches].is_a? Regexp or @opts[:matches].nil?
+        end
+
+    end
+
+end
+

data/lib/pablo/token.rb

@@ -0,0 +1,66 @@
+###### DON'T PANIC License 1.1 ###########
+#
+# Don't panic, this piece of software is
+# free, i.e. you can do with it whatever
+# you like, including, but not limited to:
+# 
+#   * using it
+#   * copying it
+#   * (re)distributing it
+#   * burning/burying/shredding it
+#   * eating it
+#   * using it to obtain world domination
+#   * and ignoring it
+# 
+# Under the sole condition that you
+# 
+#   * CONSIDER buying the author a strong
+#     brownian motion producer, say a nice
+#     hot cup of tea, should you ever meet
+#     him in person.
+#
+##########################################
+
+class Pablo
+
+    class Token < Pablo::Parser
+
+        include Pablo::Helpers
+
+        def parse args
+            idx = args.zip((0...args.length).to_a).find_index { |(a,i)|
+                verifies?(a,i)
+            }
+
+            unless idx.nil?
+                name = @names[0]
+                args.slice idx
+                @names.each { |n| @pablo.tokens[n] = true } unless name.nil?
+
+                if returning(consume?(name, args)) { run?(args) }
+                    @names[1..-1].each { |n| @pablo.tokens[n] = @pablo.tokens[@names[0]] }
+                end
+
+                args.unslice
+                true
+            else
+                false
+            end
+        end
+
+        #
+        # Format a token's names to be displayed to the user.
+        def names_to_user
+            @names.collect(&:to_s).join('|')
+        end
+
+        #
+        # Format a token's names to be used in a Regexp
+        def names_to_rex
+            Regexp.new(names_to_user)
+        end
+
+    end
+
+end
+

data/lib/pablo/version.rb

@@ -0,0 +1,29 @@
+###### DON'T PANIC License 1.1 ###########
+#
+# Don't panic, this piece of software is
+# free, i.e. you can do with it whatever
+# you like, including, but not limited to:
+# 
+#   * using it
+#   * copying it
+#   * (re)distributing it
+#   * burning/burying/shredding it
+#   * eating it
+#   * using it to obtain world domination
+#   * and ignoring it
+# 
+# Under the sole condition that you
+# 
+#   * CONSIDER buying the author a strong
+#     brownian motion producer, say a nice
+#     hot cup of tea, should you ever meet
+#     him in person.
+#
+##########################################
+
+class Pablo
+
+    VERSION = '1.0.3'
+
+end
+

data/test/fixtures/license.txt

@@ -0,0 +1,22 @@
+/*---- DON'T PANIC License 1.1 -----------
+
+  Don't panic, this piece of software is
+  free, i.e. you can do with it whatever
+  you like, including, but not limited to:
+  
+    * using it
+    * copying it
+    * (re)distributing it
+    * burning/burying/shredding it
+    * eating it
+    * using it to obtain world domination
+    * and ignoring it
+  
+  Under the sole condition that you
+  
+    * CONSIDER buying the author a strong
+      brownian motion producer, say a nice
+      hot cup of tea, should you ever meet
+      him in person.
+
+----------------------------------------*/