tango 0.0.3 → 0.0.4

data/.gitignore

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

data/Gemfile.lock

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

data/README.md

@@ -0,0 +1,45 @@
+Credit Where It's Due
+---------------------
+
+This is a re-invention of Ben Hoskings's excellent
+[Babushka](https://github.com/benhoskings/babushka).
+
+There are a bunch of things I love about Babushka, and a bunch of other things
+that really don't fit with the way we want to use it at
+[Envato](http://envato.com/). Tango is an experiment in changing around a few
+of Babushka's fundamentals to try to find a better fit.
+
+
+Example
+-------
+
+    class Homebrew < Tango::Namespace
+      def installed?(formula)
+        `brew info #{formula}` !~ /Not installed/
+      end
+
+      step "bootstrap" do
+        met? { system "brew info" }
+        meet { system %{ruby -e "$(curl -fsSL https://gist.github.com/raw/323731/install_homebrew.rb)"} }
+      end
+
+      step "install" do |formula|
+        met? { installed?(formula) }
+        meet { system "brew install #{formula}" }
+      end
+    end
+
+    class MyNamespace < Tango::Namespace
+      step "install" do
+        Homebrew.run "bootstrap"
+        Homebrew.run "install", "git"
+        Homebrew.run "install", "mysql"
+        run "install mtr"
+      end
+
+      step "install mtr" do
+        met? { Homebrew.installed?("mtr") }
+        meet { system "brew install --no-gtk mtr" }
+      end
+    end
+

data/bin/tango

@@ -3,10 +3,8 @@
 $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]
+namespace_name, step_name = ARGV[1].split(".")
+
+Object.const_get(namespace_name).run(step_name)

data/lib/tango.rb

@@ -1,5 +1,4 @@
-require 'tango/dance'
-require 'tango/dance_card'
-require 'tango/errors'
+require 'tango/as_user'
 require 'tango/logger'
-require 'tango/step_runner'
+require 'tango/met_and_meet'
+require 'tango/namespace'

data/lib/tango/as_user.rb

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

@@ -1,6 +1,9 @@
 module Tango
   class Logger
- 
+    def self.instance
+      @logger ||= Logger.new
+    end
+
     def initialize(io = STDERR)
       @io = io
       @depth = 0

data/lib/tango/met_and_meet.rb

@@ -0,0 +1,28 @@
+module Tango
+  class CouldNotMeetError   < RuntimeError; end
+  class MeetWithoutMetError < RuntimeError; end
+
+  module MetAndMeet
+
+    def met?(&met_block)
+      @met_block = met_block
+    end
+
+    def meet(&meet_block)
+      raise MeetWithoutMetError if @met_block.nil?
+
+      if instance_eval(&@met_block)
+        log "already met."
+      else
+        log "not already met."
+        instance_eval(&meet_block)
+        if instance_eval(&@met_block)
+          log "met."
+        else
+          raise CouldNotMeetError
+        end
+      end
+    end
+
+  end
+end

data/lib/tango/namespace.rb

@@ -0,0 +1,41 @@
+require 'tango/as_user'
+require 'tango/met_and_meet'
+
+module Tango
+  class Namespace
+    include AsUser
+    include MetAndMeet
+    
+    def self.step(step_name, &block)
+      define_method(step_name, &block)
+    end
+
+    def self.run(step_name, *args)
+      description = "#{name}.#{step_name}"
+      description << "(" + args.map {|arg| arg.inspect }.join(", ") + ")" unless args.empty?
+
+      logger.enter(description)
+      new.send(step_name, *args)
+      logger.leave(description)
+    end
+
+    def run(step_name, *args)
+      self.class.run(step_name, *args)
+    end
+
+    def log(message)
+      self.class.logger.log(message)
+    end
+
+    def self.method_missing(method, *args)
+      new.send(method, *args)
+    end
+
+  private
+
+    def self.logger
+      Logger.instance
+    end
+
+  end
+end

data/lib/tango/version.rb

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

data/spec/met_and_meet_spec.rb

@@ -0,0 +1,74 @@
+require 'tango'
+
+module Tango
+  describe MetAndMeet do
+
+    before do
+      @stub = Class.new do
+        include MetAndMeet
+
+        def log(message); end
+      end
+    end
+
+    it "should check the met?, run the meet, then check the met? again" do
+      met_block_calls  = 0
+      meet_block_calls = 0
+
+      @stub.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
+
+      @stub.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
+        @stub.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
+        @stub.new.instance_eval do
+          meet { }
+        end
+      end.should raise_error(MeetWithoutMetError)
+    end
+
+  end
+end
+

data/spec/{dance_spec.rb → namespace_spec.rb}

@@ -1,25 +1,37 @@
 require 'tango'
 
+class StubLogger
+  def enter(name); end
+  def leave(name); end
+  def log(message); end
+end
+
+class StubbedNamespace < Tango::Namespace
+  def self.logger
+    @logger ||= StubLogger.new
+  end
+end
+
 module Tango
-  describe Dance do
+  describe Namespace do
 
     it "should run a step" do
       step_run = false
 
-      dance = Dance.new do
+      namespace = Class.new(StubbedNamespace) do
         step "example step" do
           step_run = true
         end
       end
 
-      dance.run "example step"
+      namespace.run "example step"
       step_run.should be_true
     end
 
     it "should run one step from within another" do
       inner_step_run = false
 
-      dance = Dance.new do
+      namespace = Class.new(StubbedNamespace) do
         step "outer step" do
           run "inner step"
         end
@@ -29,24 +41,24 @@ module Tango
         end
       end
 
-      dance.run "outer step"
+      namespace.run "outer step"
       inner_step_run.should be_true
     end
 
     context "passing arguments" do
       it "should pass arguments to a step" do
-        dance = Dance.new do
+        namespace = Class.new(StubbedNamespace) do
           step "example step" do |a, b|
             a.should == 1
             b.should == 2
           end
         end
 
-        dance.run "example step", 1, 2
+        namespace.run "example step", 1, 2
       end
 
       it "should pass arguments when running other steps" do
-        dance = Dance.new do
+        namespace = Class.new(StubbedNamespace) do
           step "outer step" do
             run "inner step", 1, 2
           end
@@ -57,26 +69,7 @@ module Tango
           end
         end
 
-        dance.run "outer step"
-      end
-    end
-
-    context "error handling" do
-      it "should raise an error on an attempt to redefine a step" do
-        expect do
-          Dance.new do
-            step "example step" do; end
-            step "example step" do; end
-          end
-        end.should raise_error(StepAlreadyDefinedError)
-      end
-
-      it "should raise an error on an attempt to run an undefined step" do
-        dance = Dance.new do; end
-
-        expect do
-          dance.run "undefined step"
-        end.should raise_error(UndefinedStepError)
+        namespace.run "outer step"
       end
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tango
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Pete Yandell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 +11:00
+date: 2011-03-30 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,20 +46,18 @@ files:
 - .rspec
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
 - bin/tango
 - lib/tango.rb
-- lib/tango/dance.rb
-- lib/tango/dance_card.rb
-- lib/tango/errors.rb
+- lib/tango/as_user.rb
 - lib/tango/logger.rb
-- lib/tango/noop_logger.rb
-- lib/tango/step_runner.rb
+- lib/tango/met_and_meet.rb
+- lib/tango/namespace.rb
 - lib/tango/version.rb
-- spec/dance_card_spec.rb
-- spec/dance_spec.rb
 - spec/logger_spec.rb
-- spec/step_runner_spec.rb
+- spec/met_and_meet_spec.rb
+- spec/namespace_spec.rb
 - tango.gemspec
 has_rdoc: true
 homepage: ""
@@ -96,7 +94,6 @@ signing_key:
 specification_version: 3
 summary: Experiment in deployment tools.
 test_files: 
-- spec/dance_card_spec.rb
-- spec/dance_spec.rb
 - spec/logger_spec.rb
-- spec/step_runner_spec.rb
+- spec/met_and_meet_spec.rb
+- spec/namespace_spec.rb

data/lib/tango/dance.rb

@@ -1,22 +0,0 @@
-module Tango
-  class Dance
-
-    def initialize(dance_card = nil, &block)
-      @dance_card = dance_card
-      @steps      = {}
-      instance_eval(&block)
-    end
-
-    def step(name, &block)
-      raise StepAlreadyDefinedError, "Step #{name} already defined" if @steps.has_key?(name)
-      @steps[name] = block
-    end
-
-    def run(step_name, *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
-end

data/lib/tango/dance_card.rb

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

@@ -1,6 +0,0 @@
-module Tango
-  class StepAlreadyDefinedError < RuntimeError; end
-  class UndefinedStepError      < RuntimeError; end
-  class CouldNotMeetError       < RuntimeError; end
-  class MeetWithoutMetError     < RuntimeError; end
-end

data/lib/tango/noop_logger.rb

@@ -1,15 +0,0 @@
-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,50 +0,0 @@
-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(context = nil)
-      @context = context
-    end
-
-    def met?(&met_block)
-      @met_block = met_block
-    end
-
-    def meet(&meet_block)
-      raise MeetWithoutMetError if @met_block.nil?
-      if instance_eval(&@met_block)
-        log "already met."
-      else
-        log "not already met."
-        instance_eval(&meet_block)
-        if instance_eval(&@met_block)
-          log "met."
-        else
-          raise CouldNotMeetError
-        end
-      end
-    end
-
-    def 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
-end

data/spec/dance_card_spec.rb

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

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