argv 1.1.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6d3305ab1c2290e56cc9749439775e019de80cd
-  data.tar.gz: 7bb4f9174d881d688a34899fdea86c86f8dca300
+  metadata.gz: 6bda76d6b927be05fc63143b9bde823c8c397bd9
+  data.tar.gz: 2afca9cf6493a55f328532b75a59e31cb0cd643c
 SHA512:
-  metadata.gz: d9ddd7515b54d4a16c826e3ccbfac4984a54e8df7b4fe358fc2b2f7af88d40d335dde8ae9b45b7ee7f42306904a173036b90fc6ae5d59ccc61e33852024e0bd7
-  data.tar.gz: d7419e12eaac5a53391dc74ba0f02b716b406cc9d7b84f1aaaf63823db092af4bb191ee61f60fcec1263a2119f11b32265d4f893db47c36902220f83b17326a9
+  metadata.gz: a0becc8a32de3cfd6f5495f7c4e0fa17db6d6462f74f15a5001a140e6cf03d776a9625bd9d79e502a9493d54b18dd0e432ff39098f46809eb9c3a902c5283bb7
+  data.tar.gz: 6adf6f6ab00b2e021f9c4dedcab2bc41f5673445b02bb71124908da494772b3c7e6e9749d58c76a27be0697061d68af86fb05bd7014c070dc8cfb810a58996e3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    argv (1.1.1)
+    argv (2.1.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -10,51 +10,55 @@ With this extension module, you can parse in an easy way the script input tags
 
     require 'argv'
 
-    #> $ script.rb --test this --hello world --sup
+    #$ ruby sample/test.rb --test test this ok
 
-    puts ARGV.flag_tags
-    # {"--test"=>"this", "--hello"=>"world"}
+    puts ARGV.to_hash
+    # {"--test"=>"test"}
 
-    puts ARGV.flags.inspect
-    # ["--test", "--hello", "--sup"]
-
-```
-
-```ruby
+    puts ARGV.to_hash( multi_value: true )
+    # {"--test"=>["test", "this", "ok"]}
 
+    puts ARGV.to_hash( sym_key: true )
+    # {:test=>"test"}
 
-    #> $ script.rb  --test this --hello world --su-p asd sdsd -asd -dsa
+    puts ARGV.to_hash( s: true, m: true )
+    # {:test=>["test", "this", "ok"]}
 
     puts ARGV.values.inspect
-    #> ["this", "world", "asd", "sdsd"]
+    # ["test", "this", "ok"]
 
-    puts ARGV.flagtags sym_key: true
-    #> {:test=>"this", :hello=>"world", :"su-p"=>"asd"}
+    puts ARGV.keys.inspect
+    # ["--test"]
 
+    puts ARGV.flag_syms.inspect
+    # [:test, :test, :this, :ok]
 
 ```
 
-```ruby
-
+#### For Modules
 
-    #> $ script.rb  --test this this multi value --hello world asdf
+if you write module and you want to have some custom tags and help msg for that,
+use the following example
 
-    puts ARGV.values.inspect
-    #> ["this", "world", "asd", "sdsd"]
-
-    puts ARGV.flagtags sym_key: true
-    #> {:test=>"this", :hello=>"world", :"su-p"=>"asd"}
+```ruby
 
+    require 'argv'
 
-```
+    ARGVEXT.add_help_msg "This will show you the help msg (this)",:helper,:help,:h
 
-### multi value use case
+    #
+    # ARGVEXT.help_msg or show_help will read on your values and will produce the following with this example
+    #
+    #   This will show you the help msg (this)
+    #         --helper
+    #         --help
+    #          -h
 
-```ruby
+    # this will run on the terminal and break Process,
+    # if the user give one of the helper tags as argv
 
-    #> $ script.rb --test this --hello world --su-p asd sdsd -asd -dsa
+```
 
-    puts ARGV.flag_multi_value.inspect
-    #> {"--test"=>["this"], "--hello"=>["world"], "--su-p"=>["asd", "sdsd"]}
+### Test
 
-```
+* you can find a test file in the sample named as "test"

data/VERSION

@@ -1 +1 @@
-1.1.1
+2.1.0

data/lib/argv.rb

@@ -1,70 +1,2 @@
-module ARGVEXT
-
-  def flag_tags opts= {}
-    raise(ArgumentError) unless opts.class <= Hash
-
-    opts[:sym_key] ||= opts[:sym] || opts[:sk] || opts[:s]
-
-    return_obj= {}
-    self.count.times do |index|
-
-      next if self[index+1].nil?
-      if self[index][0].include?('-') && !self[index+1][0].include?('-')
-        return_obj[( opts[:sym_key] ?  self[index].dup.to_s.gsub!(/^-*/,'').to_sym :  self[index] )]= self[index+1]
-      end
-
-    end
-    return return_obj
-
-  end
-  alias :flag_value :flag_tags
-  alias :flag_tag   :flag_tags
-  alias :flagtag    :flag_tags
-  alias :flagtags   :flag_tags
-
-  def flag_multi_value opts= {}
-    raise(ArgumentError) unless opts.class <= Hash
-
-    opts[:sym_key] ||= opts[:sym] || opts[:sk] || opts[:s]
-
-
-    return_obj= {}
-    self.count.times do |index|
-
-      begin
-
-        if self[index][0].include?('-') && !self[index+1][0].include?('-')
-
-          new_element= []
-          index_at= index+1
-          loop do
-            if self[index_at].nil? || self[index_at].to_s[0].include?('-')
-              break
-            else
-              new_element.push(self[index_at])
-            end
-            index_at += 1
-          end
-          return_obj[( opts[:sym_key] ?  self[index].dup.to_s.gsub!(/^-*/,'').to_sym :  self[index] )]= new_element
-
-        end
-
-      rescue
-      end
-
-    end
-    return return_obj
-
-  end
-
-  def flags
-    self.select { |e| e[0].include?('-') }
-  end
-
-  def values
-    self.select { |e| !e[0].include?('-') }
-  end
-
-end
-
-ARGV.__send__ :extend,ARGVEXT
+require 'argv/ext'
+require 'argv/cms'

data/lib/argv/cms.rb

@@ -0,0 +1,33 @@
+module ARGVEXT
+  class << self
+
+    @@help_msg_obj ||= []
+    def add_help_msg msg,*keys
+      raise unless msg.class <= String
+      @@help_msg_obj.push [msg,keys]
+      return nil
+    end
+
+    def help_msg
+
+      helper_sym= [:helper,:help,:h]
+      self.add_help_msg "This will show you the help msg (this)",*helper_sym
+      unless ::ARGV.sym_flags.select{ |e| helper_sym.include?(e) }.empty?
+
+        tmp_ary= []
+        @@help_msg_obj.each{ |ary|
+          tmp_ary.push(ary[0])
+          ary[1].each{|e| tmp_ary.push( ( e.to_s.length == 1 ? "-#{e}" : "--#{e}" ) )}
+          tmp_ary.push("")
+        }
+
+        tmp_ary.each{ |element| element.include?('--') ? element.gsub!('--',"\t--") : element.gsub!('-',"\t -")}
+        puts "",tmp_ary.join("\n"),""
+        Process.exit!
+
+      end
+    end
+    alias :show_help :help_msg
+
+  end
+end

data/lib/argv/ext.rb

@@ -0,0 +1,77 @@
+module ARGVEXT
+
+  module EXTENSION
+
+    def to_hash opts= {}
+      raise(ArgumentError) unless opts.class <= Hash
+
+      opts[:sym_key]      ||= opts[:sk] ||  opts[:sym]  || opts[:s]
+      opts[:multi_value]  ||= opts[:mv] ||  opts[:m]
+
+      return_obj= {}
+      self.count.times do |index|
+        unless opts[:multi_value]
+
+          next if self[index+1].nil?
+          if self[index][0].include?('-') && !self[index+1][0].include?('-')
+            return_obj[( opts[:sym_key] ?  self[index].to_s.dup.gsub!(/^-*/,'').to_sym :  self[index] )]= self[index+1]
+          end
+
+        else
+
+          begin
+
+            if self[index][0].include?('-') && !self[index+1][0].include?('-')
+
+              new_element= []
+              index_at= index+1
+              loop do
+                if self[index_at].nil? || self[index_at].to_s[0].include?('-')
+                  break
+                else
+                  new_element.push(self[index_at])
+                end
+                index_at += 1
+              end
+              return_obj[( opts[:sym_key] ?  self[index].to_s.dup.gsub!(/^-*/,'').to_sym :  self[index] )]= new_element
+
+            end
+
+          rescue
+          end
+
+
+        end
+      end
+      return return_obj
+
+    end
+
+    alias :flagtag    :to_hash
+    alias :flagtags   :to_hash
+
+    def flags
+      self.select { |e| e[0].include?('-') }
+    end
+
+    alias :flag :flags
+    alias :tags :flags
+    alias :keys :flags
+
+    def sym_flags
+      self.flags.map { |e| e.to_s.dup.gsub!(/^-*/,'').to_sym }
+    end
+
+    alias :flag_syms  :sym_flags
+    alias :flag_sym   :sym_flags
+    alias :tag_syms   :sym_flags
+    alias :key_syms   :sym_flags
+
+    def values
+      self.select { |e| !e[0].include?('-') }
+    end
+
+  end
+
+end
+ARGV.__send__ :extend,ARGVEXT::EXTENSION

data/sample/test.rb

@@ -1,9 +1,26 @@
-require_relative "../lib/configer.rb"
+require "argv"
 
-Configer.mount_yaml
-Configer.mount_json
+#$ ruby sample/test.rb --test test this ok
+ARGVEXT.help_msg
 
-configer #> config
+puts "","original ARGV:",ARGV.inspect,""
 
-# for example we can call the root/sample/meta/test.yml file parsed data as
-puts configer.sample.meta.test #> { hello: world }
+puts "hash from argv:",ARGV.to_hash,""
+# {"--test"=>"test"}
+
+puts "multi valued hash:",ARGV.to_hash( multi_value: true ),""
+# {"--test"=>["test", "this", "ok"]}
+
+puts "sym keyed hash:",ARGV.to_hash( sym_key: true ),""
+# {:test=>"test"}
+
+puts "sym keyed multi valued hash:",ARGV.to_hash( s: true, m: true ),""
+# {:test=>["test", "this", "ok"]}
+
+puts "argv values without the tags:",ARGV.values.inspect,""
+# ["test", "this", "ok"]
+
+puts "argv tags, \"keys\":",ARGV.keys.inspect,""
+# ["--test"]
+
+puts "symbolized flags:",ARGV.sym_flags.inspect,""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argv
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -55,6 +55,8 @@ files:
 - VERSION
 - argv.gemspec
 - lib/argv.rb
+- lib/argv/cms.rb
+- lib/argv/ext.rb
 - sample/test.rb
 homepage: 
 licenses: []