optimus 0.0.1

data/lib/optimus.rb

@@ -0,0 +1,21 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optimus/optimus'
+require 'optimus/implementations'
+
+require 'optimus/version'

data/lib/optimus/implementation.rb

@@ -0,0 +1,30 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+class Optimus
+
+class Implementation
+    attr_reader :parser, :interface
+
+    def initialize (parser, interface)
+        @parser    = parser
+        @interface = interface
+    end
+end
+
+end

data/lib/optimus/implementations.rb

@@ -0,0 +1,18 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optimus/implementations/standard'

data/lib/optimus/implementations/advanced.rb

@@ -0,0 +1,32 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+class Optimus
+
+module Parsers
+
+class AdvancedParser
+
+end
+
+Advanced = AdvancedParser.new
+
+end
+
+end
+# /--(?<commmand>\w+)(=(?<argument>.*))?/

data/lib/optimus/implementations/standard.rb

@@ -0,0 +1,197 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#           meh  [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'forwardable'
+require 'date'
+
+require 'optimus/option'
+require 'optimus/options'
+
+require 'optimus/implementation'
+require 'optimus/interface'
+require 'optimus/parser'
+
+class Optimus
+
+module Implementations
+
+class Standard < Implementation
+  class Parser < Optimus::Parser
+    def initialize (implementation, options=nil)
+      super(implementation, options)
+  
+      if !@options[:separators]
+        @options[:separators] = {}
+      end
+  
+      if !@options[:separators][:long]
+        @options[:separators][:long] = '--'
+      end
+  
+      if !@options[:separators][:short]
+        @options[:separators][:short] = '-'
+      end
+    end
+  
+    def parse (result, values, options=nil)
+      options   = @options.merge(options) if options.is_a? Hash
+      active  = nil
+      type    = nil
+  
+      values.each {|value|
+        if active
+          if value.match(/^#{Regexp.escape(@options[:separators][:long])}|#{Regexp.escape(@options[:separators][:short])}\w/)
+            result.data[:parameters][active] = { :type => type, :value => true }
+          else
+            result.data[:parameters][active] = { :type => type, :value => value }
+          end
+
+          active = nil
+        else
+          if matches = value.match(/^#{Regexp.escape(@options[:separators][:long])}(\w+)$/)
+            active = matches[1]
+            type = :long
+          elsif matches = value.match(/^#{Regexp.escape(@options[:separators][:short])}(\w+)$/)
+            if matches[1].length == 1
+              active = matches[1]
+              type = :short
+            else
+              matches[1].chars.each {|char|
+                result.data[:parameters][char] = { :type => :short, :value => true }
+              }
+            end
+          else
+            result.data[:arguments] << value
+          end
+        end
+      }
+
+      result.normalize
+      result
+    end
+  end
+
+  class Interface < Optimus::Interface
+    attr_reader :parameters, :arguments, :options, :data
+
+    alias params parameters
+    alias args   arguments
+
+    extend Forwardable
+
+    def_delegators :@options, :each_value, :merge!
+
+    alias each each_value
+
+    def initialize (implementation)
+      super(implementation)
+
+      @options = {}
+
+      @data = {
+        :parameters => {},
+        :arguments  => []
+      }
+
+      @internal = {}
+    end
+
+    def merge (hash)
+      result = self.clone
+      result.merge! hash
+      result
+    end
+
+    def set (arguments)
+      if !arguments[:long]
+        raise 'You have to pass at least :long.'
+      end
+
+      arguments[:long]  = arguments[:long].to_sym
+      arguments[:short] = arguments[:short].to_sym if arguments[:short]
+
+      option    = Option.new(arguments)
+      option.name = arguments[:long]
+
+      @options[option.name] = option
+    end
+
+    def get (name)
+      @options[name]
+    end
+
+    def normalize
+      @parameters = {}
+      @arguments  = @data[:arguments]
+
+      @options.each_value {|option|
+        if option.default
+          @parameters[option.long]  = option.default
+          @parameters[option.short] = option.default
+        end
+      }
+
+      @data[:parameters].each {|key, value|
+        if value[:type] == :long
+          if @options[key]
+            @parameters[@options[key].long]  = value[:value]
+            @parameters[@options[key].short] = value[:value]
+          end
+        else
+          @options.each_value {|option|
+            if option.short == key
+              @parameters[option.long]  = value[:value]
+              @parameters[option.short] = value[:value]
+            end
+          }
+        end
+      }
+
+      @options.each_value {|option|
+        case option.type
+          when :numeric
+            value = @parameters[option.long]
+            value = (value.to_i == value.to_f) ? value.to_i : value.to_f
+
+          when :boolean
+            value = @parameters[option.long] == 'true'
+
+          when :date
+            value = Date.parse(@parameters[option.long])
+
+          when :array
+            value = @parameters[option.long].split(/,/)
+
+          when :hash
+            value = Hash[@parameters[option.long].split(/,/).split(/=/)]
+        end
+
+        @parameters[option.long]  = value
+        @parameters[option.short] = value
+      }
+    end
+  end
+
+  def initialize (parserOptions=nil)
+    super(Parser.new(self, parserOptions), Interface.new(self))
+  end
+end
+
+end
+
+end

data/lib/optimus/interface.rb

@@ -0,0 +1,36 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+class Optimus
+
+# This is only an abstract class to implement Optimus interfaces.
+#
+# Required methods are: LOL I DUNNO
+class Interface
+    attr_reader :implementation
+
+    def initialize (implementation)
+        @implementation = implementation
+    end
+
+    def inspect
+        "#<Interface>"
+    end
+end
+
+end

data/lib/optimus/optimus.rb

@@ -0,0 +1,59 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optimus/options'
+
+class Optimus
+    attr_reader :options, :implementation
+
+    # Initialize Optimus with an array of options or ARGV
+    def initialize (*args)
+        if !block_given?
+            options = args.shift || []
+        end
+
+        values         = args.shift || ARGV
+        implementation = args.shift || Implementations::Standard.new
+
+        if block_given?
+            yield @options = Options.new(implementation)
+            @options.parse(values)
+        else
+            @options = Options.parse(options, values, implementation)
+        end
+
+        @implementation = implementation
+    end
+
+    # Parse additional options and merge them to the Optimus object
+    def parse (values, parserOptions=nil)
+        options = Options.parse(@options.options, values, @implementation, parserOptions)
+
+        if block_given?
+            yield options
+        end
+
+        @options.merge!(options)
+
+        return options
+    end
+
+    def method_missing (method, *args, &block)
+        @options.send(method, *args, &block)
+    end
+end

data/lib/optimus/option.rb

@@ -0,0 +1,36 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'ostruct'
+
+class Optimus
+    class Option < OpenStruct
+        attr_accessor :name
+
+        def initialize (arguments)
+            if !arguments.is_a? Hash
+                raise 'You have to pass a Hash'
+            end
+
+            super(arguments)
+        end
+
+        alias to_hash marshal_dump
+        alias to_h    marshal_dump
+    end
+end

data/lib/optimus/options.rb

@@ -0,0 +1,48 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optimus/option'
+
+class Optimus
+    class Options
+        attr_reader :implementation
+
+        def self.parse (options, values, implementation, parserOptions=nil)
+            result = Options.new(implementation)
+
+            options.each {|option|
+                result.set(option)
+            }
+
+            implementation.parser.parse(result, values, parserOptions)
+        end
+
+        def initialize (implementation)
+            @implementation = implementation
+        end
+
+        def parse (values, options=nil)
+            @implementation.parser.parse(self, values, options)
+        end
+
+        def method_missing (method, *args, &block)
+            @implementation.interface.send(method, *args, &block)
+        end
+    end
+end
+

data/lib/optimus/parser.rb

@@ -0,0 +1,39 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+class Optimus
+
+class Parser
+    attr_reader :implementation, :options
+
+    def initialize (implementation, options=nil)
+        @implementation = implementation
+
+        if !options.is_a? Hash
+            @options = {}
+        else
+            @options = options
+        end
+    end
+
+    def inspect
+        "#<Parser:#{@options.inspect}>"
+    end
+end
+
+end

data/lib/optimus/version.rb

@@ -0,0 +1,22 @@
+#  Copyright (C) 2010 tilde  [tilde AT autistici DOT org]
+#                     meh    [meh.ffff AT gmail DOT com]
+#
+#  This file is part of optimus.
+#  
+#  optimus is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with optimus.  If not, see <http://www.gnu.org/licenses/>.
+
+class Optimus
+    Version = '0.0.1'
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: optimus
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- tilde
+- meh.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: An automated yet fully customizable command line options parser.
+email: 
+- tilde@autistici.org
+- meh.ffff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/optimus.rb
+- lib/optimus/optimus.rb
+- lib/optimus/parser.rb
+- lib/optimus/options.rb
+- lib/optimus/interface.rb
+- lib/optimus/implementations.rb
+- lib/optimus/version.rb
+- lib/optimus/implementation.rb
+- lib/optimus/implementations/standard.rb
+- lib/optimus/implementations/advanced.rb
+- lib/optimus/option.rb
+has_rdoc: true
+homepage: http://github.com/tilde/optimus
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A command line opt parser.
+test_files: []
+