tango 0.0.6 → 0.0.7

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
+tmp/*
 *.gem
 .bundle
 .DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tango (0.0.6)
+    tango (0.0.7)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -73,6 +73,44 @@ Running the Example
 
     tango example_installer.rb ExampleInstaller.install
 
+Useful Helper Methods
+---------------------
+
+### Running Shell Commands
+
+    step "install something" do
+      result = shell("apt-get", "install", "something")
+      if result.succeeded?
+        write("/tmp/something-install.log", result.output)
+      end
+    end
+
+### Writing Config Files
+
+    step "configure foo" do
+      @log_directory = "/var/log/foo.log"
+      write "/etc/foo.conf", <<-EOF
+        # Config file for foo
+        log_file <%= @log_file %>
+      end
+    end
+
+### Changing the Working Directory
+
+    step "migrate" do
+      cd "/rails_apps/blog" do
+        shell "rake db:migrate"
+      end
+    end
+
+### Running As Another User
+
+    step "..." do
+      as "fred" do
+        FileUtils.touch("/home/fred/fred_woz_ere")
+      end
+    end
+
 Copyright
 ---------
 

data/lib/tango/config_files.rb

@@ -0,0 +1,20 @@
+require 'erb'
+
+module Tango
+  module ConfigFiles
+
+    def write(path, contents)
+      contents = unindent(contents)
+      contents = ERB.new(contents).result(binding)
+      File.open(path, "w") {|file| file.write(contents) }
+    end
+
+  private
+
+    def unindent(text)
+      indent = /^ */.match(text)
+      text.gsub(/^#{indent}/, "")
+    end
+
+  end
+end

data/lib/tango/runner.rb

@@ -1,14 +1,18 @@
 require 'tango/as_user'
+require 'tango/config_files'
 require 'tango/delegate'
 require 'tango/met_and_meet'
 require 'tango/shell'
+require 'tango/working_directory'
 
 module Tango
   class Runner
     include AsUser
+    include ConfigFiles
     include Delegate
     include MetAndMeet
     include Shell
+    include WorkingDirectory
     
     def self.step(step_name, &block)
       define_method(step_name) do |*args|

data/lib/tango/version.rb

@@ -1,3 +1,3 @@
 module Tango
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/tango/working_directory.rb

@@ -0,0 +1,15 @@
+module Tango
+  module WorkingDirectory
+
+    def cd(directory)
+      old_directory = Dir.getwd
+      begin
+        Dir.chdir(directory)
+        yield
+      ensure
+        Dir.chdir(old_directory)
+      end
+    end
+
+  end
+end

data/spec/config_files_spec.rb

@@ -0,0 +1,51 @@
+require 'tango'
+
+module Tango
+  describe ConfigFiles do
+
+    before do
+      stub_class = Class.new do
+        include ConfigFiles
+
+        attr_accessor :world
+      end
+      @stub = stub_class.new
+
+      # Clear out the tmp directory before each test.
+      Dir.glob("tmp/*").each {|path| File.delete(path) }
+    end
+
+    it "should write a file" do
+      @stub.write("tmp/example.conf", "Hello, world!")
+      File.should exist("tmp/example.conf")
+      File.read("tmp/example.conf").should == "Hello, world!"
+    end
+
+    it "should overwrite an existing file" do
+      FileUtils.touch("tmp/example.conf")
+      @stub.write("tmp/example.conf", "Hello, world!")
+      File.read("tmp/example.conf").should == "Hello, world!"
+    end
+
+    it "should unindent contents before writing" do
+      @stub.write("tmp/example.conf", <<-EOF)
+        Goodbye
+          cruel
+        world!
+      EOF
+      File.read("tmp/example.conf").should == "Goodbye\n  cruel\nworld!\n"
+    end
+
+    it "should render ERB in the contents" do
+      @stub.write("tmp/example.conf", "Hello, <%= 'world!' %>")
+      File.read("tmp/example.conf").should == "Hello, world!"
+    end
+
+    it "should allow access to instance variables in the ERB" do
+      @stub.world = "world!"
+      @stub.write("tmp/example.conf", "Hello, <%= @world %>")
+      File.read("tmp/example.conf").should == "Hello, world!"
+    end
+    
+  end
+end

data/spec/working_directory_spec.rb

@@ -0,0 +1,57 @@
+require 'tango'
+
+module Tango
+  describe WorkingDirectory do
+    
+    before do
+      stub_class = Class.new do
+        include WorkingDirectory
+      end
+      @stub = stub_class.new
+
+      # Make doubly sure we reset the working directory after each test.
+      @original_directory = Dir.getwd
+    end
+
+    after do
+      Dir.chdir(@original_directory)
+    end
+
+    it "should run a block" do
+      block_run = false
+      @stub.cd("/tmp") { block_run = true }
+      block_run.should be_true
+    end
+
+    it "should return the return value of the block" do
+      result = @stub.cd("/tmp") { "I woz ere." }
+      result.should == "I woz ere."
+    end
+
+    it "should change directory" do
+      directory = Dir.getwd + "/lib"
+      @stub.cd(directory) do
+        Dir.getwd.should == directory
+      end
+    end
+
+    it "should restore the original working directory" do
+      old_directory = Dir.getwd
+      directory = Dir.getwd + "/lib"
+      @stub.cd(directory) { }
+      Dir.getwd.should == old_directory
+    end
+
+    it "should restore the original directory after an exception" do
+      old_directory = Dir.getwd
+      directory = Dir.getwd + "/lib"
+      expect {
+        @stub.cd(directory) { raise "Uh oh!" }
+      }.should raise_error
+      Dir.getwd.should == old_directory
+    end
+
+  end
+end
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tango
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Pete Yandell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-02 00:00:00 +11:00
+date: 2011-04-11 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,16 +52,20 @@ files:
 - bin/tango
 - lib/tango.rb
 - lib/tango/as_user.rb
+- lib/tango/config_files.rb
 - lib/tango/delegate.rb
 - lib/tango/logger.rb
 - lib/tango/met_and_meet.rb
 - lib/tango/runner.rb
 - lib/tango/shell.rb
 - lib/tango/version.rb
+- lib/tango/working_directory.rb
+- spec/config_files_spec.rb
 - spec/logger_spec.rb
 - spec/met_and_meet_spec.rb
 - spec/runner_spec.rb
 - spec/shell_spec.rb
+- spec/working_directory_spec.rb
 - tango.gemspec
 has_rdoc: true
 homepage: ""
@@ -98,7 +102,9 @@ signing_key:
 specification_version: 3
 summary: Experiment in deployment tools.
 test_files: 
+- spec/config_files_spec.rb
 - spec/logger_spec.rb
 - spec/met_and_meet_spec.rb
 - spec/runner_spec.rb
 - spec/shell_spec.rb
+- spec/working_directory_spec.rb