coulis 0.2.0 → 0.2.5

data/lib/coulis.rb

@@ -2,7 +2,8 @@ require "timeout"
 
 class Coulis
   class << self
-    attr_accessor :_definitions, :bin, :timeout, :no_double_dash
+    attr_accessor :_definitions, :_safe_args, :_help
+    attr_accessor :bin, :timeout, :no_double_dash, :safe_mode
 
     def exec(*args, &block)
       self.new.exec *args, &block
@@ -16,6 +17,10 @@ class Coulis
       @bin = p.to_s
     end
 
+    def _safe_mode(bool=true)
+      @safe_mode = bool
+    end
+
     def _timeout(t)
       @timeout = t
     end
@@ -27,6 +32,30 @@ class Coulis
     def adef(name, option=nil, &block)
       (@_definitions||={})[name.to_sym] = (option || block )
     end
+
+    def help(help_arg="--help")
+      return @_help if @_help && !@_help.empty?
+
+      @_help = options { @args = [help_arg] }.
+        exec.split("\n").map(&:strip)
+    end
+
+    def _safe_args(&block)
+      return @_safe_args if @_safe_args
+      @_safe_args ||= []
+      if block_given?
+        @_safe_args = instance_eval(&block)
+      else
+        help.each do |l|
+          args = l.scan(/(\-{1,2}[\w\-]+)[\W]/)
+          unless args.empty?
+            args.each{|a| @_safe_args << a.to_s}
+          end
+        end
+      end
+
+      return @_safe_args.uniq!
+    end
   end
 
   attr_accessor :args
@@ -148,13 +177,19 @@ class Coulis
       return self
     end
 
-    q = ""
-    q = "'" if args[0].to_s[0..0] != "'"
-    full_arg = [ definition || arg_name , "#{q}#{args[0]}#{q}" ]
+    if args[0].is_a?(Hash) # no value but options
+      full_arg = [ definition || arg_name ]
+      opts = args[0]
+    else
+      q = ""
+      q = "'" if args[0].to_s[0..0] != "'"
+      full_arg = [ definition || arg_name , "#{q}#{args[0]}#{q}" ]
+      opts = args[1]
+    end
 
-    insert_arg(full_arg, args[1])
+    insert_arg(full_arg, opts)
     # delete doublon
-    if args[1] && args[1].has_key?(:uniq)
+    if opts && opts.has_key?(:uniq)
       uniq_arg(definition || arg_name)
     end
     self
@@ -167,7 +202,17 @@ class Coulis
     self
   end
 
+  def safe_arg?(argname)
+    # help parsing issue, so safe mode is off
+    return true if(self.class._safe_args || []).empty?
+    !self.class._safe_args.find{|a| a.to_s == argname.to_s}.nil?
+  end
+
   def insert_arg(arg, opts=nil)
+    if self.class.safe_mode || (opts && opts[:safe] == true)
+      return unless safe_arg?(arg[0])
+    end
+
     if !opts
       @args << arg
       return self
@@ -175,10 +220,12 @@ class Coulis
 
     if arg_to_find = opts[:before] || opts[:after]
       found = @args.find{|a| 
-        a[0] == self.class._definitions[arg_to_find.to_sym] || arg_to_find
+        a[0] == (self.class._definitions[arg_to_find.to_sym] || arg_to_find)
       }
+
       if found && index = @args.index(found)
-        @args.insert(index+1, arg)
+        index+=1 if opts[:after]
+        @args.insert(index, arg)
       end
     else
       @args << arg

data/test/coulis_test.rb

@@ -2,6 +2,8 @@ require "test/unit"
 require "coulis"
 
 class Ls < Coulis
+  _safe_args { help.to_s.match(/ls \[-([\w]+)\]/)[1].chars.to_a }
+
   adef :all, "-a"
   adef :human, "-h"
   adef :full, "-a -h"
@@ -13,6 +15,7 @@ class FFMpeg < Coulis
 end
 
 class Ping < Coulis
+  _safe_args { ["-c"] }
   _bin `whereis ping`.strip
   adef :count, "-c"
 end
@@ -25,6 +28,10 @@ class NSLookup < Coulis
   end
 end
 
+class Curl < Coulis
+  _safe_mode
+end
+
 class SimpleCliTest < Test::Unit::TestCase
   def teardown
     #Ls.new.reset
@@ -33,6 +40,9 @@ class SimpleCliTest < Test::Unit::TestCase
 
   def test_shit
     #p Ls.options { full }
+    ls = Ls.options {
+      all :uniq => true
+    }
   end
 
   def test_default_bin
@@ -243,4 +253,84 @@ class SimpleCliTest < Test::Unit::TestCase
     ffmpeg.input "video2.mp4", :before => "-y", :uniq => true
     assert_equal "ffmpeg -i 'video2.mp4' -y 'out.avi'", ffmpeg.command
   end
+
+  def test_arg_with_no_value_but_options
+    ls = Ls.options {
+      human
+      all :before => :human
+    }
+    assert_equal "ls -a -h", ls.command
+  end
+
+  def test_list_safe_args
+    args = Ls._safe_args
+    assert_instance_of Array, args
+    assert args.size > 0
+    #p args
+
+    args = FFMpeg._safe_args
+    assert_instance_of Array, args
+    assert args.size > 0
+    #p args
+
+    args = Ping._safe_args
+    assert_instance_of Array, args
+    assert args.size > 0
+    #p args
+
+    args = Curl._safe_args
+    assert_instance_of Array, args
+    assert args.size > 0
+    #p args
+  end
+
+  def test_safe_mode_is_true_per_arg
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      nonexistingarg "nio", :safe => true
+    }
+    ffmpeg.fake_arg :safe => true
+    ffmpeg.fake_but_ok
+
+    args = [["nope1", "1"], ["nope2", "2"], ["-y", "output.avi"]]
+    args.each{|k,v| ffmpeg.send(k,v, :safe => true)}
+    assert_equal "ffmpeg -i 'video.mp4' -fake_but_ok -y 'output.avi'", ffmpeg.command
+
+    ping = Ping.options {
+      count 2, :safe => true
+      nope "no", :safe => true
+      nope2 "no2"
+    }
+    assert_equal "/sbin/ping -c '2' --nope2 'no2'", ping.command
+  end
+
+  def test_safe_mode_is_true_per_class
+    FFMpeg._safe_mode
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      nonexistingarg "nio"
+    }
+    assert_equal "ffmpeg -i 'video.mp4'", ffmpeg.command
+
+    curl = Curl.options {
+      request "POST"
+      data "test=ok"
+      url "http://mysite.com/test"
+      fake_arg "ok"
+    }
+
+    assert_equal "curl --request 'POST' --data 'test=ok' --url 'http://mysite.com/test'", curl.command
+  end
+
+  def test_safe_mode_is_off_if_help_parsing_issue
+    FFMpeg._safe_args = nil
+    FFMpeg._help = "ffmpeg help broken"
+    FFMpeg._safe_mode
+
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      nonexistingarg "nio"
+    }
+    assert_equal "ffmpeg -i 'video.mp4' -nonexistingarg 'nio'", ffmpeg.command
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: coulis
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Bruno Celeste
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-03 00:00:00 Z
+date: 2012-07-04 00:00:00 Z
 dependencies: []
 
 description: Simple but powerful CLI Wrapper