cocaine 0.4.0 → 0.4.1

data/NEWS.md

@@ -1,3 +1,18 @@
+New for 0.4.1:
+
+* Introduce FakeRunner for testing, so you don't really run commands.
+* Fix logging: output the actual command, not the un-interpolated pattern.
+* Prevent color codes from being output if log destination isn't a TTY.
+
+New for 0.4.0:
+
+* Moved interpolation to the `run` method, instead of interpolating on `new`.
+* Remove official support for REE.
+
+New for 0.3.2:
+
+* Fix a hang when processes wait for IO.
+
 New for 0.3.1:
 
 * Made the `Runner` manually swappable, in case `ProcessRunner` doesn't work

data/lib/cocaine/command_line.rb

@@ -29,6 +29,14 @@ module Cocaine
         @runner || best_runner
       end
 
+      def fake!
+        @runner = FakeRunner.new
+      end
+
+      def unfake!
+        @runner = nil
+      end
+
       private
 
       def best_runner
@@ -63,8 +71,9 @@ module Cocaine
     def run(interpolations = {})
       output = ''
       begin
-        @logger.info("\e[32mCommand\e[0m :: #{command}") if @logger
-        output = execute(command(interpolations))
+        full_command = command(interpolations)
+        log("#{colored("Command")} :: #{full_command}")
+        output = execute(full_command)
       rescue Errno::ENOENT
         raise Cocaine::CommandNotFoundError
       ensure
@@ -85,6 +94,20 @@ module Cocaine
 
     private
 
+    def colored(text, ansi_color = "\e[32m")
+      if @logger && @logger.tty?
+        "#{ansi_color}#{text}\e[0m"
+      else
+        text
+      end
+    end
+
+    def log(text)
+      if @logger
+        @logger.info(text)
+      end
+    end
+
     def execute(command)
       runner.call(command, environment)
     end

data/lib/cocaine/command_line/runners.rb

@@ -1,3 +1,4 @@
 require 'cocaine/command_line/runners/backticks_runner'
 require 'cocaine/command_line/runners/process_runner'
 require 'cocaine/command_line/runners/posix_runner'
+require 'cocaine/command_line/runners/fake_runner'

data/lib/cocaine/command_line/runners/fake_runner.rb

@@ -0,0 +1,22 @@
+module Cocaine
+  class CommandLine
+    class FakeRunner
+      
+      attr_reader :commands
+
+      def initialize
+        @commands = []
+      end
+
+      def call(command, env = {})
+        commands << [command, env]
+        ""
+      end
+
+      def ran?(predicate_command)
+        @commands.any?{|(command, env)| command =~ Regexp.new(predicate_command) }
+      end
+
+    end
+  end
+end

data/lib/cocaine/version.rb

@@ -1,3 +1,3 @@
 module Cocaine
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

data/spec/cocaine/command_line/runners/fake_runner_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Cocaine::CommandLine::FakeRunner do
+  it 'records commands' do
+    subject.call("some command", :environment)
+    subject.call("other command", :other_environment)
+    subject.commands.should eq [["some command", :environment], ["other command", :other_environment]]
+  end
+
+  it 'can tell if a command was run' do
+    subject.call("some command", :environment)
+    subject.call("other command", :other_environment)
+    subject.ran?("some command").should be_true
+    subject.ran?("no command").should be_false
+  end
+
+  it 'can tell if a command was run even if shell options were set' do
+    subject.call("something 2>/dev/null", :environment)
+    subject.ran?("something").should be_true
+  end
+
+end

data/spec/cocaine/command_line_spec.rb

@@ -173,18 +173,22 @@ describe Cocaine::CommandLine do
     Cocaine::CommandLine.new("convert").should_not be_unix
   end
 
+  it "colorizes the output to a tty" do
+    logger = FakeLogger.new(:tty => true)
+    Cocaine::CommandLine.new("echo", "'Logging!' :foo", :logger => logger).run(:foo => "bar")
+    logger.entries.should include("\e[32mCommand\e[0m :: echo 'Logging!' 'bar'")
+  end
+
   it "logs the command to a supplied logger" do
-    logger = stub
-    logger.stubs(:info).with(anything).returns(nil)
-    Cocaine::CommandLine.new("echo", "'Logging!'", :logger => logger).run
-    logger.should have_received(:info).with("\e[32mCommand\e[0m :: echo 'Logging!'")
+    logger = FakeLogger.new
+    Cocaine::CommandLine.new("echo", "'Logging!' :foo", :logger => logger).run(:foo => "bar")
+    logger.entries.should include("Command :: echo 'Logging!' 'bar'")
   end
 
   it "logs the command to a default logger" do
-    Cocaine::CommandLine.logger = stub
-    Cocaine::CommandLine.logger.stubs(:info).with(anything).returns(nil)
+    Cocaine::CommandLine.logger = FakeLogger.new
     Cocaine::CommandLine.new("echo", "'Logging!'").run
-    Cocaine::CommandLine.logger.should have_received(:info).with("\e[32mCommand\e[0m :: echo 'Logging!'")
+    Cocaine::CommandLine.logger.entries.should include("Command :: echo 'Logging!'")
   end
 
   it "is fine if no logger is supplied" do
@@ -232,5 +236,27 @@ describe Cocaine::CommandLine do
       cmd.runner.class.should == Cocaine::CommandLine::BackticksRunner
     end
 
+    it "can go into 'Fake' mode" do
+      Cocaine::CommandLine.fake!
+
+      cmd = Cocaine::CommandLine.new("echo", "hello")
+      cmd.runner.class.should eq Cocaine::CommandLine::FakeRunner
+    end
+
+    it "can turn off Fake mode" do
+      Cocaine::CommandLine.fake!
+      Cocaine::CommandLine.unfake!
+
+      cmd = Cocaine::CommandLine.new("echo", "hello")
+      cmd.runner.class.should_not eq Cocaine::CommandLine::FakeRunner
+    end
+
+    it "can use a FakeRunner even if not in Fake mode" do
+      Cocaine::CommandLine.unfake!
+
+      cmd = Cocaine::CommandLine.new("echo", "hello", :runner => Cocaine::CommandLine::FakeRunner.new)
+      cmd.runner.class.should eq Cocaine::CommandLine::FakeRunner
+    end
+
   end
 end

data/spec/support/fake_logger.rb

@@ -0,0 +1,18 @@
+class FakeLogger
+  def initialize(options = {})
+    @tty = options[:tty]
+    @entries = []
+  end
+
+  def info(text)
+    @entries << text
+  end
+
+  def entries
+    @entries
+  end
+
+  def tty?
+    @tty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocaine
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -110,15 +110,18 @@ files:
 - lib/cocaine/command_line.rb
 - lib/cocaine/command_line/runners.rb
 - lib/cocaine/command_line/runners/backticks_runner.rb
+- lib/cocaine/command_line/runners/fake_runner.rb
 - lib/cocaine/command_line/runners/posix_runner.rb
 - lib/cocaine/command_line/runners/process_runner.rb
 - lib/cocaine/exceptions.rb
 - lib/cocaine/version.rb
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
+- spec/cocaine/command_line/runners/fake_runner_spec.rb
 - spec/cocaine/command_line/runners/posix_runner_spec.rb
 - spec/cocaine/command_line/runners/process_runner_spec.rb
 - spec/cocaine/command_line_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_logger.rb
 - spec/support/nonblocking_examples.rb
 - spec/support/stub_os.rb
 - spec/support/with_exitstatus.rb
@@ -148,10 +151,12 @@ specification_version: 3
 summary: A small library for doing (command) lines
 test_files:
 - spec/cocaine/command_line/runners/backticks_runner_spec.rb
+- spec/cocaine/command_line/runners/fake_runner_spec.rb
 - spec/cocaine/command_line/runners/posix_runner_spec.rb
 - spec/cocaine/command_line/runners/process_runner_spec.rb
 - spec/cocaine/command_line_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_logger.rb
 - spec/support/nonblocking_examples.rb
 - spec/support/stub_os.rb
 - spec/support/with_exitstatus.rb