ruby-unix-now 0.0.0

data/README.md

@@ -0,0 +1,69 @@
+# run | Ruby Unix Now
+A tiny library which attempts to bridge the gap between ruby code and executing system commands. No more more string concatenation to build up commands. 
+
+The simplest way to execute a command in ruby is to embed your command in backticks. 
+
+    `whoami` #=> john
+
+So far, so good. Using run, the equivalent command would be 
+    run :whoami
+  
+Not much difference. However, as soon as we start to introduce arguments, conditional logic and so on, string concatenation and backticks starts to get ugly.
+
+    command = "rsync -r, --progress"
+    command << " -z -h " if condition_x
+    command << " --from #{from_path} --to #{to_path}"
+    `#{command}`
+  
+Run tries to solve these problems my making it easy to
+
+  1. Embed variables
+  2. Add optional arguments
+  3. Lay out complicated commands
+
+It does this just by assigning meaning to the standard Ruby structures. 
+  
+  - Hashes are options
+  - Symbols are either commands or flags
+  - Strings are values
+  - Arrays are lists of options
+
+The equivalent run command to the one above would be
+
+    options = {}
+    options.merge!(:z, :h) if condition_x_
+    run :rsync, :r, :progress, options, --from from_path, --to to_path
+  
+Nore more embedding variables in string, no more arbitrary spaces to make 
+strings glue together correctly.
+
+Another example taken from a real life script
+
+Normal commands
+  
+    `mkdir -p #{xapian_path}`
+    `rm -r -f #{to`
+    `cp -r, #{from} #{to}`
+  
+With Run
+
+    run :mkdir, :p, xapian_path
+    run :rm, :r, :f, to
+    run :cp, :r, from, to
+
+Run also helps you along with some other common scenarios, such as aborting on error and echoing commands as they are executed. 
+
+If we want to check that the backtick command ran successfully, we have to add more code
+
+    unless $?.success?
+      'Ohoh'
+      exit -1
+    end
+  
+Run will by default raise an exception, but you can also configure it to exit with an error message.
+
+## More examples
+
+    psql = ['psql', :d, source['database'], auth]
+    input = ['pg_dump', :i, auth, '--data-only', :table,'xapian_texts', config['database']]
+    run input, '|', psql

data/lib/ruby-unix-now.rb

@@ -0,0 +1,57 @@
+
+def log(msg, level = 0)
+  puts (' ' * (level * 2)) + '# ' + msg
+end
+
+def run(*arguments)
+  options = (arguments.last.is_a?(Hash) && arguments.pop) || {}
+  cmd = expand_cmd(*arguments)
+  log(cmd)
+  result = if options[:sync]
+    `#{cmd}`
+  else
+    system(cmd)
+  end
+  unless $?.success?
+    exit -1
+  end
+  result
+end
+
+def expand_cmd(*arguments)
+  command = arguments.shift.to_s
+  cmd = command + ' ' + arguments.map{|a| a.to_cmd_opt}.join(' ')
+end
+
+class Symbol
+  def to_cmd_opt
+    string = to_s
+    if string.length == 1
+      '-' + string
+    else
+      '--' + string
+    end
+  end
+end
+
+class Array
+  def to_cmd_opt
+    map{|a| a.to_cmd_opt}.join(' ')
+  end
+end
+
+class String
+  def to_cmd_opt
+    self
+  end
+end
+
+class Hash
+  def to_cmd_opt(style = :gnu)
+    map do |key, value| 
+      prefix = ((style == :gnu && key.to_s.size > 1) ? '--' : '-')
+      assignment = (key.to_s.size == 1 || style == :unix) ? ' ' : '='
+      value.is_a?(TrueClass) ? "#{prefix}#{key}" : "#{prefix}#{key}#{assignment}#{value}"
+    end.join(' ')
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-unix-now
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tor Erik Linnerud
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A tiny library which attempts to bridge the gap between ruby code and executing system commands. No more more string concatenation to build up commands.
+email: tel@jklm.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- lib/ruby-unix-now.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/toreriklinnerud/ruby-unix-now
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Run system commands using the best of ruby syntax: symbols, hashes and arrays."
+test_files: []
+