tango 0.0.9 → 0.1.0

data/Gemfile.lock

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

data/README.md

@@ -31,10 +31,8 @@ Example Runner
         shell("dpkg-query", "--status", package, :echo => false).output !~ /not.installed|deinstall/
       end
 
-      step "install" do |package|
+      step :install do |package|
         met? { installed?(package) }
-        # Need to figure out how to make this non-interactive. See:
-        # http://ubuntuforums.org/showthread.php?t=1218525
         meet { shell("apt-get", "install", "-y", package) }
       end
     end
@@ -44,7 +42,7 @@ Example Runner
         shell("gem", "query", "--installed", "--name-matches", gem, :echo => false).output =~ /true/
       end
 
-      step "install" do |gem|
+      step :install do |gem|
         met? { installed?(gem) }
         meet { shell("gem", "install", gem) }
       end
@@ -56,7 +54,7 @@ Example Runner
         @gem = GemInstaller.new
       end
 
-      step "install" do
+      step :install do
         @apt.install "build-essential"
 
         @apt.install "mysql-server"
@@ -71,23 +69,25 @@ Example Runner
 Running the Example
 -------------------
 
-    tango example_installer.rb ExampleInstaller.install
+    sudo tango example_installer.rb ExampleInstaller.install
 
 Useful Helper Methods
 ---------------------
 
 ### Running Shell Commands
 
-    step "install something" do
+    step :install_something do
       result = shell("apt-get", "install", "something")
       if result.succeeded?
         write("/tmp/something-install.log", result.output)
       end
     end
 
+Use shell! to raise an exception if the command exits with non-zero status.
+
 ### Writing Config Files
 
-    step "configure foo" do
+    step :configure_foo do
       @log_directory = "/var/log/foo.log"
       write "/etc/foo.conf", <<-EOF
         # Config file for foo
@@ -95,27 +95,44 @@ Useful Helper Methods
       end
     end
 
+### Fetching a Remote URL
+
+    step :install do
+      cd "/tmp" do
+        fetch "http://example.com/something.tar.gz"
+      end
+    end
+
+Chainable Helper Methods
+------------------------
+
+You can use these together like this:
+
+    in_directory("/tmp").with_umask(0022) do
+      ...
+    end
+
 ### Changing the Working Directory
 
-    step "migrate" do
-      cd "/rails_apps/blog" do
+    step :migrate do
+      in_directory "/rails_apps/blog" do
         shell "rake db:migrate"
       end
     end
 
-### Running As Another User
+### Changing the umask
 
-    step "..." do
-      as "fred" do
-        FileUtils.touch("/home/fred/fred_woz_ere")
+    step :install do
+      with_umask 0077 do
+        shell "make install"
       end
     end
 
-### Fetching a Remote URL
+### Running As Another User
 
-    step "..." do
-      cd "/tmp" do
-        fetch "http://example.com/something.tar.gz"
+    step :install do
+      as_user "fred" do
+        FileUtils.touch("/home/fred/fred_woz_ere")
       end
     end
 

data/lib/tango.rb

@@ -1,2 +1,3 @@
+require 'tango/contexts'
 require 'tango/logger'
 require 'tango/runner'

data/lib/tango/contexts.rb

@@ -0,0 +1,4 @@
+require 'tango/contexts/chain'
+require 'tango/contexts/directory'
+require 'tango/contexts/helpers'
+require 'tango/contexts/umask'

data/lib/tango/contexts/chain.rb

@@ -0,0 +1,36 @@
+require 'tango/contexts/helpers'
+
+module Tango
+  module Contexts
+    class Chain
+
+      include Helpers
+    
+      def initialize
+        @contexts = []
+      end
+
+      def in_context(context, &block)
+        @contexts << context
+        if block_given?
+          call_in_contexts(&block)
+        else
+          self
+        end
+      end
+
+    private
+
+      def call_in_contexts
+        @contexts.each {|context| context.enter }
+        begin
+          yield
+        ensure
+          @contexts.reverse.each {|context| context.leave }
+        end
+      end
+
+    end
+  end
+end
+

data/lib/tango/contexts/directory.rb

@@ -0,0 +1,20 @@
+module Tango
+  module Contexts
+    class Directory
+
+      def initialize(directory)
+        @directory = directory
+      end
+
+      def enter
+        @old_directory = Dir.getwd
+        Dir.chdir(@directory)
+      end
+
+      def leave
+        Dir.chdir(@old_directory)
+      end
+
+    end
+  end
+end

data/lib/tango/contexts/helpers.rb

@@ -0,0 +1,19 @@
+module Tango
+  module Contexts
+    module Helpers
+
+      def in_context(context, &block)
+        Chain.new.in_context(context, &block)
+      end
+
+      def in_directory(directory, &block)
+        in_context(Directory.new(directory), &block)
+      end
+
+      def with_umask(umask, &block)
+        in_context(Umask.new(umask), &block)
+      end
+
+    end
+  end
+end

data/lib/tango/contexts/umask.rb

@@ -0,0 +1,19 @@
+module Tango
+  module Contexts
+    class Umask
+
+      def initialize(umask)
+        @umask = umask
+      end
+
+      def enter
+        @old_umask = File.umask(@umask)
+      end
+
+      def leave
+        File.umask(@old_umask)
+      end
+
+    end
+  end
+end

data/lib/tango/contexts/user.rb

@@ -0,0 +1,24 @@
+module Tango
+  module Contexts
+    class User
+
+      def initialize(username)
+        @username = username
+      end
+
+      def enter
+        @uid, @gid = Process.euid, Process.egid
+        Process::Sys.seteuid(0) if @uid != 0
+        info = Etc.getpwnam(@username)
+        Process::Sys.setegid(info.gid)
+        Process::Sys.seteuid(info.uid)
+      end
+
+      def leave
+        Process::Sys.seteuid(@uid)
+        Process::Sys.setegid(@gid)
+      end
+
+    end
+  end
+end

data/lib/tango/runner.rb

@@ -1,20 +1,18 @@
-require 'tango/as_user'
 require 'tango/config_files'
+require 'tango/contexts/helpers'
 require 'tango/delegate'
 require 'tango/fetch'
 require 'tango/met_and_meet'
 require 'tango/shell'
-require 'tango/working_directory'
 
 module Tango
   class Runner
-    include AsUser
     include ConfigFiles
+    include Contexts::Helpers
     include Delegate
     include Fetch
     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.9"
+  VERSION = "0.1.0"
 end

data/spec/contexts/chain_spec.rb

@@ -0,0 +1,78 @@
+require 'tango'
+
+module Tango::Contexts
+  describe Chain do
+
+    before do
+      @context_class = Class.new do
+        def in_context?
+          @in_context
+        end
+
+        def initialize
+          @in_context = false
+        end
+
+        def enter 
+          @in_context = true
+        end
+
+        def leave
+          @in_context = false
+        end
+      end
+
+      @context = @context_class.new
+    end
+
+    it "should run a block" do
+      block_run = false
+      Chain.new.in_context(@context) { block_run = true }
+      block_run.should be_true
+    end
+
+    it "should return the return value of the block" do
+      result = Chain.new.in_context(@context) { "I woz ere." }
+      result.should == "I woz ere."
+    end
+
+    it "should run the context's enter method before the block" do
+      Chain.new.in_context(@context) do
+        @context.should be_in_context
+      end
+    end
+
+    it "should run the context's leave method after leaving the block" do
+      Chain.new.in_context(@context) { }
+      @context.should_not be_in_context
+    end
+
+    it "should run the context's leave method on an exception" do
+      expect {
+        Chain.new.in_context(@context) { raise "Uh oh" }
+      }.should raise_error("Uh oh")
+      @context.should_not be_in_context
+    end
+
+    describe "when chaining contexts" do
+      before do
+        @a = @context_class.new
+        @b = @context_class.new
+      end
+
+      it "should run the enter method of each context" do
+        Chain.new.in_context(@a).in_context(@b) do
+          @a.should be_in_context
+          @b.should be_in_context
+        end
+      end
+
+      it "should run the leave method of each context" do
+        Chain.new.in_context(@a).in_context(@b) { }
+        @a.should_not be_in_context
+        @b.should_not be_in_context
+      end
+    end
+
+  end
+end

data/spec/contexts/directory_spec.rb

@@ -0,0 +1,37 @@
+require 'tango'
+
+module Tango::Contexts
+  describe Directory do
+    
+    before do
+      stub_class = Class.new do
+        include Helpers
+      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 change the working directory" do
+      directory = Dir.getwd + "/lib"
+      @stub.in_directory(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.in_directory(directory) { }
+      Dir.getwd.should == old_directory
+    end
+
+  end
+end
+
+

data/spec/contexts/umask_spec.rb

@@ -0,0 +1,33 @@
+require 'tango'
+
+module Tango::Contexts
+  describe Umask do
+
+    before do
+      stub_class = Class.new do
+        include Helpers
+      end
+      @stub = stub_class.new
+
+      # Make double sure we reset the umask after each test.
+      @original_umask = File.umask
+    end
+
+    after do
+      File.umask(@original_umask)
+    end
+
+    it "should change the umask" do
+      @stub.with_umask(0777) do
+        File.umask.should == 0777
+      end
+    end
+
+    it "should restore the original umask" do
+      old_umask = File.umask
+      @stub.with_umask(0777) { }
+      File.umask.should == old_umask
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tango
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Pete Yandell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 +10:00
+date: 2011-04-14 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,8 +51,13 @@ files:
 - Rakefile
 - bin/tango
 - lib/tango.rb
-- lib/tango/as_user.rb
 - lib/tango/config_files.rb
+- lib/tango/contexts.rb
+- lib/tango/contexts/chain.rb
+- lib/tango/contexts/directory.rb
+- lib/tango/contexts/helpers.rb
+- lib/tango/contexts/umask.rb
+- lib/tango/contexts/user.rb
 - lib/tango/delegate.rb
 - lib/tango/fetch.rb
 - lib/tango/logger.rb
@@ -60,14 +65,16 @@ files:
 - lib/tango/runner.rb
 - lib/tango/shell.rb
 - lib/tango/version.rb
-- lib/tango/working_directory.rb
 - spec/config_files_spec.rb
+- spec/contexts/chain_spec.rb
+- spec/contexts/directory_spec.rb
+- spec/contexts/umask_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
+- tmp/.gitignore
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -104,8 +111,10 @@ specification_version: 3
 summary: Experiment in deployment tools.
 test_files: 
 - spec/config_files_spec.rb
+- spec/contexts/chain_spec.rb
+- spec/contexts/directory_spec.rb
+- spec/contexts/umask_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

data/lib/tango/as_user.rb

@@ -1,17 +0,0 @@
-module Tango
-  module AsUser
-
-    def as(username)
-      info = Etc.getpwent(username)
-      uid, gid = Process.euid, Process.egid
-      Process::Sys.seteuid(0) if uid != 0
-      Process::Sys.setegid(info.gid)
-      Process::Sys.seteuid(info.uid)
-      yield
-    ensure
-      Process::Sys.seteuid(uid)
-      Process::Sys.setegid(gid)
-    end
-
-  end
-end

data/lib/tango/working_directory.rb

@@ -1,15 +0,0 @@
-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/working_directory_spec.rb

@@ -1,57 +0,0 @@
-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
-
-