yaop 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+   gem "hash-utils", ">= 0.1.0"
+   gem "types", ">= 0.1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    git (1.2.5)
+    hash-utils (0.15.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    multitype-introspection (0.1.2)
+    rake (0.9.0)
+    types (0.1.3)
+      abstract (>= 1.0.0)
+      multitype-introspection (>= 0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  hash-utils (>= 0.1.0)
+  jeweler (~> 1.5.2)
+  types (>= 0.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+YAOP -- Yet Another Options Parser
+==================================
+
+**YAOP** parses the command-line for both named (*arguments*) and 
+unnamed (*parameters*) options and returns them in hash and array.
+It's intended to be feature-less, simple and lightweight one. It uses
+declarative approach. See example:
+
+    require "yaop"
+    
+    options = YAOP::get do
+        option "--strip"
+        type Boolean, false       # simple presency is enough
+        
+        options "-l", "--level"   # both of them
+        type Integer, 7           # first part, default value 7
+        type Integer, 8           # second part, default value 8
+        type Integer, 9           # third part, default value 9
+    end
+    
+If command line will be `script.rb -l 1 2 --strip "file1.txt" "file2.txt"`,
+result will be:
+
+    p options.arguments
+    # will print { "--strip" => true, "-l" => [1, 2, 9], "--level" => [1, 2, 9] }
+    
+    p options.parameters
+    # will print ["file1.txt", "file2.txt"]
+    
+Be warn, classic syntax like `-sl 1` isn't supported.
+
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/yaop/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  
+  gem.name = "yaop"
+  gem.homepage = "https://github.com/martinkozak/yaop"
+  gem.license = "MIT"
+  gem.summary = "Yet another options parser. Parses the command-line arguments and parameters. Simple, lightweight with nice declarative approach."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/yaop.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "types"
+require "hash-utils/hash"    # >= 0.1.0
+
+##
+# Yet anothet options parser. Very rubyfied declarative 
+# definitions support.
+#
+
+class YAOP
+
+    ##
+    # Holds options currently set for parsing.
+    #
+    
+    @options
+    
+    ##
+    # Stack of option in current settings. Although maybe its holder 
+    # rather than stack.
+    #
+    
+    @stack
+    
+    ##
+    # Result struct.
+    #
+    
+    Result = Struct::new(:arguments, :parameters)
+
+    ##
+    # Returns command line options.
+    #
+    # @param [Proc] block arguments declaration
+    # @return [OptionsHash] hash with options
+    #
+    
+    def self.get(&block)
+        parser = YAOP::new
+        parser.instance_eval(&block)
+        return parser.result
+    end
+    
+    ##
+    # Constructor.
+    #
+    
+    def initialize
+        @options = [ ]
+        @stack = nil
+    end
+    
+    ##
+    # Sets option names. Assigning of the new option names will cause 
+    # setting the current one to assigned options.
+    #
+    # @param [*String] args option names including leading character
+    # 
+    
+    def option(*args)
+        if not @stack.nil?
+            @options << @stack
+        end
+        
+        __reset_stack
+        @stack.options = args.map { |i| i.to_s.to_sym }
+    end
+    
+    alias :options :option
+    
+    ##
+    # Defines type and default value specification for current option.
+    #
+    # Can be used multiple times as indication, argument receives more 
+    # values treated as separated Ruby arguments.
+    #
+    # @param [Class] type type which can be +Boolean+, +String+ or +Integer+
+    # @default [Object] the default value
+    #
+    
+    def type(type, default = nil)
+        @stack.types << [type, default]
+    end
+    
+    ##
+    # Returns list of arguments and parameters according to definition.
+    # @return [YAOP::Result] struct with arguments and parameters
+    #
+    
+    def result
+    
+        # Commits last stack
+        if not @stack.nil?
+            @options << @stack
+            @stack = nil
+        end
+        
+        # Creates options index
+        index = { }
+        @options.each do |i|
+            i.options.each do |id|
+                index[id] = i
+            end
+        end
+
+        # Parses
+        last = nil    # note: it's used below
+        params = [ ]
+        
+        ARGV.each do |arg|
+            if index.has_key? arg.to_sym
+                last = arg.to_sym
+                index[last].present = true
+            elsif not last.nil?
+                index[last].values << arg
+            else
+                params << arg
+            end
+        end
+
+        # Converts datatypes
+        result = Hash::new { |dict, key| dict[key] = [ ] }
+
+        index.each_pair do |opt, spec|
+            spec.types.each_index do |i|
+                type, default = spec.types[i]
+                value = nil
+
+                case type.hash
+                    when Integer.hash
+                        value = i < spec.values.length ? spec.values[i].to_i : default
+                    when String.hash
+                        value = i < spec.values.length ? spec.values[i].to_s : default
+                    when Boolean.hash
+                        value = spec.present ? true : default
+                end
+                
+                if not value.nil?
+                    result[opt] << value
+                end
+            end
+        end
+
+        # Converts single value arguments to single-ones
+        result.each_pair do |opt, values|
+            if index[opt].types.length == 1
+                result[opt] = values.first
+            end
+        end
+        
+        # Takes parameters from last argument
+        if not last.nil?
+            parameters = index[last].values[index[last].types.length..-1]
+        else
+            parameters = params
+        end
+           
+        parameters = [ ] if parameters.nil?
+        
+        
+        return self.class::Result::new(
+            result.map_keys! { |k| k.to_s },              # converts keys from symbols back to string
+            parameters
+        )
+        
+    end
+    
+    ##
+    # Resets stack.
+    #
+    
+    private
+    def __reset_stack
+        @stack = __struct::new([], [], [], false)
+    end
+    
+    ##
+    # Creates and returns stack struct.
+    #
+    
+    private
+    def __struct
+        if @struct.nil?
+            @struct = Struct::new(:options, :types, :values, :present)
+        end
+        
+        @struct
+    end
+end
+
+=begin
+p YAOP::get {
+    option "-s", "--strip"
+    type Boolean, false
+    
+    option "-l", "--level"
+    type Integer, 7
+    type Integer, 8
+}
+=end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: yaop
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash-utils
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: types
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/yaop.rb
+homepage: https://github.com/martinkozak/yaop
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1846092196582087239
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Yet another options parser. Parses the command-line arguments and parameters. Simple, lightweight with nice declarative approach.
+test_files: []
+