tango 0.0.2 → 0.0.3

data/Gemfile.lock

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

data/bin/tango

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/../lib")
+require 'tango'
+
+def dance(name, &block)
+  Tango::DanceCard.instance.dance(name, &block)
+end
+
+load ARGV[0]
+
+Tango::DanceCard.instance.run ARGV[1]

data/lib/tango/dance.rb

@@ -1,20 +1,21 @@
 module Tango
   class Dance
 
-    def initialize(&block)
-      @steps = {}
-      DanceBuilder.new(self).instance_eval(&block)
+    def initialize(dance_card = nil, &block)
+      @dance_card = dance_card
+      @steps      = {}
+      instance_eval(&block)
     end
 
-    def define_step(name, step)
+    def step(name, &block)
       raise StepAlreadyDefinedError, "Step #{name} already defined" if @steps.has_key?(name)
-      step.dance   = self
-      @steps[name] = step
+      @steps[name] = block
     end
 
     def run(step_name, *args)
-      raise UndefinedStepError, "Step #{step_name} not defined" unless @steps.has_key?(step_name)
-      @steps[step_name].run(*args)
+      step = @steps[step_name]
+      raise UndefinedStepError, "Step #{step_name} not defined" if step.nil?
+      StepRunner.new(@dance_card || self).instance_exec(*args, &step)
     end
 
   end

data/lib/tango/dance_card.rb

@@ -0,0 +1,32 @@
+require 'tango/logger'
+require 'tango/noop_logger'
+
+module Tango
+  class DanceCard
+
+    def self.instance
+      @dance_card ||= DanceCard.new(Logger.new)
+    end
+
+    def initialize(logger = nil)
+      @logger = logger || NoopLogger.new
+      @dances = {}
+    end
+
+    def dance(name, &block)
+      @dances[name] = Dance.new(self, &block)
+    end
+
+    def run(name, *args)
+      dance_name, step_name = *name.split(":")
+      @logger.enter(name)
+      @dances[dance_name].run(step_name, *args)
+      @logger.leave(name)
+    end
+
+    def log(message)
+      @logger.log(message)
+    end
+
+  end
+end

data/lib/tango/logger.rb

@@ -0,0 +1,30 @@
+module Tango
+  class Logger
+ 
+    def initialize(io = STDERR)
+      @io = io
+      @depth = 0
+    end
+
+    def enter(step_name)
+      @io.puts "#{indent}#{step_name} {\n"
+      @depth += 1
+    end
+
+    def log(message)
+      @io.puts "#{indent}#{message}\n"
+    end
+
+    def leave(step_name)
+      @depth -= 1
+      @io.puts "#{indent}} √ #{step_name}\n"
+    end
+
+  private
+
+    def indent
+      "  " * @depth
+    end
+
+  end
+end

data/lib/tango/noop_logger.rb

@@ -0,0 +1,15 @@
+module Tango
+  class NoopLogger
+ 
+    def enter(step_name)
+    end
+
+    def log(message)
+    end
+
+    def leave(step_name)
+    end
+
+  end
+end
+

data/lib/tango/step_runner.rb

@@ -1,8 +1,10 @@
 module Tango
+  # A step's block is instance_execed against one of these. It provides all the
+  # methods accessible from within the step.
   class StepRunner
 
-    def initialize(step)
-      @step = step
+    def initialize(context = nil)
+      @context = context
     end
 
     def met?(&met_block)
@@ -11,14 +13,37 @@ module Tango
 
     def meet(&meet_block)
       raise MeetWithoutMetError if @met_block.nil?
-      unless instance_eval(&@met_block)
+      if instance_eval(&@met_block)
+        log "already met."
+      else
+        log "not already met."
         instance_eval(&meet_block)
-        raise CouldNotMeetError unless instance_eval(&@met_block)
+        if instance_eval(&@met_block)
+          log "met."
+        else
+          raise CouldNotMeetError
+        end
       end
     end
 
     def run(step_name, *args)
-      @step.dance.run(step_name, *args)
+      @context.run(step_name, *args)
+    end
+
+    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
+
+    def log(message)
+      @context.log(message) unless @context.nil?
     end
 
   end

data/lib/tango/version.rb

@@ -1,3 +1,3 @@
 module Tango
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/tango.rb

@@ -1,5 +1,5 @@
 require 'tango/dance'
-require 'tango/dance_builder'
+require 'tango/dance_card'
 require 'tango/errors'
-require 'tango/step'
+require 'tango/logger'
 require 'tango/step_runner'

data/spec/dance_card_spec.rb

@@ -0,0 +1,56 @@
+require 'tango'
+
+module Tango
+  describe DanceCard do
+
+    it "should run a step in a dance by name" do
+      step_run = false
+      card = DanceCard.new
+      card.dance "example dance" do
+        step "example step" do
+          step_run = true
+        end
+      end
+
+      card.run "example dance:example step"
+
+      step_run.should be_true
+    end
+
+    it "should pass arguments to a step" do
+      card = DanceCard.new
+      card.dance "example dance" do
+        step "example step" do |a, b|
+          a.should == 1
+          b.should == 2
+        end
+      end
+
+      card.run "example dance:example step", 1, 2
+    end
+
+    it "should call a step in another dance by name" do
+      step_run = false
+
+      card = DanceCard.new
+
+      card.dance "foxtrot" do
+        step "foxtrot step" do
+          step_run = true
+        end
+      end
+
+      card.dance "flamenco" do
+        step "flamenco step" do
+          run "foxtrot:foxtrot step"
+        end
+      end
+
+      card.run "flamenco:flamenco step"
+
+      step_run.should be_true
+    end
+
+  end
+end
+

data/spec/logger_spec.rb

@@ -0,0 +1,30 @@
+require 'tango'
+require 'stringio'
+
+module Tango
+  describe Logger do
+
+    before do
+      @io = StringIO.new
+      @logger = Logger.new(@io)
+    end
+
+    it "should output the step name when entering a step" do
+      @logger.enter("example step")
+      @io.string.should == "example step {\n"
+    end
+
+    it "should output a closing brace when leaving a step" do
+      @logger.enter("example step")
+      @logger.leave("example step")
+      @io.string.should == "example step {\n} √ example step\n"
+    end
+
+    it "should indent nested steps" do
+      @logger.enter("outer step")
+      @logger.enter("inner step")
+      @io.string.should == "outer step {\n  inner step {\n"
+    end
+
+  end
+end

data/spec/step_runner_spec.rb

@@ -0,0 +1,67 @@
+require 'tango'
+
+module Tango
+  describe StepRunner do
+
+    context "with a meet block and a met block" do
+      it "should check the met?, run the meet, then check the met? again" do
+        met_block_calls  = 0
+        meet_block_calls = 0
+
+        StepRunner.new.instance_eval do
+          met? do
+            met_block_calls += 1
+            meet_block_calls > 0
+          end
+          meet { meet_block_calls += 1 }
+        end
+
+        met_block_calls.should  == 2
+        meet_block_calls.should == 1
+      end
+
+      it "should not run the meet if the met? succeeds the first time" do
+        met_block_calls  = 0
+        meet_block_calls = 0
+
+        StepRunner.new.instance_eval do
+          met? do
+            met_block_calls += 1
+            true
+          end
+          meet { meet_block_calls += 1 }
+        end
+
+        met_block_calls.should  == 1
+        meet_block_calls.should == 0
+      end
+
+      it "should raise if the met? block fails twice" do
+        met_block_calls  = 0
+        meet_block_calls = 0
+
+        expect do
+          StepRunner.new.instance_eval do
+            met? do
+              met_block_calls += 1
+              false
+            end
+            meet { meet_block_calls += 1 }
+          end
+        end.should raise_error(CouldNotMeetError)
+
+        met_block_calls.should  == 2
+        meet_block_calls.should == 1
+      end
+
+      it "should raise an error if there's a meet block without a met block" do
+        expect do
+          StepRunner.new.instance_eval do
+            meet { }
+          end
+        end.should raise_error(MeetWithoutMetError)
+      end
+    end
+
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tango
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Pete Yandell
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 +11:00
+date: 2011-03-29 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,8 +35,8 @@ dependencies:
 description: Experiment in deployment tools, taking ideas from babushka and elsewhere.
 email: 
 - pete@notahat.com
-executables: []
-
+executables: 
+- tango
 extensions: []
 
 extra_rdoc_files: []
@@ -45,15 +47,19 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
+- bin/tango
 - lib/tango.rb
 - lib/tango/dance.rb
-- lib/tango/dance_builder.rb
+- lib/tango/dance_card.rb
 - lib/tango/errors.rb
-- lib/tango/step.rb
+- lib/tango/logger.rb
+- lib/tango/noop_logger.rb
 - lib/tango/step_runner.rb
 - lib/tango/version.rb
+- spec/dance_card_spec.rb
 - spec/dance_spec.rb
-- spec/step_spec.rb
+- spec/logger_spec.rb
+- spec/step_runner_spec.rb
 - tango.gemspec
 has_rdoc: true
 homepage: ""
@@ -69,6 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -77,6 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -88,5 +96,7 @@ signing_key:
 specification_version: 3
 summary: Experiment in deployment tools.
 test_files: 
+- spec/dance_card_spec.rb
 - spec/dance_spec.rb
-- spec/step_spec.rb
+- spec/logger_spec.rb
+- spec/step_runner_spec.rb

data/lib/tango/dance_builder.rb

@@ -1,13 +0,0 @@
-module Tango
-  class DanceBuilder
-
-    def initialize(dance)
-      @dance = dance
-    end
-
-    def step(name, &block)
-      @dance.define_step(name, Step.new(&block))
-    end
-
-  end
-end

data/lib/tango/step.rb

@@ -1,14 +0,0 @@
-module Tango
-  class Step
-    def initialize(&block)
-      @block = block
-    end
-
-    attr_accessor :dance
-    attr_reader :block
-
-    def run(*args)
-      StepRunner.new(self).instance_exec(*args, &block)
-    end
-  end
-end

data/spec/step_spec.rb

@@ -1,108 +0,0 @@
-require 'tango'
-
-module Tango
-  describe Step do
-
-    context "with just a plain block" do
-      it "should run the block" do
-        block_calls = 0
-        step = Step.new do
-          block_calls += 1
-        end
-
-        step.run
-        block_calls.should == 1
-      end
-    end
-
-    context "with a meet block and a met block" do
-      it "should check the met?, run the meet, then check the met? again" do
-        met_block_calls  = 0
-        meet_block_calls = 0
-        step = Step.new do
-          met? do
-            met_block_calls += 1
-            meet_block_calls > 0
-          end
-          meet { meet_block_calls += 1 }
-        end
-
-        step.run
-        met_block_calls.should  == 2
-        meet_block_calls.should == 1
-      end
-
-      it "should not run the meet if the met? succeeds the first time" do
-        met_block_calls  = 0
-        meet_block_calls = 0
-        step = Step.new do
-          met? do
-            met_block_calls += 1
-            true
-          end
-          meet { meet_block_calls += 1 }
-        end
-
-        step.run
-        met_block_calls.should  == 1
-        meet_block_calls.should == 0
-      end
-
-      it "should raise if the met? block fails twice" do
-        met_block_calls  = 0
-        meet_block_calls = 0
-        step = Step.new do
-          met? do
-            met_block_calls += 1
-            false
-          end
-          meet { meet_block_calls += 1 }
-        end
-
-        expect { step.run }.should raise_error(CouldNotMeetError)
-        met_block_calls.should  == 2
-        meet_block_calls.should == 1
-      end
-
-      it "should raise an error if there's a meet block without a met block" do
-        step = Step.new do
-          meet { }
-        end
-
-        expect { step.run }.should raise_error(MeetWithoutMetError)
-      end
-    end
-
-    context "step arguments" do
-      it "should pass a single argument to the step" do
-        step = Step.new do |a|
-          a.should == 1
-        end
-
-        step.run(1)
-      end
-
-      it "should pass multiple arguments to the step" do
-        step = Step.new do |a, b|
-          a.should == 1
-          b.should == 2
-        end
-
-        step.run(1, 2)
-      end
-
-      it "should capture arguments in the met? and meet blocks" do
-        step = Step.new do |argument|
-          met? do
-            argument.should == 1
-            false
-          end
-          meet { argument.should == 1 }
-        end
-
-        expect { step.run(1) }.should raise_error(CouldNotMeetError)
-      end
-    end
-
-  end
-end