colin 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7222aa55c17154f596de33d400ed698445c7b623
-  data.tar.gz: 090d2c27d773f6f894b62b848de35161dd5faae1
+  metadata.gz: 0140f7ae2032f04b7c20e60bec743b521c472b03
+  data.tar.gz: fa9a91123f70ba5d72fee59c5017ad9728599e67
 SHA512:
-  metadata.gz: 5ce2be56fe031d7b79dd5e42d52b3ad2bcd6bb6821076a3f33edb9c6244c891b8730087a35548c0c56a34bc60140829945dd1c81f3d3a1143471ec32451ec1fa
-  data.tar.gz: 067c6057ce13e7969ef01937403df67c170a87812d8d71c294a10a4f9267eddbf5ba1786b02e455338b9fea9a06b879481074b846b04930ab510b4345635c7ab
+  metadata.gz: 7745ec915493d1c79f18ecf5c2be9329e24591a1eede5aa54887e18c2cb6935f71a70fd80dc20169418cc5fd4e3d566119552a20d84b4b81aacf97b913539828
+  data.tar.gz: 9c9c305b73c88929b825601279c370651fc4c49a82503812270dfc0e2a7f1fb9b4ac990bf5964a60222851c3b82c60dcae85c6f453d026b9b397a92247ac3f3d

data/README.md

@@ -1,12 +1,54 @@
-# colin
+# CoLIn
 
-Command Line Interface.
-
-Nothing to see here yet
+**Co**mmand **L**ine **In**terface.
 
 ## Usage
 
-TODO: Write usage instructions here
+Colin's main focus is to parse command line arguments, but it's not constrained by it.
+
+You can parse any array and get an options hash back.
+
+To parse an array, just pass it as the only argument to `Colin::Parser#new`.
+
+Let's see an example:
+
+```ruby
+  require "colin"
+  
+  args = %w[first --name=Federico --age 100 second -y 2015 -f -nnumber]
+  
+  cli = Colin::Parser.new(args)
+  
+  cli.options
+  # => {:name=>"Federico", :age=>100, :y=>2015, :f=>true, :n=>"number"}
+  
+  cli.args
+  # => ["first", "second"]
+```
+
+If you want to assign names to the remaining arguments, you can call the `#named_options` method.
+
+It receives an array with the names for the remaining options and it removes as many remaining options as elements there are on the array.
+
+```ruby
+  require "colin"
+  
+  args = %w[first --name=Federico --age 100 second -y 2015 -f -nnumber third]
+  
+  cli = Colin::Parser.new(args).named_options([:do, :dont])
+  
+  cli.options
+  # => {:name=>"Federico",
+  #     :age=>100,
+  #     :y=>2015,
+  #     :f=>true,
+  #     :n=>"number",
+  #     :do=>"first",
+  #     :dont=>"second"}
+  
+  cli.args
+  # => ["third"]
+```
 
 ## Installation
 

data/colin.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "colin"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.3"
   spec.authors       = ["Federico Iachetti"]
   spec.email         = ["iachetti.federico@gmail.com"]
   spec.summary       = %q{COmmand Line INterface.}

data/lib/colin.rb

@@ -28,6 +28,7 @@ module Colin
         break if @skipped.empty?
         set(opt.to_s, @skipped.shift)
       end
+      self
     end
     
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Federico Iachetti