capistrano-fanfare 0.0.22 → 0.0.23

data/.travis.yml

@@ -3,6 +3,8 @@ language: ruby
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: rbx-19mode
+    - rvm: rbx-18mode
 
 rvm:
   - 1.9.3

data/README.md

@@ -1,4 +1,4 @@
-# <a name="title"></a> Capistrano::Fanfare [![Build Status](https://secure.travis-ci.org/fnichol/capistrano-fanfare.png)](http://travis-ci.org/fnichol/capistrano-fanfare) [![Dependency Status](https://gemnasium.com/fnichol/capistrano-fanfare.png)](https://gemnasium.com/fnichol/capistrano-fanfare)
+# <a name="title"></a> Capistrano::Fanfare [![Build Status](https://secure.travis-ci.org/fnichol/capistrano-fanfare.png)](http://travis-ci.org/fnichol/capistrano-fanfare) [![Dependency Status](https://gemnasium.com/fnichol/capistrano-fanfare.png)](https://gemnasium.com/fnichol/capistrano-fanfare) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fnichol/capistrano-fanfare)
 
 **Notice:** This README is under active development.
 
@@ -38,6 +38,7 @@ Create a `Capfile` that looks like:
     fanfare_recipe 'colors'
     fanfare_recipe 'ssh'
     fanfare_recipe 'console'
+    fanfare_recipe 'log'
     fanfare_recipe 'campfire'
     fanfare_recipe 'airbrake'
 
@@ -107,6 +108,8 @@ There are several optional recipes that need additional gems in your Gemfile:
   Connect to your infrastructure nodes without thinking.
 * [console](#recipes-console):
   Rails 2/3, Sinatra, and Rack consoles, running in one command.
+* [log](#recipes-log):
+  Ability to tail logs and load logs into a local editor.
 * [colors](#recipes-colors):
   Deploys, but prettier.
 * [campfire](#recipes-campfire):
@@ -172,6 +175,10 @@ a few additional helpers.
 
 > Rails 2/3, Sinatra, and Rack consoles, running in one command.
 
+#### <a name="recipes-log"></a> log
+
+> Ability to tail logs and load logs into a local editor.
+
 #### <a name="recipes-colors"></a> colors
 
 > Deploys, but prettier.

data/lib/capistrano/fanfare.rb

@@ -11,6 +11,13 @@ module Capistrano
       def fanfare_recipe(recipe)
         require "capistrano/fanfare/#{recipe}"
       end
+
+      def fanfare_require(gem_name, path = gem_name)
+        require path
+      rescue LoadError => error
+        raise "#{gem_name} gem could not be loaded: (#{error.message}). " +
+          "Please ensure it is in your Gemfile."
+      end
     end
   end
 end

data/lib/capistrano/fanfare/airbrake.rb

@@ -2,15 +2,7 @@ require 'capistrano'
 
 module Capistrano::Fanfare::Airbrake
   def self.load_into(configuration)
-    configuration.load do
-      begin
-        require 'airbrake/capistrano'
-
-      rescue LoadError => error
-        raise "airbrake gem could not be loaded: (#{error.message}). " +
-          "Please ensure it is in your Gemfile."
-      end
-    end
+    configuration.load { fanfare_require 'airbrake', 'airbrake/capistrano' }
   end
 end
 

data/lib/capistrano/fanfare/campfire.rb

@@ -3,13 +3,7 @@ require 'capistrano'
 module Capistrano::Fanfare::Campfire
   def self.load_into(configuration)
     configuration.load do
-      begin
-        require 'campy'
-
-      rescue LoadError => error
-        raise "campy gem could not be loaded: (#{error.message}). " +
-          "Please ensure it is in your Gemfile."
-      end
+      fanfare_require 'campy'
 
       set(:campfire_yaml_file) do
         yaml_file = File.expand_path(ENV['CAMPFIRE_YAML_FILE'] || '~/.campfire.yml')

data/lib/capistrano/fanfare/foreman.rb

@@ -1,17 +1,11 @@
 require 'capistrano'
 require 'capistrano/fanfare/foreman/strategy'
 
-begin
-  require 'foreman/procfile'
-
-rescue LoadError => error
-  raise "Foreman gem could not be loaded: (#{error.message}). " +
-    "Please ensure it is in your Gemfile."
-end
-
 module Capistrano::Fanfare::Foreman
   def self.load_into(configuration)
     configuration.load do
+      fanfare_require 'foreman', 'foreman/procfile'
+
       set(:local_procfile)      { ENV['PROCFILE'] || "Procfile" }
       set(:user_home)           { capture("echo $HOME").chomp }
 

data/lib/capistrano/fanfare/log.rb

@@ -0,0 +1,92 @@
+require 'capistrano'
+require 'tempfile'
+
+module Capistrano::Fanfare::Log
+  def self.load_into(configuration)
+    configuration.load do
+      set :tail_cmd, "tail"
+
+      def resolve_logfile
+        rack_env = fetch(:rails_env, nil) || fetch(:rack_env, nil) || "production"
+
+        File.join(current_path, "log", "#{rack_env}.log")
+      end
+
+      def resolve_editor
+        ENV['editor'] || ENV['EDITOR'] || ENV['VISUAL'] || "vi"
+      end
+
+      def log_exec(cmd)
+        exec cmd
+      end
+
+      # =========================================================================
+      # These are the tasks that are available to help with deploying web apps.
+      # You can have cap give you a summary of them with `cap -T'.
+      # =========================================================================
+
+      namespace :log do
+        desc <<-DESC
+          Tails the deployed application log.You can set the rails \
+          environment by setting the :rails_env variable. The defaults are:
+
+              set :rails_env, "production"
+              set :tail_cmd,  "tail"
+        DESC
+        task :tail, :role => :app, :except => { :no_release => true } do
+          stream("#{tail_cmd} -f #{resolve_logfile}")
+        end
+
+        desc <<-DESC
+          View log files in local editor. You can set the rails environment \
+          and tail command by setting variables. The defaults are:
+
+              set :rails_env, "production"
+              set :tail,      "tail"
+
+          To override the default number of lines (500), you can pass in \
+          the `n' environment variable like so:
+
+              $ cap log:view n=900
+
+          To override your EDITOR/VISUAL environment settings for your visual \
+          editor, you can pass in the `editor' environment variable like so:
+
+              $ cap log:view editor=nano
+
+          Otherwise this task will try to resolve your editor in the \
+          following order:
+
+              1) use the `editor' environment override variable value
+              2) use the `EDITOR' shell environment variable value
+              3) use the `VISUAL' shell environment variable value
+              4) use `vi' which should be in almost any PATH
+        DESC
+        task :view, :role => :app, :except => { :no_release => true } do
+          line_nums = ENV["n"] || 500
+          cmd       = "#{tail_cmd} -n #{line_nums} #{resolve_logfile}"
+          logs      = Hash.new { |h,k| h[k] = '' }
+
+          run(cmd) do |channel, stream, data|
+            logs[channel[:host]] << data
+            break if stream == :err
+          end
+
+          tmpfile = Tempfile.open('w')
+          logs.each do |host, log|
+            tmpfile.write("--- #{host} ---\n\n")
+            tmpfile.write(log + "\n")
+          end
+          tmpfile.flush
+          tmpfile.close
+
+          log_exec "#{resolve_editor} #{tmpfile.path}"
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Fanfare::Log.load_into(Capistrano::Configuration.instance)
+end

data/lib/capistrano/fanfare/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Fanfare
-    VERSION = "0.0.22"
+    VERSION = "0.0.23"
   end
 end

data/spec/log_spec.rb

@@ -0,0 +1,119 @@
+require 'minitest/autorun'
+require 'minitest/capistrano'
+require 'capistrano/fanfare'
+require 'capistrano/fanfare/log'
+require 'mocha'
+
+describe Capistrano::Fanfare::Log do
+  before do
+    @config = Capistrano::Configuration.new
+    Capistrano::Fanfare::Log.load_into(@config)
+    @config.extend(MiniTest::Capistrano::ConfigurationExtension)
+  end
+
+  describe "for variables" do
+    it "sets :tail_cmd to 'tail'" do
+      @config.fetch(:tail_cmd).must_equal "tail"
+    end
+  end
+
+  describe "for namespace :log" do
+    before do
+      @config.set :tail_cmd,      "/usr/bin/tail"
+      @config.set :current_path,  "/my/path"
+    end
+
+    describe "task :tail" do
+      it "tails a log file based on :rails_env variable" do
+        @config.set :rails_env, "uat"
+        @config.find_and_execute_task("log:tail")
+
+        @config.must_have_streamed "/usr/bin/tail -f /my/path/log/uat.log"
+      end
+
+      it "tails a log file based on :rack_env variable" do
+        @config.set :rack_env, "staging"
+        @config.find_and_execute_task("log:tail")
+
+        @config.must_have_streamed "/usr/bin/tail -f /my/path/log/staging.log"
+      end
+
+      it "tails the production log file if :rails_env and :rack_env does not exist" do
+        @config.find_and_execute_task("log:tail")
+
+        @config.must_have_streamed "/usr/bin/tail -f /my/path/log/production.log"
+      end
+    end
+
+    describe "task :view" do
+      before do
+        @config.stubs(:log_exec).returns(true)
+        @tempfile = Tempfile.open('w')
+        Tempfile.stubs(:open).with('w').returns(@tempfile)
+      end
+
+      describe "resolving log file" do
+        it "runs a tail on a log file based on :rails_env variable" do
+          @config.set :rails_env, "uat"
+          @config.find_and_execute_task("log:view")
+
+          @config.must_have_run "/usr/bin/tail -n 500 /my/path/log/uat.log"
+        end
+
+        it "runs a tail on a log file based on :rack_env variable" do
+          @config.set :rack_env, "staging"
+          @config.find_and_execute_task("log:view")
+
+          @config.must_have_run "/usr/bin/tail -n 500 /my/path/log/staging.log"
+        end
+
+        it "runs a tail of the production log file if :rails_env and :rack_env does not exist" do
+          @config.find_and_execute_task("log:view")
+
+          @config.must_have_run "/usr/bin/tail -n 500 /my/path/log/production.log"
+        end
+      end
+
+      it "runs a tail on a log file with a specified line count" do
+        ENV['_SPEC_n'] = ENV['n']
+        ENV['n'] = '987'
+        @config.find_and_execute_task("log:view")
+
+        @config.must_have_run "/usr/bin/tail -n 987 /my/path/log/production.log"
+        ENV['n'] = ENV.delete('_SPEC_n')
+      end
+
+      describe "resolving an editor" do
+        ENV_EDITORS = %w{VISUAL EDITOR editor}
+
+        before do
+          ENV_EDITORS.each do |e|
+            ENV["_SPEC_#{e}"] = ENV[e]
+            ENV.delete(e)
+          end
+        end
+
+        after do
+          ENV_EDITORS.each do |e|
+            ENV[e] = ENV.delete("_SPEC_#{e}")
+          end
+        end
+
+        it "opens the logfile in vi by default" do
+          @config.expects(:log_exec).with("vi #{@tempfile.path}")
+
+          @config.find_and_execute_task("log:view")
+        end
+
+        ENV_EDITORS.each do |v|
+          it "opens the logfile in the editor in ENV['#{v}']" do
+            ENV[v] = "/this/editor/#{v}"
+            @config.expects(:log_exec).with("#{ENV[v]} #{@tempfile.path}")
+
+            @config.find_and_execute_task("log:view")
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-fanfare
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -155,6 +155,7 @@ files:
 - lib/capistrano/fanfare/foreman/strategy/runit.rb
 - lib/capistrano/fanfare/git_style.rb
 - lib/capistrano/fanfare/info.rb
+- lib/capistrano/fanfare/log.rb
 - lib/capistrano/fanfare/multistage.rb
 - lib/capistrano/fanfare/ssh.rb
 - lib/capistrano/fanfare/version.rb
@@ -178,6 +179,7 @@ files:
 - spec/git_style_strategy_spec.rb
 - spec/info_spec.rb
 - spec/loading_spec.rb
+- spec/log_spec.rb
 - spec/multistage_spec.rb
 - spec/ssh_spec.rb
 homepage: https://github.com/fnichol/capistrano-fanfare
@@ -194,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3688449692979042499
+      hash: 1800512189970899155
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -203,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3688449692979042499
+      hash: 1800512189970899155
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -231,5 +233,6 @@ test_files:
 - spec/git_style_strategy_spec.rb
 - spec/info_spec.rb
 - spec/loading_spec.rb
+- spec/log_spec.rb
 - spec/multistage_spec.rb
 - spec/ssh_spec.rb