raph 0.0.2 → 0.0.3

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2015 Vitalii Elenhaupt
-
-MIT License
-
-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.
+Copyright (c) 2015 Vitalii Elenhaupt
+
+MIT License
+
+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

@@ -1,103 +1,102 @@
-# raph [![Gem Version](https://badge.fury.io/rb/raph.svg)](https://rubygems.org/gems/raph) [![Build Status](https://api.travis-ci.org/veelenga/raph.svg?branch=master)](https://travis-ci.org/veelenga/raph)
-
-![This is Raph](http://upload.wikimedia.org/wikipedia/en/5/58/TMNTRaphael2012.png)
-
-**R**uby **A**rgument **P**arsing for **H**umans
-
-Inspired by [args](https://github.com/kennethreitz/args)
-
-## Installation:
-
-`$ gem install raph`
-
-
-## Usage:
-
-Here is application sample:
-
-```ruby
-# sample.rb
-require 'raph'
-
-puts "Arguments passed in:  #{$raph.all}"
-puts "Flags detected:       #{$raph.flags}"
-puts "Files detected:       #{$raph.files}"
-puts "Assignments detected: #{$raph.assignments}"
-```
-
-If you do not pass any arguments:
-
-```sh
-$ ruby sample.rb
-Arguments passed in:  []
-Flags detected:       []
-Files detected:       []
-Assignments detected: []
-```
-
-If you have few arguments passed:
-
-```sh
-$ ruby sample.rb -v --flag1 --flag2 --formatter=simple --convert=true
-Arguments passed in:  ["-v", "--flag1", "--flag2", "--formatter=simple", "--convert=true"]
-Flags detected:       [:v, :flag1, :flag2]
-Files detected:       []
-Assignments detected: {:formatter=>"simple", :convert=>"true"}
-```
-
-And finnaly if you pass expanded arguments:
-
-```sh
-$ ruby sample.rb -f spec/*.rb
-Arguments passed in:  ["-f", "spec/raph_spec.rb", "spec/spec_helper.rb"]
-Flags detected:       [:f]
-Files detected:       ["spec/raph_spec.rb", "spec/spec_helper.rb"]
-Assignments detected: {}
-```
-
-## Advanced usage:
-
-You can use `raph` with custom parsers. For example:
-
-```ruby
-require 'raph'
-
-include Raph
-
-class AnimalParser < BaseParser
-  ANIMALS = ['cat', 'dog', 'pig', 'bear', 'elephant']
-
-  def id
-    :animals
-  end
-
-  def parse(args)
-    animals = []
-    args.each do |arg|
-      animals << arg if ANIMALS.include? arg.strip.downcase
-    end
-    animals
-  end
-end
-
-args = [ '--my-animals', 'cat', 'bird', 'dog', 'elephant' ]
-
-raph = Raph::Raph.new.tap do |r|
-  r.add_parser( AnimalParser.new )
-  r.parse( args )
-end
-
-# Raph#animals attribute is added dynamically.
-# It is defined by AnimalParser#id method.
-puts "All:        #{raph.all}"
-puts "My animals: #{raph.animals}"
-
-#All:        ["--my-animals", "cat", "bird", "dog", "elephant"]
-#My animals: ["cat", "dog", "elephant"]
-
-```
-
-## TODO:
- - Grouped arguments parser.
- - Not-files parser.
-
+# raph [![Gem Version](https://badge.fury.io/rb/raph.svg)](https://rubygems.org/gems/raph) [![Build Status](https://api.travis-ci.org/veelenga/raph.svg?branch=master)](https://travis-ci.org/veelenga/raph)
+
+![This is Raph](http://upload.wikimedia.org/wikipedia/en/5/58/TMNTRaphael2012.png)
+
+**R**uby **A**rgument **P**arsing for **H**umans
+
+Inspired by [args](https://github.com/kennethreitz/args)
+
+## Installation:
+
+`$ gem install raph`
+
+
+## Usage:
+
+Here is application sample:
+
+```ruby
+# sample.rb
+require 'raph'
+
+puts "Arguments passed in:  #{$raph.all}"
+puts "Flags detected:       #{$raph.flags}"
+puts "Files detected:       #{$raph.files}"
+puts "Assignments detected: #{$raph.assignments}"
+puts "Grouped arguments:    #{$raph.grouped_args}"
+```
+
+If you do not pass any arguments:
+
+```sh
+$ ruby sample.rb
+Arguments passed in:  []
+Flags detected:       []
+Files detected:       []
+Assignments detected: {}
+Grouped arguments:    {}
+```
+
+If you have few arguments passed:
+
+```sh
+$ ruby sample.rb -v 1 2 3 --flag1 3 --flag2 --formatter=simple true
+Arguments passed in:  ["-v", "1", "2", "3", "--flag1", "3", "--flag2", "--formatter=simple", "true"]
+Flags detected:       [:v, :flag1, :flag2]
+Files detected:       []
+Assignments detected: {:formatter=>"simple"}
+Grouped arguments:    {:v=>["1", "2", "3"], :flag1=>["3"], :flag2=>[], :"formatter=simple"=>["true"]}
+```
+
+And finnaly if you pass expanded arguments:
+
+```sh
+$ ruby sample.rb -f spec/*.rb
+Arguments passed in:  ["-f", "spec/raph_spec.rb", "spec/spec_helper.rb"]
+Flags detected:       [:f]
+Files detected:       ["spec/raph_spec.rb", "spec/spec_helper.rb"]
+Assignments detected: {}
+Grouped arguments:    {:f=>["spec/raph_spec.rb", "spec/spec_helper.rb"]}
+```
+
+## Advanced usage:
+
+You can use `raph` with custom parsers. For example:
+
+```ruby
+require 'raph'
+
+include Raph
+
+class AnimalParser < BaseParser
+  ANIMALS = ['cat', 'dog', 'pig', 'bear', 'elephant']
+
+  def id
+    :animals
+  end
+
+  def parse(args)
+    animals = []
+    args.each do |arg|
+      animals << arg if ANIMALS.include? arg.strip.downcase
+    end
+    animals
+  end
+end
+
+args = [ '--my-animals', 'cat', 'bird', 'dog', 'elephant' ]
+
+raph = Raph::Raph.new.tap do |r|
+  r.add_parser( AnimalParser.new )
+  r.parse( args )
+end
+
+# Raph#animals attribute is added dynamically.
+# It is defined by AnimalParser#id method.
+puts "All:        #{raph.all}"
+puts "My animals: #{raph.animals}"
+
+#All:        ["--my-animals", "cat", "bird", "dog", "elephant"]
+#My animals: ["cat", "dog", "elephant"]
+
+```

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: [:spec]
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/example/sample.rb

@@ -1,6 +1,7 @@
-require 'raph'
-
-puts "Arguments passed in:  #{$raph.all}"
-puts "Flags detected:       #{$raph.flags}"
-puts "Files detected:       #{$raph.files}"
-puts "Assignments detected: #{$raph.assignments}"
+require 'raph'
+
+puts "Arguments passed in:  #{$raph.all}"
+puts "Flags detected:       #{$raph.flags}"
+puts "Files detected:       #{$raph.files}"
+puts "Assignments detected: #{$raph.assignments}"
+puts "Grouped arguments:    #{$raph.grouped_args}"

data/lib/raph.rb

@@ -1,61 +1,110 @@
-require 'raph/parser/file_parser'
-require 'raph/parser/flag_parser'
-require 'raph/parser/assignment_parser'
-
-module Raph
-  # TODO: class description
-  class Raph
-    def initialize
-      @parsed = {}
-      @parsers = []
-    end
-
-    def parse(args)
-      @all = args.dup
-
-      @parsers.each do |p|
-        @parsed[p.id.to_sym] = p.parse(@all)
-      end
-    end
-
-    def all
-      @all.dup
-    end
-
-    def add_parser(parser)
-      @parsers.push parser
-    end
-
-    def method_missing(method_sym, *arguments, &block)
-      # TODO: do not accept any arguments or block
-      if has_attribute? method_sym
-        get_attribute_value method_sym
-      else
-        super
-      end
-    end
-
-    private
-
-    # Returns true if this class has dynamic argument 'arg'
-    def has_attribute?(arg)
-      @parsed.include? arg
-    end
-
-    # Returns value of dynamic argument 'arg'
-    def get_attribute_value(arg)
-      @parsed[arg]
-    end
-  end
-
-  include Parser
-
-  $raph = Raph.new.tap do |r|
-    r.add_parser(FileParser.new)
-    r.add_parser(FlagParser.new)
-    r.add_parser(AssignmentParser.new)
-
-    r.parse(ARGV)
-  end
-end
-
+require 'raph/parser/file_parser'
+require 'raph/parser/flag_parser'
+require 'raph/parser/assignment_parser'
+require 'raph/parser/grouped_arg_parser'
+
+module Raph
+  #
+  # Ruby Argument Parser for Humans.
+  # Parses arguments using external parsers.
+  #
+  #   class Parser1 < BaseParser
+  #     def id
+  #       'parser1_result'
+  #     end
+  #
+  #     def parse(arg)
+  #       # return your parsed arguments
+  #     end
+  #   end
+  #
+  #   class Parser2 < Base
+  #     def id
+  #       'parser2_result'
+  #     end
+  #
+  #     def parse(arg)
+  #       # return your parsed arguments
+  #     end
+  #   end
+  #
+  #   raph = Raph.new.tap do |r|
+  #     r.add_parser(Parser1.new)
+  #     r.add_parser(Parser2.new)
+  #     # ...
+  #
+  #     r.parse (arguments)
+  #   end
+  #
+  #   puts raph.parser1_result # parsed arguments by Parser1
+  #   puts raph.parser2_result # parsed arguments by Parser2
+  class Raph
+    #
+    # Initializes Raph.
+    def initialize
+      @parsed = {}
+      @parsers = []
+    end
+
+    #
+    # Parses arguments using external parsers.
+    #
+    # +args+:: arguments to be parsed.
+    def parse(args)
+      @all = args.dup
+
+      @parsers.each do |p|
+        @parsed[p.id.to_sym] = p.parse(@all)
+      end
+    end
+
+    #
+    # Returns all arguments.
+    def all
+      @all.dup
+    end
+
+    #
+    # Adds new external parser to parser list.
+    #
+    # +parser+:: external parser.
+    def add_parser(parser)
+      @parsers.push parser
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if has_attribute? method_sym
+        raise 'Arguments not applicable' if arguments.length > 0
+        raise 'Block not applicable' if block_given?
+        get_attribute_value method_sym
+      else
+        super
+      end
+    end
+
+    private
+
+    #
+    # Returns true if this class has dynamic argument +arg+.
+    def has_attribute?(arg)
+      @parsed.include? arg
+    end
+
+    #
+    # Returns value of dynamic argument +arg+
+    def get_attribute_value(arg)
+      @parsed[arg]
+    end
+  end
+
+  include Parser
+
+  $raph = Raph.new.tap do |r|
+    r.add_parser(FileParser.new)
+    r.add_parser(FlagParser.new)
+    r.add_parser(AssignmentParser.new)
+    r.add_parser(GroupedArgParser.new)
+
+    r.parse(ARGV)
+  end
+end