benzo 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+  - ree
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benzo.gemspec
+gemspec
+
+gem 'awesome_print'
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Spike Grobstein
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# Benzo  [![Build Status](https://travis-ci.org/spikegrobstein/benzo.png)](https://travis-ci.org/spikegrobstein/benzo)
+
+*Take the edge off when doing (command) lines.*
+
+Wrapping [Cocaine](https://github.com/thoughtbot/cocaine), this library will
+greatly simplify building complex and conditional commandline arguments.
+
+This is especially useful when creating wrappers for other commandline tools.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'benzo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benzo
+
+## Quickstart Example
+
+Given that you want to make a call to `pg_dump`, but depending on some conditions
+in your code, you may want to have certain arguments shown or not shown:
+
+```ruby
+# the state of our app:
+@verbose = true
+@database = 'app_production'
+@file = 'app_prod-dump'
+
+# build the Cocaine::Commandline with Benzo
+line = Benzo.line('pg_dump', {
+  '-v' => @verbose,
+  '--schema-only' => @schema_only, # note, @schema_only is nil
+  '-f :filename' => @file,
+  ':db_name' => @database
+})
+
+line.run # execute the command
+```
+
+Benzo takes 2 arguments: `command` and `options_map`. The command is, like in
+`cocaine`, the command you wish to run, and `options_map` is a hash containing
+the data necessary to build the commandline arguments.
+
+Any value in the hash that evaluates to `false` (this includes `nil`) will be
+omitted from the command.
+
+## How options_map works
+
+`options_map` is a hash that gets processed by `Benzo` to create the
+`Cocaine::CommandLine` object. The hash gets iterated over and any values that
+evaluate to `false` are discarded, then the keys are concatinated together with
+spaces to create the commandline arguments that are passed to `cocaine`. Any
+symbols embedded in those strings will be used to build the variables to be
+interpolated by `cocaine`.
+
+Given the following `options_map`:
+
+```ruby
+{
+  '-f :file' => "file.dat",
+  "-v" => true,
+  "-d" => false,
+  ":data" => nil
+}
+```
+
+The resulting command's arguments will be built as `-f 'file.dat' -v` omitting the
+`-d` and `:data` values because the values of the hash evaluated to false.
+
+When `Benzo` looks at the keys, it tries to find a symbol (a string leading with
+a `:`). It will then use that as the key for whatever value it points to when
+building the commandline. For example, `'-f :file' => 'file.dat'` will set `:file`
+to `'file.dat'` when passing it to `cocaine`.
+
+You can also pass a symbol as a key directly to the `options_map`, which will be
+passed directly to `cocaine` when building the commandline. This is useful if you
+want to use the `Logger` or `:expected_outcodes` facilities in `cocaine`. For
+example (modified from one of the `cocaine` examples):
+
+```ruby
+line = Benzo.line('/usr/bin/false', {
+  :expected_outcodes => [ 0, 1 ]
+})
+
+begin
+  line.run
+rescue Cocaine::ExitStatusError => e
+  # => You never get here!
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgements
+
+Benzo is written by Spike Grobstein, and wraps [Cocaine](https://github.com/thoughtbot/cocaine) by
+[Thoughtbot](http://www.thoughtbot.com)
+
+## Author
+
+Spike Grobstein  
+me@spike.cx  
+http://spike.grobste.in  
+https://github.com/spikegrobstein
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/benzo.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/benzo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Spike Grobstein"]
+  gem.email         = ["me@spike.cx"]
+  gem.description   = %q{Take the edge off when doing (command) lines.}
+  gem.summary       = %q{A robust mapper for complex commandline calls using cocaine.}
+  gem.homepage      = "https://github.com/spikegrobstein/benzo"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "benzo"
+  gem.require_paths = ["lib"]
+  gem.version       = Benzo::VERSION
+
+  gem.add_dependency 'cocaine'
+end

data/lib/benzo/version.rb

@@ -0,0 +1,3 @@
+class Benzo
+  VERSION = "1.0.0"
+end

data/lib/benzo.rb

@@ -0,0 +1,68 @@
+require "benzo/version"
+require 'cocaine'
+
+class Benzo
+
+  attr_accessor :command, :options_map
+  attr_accessor :line, :vars
+
+  def initialize(command, options_map)
+    @command = command
+    @options_map = options_map
+    @line = []
+    @vars = {}
+
+    map!
+  end
+
+  # convenience method for creating a new Benzo object with the given
+  # arguments and returning the Cocaine::Commandline
+  def self.line(command, options_map)
+    b = new(command, options_map)
+    line = b.to_cocaine
+
+    b = nil
+    line
+  end
+
+  # convert this object into a Cocaine::CommandLine
+  def to_cocaine
+    ::Cocaine::CommandLine.new(@command, @line.join(' '), @vars)
+  end
+
+  private
+
+  # iterate over the options map and build
+  # this object's mapping.
+  def map!
+    @options_map.each do |k,v|
+      sym = if k.is_a? Symbol
+        k
+      else
+        @line << k if v
+        sym = get_symbol(k)
+      end
+
+      if sym
+        @vars[sym] = v
+      end
+    end
+  end
+
+  # given a string, pull out the symbol
+  # this is used to get the key for the variable to pass to cocaine.
+  # returns nil if no symbol found
+  # raises an ArgumentError if the symbol isn't well-formed (has bad chars)
+  def get_symbol(str)
+    m = str.match /:(\S+)/
+
+    return nil unless m
+    sym = m[1]
+
+    raise ArgumentError if sym.match(/[^a-z0-9_]/i)
+
+    :"#{sym}"
+  end
+
+
+end

data/spec/benzo_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Benzo do
+
+  let(:benzo) { Benzo.new 't', {} }
+
+  context "#map!" do
+
+    it "should append to @line if v evaluates to true" do
+      benzo.options_map = { ':file_name' => 'demo.dat' }
+      benzo.send(:map!)
+
+      benzo.line.count.should == 1
+      benzo.line.first.should == ':file_name'
+    end
+
+    it "should not append to @line if v is nil" do
+      benzo.options_map = { ':file_name' => nil }
+      benzo.send(:map!)
+
+      benzo.line.count.should == 0
+    end
+
+    it "should not append to @line if v is false" do
+      benzo.options_map = { ':file_name' => false }
+      benzo.send(:map!)
+
+      benzo.line.count.should == 0
+    end
+
+    it "should add to @vars if there's a symbol in the string" do
+      benzo.options_map = { ':file_name' => 'demo.dat' }
+      benzo.send(:map!)
+
+      benzo.vars.keys.count.should == 1
+      benzo.vars.keys.first.should == :file_name
+    end
+
+    it "should not add to @vars if there's no symbol in the string" do
+      benzo.options_map = { '-v' => true }
+      benzo.send(:map!)
+
+      benzo.vars.keys.count.should == 0
+    end
+
+    it "should append the value to @vars if the key is a symbol" do
+      benzo.options_map = { :logger => 'this_logger' }
+      benzo.send(:map!)
+
+      benzo.vars[:logger].should_not be_nil
+    end
+
+  end
+
+  context "#get_symbol" do
+
+    def get_symbol(str)
+      benzo.send(:get_symbol, str)
+    end
+
+    it "should find the symbol" do
+      get_symbol('-f :file').should == :file
+    end
+
+    it "should return the first symbol it finds" do
+      get_symbol('-a :file :gooop').should == :file
+    end
+
+    it "should find symbols with underscores" do
+      get_symbol('-d :db_name').should == :db_name
+    end
+
+    it "should find symbols with capital letters" do
+      get_symbol(':FileName').should == :FileName
+    end
+
+    it "should raise an error if the symbol has other chars" do
+      lambda { get_symbol('-q :what?') }.should raise_error
+    end
+
+    it "should raise an error when encountering symbols with dash" do
+      lambda { get_symbol('-f :this-that') }.should raise_error
+    end
+
+    it "should not include dots in the symbol" do
+      lambda { get_symbol('-f :file.ext') }.should raise_error
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'awesome_print'
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'benzo'
+
+def fixture_path(filename)
+  File.join( File.dirname(__FILE__), 'fixtures', filename )
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: benzo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Take the edge off when doing (command) lines.
+email:
+- me@spike.cx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- benzo.gemspec
+- lib/benzo.rb
+- lib/benzo/version.rb
+- spec/benzo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spikegrobstein/benzo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A robust mapper for complex commandline calls using cocaine.
+test_files:
+- spec/benzo_spec.rb
+- spec/spec_helper.rb
+has_rdoc: