baboon 1.0.6 → 1.0.8

data/README.md

@@ -14,20 +14,18 @@ Baboon is simple. You provide your server addresses, environments, path, reposit
 # Install
 This must be installed under a current rails application. We recommend vendoring or installing through bundler.
 
-	gem install baboon
+	$ gem install baboon
 
 ---
 # Configure
 
 In your Gemfile, then `bundle install`.
 
-	group :development do
-	  gem 'baboon'
-	end
+	gem 'baboon'
 	
 Now that the gem is installed, run the config generator
 
-	rails g baboon:install
+	$ rails g baboon:install
 
 This will build a file into your application under `config/initializers/baboon.rb`. Open this file and start editing. Here is an example of the main configuration options:
 
@@ -45,13 +43,17 @@ These must be properly filled out so baboon can properly make deploys.
 
 ---
 # Commands
-Once everything is setup you can run `baboon` to see availabe tasks. Start by seeing if your configuration was properlly generated.
+Once everything is setup you can run `baboon` to see available commands. Start by seeing if your configuration was properly generated by running the following command:
+
+	$ baboon configuration
+	
+Once you see and verify your Baboon.configuration you can now go ahead and test a deploy. For now, lets assume you have everything in your config correct and you are deploying to production, run the following command to do a cold deploy:
 
-	baboon configuration
+	$ baboon deploy
 	
-Once you see and verify your Baboon.configuration you can now go ahead and test a deploy. For now, lets assume you have everything in your config correct and you are deploying to production:
+To view the available servers you have setup in your config file, the following command will tell you which servers are set to be deploy to:
 
-	baboon deploy
+	$ baboon servers
 	
 Thats it? Yeah, thats it! You should see your bundle installing and Baboon running all tasks. Custom tasks coming soon.
 
@@ -91,7 +93,7 @@ Intial setup of the CLI and basic deploys are working.
 Multiple server deployments now work.
 
 #### 1.0.6
-Changed the order of bundle installing on Rails package
+Changed the order of bundle installing on Rails package. Wrote tests for CLI.
 
 ## How to contribute
  

data/Rakefile

@@ -7,4 +7,4 @@ end
 
 task :bgem do
   sh 'gem build *.gemspec'
-end
+end

data/lib/baboon/cli/options.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'baboon/version'
 
 module Baboon
   class CLI
@@ -20,9 +21,6 @@ module Baboon
       # The hash of (parsed) command-line options
       attr_reader :options
 
-      # Return an OptionParser instance that defines the acceptable command
-      # line switches for Capistrano, and what their corresponding behaviors
-      # are.
       def option_parser #:nodoc:
         @logger = Logger.new
         @option_parser ||= OptionParser.new do |opts|
@@ -58,13 +56,13 @@ module Baboon
 						"Choose logger method. STDERR used by default."
 					) do |value|
 						options[:output] = if value.nil? || value.upcase == 'STDERR'
-																 # Using default logger.
-																 nil
-															 elsif value.upcase == 'STDOUT'
-																 $stdout
-															 else
-																 value
-															 end
+							 # Using default logger.
+							 nil
+						 elsif value.upcase == 'STDOUT'
+							 $stdout
+						 else
+							 value
+						 end
 					end
 
           opts.on("-n", "--dry-run",
@@ -113,10 +111,10 @@ module Baboon
           ) { options[:tool] = true }
 
           opts.on("-V", "--version",
-            "Display the Capistrano version, and exit."
+            "Display the Baboon version, and exit."
           ) do
-            require 'capistrano/version'
-            puts "Capistrano v#{Capistrano::Version}"
+            require 'baboon/version'
+            puts "Baboon v#{Baboon::Version}"
             exit
           end
 
@@ -128,7 +126,7 @@ module Baboon
           end
 
           opts.on("-X", "--skip-system-config",
-            "Don't load the system config file (capistrano.conf)"
+            "Don't load the system config file (Baboon.configuration)"
           ) { options.delete(:sysconf) }
 
           opts.on("-x", "--skip-user-config",
@@ -199,7 +197,7 @@ module Baboon
       end
 
       def default_sysconf #:nodoc:
-        File.join(sysconf_directory, "capistrano.conf")
+        File.join(sysconf_directory, "Baboon.configuration")
       end
 
       def default_dotfile #:nodoc:

data/lib/baboon/cli.rb

@@ -2,12 +2,16 @@ require 'baboon'
 require 'baboon/configuration'
 require 'baboon/logger'
 
-require 'thor'
+require 'find'
 require 'net/ssh'
+require 'thor'
 
 module Baboon
   class Error
     class << self
+      # stop
+      # @param:
+      # @return: StandardError class, will halt execution of program
       def stop reason
         raise StandardError, reason
       end
@@ -16,6 +20,41 @@ module Baboon
   
   class Util
     class << self
+      # file_check!
+      # @param: String file path
+      # @return: Boolean || String depending on if file is found
+      def file_check! file
+        return false if file.nil? || !file
+        
+      end
+      
+      # locate_file
+      # Will try and locate the baboon.rb file it it does not exist. Great method
+      # used especially for testing Baboon.
+      # @param:
+      # @return: String[file path, used to locate and initialize the configuration file]
+      def locate_file
+        config_file = ''
+        default_baboon_file_path = "config/initializers/baboon.rb"
+        if File.exists?(default_baboon_file_path)
+          config_file = default_baboon_file_path
+        else
+          Find.find('.') do |path|
+            if path.include?('baboon.rb') 
+              next unless File.open(path, &:readline).include?('Baboon.configure do |config|')
+              config_file = path
+              break
+            end
+          end
+        end
+        config_file
+      end
+      
+      # read_configuration
+      # This will attempt to read the configuration file, only need until after the file
+      # is found in the application.
+      # @param: String[file path, relative to the directory of the configuration]
+      # @return: Hash[configuration options in the config file, use these to set Baboon.configuration]
       def read_configuration(file)
         configuration = []
         line_number = 0
@@ -39,20 +78,36 @@ module Baboon
   end
   
   class Cli < Thor
-    attr_accessor :logger, :configuration
+    # @logger: call an instance of the logger class, use throughout baboon
+    # @configuration: holds the default baboon configuration set in config file
+    # @configuration_file: the exact file location of baboon configuration
+    attr_accessor :logger, :configuration, :configuration_file, :block
 
+    # initialize
+    # @param: Array
+    # @ereturn: instance
     def initialize(*args)
       super
+      $stdout.sync ||= true
       @logger ||= Logger.new({level: 3, disable_formatters: false})
       
-      $stdout.sync = true
+      # Attempt to locate the configuration file in the project if it was not set.
+      @configuration_file = Util.locate_file
+      
+      # Return if file not found
+      if @configuration_file.nil? ||  @configuration_file == ''
+        printf "\033[22;31mB\033[22;35ma\033[22;36mb\033[22;32mo\033[01;31mo\033[01;33mn\033[22;37m - version #{Baboon::VERSION}\n"
+        printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/initializers/baboon.rb\n"
+        printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
+        @block = true
+        return
+      end
       
       # Load the users baboon configuration
-      if File.exists?("config/initializers/baboon.rb")
-        @configuration = Util.read_configuration("config/initializers/baboon.rb")
+      if File.exists?(@configuration_file) # tad redundant
+        @configuration = Util.read_configuration(@configuration_file)
         
         # configure the servers
-        
         Baboon.configure do |config|
           config.application  = @configuration[:application]
           config.repository   = @configuration[:repository]
@@ -61,16 +116,19 @@ module Baboon
           config.branch       = @configuration[:branch]
           config.rails_env    = @configuration[:rails_env]
           config.servers      = @configuration[:servers].gsub('[', '').gsub(']', '').split(',').collect(&:strip)
-        end
+        end      
       else
-        #Error.stop("Baboon says there is no configuration file at: config/initializers/baboon.rb. Please run `rails g baboon:install`")
-        printf @logger.format("Baboon says there is no configuration file at config/initializers/baboon.rb, run the following command", "31", 1)
-        printf @logger.format("USAGE: rails g baboon:install", "35", 1) 
+        printf "\033[22;31mB\033[22;35mA\033[22;36mB\033[22;32mO\033[01;31mO\033[01;33mN\033[22;37m - version #{Baboon::VERSION}\n"
+        printf "  \033[22;31mError:\033[22;37m no configuration file is present anywhere in the application or at config/initializers/baboon.rb\n"
+        printf "  \033[01;32mUsage:\033[22;37m rails g baboon:install\n"
+        @block = true
+        return
       end
     end
     
-    desc "deploy", "Starts a real deploy to a server"
+    desc "deploy", "Deploys the application to the configured servers."
     def deploy
+      return if @block
       printf @logger.format("== Baboon starting deploy", "32", 1)
       
       # Loop through each server and do deploy, we will add threading later to do simultaneous deploys
@@ -97,8 +155,7 @@ module Baboon
             
         Net::SSH.start(credentials[:host], credentials[:user]) do |session|
           instructions.each do |instruction|
-            puts "[#{current}]: #{instruction}"
-            puts ""
+            printf "[#{current}]: #{instruction}\n"
             session.exec instruction
             session.loop
           end
@@ -108,8 +165,9 @@ module Baboon
       printf @logger.format("== Baboon deploy Complete", "31", 1)
     end
 
-    desc "configuration", "Shows the current configuration for baboon"
-    def configuration
+    desc "configuration", "Shows the current configuration for baboon."
+    def configuration    
+      return if @block  
       printf @logger.format("Baboon[Application]: #{Baboon.configuration.application}", "37", 1)
       printf @logger.format("Baboon[Repository]: #{Baboon.configuration.repository}", "37", 1)
       printf @logger.format("Baboon[Deploy_path]: #{Baboon.configuration.deploy_path}", "37", 1)
@@ -118,46 +176,5 @@ module Baboon
       printf @logger.format("Baboon[Rails_env]: #{Baboon.configuration.rails_env}", "37", 1)
       printf @logger.format("Baboon[Servers]: #{Baboon.configuration.servers}", "37", 1)
     end
-    
-    desc "servers", "Shows the current servers that will get deployed to"
-    def servers
-      printf @logger.format(Baboon.configuration.servers.inspect, "31", 1)
-    end
-
-    # desc "init", "Generates deployment customization scripts for your app"
-    # def init
-    #   require 'generators/baboon/install/intall_generator'
-    #   InstallGenerator::start([])
-    # end
-    # 
-    # desc "restart", "Restarts the application on the server"
-    # def restart
-    #   run "cd #{deploy_to} && deploy/restart | tee -a log/deploy.log"
-    # end
-    # 
-    # desc "rollback", "Rolls back the checkout to before the last push"
-    # def rollback
-    #   run "cd #{deploy_to} && git reset --hard ORIG_HEAD"
-    #   invoke :restart
-    # end
-    # 
-    # desc "log", "Shows the last part of the deploy log on the server"
-    # method_option :tail, :aliases => '-t', :type => :boolean, :default => false
-    # method_option :lines, :aliases => '-l', :type => :numeric, :default => 20
-    # def log(n = nil)
-    #   tail_args = options.tail? ? '-f' : "-n#{n || options.lines}"
-    #   run "tail #{tail_args} #{deploy_to}/log/deploy.log"
-    # end
-    # 
-    # desc "upload <files>", "Copy local files to the remote app"
-    # def upload(*files)
-    #   files = files.map { |f| Dir[f.strip] }.flatten
-    #   abort "Error: Specify at least one file to upload" if files.empty?
-    # 
-    #   scp_upload files.inject({}) { |all, file|
-    #     all[file] = File.join(deploy_to, file)
-    #     all
-    #   }
-    # end
   end
-end
+end

data/lib/baboon/version.rb

@@ -1,3 +1,3 @@
 module Baboon
-  VERSION = '1.0.6'
+  VERSION = '1.0.8'
 end

data/spec/lib/baboon/cli_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Baboon::Cli do
+  describe "#initialize" do
+    before do
+      $stdout.sync ||= true
+    end
+    
+    context "when a proper configuration file is in the current path" do
+      context "when `baboon` is called from the command line with no parameters" do
+        it "gives the proper output and usage for baboon" do
+          content = capture(:stdout) { Baboon::Cli.start([]) }
+          expect(content).to match(/Tasks:\n/)
+          expect(content).to match(/configuration  # Shows the current configuration for baboon.\n/)
+          expect(content).to match(/deploy         # Deploys the application to the configured servers.\n/)
+          expect(content).to match(/help \[TASK\]    # Describe available tasks or one specific task\n\n/)
+        end
+      end
+      
+      context "when `baboon configuration` is called from the command line" do
+        it "it lists the configuration settings for the current baboon installation" do
+          content = capture(:stdout) { Baboon::Cli.start(['configuration']) }
+          expect(content).to match(/Baboon\[Application\]: console/)
+          expect(content).to match(/Baboon\[Repository\]: git@github.com:128lines\/console.fm.git/)
+          expect(content).to match(/Baboon\[Deploy_path\]: \/home\/rails\/console.fm\//)
+          expect(content).to match(/Baboon\[Deploy_user\]: :rails/)
+          expect(content).to match(/Baboon\[Branch\]: :master/)
+          expect(content).to match(/Baboon\[Rails_env\]: :production/)
+          expect(content).to match(/Baboon\[Servers\]: \[\"10.0.0.1\", \"10.0.0.1\"\]/)
+        end
+      end
+    end 
+  end #intiailize do
+end #describe Baboon::Cli do

data/spec/lib/baboon/configuration_spec.rb

@@ -3,7 +3,15 @@ require 'spec_helper'
 describe Baboon::Configuration do
   describe 'configuration object should respond accordingly if not configured' do
     before do
-      Baboon.configure do |config|; end
+      Baboon.configure do |config|
+        config.application = nil
+        config.repository  = nil
+        config.deploy_path = nil
+        config.deploy_user = nil
+        config.branch      = nil
+        config.rails_env   = nil
+        config.servers     = nil
+      end
     end
     
     context 'when nothing is given for application' do
@@ -103,11 +111,5 @@ describe Baboon::Configuration do
         Baboon.configuration.servers.should eq(['server_1', 'server_2'])
       end
     end
-    
-    context 'when multiple servers are assigned' do
-      it 'should return accordingly' do
-        # puts Baboon.configuration.servers.inspect
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -6,11 +6,52 @@ end
 ENV['RAILS_ENV'] ||= 'test'
 require File.expand_path('../../lib/baboon', __FILE__)
 
+Dir["spec/support/**/*.rb"].each { |f| require f }
+
 PROJECT_ROOT = File.expand_path('../..', __FILE__)
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
 
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
 RSpec.configure do |config|
   config.color_enabled = true
   config.tty = true
   config.mock_with :rspec
+  
+  config.before(:each) do
+    ARGV.clear
+    $stdout.sync ||= true
+  end
+
+  # Captures the output for analysis later
+  #
+  # @example Capture `$stderr`
+  #
+  #     output = capture(:stderr) { $stderr.puts "this is captured" }
+  #
+  # @param [Symbol] stream `:stdout` or `:stderr`
+  # @yield The block to capture stdout/stderr for.
+  # @return [String] The contents of $stdout or $stderr
+  def capture(stream)
+   begin
+     stream = stream.to_s
+     eval "$#{stream} = StringIO.new"
+     yield
+     result = eval("$#{stream}").string
+   ensure
+     eval("$#{stream} = #{stream.upcase}")
+   end
+
+   result
+  end
+
+  # Silences the output stream
+  #
+  # @example Silence `$stdout`
+  #
+  #     silence(:stdout) { $stdout.puts "hi" }
+  #
+  # @param [IO] stream The stream to use such as $stderr or $stdout
+  # @return [nil]
+  alias :silence :capture
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baboon
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -256,7 +256,7 @@ files:
 - lib/generators/baboon/config/templates/baboon.yml
 - lib/generators/baboon/install/install_generator.rb
 - lib/generators/baboon/install/templates/baboon.rb
-- spec/lib/baboon/cli.rb
+- spec/lib/baboon/cli_spec.rb
 - spec/lib/baboon/configuration_spec.rb
 - spec/lib/baboon_spec.rb
 - spec/lib/generators/baboon/install/install_generator_spec.rb
@@ -277,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1947214127197251774
+      hash: -4459336840231193725
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1947214127197251774
+      hash: -4459336840231193725
 requirements: []
 rubyforge_project: baboon
 rubygems_version: 1.8.24