fudge 0.5.0 → 0.6.0

data/lib/fudge/build.rb

@@ -6,9 +6,10 @@ module Fudge
     #   @return [String] a brief description of the build; this is
     #                    output by the 'list' command
     attr_accessor :about
-    attr_accessor :callbacks
+    attr_accessor :callbacks, :time
     attr_reader :success_hooks, :failure_hooks
     attr_reader :description
+    attr_reader :formatter
 
     def initialize(*args)
       @success_hooks = []
@@ -19,26 +20,40 @@ module Fudge
 
     # Run task
     def run(options={})
-      formatter = options[:formatter] || Fudge::Formatters::Simple.new
+      start_time = Time.new
+      init_formatter(options)
       success = super
       if callbacks
-        message "Running #{success ? 'success' : 'failure'} callbacks...", formatter
-        hooks = success ? @success_hooks : @failure_hooks
-
-        hooks.each do |hook|
-          return false unless hook.run :formatter => formatter
-        end
+        return false unless run_callbacks(success)
       else
-        message "Skipping callbacks...", formatter
+        message "Skipping callbacks..."
       end
+      report_time(start_time, time)
 
       success
     end
 
     private
 
-    def message(message, formatter)
+    def message(message)
       formatter.write { |w| w.info(message) }
     end
+
+    def init_formatter(options)
+      @formatter = options[:formatter] || Fudge::Formatters::Simple.new
+    end
+
+    def report_time(start_time, time)
+      message "Finished in #{"%.2f" % (Time.new - start_time)} seconds." if time
+    end
+
+    def run_callbacks(success)
+      message "Running #{success ? 'success' : 'failure'} callbacks..."
+      hooks = success ? @success_hooks : @failure_hooks
+
+      hooks.each do |hook|
+        return false unless hook.run :formatter => formatter
+      end
+    end
   end
 end

data/lib/fudge/cli.rb

@@ -14,6 +14,7 @@ module Fudge
     desc "build [BUILD_NAME]",
       "Run a build with the given name (default: 'default')"
     method_option :callbacks, :type => :boolean, :default => false
+    method_option :time, :type => :boolean, :default => false
     # Runs the parsed builds
     # @param [String] build_name the given build to run (default 'default')
     def build(build_name='default')

data/lib/fudge/rspec/matchers.rb

@@ -4,68 +4,65 @@ RSpec::Matchers.define :be_registered_as do |key|
   end
 end
 
-# Collection of matchers for use in a test environment
-module FudgeMatchers
-  # Run matcher
-  class Run
-    attr_reader :args, :expected, :task
+RSpec::Matchers.define :run_command do |*expected|
+  match do |actual|
+    @args = expected.last.kind_of?(Hash) ? expected.delete_at(-1) : {}
+    @commands = expected
+    @args[:formatter] ||= Fudge::Formatters::Simple.new
 
-    def initialize(expected, args={})
-      @expected = expected
-      @args = args
-      @args[:formatter] ||= Fudge::Formatters::Simple.new
-    end
-
-    def matches?(task)
-      @task = task
-      ran = []
+    @ran = []
 
-      to_stub =
-        if task.is_a?(Fudge::Tasks::Shell)
-          task
-        else
-          Fudge::Tasks::Shell.any_instance
-        end
-
-      to_stub.stub(:run_command) do |cmd, formatter|
+    stub = ->(*cmd, formatter) {
         raise "Run Command requires a formatter" unless formatter
-        ran.push(cmd)
+        @ran.push(*cmd)
         ['dummy output', true]
-      end
+    }
 
-      task.run(args)
-
-      @actual = ran
-      run_matches?(ran, expected)
+    if RSpec::Version::STRING =~ /\A3\.[0-9]+\.[0-9]+/
+      if actual.is_a?(Fudge::Tasks::Shell)
+        allow(actual).to receive(:run_command, &stub)
+      else
+        allow_any_instance_of(Fudge::Tasks::Shell).to receive(:run_command, &stub)
+      end
+    else
+      if actual.is_a?(Fudge::Tasks::Shell)
+        actual.stub(:run_command, &stub)
+      else
+        Fudge::Tasks::Shell.any_instance.stub(:run_command, &stub)
+      end
     end
 
-    # Failure message
-    def failure_message_for_should
-      message = ""
-      message << "Expected task :#{@task.class.name} "
-      message << "to run:\n  #{@expected}\n"
-      message << "but it ran:\n  #{@actual}"
-    end
+    actual.run(@args)
 
-    private
-    def run_matches?(ran, expected)
-      if expected.is_a? Regexp
-        ran.any? {|cmd| cmd =~ expected}
+    @commands.all? do |cmd|
+      if cmd.is_a? Regexp
+        @ran.any? {|ran| ran =~ cmd}
       else
-        ran.include? expected
+        @ran.include? cmd
       end
     end
   end
-end
 
-# Matcher to test a command has been run by the task
-def run_command(cmd, options={})
-  FudgeMatchers::Run.new cmd, options
+  format_message = ->(actual) {
+    message = ""
+    message << "Expected task :#{actual.class.name} "
+    message << "to run:\n  #{@commands}\n"
+    message << "but it ran:\n  #{@ran}"
+  }
+  if RSpec::Version::STRING =~ /\A3\.[0-9]+\.[0-9]+/
+    failure_message(&format_message)
+  else
+    failure_message_for_should(&format_message)
+  end
 end
 
 RSpec::Matchers.define :succeed_with_output do |output|
   match do |subject|
-    subject.stub(:run_command).and_return([output, true])
+    if RSpec::Version::STRING =~ /\A3\.[0-9]+\.[0-9]+/
+      allow(subject).to receive(:run_command).and_return([output, true])
+    else
+      subject.stub(:run_command).and_return([output, true])
+    end
 
     subject.run
   end
@@ -76,11 +73,19 @@ shared_examples_for 'bundle aware' do
     @normal_cmd = subject.send(:cmd)
   end
 
-  it "should prefix the command with bundle exec when bundler is set" do
-    subject.should run_command("bundle exec #{@normal_cmd}", :bundler => true)
+  it "prefixes the command with bundle exec when bundler is set" do
+    if RSpec::Version::STRING =~ /\A3\.[0-9]+\.[0-9]+/
+      expect(subject).to run_command("bundle exec #{@normal_cmd}", :bundler => true)
+    else
+      subject.should run_command("bundle exec #{@normal_cmd}", :bundler => true)
+    end
   end
 
-  it "should not prefix the command with bundle exec when bundler is not set" do
-    subject.should run_command(@normal_cmd, :bundler => false)
+  it "does not prefix the command with bundle exec when bundler is not set" do
+    if RSpec::Version::STRING =~ /\A3\.[0-9]+\.[0-9]+/
+      expect(subject).to run_command(@normal_cmd, :bundler => false)
+    else
+      subject.should run_command(@normal_cmd, :bundler => false)
+    end
   end
 end

data/lib/fudge/runner.rb

@@ -26,6 +26,7 @@ module Fudge
       # Run the build
       build = @description.builds[which.to_sym]
       build.callbacks = options[:callbacks]
+      build.time = options[:time]
       build.run :formatter => options[:formatter]
     end
 

data/lib/fudge/tasks/composite_task.rb

@@ -13,7 +13,7 @@ module Fudge
 
       # Runs the task (by default running all other tasks in order)
       def run(options={})
-        formatter = options[:formatter] || Fudge::Formatters::Simple.new
+        formatter = get_formatter(options)
         tasks.each do |t|
           apply_directory_settings(t)
           output_message(t, formatter)
@@ -53,9 +53,11 @@ module Fudge
       end
 
       def output_message(t, formatter)
-          formatter.write do |w|
-            w.info("Running task").notice(task_name(t)).notice(args_s(t))
-          end
+        name = task_name(t)
+        args = args_s(t)
+        formatter.write do |w|
+          w.info("Running task").notice(name).notice(args)
+        end
       end
 
     end

data/lib/fudge/tasks/each_directory.rb

@@ -13,7 +13,7 @@ module Fudge
 
       # Run task
       def run(options={})
-        formatter = options[:formatter] || Fudge::Formatters::Simple.new
+        formatter = get_formatter(options)
         directories.all? do |dir|
           skip_directory?(dir) ||
             WithDirectory.new(dir, formatter).inside do

data/lib/fudge/tasks/in_directory.rb

@@ -11,7 +11,7 @@ module Fudge
 
       # Run task
       def run(options={})
-        formatter = options[:formatter] || Fudge::Formatters::Simple.new
+        formatter = get_formatter(options)
         WithDirectory.new(@directory, formatter).inside do
           super
         end

data/lib/fudge/tasks/shell.rb

@@ -12,7 +12,7 @@ module Fudge
       #
       # @param [Hash] options Any options to pass to the shell
       def run(options={})
-        formatter = options[:formatter] || Fudge::Formatters::Simple.new
+        formatter = get_formatter(options)
         @output, success = run_command(cmd(options), formatter)
 
         return false unless success

data/lib/fudge/tasks/task.rb

@@ -22,6 +22,11 @@ module Fudge
 
         @args
       end
+
+      private
+      def get_formatter(options = {})
+        options[:formatter] || Fudge::Formatters::Simple.new
+      end
     end
   end
 end

data/lib/fudge/version.rb

@@ -1,4 +1,4 @@
 module Fudge
   # Define gem version
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/lib/fudge/build_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Fudge::Build do
-  it { should be_a Fudge::Tasks::CompositeTask }
+  it { is_expected.to be_a Fudge::Tasks::CompositeTask }
 
   describe "#run" do
 
@@ -12,8 +12,8 @@ describe Fudge::Build do
       it "prints messages to the formatter instead of default" do
         subject.run :formatter => formatter
 
-        stdout.string.should_not be_empty
-        stdout.string.should include "Skipping callbacks..."
+        expect(stdout.string).not_to be_empty
+        expect(stdout.string).to include "Skipping callbacks..."
       end
 
       context "when there are callback hooks" do
@@ -25,7 +25,22 @@ describe Fudge::Build do
         end
 
         it "passesformatter down to the hook run" do
-          hook.should_receive(:run).with(:formatter =>formatter).and_return(true)
+          expect(hook).to receive(:run).with(:formatter =>formatter).and_return(true)
+          subject.run :formatter => formatter
+        end
+      end
+
+      context "when the `time` flag is set" do
+        before do
+          subject.callbacks = true
+          allow(subject).to receive(:run_callbacks).and_return(true)
+          subject.time = true
+        end
+
+        it "should print out the time of the build" do
+          expect(subject).to receive(:message) do |message|
+            expect(message).to match /Finished in \d+.\d\d seconds./
+          end
           subject.run :formatter => formatter
         end
       end

data/spec/lib/fudge/cli_spec.rb

@@ -18,7 +18,7 @@ describe Fudge::Cli do
     AnotherDummyTask.ran = false
   end
 
-  describe :build do
+  describe ".build" do
     before :each do
       contents = <<-RUBY
           build :default do
@@ -30,26 +30,26 @@ describe Fudge::Cli do
           end
         RUBY
       file = double(File, read: contents, path: 'here')
-      File.stub(:open) { |&block| block.yield file }
+      allow(File).to receive(:open) { |&block| block.yield file }
     end
 
     context "when not given a build name" do
       it "runs the default build" do
         subject.build 'default'
-        expect(DummyTask.ran).to be_true
+        expect(DummyTask.ran).to be_truthy
       end
     end
 
     context "when given a build name" do
       it "runs the only the named build" do
         subject.build 'other'
-        expect(DummyTask.ran).to be_false
-        expect(AnotherDummyTask.ran).to be_true
+        expect(DummyTask.ran).to be_falsey
+        expect(AnotherDummyTask.ran).to be_truthy
       end
     end
   end
 
-  describe :init do
+  describe ".init" do
     let (:file_state) { { exists: false, content: '' } }
     let (:override_file_state) do
       ->(exists, content) {
@@ -60,18 +60,18 @@ describe Fudge::Cli do
 
     before :each do
       file = double(File)
-      file.stub(:<<) { |str| file_state[:content] = str }
-      file.stub(:read) { file_state[:content] }
-      File.stub(:open) do |&block|
+      allow(file).to receive(:<<) { |str| file_state[:content] = str }
+      allow(file).to receive(:read) { file_state[:content] }
+      allow(File).to receive(:open) do |&block|
         file_state[:exists] = true
         block.yield file
       end
-      File.stub(:exists?) { |_| file_state[:exists] }
+      allow(File).to receive(:exists?) { |_| file_state[:exists] }
 
       @output = ''
       shell = double('Thor::Shell')
-      shell.stub(:say) { |what| @output = what }
-      subject.stub(:shell).and_return(shell)
+      allow(shell).to receive(:say) { |what| @output = what }
+      allow(subject).to receive(:shell).and_return(shell)
     end
 
     context "when a Fudgefile does not exist in the current directory" do
@@ -117,7 +117,7 @@ describe Fudge::Cli do
     end
   end
 
-  describe :list do
+  describe ".list" do
     before :each do
       contents = <<-RUBY
           build :default do
@@ -129,12 +129,12 @@ describe Fudge::Cli do
           end
         RUBY
       file = double(File, read: contents, path: 'here')
-      File.stub(:open) { |&block| block.yield file }
+      allow(File).to receive(:open) { |&block| block.yield file }
 
       @output = ''
       shell = double('Thor::Shell')
-      shell.stub(:print_table) { |tab| @output = tab.map { |build, desc| "#{build}\t#{desc}" }.join("\n") }
-      subject.stub(:shell).and_return(shell)
+      allow(shell).to receive(:print_table) { |tab| @output = tab.map { |build, desc| "#{build}\t#{desc}" }.join("\n") }
+      allow(subject).to receive(:shell).and_return(shell)
     end
 
     context "when not given a filter string" do

data/spec/lib/fudge/description_spec.rb

@@ -1,8 +1,13 @@
 require 'spec_helper'
 
 describe Fudge::Description do
+  let(:input) { '' }
+  let(:file) { StringIO.new(input).tap { |s| allow(s).to receive(:path).and_return('') } }
+  subject { described_class.new(file) }
+
   let(:build) { subject.builds.values.first }
-  let(:build_tasks) { build.tasks.map }
+  let(:build_tasks) { build.tasks.dup }
+
 
   def make_build
     subject.build :default do
@@ -12,38 +17,34 @@ describe Fudge::Description do
     build.callbacks = callbacks
   end
 
-  let(:input) { '' }
-  let(:file) { StringIO.new(input).tap { |s| s.stub(:path).and_return('') } }
-  subject { described_class.new file }
-
-  describe :initialize do
+  describe "#initialize" do
     let(:input) { 'build :foo do; end' }
 
     it "should add the builds in the given string" do
-      subject.builds[:foo].should be_a Fudge::Build
+      expect(subject.builds[:foo]).to be_a Fudge::Build
     end
   end
 
-  describe :build do
+  describe "#build" do
     it "should create a new build and add it to the builds array" do
-      subject.builds.should be_empty
+      expect(subject.builds).to be_empty
 
       subject.build :some_branch do
       end
 
-      subject.builds.should have(1).item
-      subject.builds[:some_branch].should be_a Fudge::Build
+      expect(subject.builds.size).to eq(1)
+      expect(subject.builds[:some_branch]).to be_a Fudge::Build
     end
   end
 
-  describe :task do
+  describe "#task" do
     it "should add a task to the current scope" do
       subject.build :default do
         subject.task :dummy
       end
 
-      build_tasks.should have(1).item
-      build_tasks.first.should be_a DummyTask
+      expect(build_tasks.size).to eq(1)
+      expect(build_tasks.first).to be_a DummyTask
     end
 
     it "should pass arguments to the initializer" do
@@ -51,7 +52,7 @@ describe Fudge::Description do
         subject.task :dummy, :foo, :bar
       end
 
-      build_tasks.first.args.should == [:foo, :bar]
+      expect(build_tasks.first.args).to eq([:foo, :bar])
     end
 
     it "should forward missing methods to task" do
@@ -59,7 +60,7 @@ describe Fudge::Description do
         subject.dummy :foo, :bar
       end
 
-      build_tasks.first.args.should == [:foo, :bar]
+      expect(build_tasks.first.args).to eq([:foo, :bar])
     end
 
     it "should super method_missing if no task found" do
@@ -73,11 +74,11 @@ describe Fudge::Description do
         end
       end
 
-      build_tasks.first.tasks.first.should be_a DummyTask
+      expect(build_tasks.first.tasks.first).to be_a DummyTask
     end
   end
 
-  describe :task_group do
+  describe "#task_group" do
     it "should add a task group and allow it to be used in a build" do
       subject.task_group :group1 do
         subject.task :dummy
@@ -88,7 +89,7 @@ describe Fudge::Description do
       end
 
       subject.builds[:default].run
-      DummyTask.ran.should be_true
+      expect(DummyTask.ran).to be_truthy
     end
 
     it "should allow passing arguments to task groups" do
@@ -101,7 +102,7 @@ describe Fudge::Description do
       end
 
       subject.builds[:default].run
-      DummyTask.ran.should be_true
+      expect(DummyTask.ran).to be_truthy
     end
 
     it "should raise an exception if task group not found" do
@@ -127,7 +128,7 @@ describe Fudge::Description do
         end
 
         subject.builds[:default].run
-        DummyTask.ran.should be_true
+        expect(DummyTask.ran).to be_truthy
       end
 
       it "supports when options are given" do
@@ -140,9 +141,9 @@ describe Fudge::Description do
         subject.builds[:default].run
 
         # Check that the options are maintained through the call
-        build_tasks.first.args.should have(2).items
-        build_tasks.first.args[1][:foobar].should be_true
-        DummyTask.ran.should be_true
+        expect(build_tasks.first.args.size).to eq(2)
+        expect(build_tasks.first.args[1][:foobar]).to be_truthy
+        expect(DummyTask.ran).to be_truthy
       end
     end
 
@@ -151,13 +152,13 @@ describe Fudge::Description do
   describe "Callback Hooks" do
     before :each do
       @ran = []
-      Fudge::Tasks::Shell.any_instance.stub(:run_command) do |cmd|
-        @ran << cmd
-        ['', cmd != 'fail']
+      allow_any_instance_of(Fudge::Tasks::Shell).to receive(:run_command) do |cmd|
+        @ran << cmd.arguments
+        ['', cmd.arguments != 'fail']
       end
     end
 
-    describe :on_success do
+    describe "#on_success" do
       context "when callbacks is set to true" do
         let(:callbacks) { true }
 
@@ -167,8 +168,8 @@ describe Fudge::Description do
             subject.on_success { subject.shell 'BAR' }
           end
 
-          build.run.should be_true
-          @ran.should == ['FOO', 'BAR']
+          expect(build.run).to be_truthy
+          expect(@ran).to eq(['FOO', 'BAR'])
         end
 
         it "fails the build HARD when hooks fail" do
@@ -177,8 +178,8 @@ describe Fudge::Description do
             subject.on_success { subject.shell 'BAR' }
           end
 
-          build.run.should be_false
-          @ran.should == ['fail']
+          expect(build.run).to be_falsey
+          expect(@ran).to eq(['fail'])
         end
       end
 
@@ -190,15 +191,15 @@ describe Fudge::Description do
             subject.on_success { subject.shell 'echo "WOOP"' }
           end
 
-          build.run.should be_true
-          @ran.should == []
+          expect(build.run).to be_truthy
+          expect(@ran).to eq([])
         end
       end
     end
 
-    describe :on_failure do
+    describe "#on_failure" do
       before :each do
-        DummyTask.any_instance.stub(:run).and_return(false)
+        allow_any_instance_of(DummyTask).to receive(:run).and_return(false)
       end
 
       context "when callbacks is set to true" do
@@ -210,8 +211,8 @@ describe Fudge::Description do
             subject.on_failure { subject.shell 'BAR' }
           end
 
-          build.run.should be_false
-          @ran.should == ['WOOP', 'BAR']
+          expect(build.run).to be_falsey
+          expect(@ran).to eq(['WOOP', 'BAR'])
         end
 
         it "fails the build HARD when hooks fail" do
@@ -220,8 +221,8 @@ describe Fudge::Description do
             subject.on_failure { subject.shell 'BAR' }
           end
 
-          build.run.should be_false
-          @ran.should == ['fail']
+          expect(build.run).to be_falsey
+          expect(@ran).to eq(['fail'])
         end
       end
 
@@ -233,8 +234,8 @@ describe Fudge::Description do
             subject.on_failure { subject.shell 'WOOP' }
           end
 
-          build.run.should be_false
-          @ran.should == []
+          expect(build.run).to be_falsey
+          expect(@ran).to eq([])
         end
       end
     end