dotanuki 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dotanuki.gemspec
+gemspec
+
+group :test do
+	gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,27 @@
+Dotanuki
+========
+
+Simple but effective executioner of commands, which will deal correctly with
+failed commands.
+
+Examples
+========
+In the following example, if the mkdir fails, none of the other commands will
+be executed.
+
+	class Foo
+		include 'dotanuki'
+
+		def test
+			commands = [
+				"mkdir /tmp/foo",
+				"cd /tmp/foo",
+				"cp /etc/hosts ."
+			]
+
+			result = execute(commands)
+			if result.failed?
+				puts "execution failed: #{result.fail_message}"
+			end
+		end
+	end

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'metric_fu'
+

data/dotanuki.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dotanuki/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dotanuki"
+  s.version     = Dotanuki::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Martin Englund"]
+  s.email       = ["martin@englund.nu"]
+  s.homepage    = "https://github.com/pmenglund/dotanuki"
+  s.summary     = %q{Command executioner}
+  s.description = %q{A command executioner which doesn't blindly stumble on when a command fails'}
+
+  s.rubyforge_project = "dotanuki"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "popen4"
+
+  #s.add_test_dependency "rspec"
+
+end

data/lib/dotanuki.rb

@@ -0,0 +1,82 @@
+require 'popen4'
+
+module Dotanuki
+
+  # thrown when an execution error occurs
+  class ExecError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+  # class for the result of an execution of one or more commands
+  class ExecResult
+    attr_reader :stdout, :stderr, :status, :failed_index
+    def initialize(out, err, status, failed_index=nil)
+      @stdout = out
+      @stderr = err
+      @status = status
+      @failed_index = failed_index
+    end
+
+    def failed?
+      status != 0
+    end
+
+    def fail_message
+      stderr[@failed_index]
+    end
+  end
+
+  # commands can be a string or an array of strings
+  def execute(commands, options={})
+    validate_options(options)
+
+    stdout = []
+    stderr = []
+    exit_status = 0
+    failed = nil
+    index = 0
+
+    [commands].flatten.each do |command|
+      out, err, ex = _execute(command, options)
+      stdout << out
+      stderr << err
+      exit_status = ex
+      if options[:on_error] == :exception
+        if exit_status.nil?
+          raise ExecError, "#{command}: command not found"
+        elsif exit_status != 0
+          raise ExecError, stderr[index]
+        end
+      elsif exit_status.nil? || exit_status != 0
+        failed = index
+        break
+      end
+      index += 1
+    end
+
+    return ExecResult.new(stdout, stderr, exit_status, failed)
+  end
+
+  def _execute(command, options={})
+    stdout = stderr = ""
+
+    status =
+      POpen4::popen4(command) do |out, err, stdin, pid|
+        stdout = out.read.chomp
+        stderr = err.read.chomp
+      end
+
+    return stdout, stderr, status ? status.exitstatus : status
+  end
+
+  def validate_options(options)
+    options.each do |option, value|
+      if option == :on_error && value != :exception
+        raise ArgumentError, "illegal value for option #{option}: #{value}" 
+      end
+      raise ArgumentError, "illegal option: #{option}" if option != :on_error
+    end
+  end
+end

data/lib/dotanuki/version.rb

@@ -0,0 +1,3 @@
+module Dotanuki
+  VERSION = "0.0.1"
+end

data/spec/dotanuki_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Dotanuki do
+
+  class C
+    include Dotanuki
+  end
+  
+  before :all do
+    @c = C.new
+  end
+
+  NON_EXISTING_PATH = "/not/an/existing/program"
+  COMMAND_NOT_FOUND = NON_EXISTING_PATH
+  COMMAND_FAILED = "ls -d #{NON_EXISTING_PATH}"
+
+  EXISTING_PATH = "/"
+  EXISTING_COMMAND = "ls -d #{EXISTING_PATH}"
+
+  describe "execute" do
+    
+    describe "missing command" do
+      it "should stop on first" do
+        r = @c.execute([COMMAND_NOT_FOUND, EXISTING_COMMAND])
+        r.failed_index.should == 0
+      end
+
+      it "should stop on last" do
+        r = @c.execute([EXISTING_COMMAND, COMMAND_NOT_FOUND])
+        r.failed_index.should == 1
+      end
+
+      it "should return nil when not found" do
+        @c.execute([EXISTING_COMMAND, COMMAND_NOT_FOUND]).status.should be_nil
+      end
+
+      it "should return nil when not found" do
+        @c.execute([COMMAND_NOT_FOUND, EXISTING_COMMAND]).status.should be_nil
+      end
+    end
+
+    describe "failing command" do
+
+      it "should stop when the first fails" do
+        r = @c.execute([COMMAND_FAILED, "id", "id"])
+        r.failed_index.should == 0
+        r.status.should_not == 0
+      end
+
+      it "should stop on failure" do
+        r = @c.execute(["id", COMMAND_FAILED, "id"])
+        r.failed_index.should == 1
+        r.status.should_not == 0
+      end
+
+      it "should stop when the last fails" do
+        r = @c.execute(["id", "id", COMMAND_FAILED])
+        r.failed_index.should == 2
+        r.status.should_not == 0
+      end
+
+      it "should not return 0" do
+        @c.execute(COMMAND_FAILED).status.should_not == 0
+      end
+
+      it "should capture stderr" do
+        r = @c.execute(COMMAND_FAILED)
+        r.stderr[0].should == "ls: #{NON_EXISTING_PATH}: No such file or directory"
+      end
+
+    end
+
+    it "should return 0 when the command succeeds" do
+      @c.execute("ls -d /").status.should == 0
+    end
+  
+    it "should execute all commands in an array" do
+      r = @c.execute(["id", "ls -d /", "id"])
+      r.status.should == 0
+      r.stdout.size.should == 3
+      r.stderr.size.should == 3
+    end
+  
+    it "should execute a single command" do
+      r = @c.execute("echo 'bar'")
+      r.status.should == 0
+      r.stdout.should == ["bar"]
+      r.stderr.should == [""]
+    end
+  
+    it "should execute a single command" do
+      @c._execute("echo 'foo'").should == ["foo", "", 0]
+    end
+
+    describe "with exception option should throw an exception" do
+      it "on missing command" do
+        lambda { @c.execute(COMMAND_NOT_FOUND, {:on_error => :exception}) }.should raise_error Dotanuki::ExecError, "#{NON_EXISTING_PATH}: command not found"
+      end
+
+      it "exception failing" do
+        lambda { @c.execute(COMMAND_FAILED, {:on_error => :exception}) }.should raise_error Dotanuki::ExecError, "ls: #{NON_EXISTING_PATH}: No such file or directory"
+      end
+    end
+
+    it "should raise an error on invalid options" do
+      lambda { @c.execute(COMMAND_NOT_FOUND, {:on_error => :asd}) }.should raise_error ArgumentError
+    end
+
+    it "should raise an error on invalid option argument" do
+      lambda { @c.execute(COMMAND_NOT_FOUND, {:asd => :asd}) }.should raise_error ArgumentError
+    end
+
+    it "should supply correct info on a failing command" do
+      r = @c.execute("ls /asd")
+      r.failed?.should be_true
+      r.fail_message.should_not be_empty
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift('./lib')
+require 'dotanuki'
+require 'rspec'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: dotanuki
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Martin Englund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: popen4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A command executioner which doesn't blindly stumble on when a command fails'
+email: 
+- martin@englund.nu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dotanuki.gemspec
+- lib/dotanuki.rb
+- lib/dotanuki/version.rb
+- spec/dotanuki_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/pmenglund/dotanuki
+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: dotanuki
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Command executioner
+test_files: 
+- spec/dotanuki_spec.rb
+- spec/spec_helper.rb