mattock 0.0.1 → 0.1.0

data/lib/mattock/cascading-definition.rb

@@ -0,0 +1,32 @@
+require 'mattock/configurable'
+
+module Mattock
+  module CascadingDefinition
+    include Configurable
+
+    def initialize(*tasklibs)
+      setup_defaults
+      default_configuration(*tasklibs)
+
+      yield self if block_given?
+
+      resolve_configuration
+      confirm_configuration
+
+      define
+    end
+
+    def default_configuration(*tasklibs)
+    end
+
+    def resolve_configuration
+    end
+
+    def confirm_configuration
+      check_required
+    end
+
+    def define
+    end
+  end
+end

data/lib/mattock/command-task.rb

@@ -1,16 +1,8 @@
-require 'mattock/tasklib'
+require 'mattock/task'
 require 'mattock/command-line'
 
 module Mattock
-  module NeededPredicate
-    def needed_predicate(&block)
-      (class << self; self; end).instance_eval do
-        define_method(:needed?, &block)
-      end
-    end
-  end
-
-  class CommandTask < TaskLib
+  class CommandTask < Task
     setting(:task_name, :run)
     setting(:command)
     setting(:verify_command, nil)
@@ -26,25 +18,15 @@ module Mattock
       cmd
     end
 
-    def command_task
-      @command_task ||=
-        begin
-          task task_name do
-            decorated(command).must_succeed!
-          end
-        end
+    def action
+      decorated(command).must_succeed!
     end
 
-    def define
-      in_namespace do
-        command_task
-        unless verify_command.nil?
-          needed = decorated(verify_command)
-          command_task.extend NeededPredicate
-          command_task.needed_predicate do
-            !needed.succeeds?
-          end
-        end
+    def needed?
+      unless verify_command.nil?
+        !decorated(verify_command).succeeds?
+      else
+        super
       end
     end
   end

data/lib/mattock/configurable.rb

@@ -50,6 +50,19 @@ module Mattock
         return missing
       end
 
+      def copy_settings(from, to)
+        if Configurable > superclass
+          superclass.copy_settings(from, to)
+        end
+        default_values.keys.each do |field|
+          begin
+            to.__send__("#{field}=", from.__send__(field))
+          rescue NoMethodError
+            #shrug it off
+          end
+        end
+      end
+
       def nested(hash=nil)
         obj = Class.new(Struct).new
         obj.settings(hash || {})
@@ -85,10 +98,15 @@ module Mattock
         end
         return self
       end
+
+      def included(mod)
+        mod.extend ClassMethods
+      end
     end
+    extend ClassMethods
 
-    def self.included(mod)
-      mod.extend ClassMethods
+    def copy_settings_to(other)
+      self.class.copy_settings(self, other)
     end
 
     def setup_defaults
@@ -99,7 +117,7 @@ module Mattock
     def check_required
       missing = self.class.missing_required_fields_on(self)
       unless missing.empty?
-        raise "Required field#{missing.length > 1 ? "s" : ""} #{missing.join(", ")} unset on #{self.inspect}"
+        raise "Required field#{missing.length > 1 ? "s" : ""} #{missing.map{|field| field.to_s.inspect}.join(", ")} unset on #{self.inspect}"
       end
       self
     end
@@ -122,6 +140,12 @@ module Mattock
     end
     alias required_field required_fields
 
+    def nil_fields(*names)
+      self.class.nil_fields(*names)
+      self
+    end
+    alias nil_field nil_fields
+
     class Struct
       include Configurable
     end

data/lib/mattock/task.rb

@@ -0,0 +1,35 @@
+require 'mattock/cascading-definition'
+require 'rake/task'
+
+module Mattock
+  class Task < Rake::Task
+    include CascadingDefinition
+
+    setting :task_name
+
+    def action
+    end
+
+    def task_args
+      [task_name]
+    end
+
+    def task_class
+      return @task_class if @task_class
+      @task_class = Class.new(self.class) do
+        define_method :initialize, Rake::Task.instance_method(:initialize)
+      end
+    end
+
+    def inspect
+      "Mattock::Task"
+    end
+
+    def define
+      task  =task_class.define_task(*task_args) do
+        action
+      end
+      copy_settings_to(task)
+    end
+  end
+end

data/lib/mattock/tasklib.rb

@@ -1,47 +1,28 @@
-require 'ostruct'
 require 'rake/tasklib'
-require 'mattock/configurable'
+require 'mattock/cascading-definition'
 
 module Mattock
   class TaskLib < Rake::TaskLib
-    include Configurable
+    include CascadingDefinition
 
     attr_writer :namespace_name
     def self.default_namespace(name)
       setting(:namespace_name, name)
     end
 
-    def initialize(*tasklibs)
-      @tasks = []
-
-      default_configuration(*tasklibs)
-
-      yield self if block_given?
-
-      resolve_configuration
+    attr_reader :tasks
 
-      define
+    def initialize(*toolkits)
+      @tasks = []
+      super
     end
 
-    attr_reader :tasks
-
     def task(*args)
       a_task = super
       @tasks << a_task
       return a_task
     end
 
-    def default_configuration(*tasklibs)
-      setup_defaults
-    end
-
-    def resolve_configuration
-      check_required
-    end
-
-    def define
-    end
-
     def in_namespace(*tasknames)
       if tasknames.empty?
         if block_given?

data/lib/mattock/testing/mock-command-line.rb

@@ -23,4 +23,45 @@ module Mattock
 
     alias exit_status exit_code
   end
+
+  module CommandLineExampleGroup
+    def self.included(group)
+      group.class_eval do
+        let :pairs do
+          []
+        end
+
+        before :each do
+          Mattock::CommandLine.should_receive(:execute) do |cmd|
+            pattern, res = pairs.shift
+            pattern =~ cmd
+            Mattock::MockCommandResult.create(*res)
+          end.any_number_of_times
+        end
+
+        after :each do
+          pairs.should have_all_been_called
+        end
+      end
+    end
+
+    def expect_command(cmd, *result)
+      pairs << [cmd, result]
+    end
+
+    module Matchers
+      extend RSpec::Matchers::DSL
+
+      define :have_all_been_called do
+        match do |list|
+          list.empty?
+        end
+
+        failure_message_for_should do |list|
+          "Expected all commands to be run, but: #{list.map{|item| item[0].source.inspect}.join(", ")} #{list.length > 1 ? "were" : "was"} not."
+        end
+      end
+    end
+    include Matchers
+  end
 end

data/lib/mattock/testing/record-commands.rb

@@ -0,0 +1,38 @@
+require 'mattock/command-line'
+
+module Mattock
+  class CommandLine
+    @@commands = []
+    class << self
+      alias original_execute execute
+
+      def execute(command)
+        result = original_execute(command)
+        @@commands << [command, result]
+        return result
+      end
+
+      attr_accessor :command_recording_path
+
+      def command_recording_path
+        @command_recording_path ||= ENV['MATTOCK_CMDREC']
+      end
+
+      def emit_recording
+        io = $stderr
+        if command_recording_path
+          io = File.open(command_recording_path, "w")
+        else
+          io.puts "Set MATTOCK_CMDREC to write to a path"
+        end
+        @@commands.each do |pair|
+          io.puts "[/#{pair[0]}/, #{[pair[1].exit_code, pair[1].streams].inspect}]"
+        end
+      end
+    end
+  end
+end
+
+at_exit do
+  Mattock::CommandLine.emit_recording
+end

data/spec/command-line.rb

@@ -2,6 +2,10 @@ require 'mattock/command-line'
 require 'mattock/testing/rake-example-group'
 require 'mattock/testing/mock-command-line'
 
+require 'mattock/testing/record-commands'
+
+Mattock::CommandLine.command_recording_path = "/dev/null"
+
 describe Mattock::CommandLine do
   let :commandline do
     Mattock::CommandLine.new('echo', "-n") do |cmd|

data/spec/command-task.rb

@@ -5,35 +5,33 @@ require 'mattock/testing/mock-command-line'
 describe Mattock::RemoteCommandTask do
   include Mattock::RakeExampleGroup
   let! :remote_task do
-    Mattock::RemoteCommandTask.new do |t|
-      t.namespace_name = :test
-      t.remote_server.address = "nowhere.com"
-      t.command = Mattock::PrereqChain.new do |prereq|
-        prereq.add Mattock::CommandLine.new("cd", "a_dir")
-        prereq.add Mattock::PipelineChain.new do |pipe|
-          pipe.add Mattock::CommandLine.new("ls")
-          pipe.add Mattock::CommandLine.new("grep") do |cmd|
-            cmd.options << "*.rb"
-            cmd.redirect_stderr("/dev/null")
-            cmd.redirect_stdout("/tmp/rubyfiles.txt")
+    namespace :test do
+      Mattock::RemoteCommandTask.new do |t|
+        t.remote_server.address = "nowhere.com"
+        t.command = Mattock::PrereqChain.new do |prereq|
+          prereq.add Mattock::CommandLine.new("cd", "a_dir")
+          prereq.add Mattock::PipelineChain.new do |pipe|
+            pipe.add Mattock::CommandLine.new("ls")
+            pipe.add Mattock::CommandLine.new("grep") do |cmd|
+              cmd.options << "*.rb"
+              cmd.redirect_stderr("/dev/null")
+              cmd.redirect_stdout("/tmp/rubyfiles.txt")
+            end
           end
         end
+        t.verify_command = Mattock::CommandLine.new("should_do")
       end
-      t.verify_command = Mattock::CommandLine.new("should_do")
     end
   end
 
   describe "when verification indicates command should proceed" do
+    include Mattock::CommandLineExampleGroup
+
     it "should run both commands" do
-      cmds = [/should_do/, /^ssh.*cd.*ls.*grep.*rubyfiles.txt/]
-      res = [1, 0]
-      Mattock::CommandLine.should_receive(:execute) do |cmd|
-        cmd.should =~ cmds.shift
-        Mattock::MockCommandResult.create(res.shift)
-      end.exactly(2).times
+      expect_command(/should_do/, 1)
+      expect_command(/^ssh.*cd.*ls.*grep.*rubyfiles.txt/, 0)
 
       rake["test:run"].invoke
-      cmds.should == []
     end
   end
 end

data/spec/tasklib.rb

@@ -19,21 +19,16 @@ describe Mattock::Tasklib do
     TestTaskLib.new
   end
 
+  describe "defines" do
+    subject{ rake }
 
-  it "should define a root task" do
-    rake.should have_task(:test)
-  end
-
-  it "should define a namespaced task" do
-    rake.should have_task("test:task")
+    it{ should have_task(:test) }
+    it{ should have_task("test:task") }
+    it{ should_not have_task("random:tasks")}
   end
 
   it "should make root task depend on namespaced" do
-    rake.lookup(:test).should depend_on("test:task")
-  end
-
-  it "should not define random tasks" do
-    rake.should_not have_task("random:tasks")
+    rake[:test].should depend_on("test:task")
   end
 
   it "should not make namespaced task depend on root task" do

data/spec_help/spec_helper.rb

@@ -1,2 +1,5 @@
 require 'rspec'
 require 'file-sandbox'
+require 'mattock/testing/record-commands'
+
+Mattock::CommandLine.command_recording_path = "/dev/null"

metadata

@@ -2,7 +2,7 @@
 name: mattock
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Judson Lester
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-21 00:00:00 Z
+date: 2012-01-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: corundum
@@ -114,10 +114,13 @@ files:
 - lib/mattock/command-task.rb
 - lib/mattock/testing/rake-example-group.rb
 - lib/mattock/testing/mock-command-line.rb
+- lib/mattock/testing/record-commands.rb
 - lib/mattock/template-host.rb
 - lib/mattock/remote-command-task.rb
 - lib/mattock/tasklib.rb
+- lib/mattock/task.rb
 - lib/mattock/configurable.rb
+- lib/mattock/cascading-definition.rb
 - lib/mattock.rb
 - doc/README
 - doc/Specifications
@@ -186,7 +189,7 @@ rdoc_options:
 - --main
 - doc/README
 - --title
-- mattock-0.0.1 RDoc
+- mattock-0.1.0 RDoc
 require_paths: 
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -194,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 304953233
+      hash: 737860559
       segments: 
       - 0
       version: "0"