mattock 0.0.1

data/lib/mattock/template-host.rb

@@ -0,0 +1,54 @@
+require 'tilt'
+require 'valise'
+
+module Mattock
+  module ValiseManager
+    def default_valise(*dirs)
+      Valise::Set.define do
+        dirs.each do |dir|
+          ro dir
+        end
+      end
+    end
+
+    def rel_dir(base_path = nil, up_to = nil)
+      base_path ||= /(.*):\d+/.match(caller[0])[1]
+      up_to ||= "lib"
+
+      abs_path = File::expand_path(base_path)
+      base_path = abs_path.split(File::Separator)
+      until base_path.empty?
+        unless base_path.last == up_to
+          base_path.pop
+        else
+          break
+        end
+      end
+
+      if base_path.empty?
+        raise "Relative root #{up_to} not found in #{abs_path}"
+      end
+
+      return base_path
+    end
+    module_function :rel_dir, :default_valise
+  end
+
+  module TemplateHost
+    def self.template_cache
+      @template_cache ||= Tilt::Cache.new
+    end
+
+    attr_accessor :valise
+
+    def render(path, locals=nil)
+      template = TemplateHost::template_cache.fetch(path) do
+        Tilt.new(path) do |tmpl|
+          valise.find(["templates"] + valise.unpath(tmpl.file)).contents
+        end
+      end
+
+      template.render(self, locals)
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'mattock/command-line'
+
+module Mattock
+  class MockCommandResult < CommandRunResult
+    def self.create(*args)
+      if args.length == 1
+        args = [args[0], {1 => ""}]
+      end
+
+      if String == args[1]
+        args[1] = {1 => args[1]}
+      end
+
+      return self.new(*args)
+    end
+
+    def initialize(code, streams)
+      @streams = streams
+      @exit_code = code
+    end
+
+    attr_reader :exit_code, :streams
+
+    alias exit_status exit_code
+  end
+end

data/lib/mattock/testing/rake-example-group.rb

@@ -0,0 +1,79 @@
+require 'rake'
+
+module Mattock
+  module RakeExampleGroup
+    SavedEnvironmentVariables = %w{APPDATA HOME HOMEDRIVE HOMEPATH RAKE_COLUMNS RAKE_SYSTEM RAKEOPT USERPROFILE}
+    DeletedEnvironmentVariables = %w{RAKE_COLUMNS RAKE_SYSTEM RAKEOPT}
+    include Rake::DSL
+    #include FileUtils
+
+    class TaskManager
+      include Rake::TaskManager
+    end
+
+    def self.included(mod)
+      mod.class_eval do
+        let! :rake do
+          Rake.application = Rake::Application.new
+          Rake::TaskManager.record_task_metadata = true
+          RakeFileUtils.verbose_flag = false
+          Rake.application
+        end
+
+        before :each do
+          ARGV.clear
+
+          @original_ENV = {}
+          SavedEnvironmentVariables.each do |var|
+            @original_ENV[var] = ENV[var]
+          end
+          DeletedEnvironmentVariables.each do |var|
+            ENV.delete(var)
+          end
+
+        end
+
+        after :each do
+          SavedEnvironmentVariables.each do |var|
+            ENV[var]         = @original_ENV[var]
+          end
+
+          if @original_ENV['APPDATA'].nil?
+            ENV.delete 'APPDATA'
+          end
+        end
+
+        before :each do
+          @tempdir = File.join "/tmp", "test_mattock_#{$$}"
+
+          @original_PWD = Dir.pwd
+          FileUtils.mkdir_p @tempdir
+          Dir.chdir @tempdir
+        end
+
+        after :each do
+          Dir.chdir @original_PWD
+          FileUtils.rm_rf @tempdir
+        end
+      end
+    end
+
+    module Matchers
+      extend RSpec::Matchers::DSL
+
+      define :have_task do |name|
+        match do |rake|
+          !rake.lookup("rake:" + name.to_s).nil?
+        end
+      end
+
+      define :depend_on do |name|
+        match do |task|
+          task.prerequisites.include?(name)
+        end
+      end
+    end
+
+    include Matchers
+  end
+end

data/spec/command-line.rb

@@ -0,0 +1,59 @@
+require 'mattock/command-line'
+require 'mattock/testing/rake-example-group'
+require 'mattock/testing/mock-command-line'
+
+describe Mattock::CommandLine do
+  let :commandline do
+    Mattock::CommandLine.new('echo', "-n") do |cmd|
+      cmd.options << "Some text"
+    end
+  end
+
+  it "should have a name set" do
+    commandline.name.should == "echo"
+  end
+
+  it "should produce a command string" do
+    commandline.command.should == "echo -n Some text"
+  end
+
+  it "should succeed" do
+    commandline.succeeds?.should be_true
+  end
+
+  it "should not complain about success" do
+    expect do
+      commandline.must_succeed!
+    end.to_not raise_error
+  end
+
+  describe Mattock::CommandRunResult do
+    let :result do
+      commandline.run
+    end
+
+    it "should have a result code" do
+      result.exit_code.should == 0
+    end
+
+    it "should have stdout" do
+      result.stdout.should == "Some text"
+    end
+  end
+end
+
+describe Mattock::CommandLine, "that fails" do
+  let :commandline do
+    Mattock::CommandLine.new("false")
+  end
+
+  it "should not succeed" do
+    commandline.succeeds?.should == false
+  end
+
+  it "should raise error if succeed demanded" do
+    expect do
+      commandline.must_succeed
+    end.to raise_error
+  end
+end

data/spec/command-task.rb

@@ -0,0 +1,39 @@
+require 'mattock/remote-command-task'
+require 'mattock/testing/rake-example-group'
+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")
+          end
+        end
+      end
+      t.verify_command = Mattock::CommandLine.new("should_do")
+    end
+  end
+
+  describe "when verification indicates command should proceed" do
+    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
+
+      rake["test:run"].invoke
+      cmds.should == []
+    end
+  end
+end

data/spec/configurable.rb

@@ -0,0 +1,45 @@
+describe Mattock::Configurable do
+  class TestSuperStruct
+    include Mattock::Configurable
+
+    setting(:three, 3)
+    required_field(:four)
+  end
+
+  class TestStruct < TestSuperStruct
+    settings(:one => 1, :two => nested(:a => "a").required_field(:b))
+    nil_field(:five)
+  end
+
+  subject do
+    TestStruct.new.setup_defaults
+  end
+
+  it "should set defaults" do
+    subject.one.should == 1
+    subject.two.a.should == "a"
+    subject.three.should == 3
+    subject.five.should be_nil
+  end
+
+  it "should complain about unset required fields" do
+    expect do
+      subject.check_required
+    end.to raise_error
+  end
+
+  it "should complain about unset nested required fields" do
+    subject.four = 4
+    expect do
+      subject.check_required
+    end.to raise_error
+  end
+
+  it "should not complain when required fields are set" do
+    subject.four = 4
+    subject.two.b = "b"
+    expect do
+      subject.check_required
+    end.to_not raise_error
+  end
+end

data/spec/tasklib.rb

@@ -0,0 +1,42 @@
+require 'mattock/tasklib'
+require 'mattock/testing/rake-example-group'
+
+describe Mattock::Tasklib do
+  include Mattock::RakeExampleGroup
+
+  class TestTaskLib < Mattock::TaskLib
+    default_namespace :test
+    def define
+      in_namespace do
+        task :task
+      end
+
+      task root_task => self[:task]
+    end
+  end
+
+  let! :tasklib do
+    TestTaskLib.new
+  end
+
+
+  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")
+  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")
+  end
+
+  it "should not make namespaced task depend on root task" do
+    rake["test:task"].should_not depend_on("test")
+  end
+end

data/spec_help/gem_test_suite.rb

@@ -0,0 +1,17 @@
+puts Dir::pwd
+require 'test/unit'
+begin
+  require 'spec'
+rescue LoadError
+  false
+end
+
+class RSpecTest < Test::Unit::TestCase
+  def test_that_rspec_is_available
+    assert_nothing_raised("\n\n *  RSpec isn't available - please run: gem install rspec  *\n\n"){ ::Spec }
+  end
+
+  def test_that_specs_pass
+    assert(system(*%w{spec -f e -p **/*.rb spec}),"\n\n *  Specs failed  *\n\n")
+  end
+end

data/spec_help/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'file-sandbox'

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification 
+name: mattock
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Judson Lester
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: corundum
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: valise
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+description: "  If Rake won't do it by itself, you oughtta Mattock.\n\n  If you survived the pun, you might enjoy this gem.\n\n  Features:\n  Extensions to Tasklibs to support powerful deerpaths.\n  A commandline library that supports mocking for tests.\n  A module to support common templating patterns\n\n"
+email: 
+- nyarly@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- doc/README
+- doc/Specifications
+- doc/coverage/index.html
+- doc/coverage/assets/0.5.3/highlight.css
+- doc/coverage/assets/0.5.3/favicon_yellow.png
+- doc/coverage/assets/0.5.3/jquery.dataTables.min.js
+- doc/coverage/assets/0.5.3/stylesheet.css
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- doc/coverage/assets/0.5.3/fancybox/blank.gif
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_close.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_loading.png
+- doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- doc/coverage/assets/0.5.3/fancybox/fancybox-x.png
+- doc/coverage/assets/0.5.3/fancybox/fancybox-y.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- doc/coverage/assets/0.5.3/fancybox/fancybox.png
+- doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- doc/coverage/assets/0.5.3/favicon_green.png
+- doc/coverage/assets/0.5.3/magnify.png
+- doc/coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- doc/coverage/assets/0.5.3/jquery.url.js
+- doc/coverage/assets/0.5.3/app.js
+- doc/coverage/assets/0.5.3/favicon_red.png
+- doc/coverage/assets/0.5.3/highlight.pack.js
+- doc/coverage/assets/0.5.3/jquery.timeago.js
+- doc/coverage/assets/0.5.3/loading.gif
+- doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
+files: 
+- lib/mattock/command-line.rb
+- lib/mattock/command-task.rb
+- lib/mattock/testing/rake-example-group.rb
+- lib/mattock/testing/mock-command-line.rb
+- lib/mattock/template-host.rb
+- lib/mattock/remote-command-task.rb
+- lib/mattock/tasklib.rb
+- lib/mattock/configurable.rb
+- lib/mattock.rb
+- doc/README
+- doc/Specifications
+- spec/command-line.rb
+- spec/command-task.rb
+- spec/tasklib.rb
+- spec/configurable.rb
+- spec_help/spec_helper.rb
+- spec_help/gem_test_suite.rb
+- doc/coverage/index.html
+- doc/coverage/assets/0.5.3/highlight.css
+- doc/coverage/assets/0.5.3/favicon_yellow.png
+- doc/coverage/assets/0.5.3/jquery.dataTables.min.js
+- doc/coverage/assets/0.5.3/stylesheet.css
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_sw.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_e.png
+- doc/coverage/assets/0.5.3/fancybox/blank.gif
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_n.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_s.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_w.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_over.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_close.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_loading.png
+- doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.pack.js
+- doc/coverage/assets/0.5.3/fancybox/fancybox-x.png
+- doc/coverage/assets/0.5.3/fancybox/fancybox-y.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_nav_right.png
+- doc/coverage/assets/0.5.3/fancybox/fancybox.png
+- doc/coverage/assets/0.5.3/fancybox/jquery.fancybox-1.3.1.css
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_right.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_left.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_ne.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_title_main.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_nw.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_nav_left.png
+- doc/coverage/assets/0.5.3/fancybox/fancy_shadow_se.png
+- doc/coverage/assets/0.5.3/favicon_green.png
+- doc/coverage/assets/0.5.3/magnify.png
+- doc/coverage/assets/0.5.3/smoothness/jquery-ui-1.8.4.custom.css
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_888888_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_2e83ff_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_454545_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_cd0a0a_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-icons_222222_256x240.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- doc/coverage/assets/0.5.3/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- doc/coverage/assets/0.5.3/jquery.url.js
+- doc/coverage/assets/0.5.3/app.js
+- doc/coverage/assets/0.5.3/favicon_red.png
+- doc/coverage/assets/0.5.3/highlight.pack.js
+- doc/coverage/assets/0.5.3/jquery.timeago.js
+- doc/coverage/assets/0.5.3/loading.gif
+- doc/coverage/assets/0.5.3/jquery-1.6.2.min.js
+homepage: http://mattock.rubyforge.org/
+licenses: 
+- MIT
+post_install_message: Another tidy package brought to you by Judson
+rdoc_options: 
+- --inline-source
+- --main
+- doc/README
+- --title
+- mattock-0.0.1 RDoc
+require_paths: 
+- lib/
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 304953233
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: mattock
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A powerful companion to Rake
+test_files: 
+- spec_help/gem_test_suite.rb