coulis 0.1.2 → 0.2.0

data/lib/coulis.rb

@@ -2,7 +2,7 @@ require "timeout"
 
 class Coulis
   class << self
-    attr_accessor :args, :_definitions, :_bin, :timeout
+    attr_accessor :_definitions, :bin, :timeout, :no_double_dash
 
     def exec(*args, &block)
       self.new.exec *args, &block
@@ -12,69 +12,49 @@ class Coulis
       self.new(&block)
     end
 
-    def bin(p)
-      @_bin = p.to_s
+    def _bin(p)
+      @bin = p.to_s
     end
 
     def _timeout(t)
       @timeout = t
     end
 
+    def _no_double_dash
+      @no_double_dash = true
+    end
+
     def adef(name, option=nil, &block)
-      (@_definitions||={})[name.to_sym] = (option || Proc.new { self.instance_eval(&block).flatten })
-    end
-
-    def method_missing(m, args=nil)
-      m = m.to_s.gsub("=", "")
-      @args ||= []
-      definition = @_definitions[m.to_sym] rescue nil
-
-      #puts "m: #{m}, def: #{definition.inspect} | args:#{args}"
-      if definition.is_a?(Proc)
-        definition.call
-      else
-        arg_name = "#{"-" if m[0..0] != "-"}#{m}"
-        arg_name = "-" + arg_name.gsub("_", "-") if arg_name.size > 2
-
-        if args.to_s.empty?
-          @args << [ definition || arg_name ]
-        else
-          q = ""
-          q = "'" if args.to_s[0..0] != "'"
-          @args << [ definition || arg_name , "#{q}#{args}#{q}" ]
-        end
-      end
+      (@_definitions||={})[name.to_sym] = (option || block )
     end
   end
 
   attr_accessor :args
 
   def initialize(&block)
-    self.class.instance_eval(&block) if block_given?
-    @args = self.class.args
-    self.class.args = []
+    @args ||= []
+    self.instance_eval(&block) if block_given?
     self
   end
 
   def options(&block)
-    self.class.args = @args
-    self.class.new(&block)
+    self.instance_eval(&block)
+    self
   end
 
   def remove(*args)
     new_args = []
+    defs = self.class._definitions || {}
     args.each do |a|
-      @args.select {|b| b[0] == (self.class._definitions[a] || "-#{a}")}.each do |b|
+      @args.select {|b| b[0] == (defs[a] || argumentize(a))}.each do |b|
         @args.delete(b)
       end
     end
-    self.class.args = @args
     self
   end
 
   def reset
     @args = []
-    self.class.args = []
   end
 
   def build_args
@@ -82,22 +62,52 @@ class Coulis
     @args.flatten.join(" ")
   end
 
+  def argumentize(argname)
+    argname = "#{"-" if argname.to_s[0..0] != "-"}#{argname}"
+    if !self.class.no_double_dash && argname.size > 2
+      argname = "-" + argname.gsub("_", "-")
+    end
+    argname
+  end
+
+  def value_by_arg(argname)
+    definition = self.class._definitions[argname.to_sym] || argumentize(argname)
+
+    result = @args.find{|a| a[0].to_s == definition.to_s}
+    return if result.nil? 
+
+    value = result[1]
+    return nil if value.nil?
+
+    if value[0..0] == "'" && value[-1..-1]
+      return value[1..-2]
+    else
+      return value
+    end
+  end
+
   def command
-    "#{self.class._bin || self.class.to_s.downcase} #{build_args}".strip
+    "#{self.class.bin || self.class.to_s.downcase} #{build_args}".strip
   end
 
   def fire_command(&block)
     puts command + " (timeout: #{self.class.timeout || -1}) + #{block_given?}" if $DEBUG
-    res = "" unless block_given?
+    res = ""
     IO.popen(command + "  3>&2 2>&1") do |pipe|
       pipe.each("\r") do |line|
+        res << line
         if block_given?
           yield parse_output(line)
-        else
-          res << line
         end
       end
     end
+    if $?.exitstatus != 0
+      @on_error_block.call(res) if @on_error_block.is_a?(Proc)
+      after_error($?, res)
+    else
+      @on_success_block.call(res) if @on_success_block.is_a?(Proc)
+      after_success($?, res)
+    end
     return (block_given? ? $? : parse_output(res))
   end
 
@@ -105,10 +115,74 @@ class Coulis
     output
   end
 
-  def method_missing(m, args=nil)
-    self.class.args = @args
-    self.class.method_missing(m, args)
-    @args = self.class.args
+  def on_error(&block)
+    @on_error_block = block
+    self
+  end
+
+  def on_success(&block)
+    @on_success_block = block
+    self
+  end
+
+  def after_success(proc, res); end
+  def after_error(proc, res); end
+
+  def _timeout(value)
+    self.class.timeout = value
+  end
+
+  def _bin(path)
+    self.class.bin = path
+  end
+
+  def method_missing(m, *args)
+    m = m.to_s.gsub("=", "")
+    @args ||= []
+    definition = self.class._definitions[m.to_sym] rescue nil
+    #puts "m: #{m}, args: #{args.inspect}, definition: #{definition.inspect}"
+    arg_name = argumentize(m)
+
+    if args.to_s.empty?
+      insert_arg [ definition || arg_name ]
+      return self
+    end
+
+    q = ""
+    q = "'" if args[0].to_s[0..0] != "'"
+    full_arg = [ definition || arg_name , "#{q}#{args[0]}#{q}" ]
+
+    insert_arg(full_arg, args[1])
+    # delete doublon
+    if args[1] && args[1].has_key?(:uniq)
+      uniq_arg(definition || arg_name)
+    end
+    self
+  end
+
+  def uniq_arg(arg)
+    if found = @args.find{|a| a[0] == arg}
+      @args.delete found
+    end
+    self
+  end
+
+  def insert_arg(arg, opts=nil)
+    if !opts
+      @args << arg
+      return self
+    end
+
+    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
+      }
+      if found && index = @args.index(found)
+        @args.insert(index+1, arg)
+      end
+    else
+      @args << arg
+    end
     self
   end
 

data/test/coulis_test.rb

@@ -4,14 +4,16 @@ require "coulis"
 class Ls < Coulis
   adef :all, "-a"
   adef :human, "-h"
+  adef :full, "-a -h"
+end
 
-  adef :full do
-    all; human
-  end
+class FFMpeg < Coulis
+  _no_double_dash
+  adef :input, "-i"
 end
 
 class Ping < Coulis
-  bin `whereis ping`.strip
+  _bin `whereis ping`.strip
   adef :count, "-c"
 end
 
@@ -25,8 +27,12 @@ end
 
 class SimpleCliTest < Test::Unit::TestCase
   def teardown
-    Ls.new.reset
-    Ping.new.reset
+    #Ls.new.reset
+    #Ping.new.reset
+  end
+
+  def test_shit
+    #p Ls.options { full }
   end
 
   def test_default_bin
@@ -35,7 +41,7 @@ class SimpleCliTest < Test::Unit::TestCase
 
   def test_defined_bin
     assert_equal Ping.new.command, `whereis ping`.strip
-    assert_equal Ping.new.command, Ping._bin
+    assert_equal Ping.new.command, Ping.bin
   end
 
   def test_adef
@@ -43,9 +49,8 @@ class SimpleCliTest < Test::Unit::TestCase
     assert_equal Ls._definitions[:human], "-h"
   end
 
-  def test_adef_with_block
-    assert_instance_of Proc, Ls._definitions[:full]
-    assert_equal Ls._definitions[:full].call, ["-a", "-h"]
+  def test_adef_with_multiple_args
+    assert_equal Ls._definitions[:full], "-a -h"
   end
 
   def test_argument_added
@@ -53,51 +58,58 @@ class SimpleCliTest < Test::Unit::TestCase
     assert true, ls.args[0] == "-a"
   end
 
-  def test_all_arguments_from_adef_added
-    ls = Ls.options { full }
-    assert_equal ls.args.size, 2
-  end
-
   def test_not_defined_short_argument
-    ls = Ls.options { s }
-    assert_equal ls.args.size, 1
-    assert_equal ls.args.to_s, "-s"
+    ls = Ls.options { g }
+    assert_equal 1, ls.args.size
+    assert_equal "-g", ls.args.to_s
   end
   
   def test_not_defined_long_argument
     ls = Ls.options { color }
-    assert_equal ls.args.size, 1
-    assert_equal ls.args.to_s, "--color"
+    assert_equal 1, ls.args.size
+    assert_equal "--color", ls.args.to_s
   end
 
   def test_not_defined_long_argument_with_underscore
     ls = Ls.options { color_test }
-    assert_equal ls.args.size, 1
-    assert_equal ls.args.to_s, "--color-test"
+    assert_equal 1, ls.args.size
+    assert_equal "--color-test", ls.args.to_s
+  end
+
+  def test_no_double_dash_option
+    ffmpeg = FFMpeg.options { vcodec "libx264" }
+    assert_equal "ffmpeg -vcodec 'libx264'", ffmpeg.command
+  end
+
+  def test_remove_args_if_not_defined
+    ffmpeg = FFMpeg.options { vcodec "libx264" }
+    assert_equal 1, ffmpeg.args.size
+    ffmpeg.remove :vcodec
+    assert_equal 0, ffmpeg.args.size
   end
 
   def test_command
-    assert_equal Ls.options { full; s }.command, "ls -a -h -s"
+    assert_equal "ls -a -h -g", Ls.options { full; g }.command
   end
 
   def test_add_options
     ls = Ls.options { a }
-    assert_equal ls.args.flatten.size, 1
+    assert_equal 1, ls.args.flatten.size
     ls.options { l; h }
-    assert_equal ls.args.flatten.size, 3
+    assert_equal 3, ls.args.flatten.size
 
-    assert_equal ls.command, "ls -a -l -h"
+    assert_equal "ls -a -l -h", ls.command
   end
 
   def test_add_option
     ls = Ls.new
     ls.all
-    assert_equal ls.args.flatten.size, 1
-    assert_equal ls.command, "ls -a"
+    assert_equal 1, ls.args.flatten.size
+    assert_equal "ls -a", ls.command
 
     ls.l
-    assert_equal ls.args.flatten.size, 2
-    assert_equal ls.command, "ls -a -l"
+    assert_equal 2, ls.args.flatten.size
+    assert_equal "ls -a -l", ls.command
   end
 
   def test_add_option_with_args
@@ -105,25 +117,25 @@ class SimpleCliTest < Test::Unit::TestCase
       @args << ["-c", 2] << ["google.com"]
     }
 
-    assert_equal ping.command, "#{Ping._bin} -c 2 google.com"
+    assert_equal ping.command, "#{Ping.bin} -c 2 google.com"
   end
 
   def test_remove_options
     ls = Ls.options { a; l; h }
     ls.remove :a, :h
-    assert_equal ls.command, "ls -l"
+    assert_equal "ls -l", ls.command
 
     ls.reset
     ls.all
     ls.remove :all
-    assert_equal ls.command, "ls"
+    assert_equal "ls", ls.command
   end
 
   def test_reset
     ls = Ls.options { a; l; h }
-    assert_equal ls.command, "ls -a -l -h"
+    assert_equal "ls -a -l -h", ls.command
     ls.reset
-    assert_equal ls.command, "ls"
+    assert_equal "ls", ls.command
   end
 
   def test_exec
@@ -141,7 +153,7 @@ class SimpleCliTest < Test::Unit::TestCase
     end
 
     assert_instance_of Process::Status, process
-    assert_equal process.exitstatus, 0
+    assert_equal 0, process.exitstatus
   end
 
   def test_timeout
@@ -151,7 +163,7 @@ class SimpleCliTest < Test::Unit::TestCase
         _timeout 2
       }.exec
     end
-    assert_equal Ping.timeout, 2
+    assert_equal 2, Ping.timeout
   end
 
   def test_stdout
@@ -174,4 +186,61 @@ class SimpleCliTest < Test::Unit::TestCase
       assert true, ips.size > 1
     end
   end
+
+  def test_success_event
+    process = Ls.options {
+      all
+    }.on_success {|out| 
+      assert_instance_of Process::Status, $?
+      assert_equal 0, $?.exitstatus
+      assert_instance_of String, out
+    }.exec {|out| 
+      assert_instance_of String, out
+    }
+  end
+
+  def test_error_event
+    process = Ls.options {
+      @args = ["/not/a/path"]
+    }.on_error {|out|
+      assert_instance_of Process::Status, $?
+      assert_equal 1, $?.exitstatus
+      assert_instance_of String, out
+    }.exec {|out| 
+      assert_instance_of String, out
+    }
+  end
+
+  def test_getting_value_by_arg
+    ffmpeg = FFMpeg.options { input "video.mp4"; vcodec "libx264"}
+    assert_equal "video.mp4", ffmpeg.value_by_arg(:input)
+    assert_equal "libx264", ffmpeg.value_by_arg(:vcodec)
+  end
+
+  def test_adding_arg_before_another
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      y "out.avi"
+      vcodec "libx264", :before => "-y"
+    }
+    assert_equal "ffmpeg -i 'video.mp4' -vcodec 'libx264' -y 'out.avi'", ffmpeg.command
+  end
+
+  def test_adding_arg_after_another
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      y "out.avi"
+    }
+    ffmpeg.vcodec "libx264", :after => :input
+    assert_equal "ffmpeg -i 'video.mp4' -vcodec 'libx264' -y 'out.avi'", ffmpeg.command
+  end
+
+  def test_adding_uniq_arg
+    ffmpeg = FFMpeg.options {
+      input "video.mp4"
+      y "out.avi"
+    }
+    ffmpeg.input "video2.mp4", :before => "-y", :uniq => true
+    assert_equal "ffmpeg -i 'video2.mp4' -y 'out.avi'", ffmpeg.command
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: coulis
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bruno Celeste
@@ -14,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-23 00:00:00 +02:00
-default_executable: 
+date: 2012-07-03 00:00:00 Z
 dependencies: []
 
 description: Simple but powerful CLI Wrapper
@@ -29,7 +29,6 @@ extra_rdoc_files: []
 files: 
 - lib/coulis.rb
 - test/coulis_test.rb
-has_rdoc: true
 homepage: http://github.com/sadikzzz/coulis
 licenses: []
 
@@ -39,23 +38,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple CLI Wrapper