propel 0.2.2 → 0.3.1

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    propel (0.2.2)
+    propel (0.3.0)
+      colored
       json
 
 GEM
   remote: http://rubygems.org/
   specs:
+    colored (1.2)
     diff-lcs (1.1.2)
     json (1.5.1)
     rspec (2.5.0)

data/lib/propel.rb

@@ -1,5 +1,6 @@
 require 'propel/configuration'
 require 'propel/git_repository'
+require 'propel/logger'
 require 'propel/option_parser'
 require 'propel/remote_build'
 require 'propel/runner'

data/lib/propel/configuration.rb

@@ -1,19 +1,33 @@
 module Propel
   class Configuration
+
     def initialize(command_line_arguments, repository)
       @command_line_options = command_line_arguments
       @repository = repository
     end
 
     DEFAULTS = {
-        :fix_ci    => false,
-        :rebase   => true,
-        :verbose  => false,
-        :wait     => false
+        :color   => false,
+        :fix_ci  => false,
+        :rebase  => true,
+        :verbose => false,
+        :wait    => false
     }
 
     def options
-      DEFAULTS.merge(parse(options_from_config_file).merge(parse @command_line_options))
+      opts = DEFAULTS.merge(parse(options_from_config_file).merge(parse @command_line_options))
+      correct_color_setting!(opts)
+    end
+
+    def correct_color_setting!(opts)
+      if opts[:color_enabled] && RUBY_PLATFORM =~ /mswin|mingw/
+        unless ENV['ANSICON']
+          warn "You must use ANSICON 1.31 or later (http://adoxa.110mb.com/ansicon/) to use colour on Windows"
+          opts[:color] = false
+        end
+      end
+      
+      opts
     end
 
     def config_file

data/lib/propel/logger.rb

@@ -0,0 +1,38 @@
+module Propel
+  class Logger
+    COLORS = {
+        :red    => 31,
+        :green  => 32,
+        :yellow => 33,
+    }
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def print(message, color_sym = nil)
+      unless @configuration[:quiet]
+        Kernel.print color(message, color_sym)
+        STDOUT.flush
+      end
+    end
+
+    def puts(message, color_sym = nil)
+      Kernel.puts color(message, color_sym) unless @configuration[:quiet]
+    end
+
+    def warn(message, color_sym = nil)
+      Kernel.warn color(message, color_sym) unless @configuration[:quiet]
+    end
+
+    private
+    
+    def color(message, color_sym)
+      if @configuration[:color] && color_sym
+        "\e[#{COLORS[color_sym]}m#{message}\e[0m"
+      else
+        message
+      end
+    end
+  end
+end

data/lib/propel/option_parser.rb

@@ -25,16 +25,20 @@ module Propel
           options[:fix_ci] = o
         end
 
-        parser.on('-r', '--[no-]rebase', 'Determines whether or not pull uses rebase.  Propel uses rebase by default.') do |o|
+        parser.on('-r', '--[no-]rebase', 'Use pull with --rebase.  Rebase is used by default.') do |o|
           options[:rebase] = o
         end
 
-        parser.on('-w', '--[no-]wait', 'Waits for fixes to remote build') do |o|
+        parser.on('-c', '--[no-]color', '--[no-]colour', 'Turn on or off colored output. Color is off by default.') do |o|
+          options[:color] = o
+        end
+
+        parser.on('-w', '--[no-]wait', 'Waits for fixes to remote build.') do |o|
           options[:wait] = o
         end
 
-        parser.on('-v', '--verbose', 'Shows extra information') do |o|
-          options[:verbose] = o
+        parser.on('-q', '--[no-]quiet', 'Silences normal output messages.') do |o|
+          options[:quiet] = o
         end
       end
     end

data/lib/propel/runner.rb

@@ -1,35 +1,51 @@
 module Propel
   class Runner
+    attr_reader :logger
+    
     def initialize(args = [ ])
       @repository = GitRepository.new
-      @options = Configuration.new(args, @repository).options
+      @options    = Configuration.new(args, @repository).options
+      @logger     = Logger.new(@options)
     end
 
     def start
       if @repository.changed?
         if remote_build_configured?
-          check_remote_build! unless fix_ci?
+          
+          if @options[:fix_ci]
+            @logger.puts("Thanks for trying to fix the build!", :green)
+          else
+            check_remote_build!
+          end
 
         else
-          puts "Remote build is not configured, skipping check." if @options[:verbose]
+          @logger.warn "Remote build is not configured, you should point propel to the status URL of your CI server."
+          
         end
 
         propel!
       else
-        puts "There is nothing to propel - your HEAD is identical to #{@repository.remote_config} #{@repository.merge_config}."
+        @logger.puts("There is nothing to propel - your HEAD is identical to #{@repository.remote_config} #{@repository.merge_config}.", :green)
+        
       end
     end
 
     private
 
     def check_remote_build!
-      puts "Checking remote build..."
+      @logger.print "CI server status:\t"
+      STDOUT.flush
+
+      waited_for_build = false
       if @options[:wait]
         unless remote_build_green?
-          wait_with_notice do
-            log_wait_notice
+          waited_for_build = true
+          
+          say_duration do
+            @logger.puts("FAILING", :red)
+            @logger.puts "Waiting until the CI build is green."
             wait until remote_build_green?
-            puts "\nThe build has been fixed."
+            @logger.puts("\nThe CI build has been fixed.", :green)
           end
         end
 
@@ -38,41 +54,35 @@ module Propel
         alert_broken_build_and_exit unless remote_build_green?
       end
 
-      puts "Remote build is passing."
+      @logger.puts("PASSING", :green) unless waited_for_build
     end
 
-    def wait_with_notice
+    def say_duration
       start_time = Time.now
       yield
       end_time = Time.now
-      puts "We waited for #{(end_time - start_time).round} seconds while the build was failing."
-    end
-
-    def log_wait_notice
-      puts "The remote build is failing, waiting until it is green to proceed."
+      @logger.puts("We waited for #{(end_time - start_time).round} seconds while the build was failing.")
     end
 
     def alert_broken_build_and_exit
+      @logger.puts("FAILING", :red)
+
       msg = <<-EOS
-        The remote build is broken. If your commit fixes the build, run propel with the --fix-ci (-f) option.
-        If you're waiting for someone else to fix the build, use propel with --wait (-w).
+The remote build is broken. If your commit fixes the build, run propel with --fix-ci (-f).
+If you're waiting for someone else to fix the build, use propel with --wait (-w).
       EOS
 
-      $stderr.puts msg.split("\n").map(&:strip)
+      @logger.puts("")
+      warn msg
       exit 1
     end
 
-    def fix_ci?
-      @options[:fix_ci]
-    end
-
     def remote_build_configured?
       !@options[:status_url].nil?
     end
 
     def wait
-      print "."
-      STDOUT.flush
+      @logger.print(".", :yellow)
       sleep 5
     end
 

data/lib/propel/version.rb

@@ -1,3 +1,3 @@
 module Propel
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

data/propel.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
   s.add_dependency('json')
-  
+
   s.add_development_dependency('rspec', ["~> 2.5.0"])
 end

data/spec/propel/configuration_spec.rb

@@ -20,7 +20,7 @@ describe Propel::Configuration do
       configuration = Propel::Configuration.new([], Propel::GitRepository.new)
       configuration.stub!(:options_from_config_file).and_return([])
 
-      configuration.options.should == { :rebase => true, :fix_ci => false, :verbose => false, :wait => false}
+      configuration.options.should == { :rebase => true, :fix_ci => false, :verbose => false, :wait => false, :color => false }
     end    
   end
 

data/spec/propel/logger_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Propel::Logger do
+  describe "#print" do
+    it "should print the message when quiet mode is disabled" do
+      logger = Propel::Logger.new({:quiet => false})
+      Kernel.should_receive(:print).with('Hi')
+
+      logger.print('Hi')
+    end
+
+    it "should not print the message when quiet mode is enabled" do
+      logger = Propel::Logger.new({:quiet => true})
+      Kernel.should_not_receive(:print).with('Hi')
+
+      logger.print('Hi')
+    end
+
+    it "should colorize the method when color is enabled and a color is provided" do
+      logger = Propel::Logger.new({:quiet => false, :color => true})
+      Kernel.should_receive(:print).with("\e[32mHi\e[0m")
+
+      logger.print('Hi', :green)
+    end
+  end
+
+  describe "#puts" do
+    it "should puts the message when quiet mode is disabled" do
+      logger = Propel::Logger.new({:quiet => false})
+      Kernel.should_receive(:puts).with('Hi')
+
+      logger.puts('Hi')
+    end
+
+    it "should not puts the message when quiet mode is enabled" do
+      logger = Propel::Logger.new({:quiet => true})
+      Kernel.should_not_receive(:puts).with('Hi')
+
+      logger.puts('Hi')
+    end
+
+    it "should colorize the method when color is enabled and a color is provided" do
+      logger = Propel::Logger.new({:quiet => false, :color => true})
+      Kernel.should_receive(:puts).with("\e[31mHi\e[0m")
+
+      logger.puts('Hi', :red)
+    end
+  end
+
+  describe "#warn" do
+    it "should warn the message when quiet mode is disabled" do
+      logger = Propel::Logger.new({:quiet => false})
+      Kernel.should_receive(:warn).with('Hi')
+
+      logger.warn('Hi')
+    end
+
+    it "should not warn the message when quiet mode is enabled" do
+      logger = Propel::Logger.new({:quiet => true})
+      Kernel.should_not_receive(:warn).with('Hi')
+
+      logger.warn('Hi')
+    end
+
+    it "should colorize the method when color is enabled and a color is provided" do
+      logger = Propel::Logger.new({:quiet => false, :color => true})
+      Kernel.should_receive(:warn).with("\e[33mHi\e[0m")
+
+      logger.warn('Hi', :yellow)
+    end    
+  end
+end

data/spec/propel/option_parser_spec.rb

@@ -10,14 +10,14 @@ describe Propel::OptionParser do
       Propel::OptionParser.parse!(['--no-rebase'])[:rebase].should be_false
     end
 
-    it "should set verbose to true when given as an option" do
-      Propel::OptionParser.parse!(['--verbose'])[:verbose].should be_true
-    end
-
     it "should set wait to true when given as an option" do
       Propel::OptionParser.parse!(['--wait'])[:wait].should be_true
     end
 
+    it "should set quiet to true when given as an option" do
+      Propel::OptionParser.parse!(['--quiet'])[:quiet].should be_true
+    end
+
     it "should set the status url based on the given parameters" do
       Propel::OptionParser.parse!(['--status-url', 'http://ci.example.com/feed.rss'])[:status_url].
           should == 'http://ci.example.com/feed.rss'

data/spec/propel/runner_spec.rb

@@ -9,15 +9,14 @@ describe Propel::Runner do
 
   describe ".start" do
     it "should not call propel! if there is nothing to push" do
-      runner = Propel::Runner.new
+      runner = Propel::Runner.new(%w[--quiet])
       @git_repository.should_receive(:changed?).and_return(false)
       runner.should_not_receive(:propel!)
-      runner.stub!(:puts)
       runner.start
     end
 
     it "should call propel! if there are changes to the current branch" do
-      runner = Propel::Runner.new
+      runner = Propel::Runner.new(%w[--quiet])
 
       @git_repository.stub!(:changed?).and_return(true)
       @git_repository.stub!(:remote_config).and_return('origin')
@@ -28,34 +27,33 @@ describe Propel::Runner do
     end
 
     it "should call propel! if the remote build is configured and passing" do
-      runner = Propel::Runner.new(%w[ --status-url http://ci.example.com/status ])
+      runner = Propel::Runner.new(%w[ --status-url http://ci.example.com/status --quiet ])
+      
       runner.stub!(:remote_build_configured?).and_return(true)
       runner.stub!(:remote_build_green?).and_return(true)
 
       runner.should_receive(:propel!)
-      runner.should_receive(:puts).with("Checking remote build...")
-      runner.should_receive(:puts).with("Remote build is passing.")
       runner.start
     end
 
     it "should call propel! if the remote build is not configured" do
-      runner = Propel::Runner.new
+      runner = Propel::Runner.new(%w[--quiet])
       runner.stub!(:remote_build_configured?).and_return false
       runner.should_receive(:propel!)
+      runner.logger.should_receive(:warn).with("Remote build is not configured, you should point propel to the status URL of your CI server.")
 
       runner.start
     end
 
     class TestError < StandardError ; end
     it "should send an alert about the broken build if the remote build is configured but not passing" do
-      runner = Propel::Runner.new
+      runner = Propel::Runner.new(%w[--quiet])
       runner.stub!(:remote_build_configured?).and_return true
       runner.stub!(:remote_build_green?).and_return false
 
       runner.should_receive(:alert_broken_build_and_exit).and_raise(TestError.new("Execution should be aborted here"))
       runner.should_not_receive(:propel!)
 
-      runner.should_receive(:puts).with("Checking remote build...")
       lambda {
         runner.start
       }.should raise_error(TestError)
@@ -64,6 +62,7 @@ describe Propel::Runner do
     it "should call propel! when the remote build is failing if --fix-ci is specified" do
       runner = Propel::Runner.new %w[ --fix-ci ]
       runner.stub!(:remote_build_configured?).and_return true
+      runner.logger.should_receive(:puts).with("Thanks for trying to fix the build!", :green)
       runner.stub!(:remote_build_passing?).and_return false
       runner.should_receive(:propel!)
 
@@ -74,14 +73,17 @@ describe Propel::Runner do
       runner = Propel::Runner.new %w[ --fix-ci ]
       runner.stub!(:remote_build_configured?).and_return false
 
+      runner.logger.should_receive(:warn).with("Remote build is not configured, you should point propel to the status URL of your CI server.")
       runner.should_receive(:propel!)
 
       runner.start
     end
 
     it "should run a command using pull --rebase by default" do
-      runner = Propel::Runner.new
-      
+      runner = Propel::Runner.new(%w[--quiet])
+
+      runner.logger.should_receive(:warn).with("Remote build is not configured, you should point propel to the status URL of your CI server.")
+
       runner.should_receive(:system).with("git pull --rebase && rake && git push")
       runner.start
     end
@@ -89,23 +91,19 @@ describe Propel::Runner do
     it "should run a command using pull without --rebase when --no-rebase is specified" do
       runner = Propel::Runner.new(['--no-rebase'])
       runner.should_receive(:system).with("git pull && rake && git push")
+      runner.logger.should_receive(:warn).with("Remote build is not configured, you should point propel to the status URL of your CI server.")
+
       runner.start
     end
 
     it "should wait for the build to pass if the user specifies the --wait option" do
-      runner = Propel::Runner.new(['--wait'])
+      runner = Propel::Runner.new(%w[--wait --quiet])
       runner.stub!(:remote_build_configured?).and_return true
 
       runner.should_receive(:remote_build_green?).twice.and_return(false, true)
 
-      runner.should_receive(:log_wait_notice)
-
-      runner.should_receive(:wait_with_notice).and_yield
+      runner.should_receive(:say_duration).and_yield
 
-      runner.stub!(:puts)
-      runner.stub!(:print).with('.')
-      runner.stub!(:sleep).with(5)
-      
       runner.should_receive(:propel!)
       runner.start
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: propel
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Justin Leitgeb
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 -05:00
+date: 2011-05-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -68,6 +69,7 @@ files:
 - lib/propel.rb
 - lib/propel/configuration.rb
 - lib/propel/git_repository.rb
+- lib/propel/logger.rb
 - lib/propel/option_parser.rb
 - lib/propel/remote_build.rb
 - lib/propel/runner.rb
@@ -81,6 +83,7 @@ files:
 - spec/fixtures/team_city/passing_build.rss
 - spec/propel/configuration_spec.rb
 - spec/propel/git_repository_spec.rb
+- spec/propel/logger_spec.rb
 - spec/propel/option_parser_spec.rb
 - spec/propel/remote_build_spec.rb
 - spec/propel/runner_spec.rb