ion1-mischacks 0.0.1

data/COPYING

@@ -0,0 +1,13 @@
+Copyright © 2009 Johan Kiviniemi
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2009-06-28
+
+* Initial release
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+COPYING
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/mischacks.rb
+mischacks.gemspec
+spec/mischacks_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,39 @@
+= MiscHacks
+
+* http://johan.kiviniemi.name/software/mischacks/
+
+== DESCRIPTION:
+
+Safely pass parameters to sh scripts.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+  MiscHacks.sh %q{
+    diff -u "$1" "$2" | tr a-z A-Z >"$output"
+  }, '/dev/null', '/etc/motd', :output => 'foo'
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install ion1-mischacks --source http://gems.github.com/
+
+== LICENSE:
+
+Copyright © 2009 Johan Kiviniemi
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+# mischacks – Miscellaneous methods that may or may not be useful
+# Copyright © 2009 Johan Kiviniemi
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)+'/lib')
+
+require 'rubygems'
+
+require 'hoe'
+require 'rake'
+require 'rake/clean'
+
+task :default => :spec
+
+Hoe.spec 'mischacks' do
+  developer 'Johan Kiviniemi', 'devel@johan.kiviniemi.name'
+end
+
+# http://blog.behindlogic.com/2008/10/auto-generate-your-manifest-and-gemspec.html
+desc "Generate manifest, gemspec"
+task :cultivate do
+  system 'touch Manifest.txt; rake -s check_manifest | patch'
+  system 'rake -s debug_gem >"$(basename "$(pwd)")".gemspec'
+end
+
+# vim:set et sw=2 sts=2:

data/lib/mischacks.rb

@@ -0,0 +1,91 @@
+# mischacks – Miscellaneous methods that may or may not be useful
+# Copyright © 2009 Johan Kiviniemi
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+module MiscHacks
+  VERSION = '0.0.1'
+
+  class ChildError < RuntimeError
+    attr_reader :status
+
+    def initialize status
+      @status = Integer status
+      super "Child failed with status #{status}"
+    end
+  end
+
+  def self.checking_exit_status
+    fork do
+      yield
+    end.tap do |pid|
+      _, status = Process.wait2 pid
+      raise ChildError, status.exitstatus if status.exitstatus != 0
+    end
+
+    nil
+  end
+
+  def self.do_and_exit bang=false
+    my_exit = if bang then method :exit! else method :exit end
+
+    status = 1
+    begin
+      yield
+    rescue SystemExit => e
+      status = e.status
+    ensure
+      my_exit.call status
+    end
+  end
+
+  def self.do_and_exit! &block
+    do_and_exit true, &block
+  end
+
+  def self.sh cmd, *args
+    env = if args.last.is_a? Hash then args.pop else {} end
+
+    checking_exit_status do
+      do_and_exit! do
+        begin
+          env.each_pair do |k, v| ENV[k.to_s] = v.to_s end
+          exec *(%W{sh -e -c #{cmd} sh} + args.map {|a| a.to_s })
+        rescue Exception => e
+          warn e.to_formatted_string
+        end
+      end
+    end
+
+    nil
+  end
+end
+
+module MiscHacks
+  module ExceptionMixin
+    def to_formatted_string
+      bt   = backtrace.dup
+      head = bt.shift
+      (
+        ["#{head}: #{self} (#{self.class})"] +
+        bt.map do |l| "\tfrom #{l}" end
+      ).map do |l| "#{l}\n" end.join
+    end
+  end
+end
+
+Exception.class_eval do
+  include MiscHacks::ExceptionMixin
+end
+
+# vim:set et sw=2 sts=2:

data/mischacks.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mischacks}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Johan Kiviniemi"]
+  s.date = %q{2009-06-28}
+  s.description = %q{Safely pass parameters to sh scripts.}
+  s.email = ["devel@johan.kiviniemi.name"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["COPYING", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/mischacks.rb", "mischacks.gemspec", "spec/mischacks_spec.rb", "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://johan.kiviniemi.name/software/mischacks/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mischacks}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Safely pass parameters to sh scripts.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 2.3.1"])
+    else
+      s.add_dependency(%q<hoe>, [">= 2.3.1"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 2.3.1"])
+  end
+end

data/spec/mischacks_spec.rb

@@ -0,0 +1,170 @@
+# mischacks – Miscellaneous methods that may or may not be useful
+# Copyright © 2009 Johan Kiviniemi
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require File.expand_path(File.dirname(__FILE__)+'/spec_helper.rb')
+require 'mischacks'
+
+require 'digest/sha1'
+
+mh = MiscHacks
+ce = MiscHacks::ChildError
+
+describe mh do
+  describe 'checking_exit_status' do
+    it 'should raise an error when child fails' do
+      lambda do mh.checking_exit_status do exit  1 end end.should raise_error ce
+      lambda do mh.checking_exit_status do exit! 1 end end.should raise_error ce
+
+      lambda do mh.checking_exit_status do exit  0 end end.should_not raise_error
+      lambda do mh.checking_exit_status do exit! 0 end end.should_not raise_error
+    end
+
+    it 'should handle exec' do
+      lambda do mh.checking_exit_status do exec 'false' end end.should raise_error ce
+      lambda do mh.checking_exit_status do exec 'true'  end end.should_not raise_error
+    end
+  end
+
+  describe 'do_and_exit' do
+    it 'should have an exit status of 1 when the block does not exit' do
+      lambda do
+        mh.do_and_exit do end
+        exit 2  # Should never reach this.
+      end.should exit_with 1
+    end
+
+    it 'should have the proper exit status when the block exits' do
+      [0, 1, 42, 255].each do |i|
+        lambda do
+          mh.do_and_exit do exit i end
+          exit 2  # Should never reach this.
+        end.should exit_with i
+      end
+    end
+
+    it 'should handle exec' do
+      [0, 1, 42, 255].each do |i|
+        lambda do
+          mh.do_and_exit do exec *%W{sh -c #{'exit "$1"'} sh #{i}} end
+          exit 2  # Should never reach this.
+        end.should exit_with i
+      end
+    end
+
+    it 'should handle exit! and plain exit' do
+      lambda do
+        begin
+          mh.do_and_exit do end
+        rescue SystemExit => e
+          exit 2
+        end
+      end.should exit_with 2
+
+      lambda do
+        begin
+          mh.do_and_exit true do end
+        rescue SystemExit => e
+          exit 2  # Should never reach this.
+        end
+      end.should exit_with 1
+
+      lambda do
+        begin
+          mh.do_and_exit! do end
+        rescue SystemExit => e
+          exit 2  # Should never reach this.
+        end
+      end.should exit_with 1
+    end
+  end
+
+  describe 'sh' do
+    unsafe_str = %q{" 'foo' $(bar) `baz` "}
+    checksum   = Digest::SHA1.hexdigest unsafe_str
+
+    it "should raise #{ce} on error" do
+      good = ['true', '', 'printf ""']
+      bad  = ['false', 'exit 2', 'return 2']
+
+      bad.each do |c|
+        lambda do mh.sh c end.should raise_error ce
+      end
+
+      good.each do |c|
+        lambda do mh.sh c end.should_not raise_error
+      end
+    end
+
+    it 'should call sh with -e' do
+      lambda do mh.sh 'false; true' end.should raise_error ce
+    end
+
+    it 'should pass normal parameters safely' do
+      test = lambda do |str, sha|
+        mh.sh %q{
+          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
+          trap 'rm -f "$temp"' 0 1 2 13 15
+          printf "%s" "$1" >"$temp"
+          printf "%s *%s\n" "$2" "$temp" | sha1sum -c >/dev/null 2>&1
+        }, str, sha
+      end
+
+      lambda do test.call unsafe_str, checksum end.should_not raise_error
+      lambda do test.call 'foo',      checksum end.should raise_error ce
+    end
+
+    it 'should pass environment variables safely' do
+      test = lambda do |str, sha|
+        mh.sh %q{
+          temp="$(mktemp -t mischacks.XXXXXXXXXX)"
+          trap 'rm -f "$temp"' 0 1 2 13 15
+          printf "%s" "$string" >"$temp"
+          printf "%s *%s\n" "$checksum" "$temp" | sha1sum -c >/dev/null 2>&1
+        }, :string => str, :checksum => sha
+      end
+
+      lambda do test.call unsafe_str, checksum end.should_not raise_error
+      lambda do test.call 'foo',      checksum end.should raise_error ce
+    end
+  end
+
+  describe 'ExceptionMixin to_formatted_string' do
+    it 'should return the proper string for an exception' do
+      klass = Class.new RuntimeError
+
+      begin
+        raise klass, 'foo'
+
+      rescue klass => e
+        lines = e.to_formatted_string.split /\n/
+        head  = lines.shift
+
+        e_class_re  = Regexp.quote e.class.to_s
+        e_msg_re    = Regexp.quote e.to_s
+        filename_re = Regexp.quote File.basename(__FILE__)
+
+        head_re = %r{\A.+/#{filename_re}:\d+: #{e_msg_re} \(#{e_class_re}\)\z}
+        head.should match head_re
+
+        lines.length.should == caller.length
+        lines.zip caller do |a, b|
+          a.should == "\tfrom #{b}"
+        end
+      end
+    end
+  end
+end
+
+# vim:set et sw=2 sts=2:

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# mischacks – Miscellaneous methods that may or may not be useful
+# Copyright © 2009 Johan Kiviniemi
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)+'/../lib')
+
+require 'mischacks'
+
+Spec::Matchers.define :exit_with do |expected|
+  match do |block|
+    @status = 0
+
+    begin
+      MiscHacks.checking_exit_status do
+        block.call
+      end
+    rescue MiscHacks::ChildError => e
+      @status = e.status
+    end
+
+    @status.eql? expected
+  end
+
+  failure_message_for_should do |block|
+    "expected exit value #{expected}, got #{@status}"
+  end
+
+  failure_message_for_should do |block|
+    "did not expect exit value #{@status}"
+  end
+end
+
+# vim:set et sw=2 sts=2:

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ion1-mischacks
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Johan Kiviniemi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.1
+    version: 
+description: Safely pass parameters to sh scripts.
+email: 
+- devel@johan.kiviniemi.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- COPYING
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/mischacks.rb
+- mischacks.gemspec
+- spec/mischacks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://johan.kiviniemi.name/software/mischacks/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: mischacks
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Safely pass parameters to sh scripts.
+test_files: []
+