arguvia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 649a7cfe18e7aea4094964e4a5974b8983dc43f3
+  data.tar.gz: 8e363991a977f8d560a649c9999dee1aeae2e14e
+SHA512:
+  metadata.gz: 25474e2f5bbb4decb95fe282a85594981257b69fbf939239aba0b3f17598a7d115cc6024ac14ca9c602737fda1c89c7b51052903ba2c8a9525db44f5c0453771
+  data.tar.gz: 10ec1e19d3909014bae42be9ca82bd10b72b4fa3c569b5e6227c425453f769961b34e1ac9bb941fb7fa6bc1ce4f5e1ca798ef5f407681a843b38818c36d87f55

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Joseph (fluorine@github)
+
+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,62 @@
+Arguvia v0.1.0
+==============
+This gem contains a function-like argument parser
+for command-line applications.
+
+This is an example of a command-line application
+that uses function-like arguments:
+
+	dictionary.rb words(10) open-file(words.txt) Singular
+
+
+Description
+-----------
+Arguvia gem allows any Ruby application to use function-like
+arguments for its command-line interface.
+
+This gem contains the `Arguvia` class, which parses the given
+list of arguments to map them to class members and indeternal
+Ruby values.
+
+
+Using the Arguvia class
+-----------------------
+Let's take the introductory example to show how
+the `Arguvia` class works:
+
+	dictionary.rb words(10) open-file(words.txt) Singular
+
+The `dictionary.rb` hypothetic script uses function-like
+command-line arguments through the `arguvia` gem.
+
+The `Arguvia` class generates the class members for
+the given command-line arguments.
+
+	require 'arguvia'
+	x = Arguvia.new     # It equals to 'Arguvia.new(ARGV)'
+	x.words             # => 10
+	x.open_file         # => "words.txt"
+	x.singular          # => true
+	x.undefined         # => false
+
+`Arguvia` class uses the dynamic and metaprogramming
+features of Ruby to generate an object, which members maps
+the given arguments.
+
+Examples of valid arguments
+----------------------------------
+|Argument   |Identifier | Value  |
+|:---------:|:---------:|:------:|
+|foo        |`x.foo`    |true    |
+|--etc      |`x._etc `  |true    |
+|-h         |`x._h`     |true    |
+|           |`x.baz`    |nil     |
+|func(1)    |`x.func`   |1       |
+|dir(etc)   |`x.dir`    |"etc"   |
+|xs(1, 2, 3)|`x.xs`     |[1,2,3] |
+|pair(a, 7) |`x.pair`   |["a", 7]|
+
+To do
+-----
+- Support for special symbols.
+- Support for literal strings (allow internal spaces)

data/lib/arguvia.rb

@@ -0,0 +1,58 @@
+class Arguvia
+  def initialize(args = ARGV)
+    @args = {}
+
+    # Add bindings
+    args.each do |arg|
+      case arg
+      when /^([\w\-]+)$/
+        @args[__parse_key(arg)] = true
+      when /^([\w\-]+)\((.*)\)$/
+        @args[__parse_key($1)] = __parse_value($2)
+      else
+        raise ArgumentError
+      end
+    end
+  end
+
+  # Generate ghost methods, if requiered
+  def method_missing(name, *args)
+    super unless args.length == 0
+    @args[name]
+  end
+
+  # Add responding methods
+  def respond_to?(name)
+    return true if @args.keys.include? name
+    super(name)
+  end
+
+  #
+  # Internal methods
+  #
+
+  private
+
+  # Parse key type
+  def __parse_key(str)
+    return str.gsub(/-+/, "_").downcase.to_sym
+  end
+
+  # Parse value type
+  def __parse_value(str)
+    case str
+    when /,/
+      # Split and evaluate recursively
+      # if multiple arguments.
+      str.split(/,/).map do |item|
+        __parse_value(item.strip)
+      end
+    when /-?\d+\.\d+/
+      str.to_f
+    when /-?\d+/
+      str.to_i
+    else
+      str
+    end
+  end
+end

data/lib/arguvia/version.rb

@@ -0,0 +1,3 @@
+module Arguvia
+	VERSION = "0.1.0"
+end

data/test/test_arguvia.rb

@@ -0,0 +1,71 @@
+require 'arguvia'
+require 'test/unit'
+
+class TestArguvia < Test::Unit::TestCase
+  def setup
+    # Simple boolean arguments
+    @simple_strs = ["hola", "mundo", "vi-va", "--foo", "rivendel"]
+    @simple_args = Arguvia.new(@simple_strs)
+
+    # Function-like arguments
+    @func_strs = ["hola(mundo)", "integer(12)", "float(12.345)",
+                  "multi(1, 2, 3)", "ma-ny(a, ab, cde)"]
+    @func_res  = {hola: "mundo", integer: 12,
+                  float: 12.345, multi: [1, 2, 3],
+                  ma_ny: ["a", "ab", "cde"]}
+    @func_args = Arguvia.new(@func_strs)
+
+    # Complex arguments
+    @complex_strs = ["hola-mundo(saludo, despedida)", "--help",
+                     "numbers(1, 1.23, -1, -3.245)",
+                     "--file(/usr/hi/hola.txt)", "--PATH(ruby.exe)"]
+    @complex_res  = {hola_mundo: ["saludo", "despedida"], _help: true,
+                     numbers: [1, 1.23, -1, -3.245], _file: "/usr/hi/hola.txt",
+                     _path: "ruby.exe"}
+    @complex_args = Arguvia.new(@complex_strs)
+  end
+
+  #
+  # Test simple arguments's method respond_to?
+  #
+
+  def test_false_respond_to
+    false_strs = ["a", "bar", "gaga", "etc", "demons"]
+    false_strs.each do |item|
+      assert_equal(@simple_args.respond_to?(item.to_sym), false)
+    end
+  end
+
+  def test_true_respond_to
+    @simple_strs.each do |item|
+      assert(@simple_args.respond_to? item.gsub(/-+/, "_").to_sym)
+    end
+  end
+
+  #
+  # Test simple arguments's generated members
+  #
+  def test_simple_arguvia_members
+    @simple_strs.each do |name|
+      assert(eval("@simple_args.#{name.gsub(/-+/, "_")}"))
+    end
+  end
+
+  #
+  # Test function-like argumens
+  #
+  def test_function_like_arguments
+    @func_res.each do |key, value|
+      assert_equal(eval("@func_args.#{key}"), value)
+    end
+  end
+
+  #
+  # Test complex function-like argumens
+  #
+  def test_complex_arguments
+    @complex_res.each do |key, value|
+      assert_equal(eval("@complex_args.#{key}"), value)
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: arguvia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies: []
+description: This script allows applications to parse and use command-line arguments
+  in a function-like fashion. For example, 'dict words(10) open-file(words.txt)'
+email: fluorine@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arguvia.rb
+- lib/arguvia/version.rb
+- README.md
+- LICENSE.txt
+- test/test_arguvia.rb
+homepage: https://github.com/fluorine/Arguvia
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A function-like argument parser for command-line applications.
+test_files: []