rake_bubbler 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+  gem 'rake'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "ruby-debug"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.4)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.11)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rake
+  rcov
+  ruby-debug
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 innov8on.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= rake-bubbler gem
+
+This gem allows capturing raketask output along with additional information (task name, duration, start time, error) while preserving old rake behavior. Such functionality can be useful for logging and monitoring purposes.
+
+Actions and prerequisites are captured as well.
+
+== Configuration
+
+Configuration should be included in Rakefile:
+
+  RakeBubbler::RakeBubbler.config do |config|
+
+    # tasks to be captured (default none)
+    config.tasks = ['db:migrate', 'upload']
+
+    config.executed = Proc.new do |task_name, duration, output, started, error|
+      puts task_name  => "example_task"
+      puts duration   => 3.0709819
+      puts output     => "Example output\n"
+      puts started    => Thu Nov 03 11:13:27 +0100 2011
+      puts error      => nil
+    end
+
+    # additional conditions required to capture data (optional)
+    config.conditions = Proc.new do
+      [true, false][rand(2)]
+    end
+
+  end  
+
+=== Executed option parameters
+
+[+task_name+] Name of the task.
+[+duration+] Real task duration with actions and prerequisites.
+[+output+] Task output captured from stdout.
+[+started+] Time when task execution began.
+[+error+] Exception captured during task execution. Nil if none.
+
+== Contributing to rake-bubbler
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 innov8on.com. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rake_bubbler"
+  gem.homepage = "http://github.com/Innov8on/RakeBubbler"
+  gem.license = "MIT"
+  gem.summary = %Q{Captures raketask output along with additional information (task name, duration, start time, error) for further usage.}
+  gem.email = "grzegorz@innov8on.com"
+  gem.authors = ["Grzegorz Miklaszewski"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rake_bubbler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rake_bubbler.rb

@@ -0,0 +1,9 @@
+require 'rake'
+
+require 'rake_bubbler/config'
+require 'rake_bubbler/bubble_task'
+require 'rake_bubbler/rake_bubbler'
+
+Rake::Task.class_eval do
+  include RakeBubbler::BubbleTask
+end

data/lib/rake_bubbler/bubble_task.rb

@@ -0,0 +1,43 @@
+require 'benchmark'
+require 'digest/md5'
+require 'shell'
+require 'tempfile'
+
+module RakeBubbler
+  module BubbleTask
+
+    def self.included(klass)
+      klass.class_eval do
+
+        def invoke_with_output_capture(*params)
+          return invoke_without_output_capture(*params) unless RakeBubbler.capture_task?(name)
+    
+          duration, error = nil
+          started = Time.now
+    
+          # capture task output
+          output = RakeBubbler.capture_output do
+            time = Benchmark.measure(name) do
+              begin
+                # invoke task
+                invoke_without_output_capture(*params)
+              rescue Exception => e
+                error = e
+              end
+            end
+    
+            duration = time.real
+          end
+    
+          RakeBubbler.executed(name, duration, output, started, error)
+          raise error if error
+        end  # invoke_with_output_capture
+
+        alias_method :invoke_without_output_capture, :invoke
+        alias_method :invoke, :invoke_with_output_capture 
+
+      end
+    end
+    
+  end  # BubbleTask 
+end # RakeBubbler

data/lib/rake_bubbler/config.rb

@@ -0,0 +1,17 @@
+module RakeBubbler
+  class Config
+    attr_writer :tasks, :conditions, :executed
+
+    def call_executed(name, duration, output, started, error)
+      @executed.respond_to?(:call) && @executed.call(name, duration, output, started, error)
+    end
+
+    def tasks_include?(name)
+      @tasks.respond_to?(:include?) && @tasks.include?(name)
+    end
+
+    def call_conditions
+      !@conditions.respond_to?(:call) || @conditions.call
+    end
+  end
+end

data/lib/rake_bubbler/rake_bubbler.rb

@@ -0,0 +1,47 @@
+module RakeBubbler
+  module RakeBubbler
+    extend self
+
+    @config = Config.new
+
+    def config
+      yield @config
+    end
+
+    def executed(name, duration, output, started, error)
+      @config.call_executed(name, duration, output, started, error) 
+    end
+
+    def capture_task?(name)
+      @config.tasks_include?(name) && @config.call_conditions
+    end
+
+    def capture_output
+      file = Tempfile.new(Digest::MD5.hexdigest((Time.now.to_i + rand(2**16)).to_s))
+  
+      read, write = IO.pipe
+  
+      save_stdout = $stdout.dup
+      $stdout.reopen(write)
+  
+      if fork
+        read.close
+        yield
+        write.close
+        $stdout.reopen(save_stdout)
+        save_stdout.close
+        Process.wait
+        file.unlink
+        file.read
+      else
+        write.close
+        $stdout.close
+        Shell.new.tee(file.path) < read > save_stdout
+        read.close
+        save_stdout.close
+        exit!
+      end  # fork
+    end  # capture_output
+
+  end
+end

data/rake_bubbler.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rake_bubbler}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Grzegorz Miklaszewski"]
+  s.date = %q{2011-11-03}
+  s.email = %q{grzegorz@innov8on.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rake_bubbler.rb",
+    "lib/rake_bubbler/bubble_task.rb",
+    "lib/rake_bubbler/config.rb",
+    "lib/rake_bubbler/rake_bubbler.rb",
+    "rake_bubbler.gemspec",
+    "test/helper.rb",
+    "test/test_rake_bubbler.rb"
+  ]
+  s.homepage = %q{http://github.com/Innov8on/RakeBubbler}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{Captures raketask output along with additional information (task name, duration, start time, error) for further usage.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rake_bubbler'
+
+class Test::Unit::TestCase
+end

data/test/test_rake_bubbler.rb

@@ -0,0 +1,79 @@
+require 'helper'
+
+class TestRakeBubbler < Test::Unit::TestCase
+  extend Rake::DSL
+
+  task(:bubbler_task1){ puts "Task 1"; sleep 1; }
+  task(:bubbler_task2, [:arg1] => :bubbler_task1){ puts "Task 2" }
+  task(:error_task){ puts "Error task"; raise 'Help me!!!' }
+
+  context 'executed block' do
+    setup do
+	    @run = 0
+	    @name, @duration, @output, @started, @error = nil
+	  
+	    @executed_proc = Proc.new do |p_name, p_duration, p_output, p_started, p_error|
+	      @run += 1
+	      @name      = p_name
+	      @duration  = p_duration
+	      @output    = p_output
+	      @started   = p_started
+        @error     = p_error
+	    end
+    end
+
+	  should 'should be executed if no error' do
+	    config(['bubbler_task2'], nil, @executed_proc) 
+	    Rake::Task['bubbler_task2'].invoke('10')
+	
+	    assert_equal 1, @run
+	    assert_equal "Task 1\nTask 2\n", @output
+	    assert_operator @duration, :>, 0
+	    assert_kind_of Time, @started
+	    assert_equal 'bubbler_task2', @name
+      assert_nil @error
+	  end
+
+    should 'be executed if error' do
+	    config(['error_task'], nil, @executed_proc)
+      
+      assert_raise(RuntimeError) do
+	      Rake::Task['error_task'].invoke
+      end
+	
+	    assert_equal 1, @run
+	    assert_equal "Error task\n", @output
+	    assert_operator @duration, :>, 0
+	    assert_kind_of Time, @started
+	    assert_equal 'error_task', @name
+      assert_not_nil @error
+    end
+  end # end context executed block
+
+  context '.capture_task?' do
+    should 'return true if task is included on the list' do
+      config(['bubbler_task1'])
+      assert RakeBubbler::RakeBubbler.capture_task?('bubbler_task1')
+    end
+
+    should 'return false if conditions are not met' do
+      config(['bubbler_task1'], Proc.new{false})
+      assert !RakeBubbler::RakeBubbler.capture_task?('bubbler_task1')
+    end
+
+    should 'return false if task is not on the list' do
+      config()
+      assert !RakeBubbler::RakeBubbler.capture_task?('bubbler_task1')
+    end
+  end # end context .capture_task?
+
+  private
+
+  def config(tasks = nil, conditions = nil, executed = nil)
+		RakeBubbler::RakeBubbler.config do |config|
+		  config.tasks        = tasks
+		  config.conditions   = conditions
+		  config.executed     = executed
+		end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: rake_bubbler
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Grzegorz Miklaszewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: rake
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: ruby-debug
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id004
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id005
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: rcov
+  prerelease: false
+  type: :development
+description: 
+email: grzegorz@innov8on.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rake_bubbler.rb
+- lib/rake_bubbler/bubble_task.rb
+- lib/rake_bubbler/config.rb
+- lib/rake_bubbler/rake_bubbler.rb
+- rake_bubbler.gemspec
+- test/helper.rb
+- test/test_rake_bubbler.rb
+homepage: http://github.com/Innov8on/RakeBubbler
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Captures raketask output along with additional information (task name, duration, start time, error) for further usage.
+test_files: []
+