bard 0.4.0 → 0.5.0

data/README.rdoc

@@ -2,14 +2,122 @@
 
   This immaculate work of engineering genius allows mere mortals to collaborate with beings of transcendent intelligence like Micah, Michael, and Nick.
 
-== Requirements
-    gem install thor
-    gem install systemu
-    gem install term-ansicolor
-    gem install git_remote_branch
+=== Requirements
     git --version >= 1.6.0
 
-== Note on Patches/Pull Requests
+=== Joining Bard
+
+	==== On any platform:
+		- gem install gemcutter
+		- gem tumble
+		- gem install bard
+
+	==== On Linux:
+
+		- Install RubyGems:
+			$> wget ...
+			$> ...
+
+		- Install Rake:
+			$> sudo gem install rake
+			( NOTE: the sudo )
+
+		- Install Apache
+			$> sudo apt-get install apache2
+
+		- Install Mysql
+			$> sudo apt-get install mysql-server
+			$> sudo /etc/init.d/mysql start
+			( No password for root, if it asks )
+			
+		- Install Passenger
+			$> sudo gem install passenger
+
+			$> sudo apt-get install apache2-prefork-dev as root.
+			$> sudo apt-get install libapr1-dev as root.
+			$> sudo apt-get install libaprutil1
+
+			$> sudo passenger-install-apache2-module
+
+		- Setup rails environment:
+			Add line to /etc/apache2/apache2.conf:
+				RailsEnv development
+			$> apache2ctl restart
+				
+	==== On Mac:
+		- ???Wtf ? I dunno. eff macs
+
+== Todos
+
+=== Adding Adva to an exising project
+	- Git clone latest tagged release from github
+	- Set up integration branch on staging
+	- Add as submodule 
+	- Bard pull will "just work" (tm)
+
+=== Joining an existing project
+	bard join will probably either do all these steps automatically, or help you do them:
+	This list summarizes the existing steps needed to join a project.
+
+	$> bard join <project-name>
+
+	- Clone the project
+		- (git clone staging@staging.botandrose.com:<project-name>)
+		- Init and update submodules
+
+	- Set up local environment:
+		- Apache
+			Put in /etc/apache2/sites-avaliable/<project-name>:
+				<VirtualHost *:80>
+					ServerName <project-name>.local
+					DocumentRoot $HOME/$BardRoot/<project-name>/public
+				</VirtualHost>
+
+			$> a2ensite <project-name>
+			$> apache2ctl restart
+
+		- Set up /etc/hosts:
+			append this line to /etc/hosts:
+				127.0.0.1 <project-name>.local
+
+		- Setup database yaml
+			- sensible default:
+				login: &login
+					adapter: mysql
+					database: <project-name>
+					username: root
+					password:
+					socket: /var/run/mysqld/mysqld.sock
+
+				development:
+					<<: *login
+
+				test: &TEST
+					<<: *login
+					database: <project-name>_test
+
+				cucumber:
+					<<: *TEST
+
+
+		- Set up gems:
+			$> rake gems:install
+
+		- Set up database
+			$> rake db:create
+			$> rake db:migrate
+
+		- Set up cap:
+			$> capify .
+			Add line to Capfile:
+				load '../cap.tasks'
+			Have cap.tasks.rb in your root work directory (eg. $HOME/work/bard )
+
+		- Seed database from staging
+			$> cap data:pull:staging
+
+
+=== Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -22,4 +130,4 @@
 
 == Copyright
 
-Copyright (c) 2009 Micah Geisel. See LICENSE for details.
+Copyright (c) 2009 Micah Geisel, Nick Hogle. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bard.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bard}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Micah Geisel", "Nick Hogle"]
-  s.date = %q{2009-09-30}
+  s.date = %q{2009-10-05}
   s.default_executable = %q{bard}
   s.description = %q{This immaculate work of engineering genius allows mere mortals to collaborate with beings of transcendent intelligence like Micah, Michael, and Nick.}
   s.email = %q{info@botandrose.com}

data/features/bard_check.feature

@@ -6,3 +6,79 @@ Feature: Bard can check its environment for missing dependencies and potential p
     And I should see the current version of git
     And I should see the current version of rubygems
     And I should see the current version of ruby
+
+  Scenario: Bard check examines a local project for problems
+    Given a shared rails project
+    When I type "bard check ."
+    Then I should see "No problems"
+
+  Scenario: Bard check detects missing database
+    Given a shared rails project
+    And the database is missing
+    When I type "bard check ."
+    Then I should see the fatal error "missing database"
+  
+  Scenario: Bard check detects pending migrations
+    Given a shared rails project
+    And I have committed a set of changes that includes a new migration
+    When I type "bard check ."
+    Then I should see the fatal error "pending migrations"
+
+  Scenario: Bard check detects missing config/database.yml
+    Given a shared rails project
+    And "config/database.yml" is missing
+    When I type "bard check ."
+    Then I should see the fatal error "missing config/database.yml"
+
+  Scenario: Bard check detects missing submodules
+    Given a shared rails project
+    And a submodule
+    And the submodule is missing
+    When I type "bard check ."
+    Then I should see the fatal error "missing submodule"
+
+  Scenario: Bard check detects missing gems
+    Given a shared rails project
+    And I have committed a set of changes that adds the test gem as a dependency
+    And I dont have the test gem installed
+    When I type "bard check ."
+    Then I should see the fatal error "missing gems"
+
+  Scenario: Bard check detects master branch checked out
+    Given a shared rails project
+    And I am on the master branch
+    When I type "bard check ."
+    Then I should see the fatal error "master branch"
+
+  Scenario: Bard check detects missing integration branch
+    Given a shared rails project
+    And there is no integration branch
+    When I type "bard check ."
+    Then I should see the fatal error "missing integration branch"
+
+  Scenario: Bard check detects missing RAILS_ENV environment variable
+    Given a shared rails project
+    And my "RAILS_ENV" environment variable is ""
+    When I type "bard check ."
+    Then I should see the warning "RAILS_ENV is not set"
+
+  Scenario: Bard check detects missing staging hook
+    Given a shared rails project
+    And my "RAILS_ENV" environment variable is "staging"
+    And there is no git hook on the staging server
+    When I type "bard check ." on the staging server
+    Then I should see the fatal error "missing git hook"
+
+  Scenario: Bard check detects unexecutable staging hook
+    Given a shared rails project
+    And my "RAILS_ENV" environment variable is "staging"
+    And the git hook on the staging server is not executable
+    When I type "bard check ." on the staging server
+    Then I should see the fatal error "unexecutable git hook"
+
+  Scenario: Bard check detects improper staging hook
+    Given a shared rails project
+    And my "RAILS_ENV" environment variable is "staging"
+    And the git hook on the staging server is bad
+    When I type "bard check ." on the staging server
+    Then I should see the fatal error "improper git hook"

data/features/step_definitions/check_steps.rb

@@ -1,20 +1,65 @@
 Then /^I should see the current version of bard$/ do
   version = File.read("#{ROOT}/VERSION").chomp
-  @stdout.should include "bard     (#{version})"
+  @stdout.should =~ /bard\s+\(#{Regexp.escape(version)}\)/
 end
 
 Then /^I should see the current version of git$/ do
   version = `git --version`[/[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/]
-  @stdout.should include "git      (#{version})"
+  @stdout.should =~ /git\s+\(#{Regexp.escape(version)}\)/
 end
 
 Then /^I should see the current version of rubygems$/ do
   version = `gem --version`.chomp
-  @stdout.should include "rubygems (#{version})"
+  @stdout.should =~ /rubygems\s+\(#{Regexp.escape(version)}\)/
 end
 
 Then /^I should see the current version of ruby$/ do
   version = `ruby --version`[/[0-9]+\.[0-9]+\.[0-9]+/]
-  @stdout.should include "ruby     (#{version})"
+  @stdout.should =~ /ruby\s+\(#{Regexp.escape(version)}\)/
+end
+
+Given /^"([^\"]*)" is missing$/ do |file|
+  type "rm #{file}"
+end
+
+Given /^the database is missing$/ do
+  File.open "config/database.yml", "w" do |f|
+    f.puts <<-DB
+development:
+  adapter: mysql
+  username: root
+  password:
+  database: bad_bad_bad
+  socket: /var/run/mysqld/mysqld.sock
+DB
+  end
+end
+
+Given /^the submodule is missing$/ do
+  type "rm -rf submodule"
+  type "mkdir submodule"
+end
+
+Given /^my "([^\"]*)" environment variable is "([^\"]*)"$/ do |key, value|
+  @env ||= Hash.new
+  @env[key] = value
+end
+
+Given /^there is no git hook on the staging server$/ do
+  Dir.chdir "#{ROOT}/tmp/origin" do
+    type "rm .git/hooks/post-receive"
+  end
+end
+
+Given /^the git hook on the staging server is not executable$/ do
+  Dir.chdir "#{ROOT}/tmp/origin" do
+    type "chmod 664 .git/hooks/post-receive"
+  end
+end
+
+Given /^the git hook on the staging server is bad$/ do
+  Dir.chdir "#{ROOT}/tmp/origin" do
+    type "echo 'bad' > .git/hooks/post-receive"
+  end
 end
 

data/features/step_definitions/git_steps.rb

@@ -2,6 +2,23 @@ Given /^I am on a non\-integration branch$/ do
   type "git checkout -b bad_bad_bad"
 end
 
+Given /^I am on the master branch$/ do
+  type "git checkout master"
+end
+
+Given /^there is no integration branch$/ do
+  type "git checkout master"
+  type "git branch -d integration"
+end
+
+Given /^there is no integration branch on the staging server$/ do
+  type "git branch -d origin/integration"
+  Dir.chdir "#{ROOT}/tmp/origin" do 
+    type "git checkout master"
+    type "git branch -d integration"
+  end
+end
+
 Given /^a dirty working directory$/ do
   File.open("dirty_file", "w") { |f| f.puts "dirty dirty" }
 end

data/features/step_definitions/global_steps.rb

@@ -29,10 +29,13 @@ BASH
 end
 
 When /^I type "([^\"]*)"$/ do |command|
-  if command =~ /^bard/
-    command = "#{ROOT}/bin/#{command}"
+  type command.sub /\b(bard)\b/, "#{ROOT}/bin/bard"
+end
+
+When /^I type "([^\"]*)" on the staging server$/ do |command|
+  Dir.chdir "#{ROOT}/tmp/origin" do
+    When %(I type "#{command}")
   end
-  type command
 end
 
 Then /^I should see the fatal error "([^\"]*)"$/ do |error_message|
@@ -42,3 +45,7 @@ end
 Then /^I should see the warning "([^\"]*)"$/ do |warning_message|
   @stderr.should include(warning_message) 
 end
+
+Then /^I should see "([^\"]*)"$/ do |message|
+  @stdout.should include(message) 
+end

data/features/support/io.rb

@@ -1,5 +1,5 @@
 def type(command)
-  @status, @stdout, @stderr = systemu command
+  @status, @stdout, @stderr = systemu command, :env => @env
   if ENV['DEBUG']
     puts '-' * 20
     puts "Executing command: #{command}"

data/lib/bard.rb

@@ -2,6 +2,7 @@ $:.unshift File.expand_path(File.dirname(__FILE__))
 require 'term/ansicolor'
 require 'systemu'
 require 'grit'
+require 'thor'
 
 require 'bard/git'
 require 'bard/io'
@@ -10,19 +11,23 @@ class Bard < Thor
   include BardGit
   include BardIO
 
-  desc "check", "check environment for missing dependencies"
-  def check
-    required = Hash.new
-    required['bard'] = `gem list bard --remote`[/[0-9]+\.[0-9]+\.[0-9]+/]
-    required['git'] = '1.6.0'
-    required['rubygems'] = '1.3.4'
-    required['ruby'] = '1.8.6'
-
-    actual = Hash.new
-    actual['bard'] = `gem list bard`[/[0-9]+\.[0-9]+\.[0-9]+/]
-    actual['git'] = `git --version`[/[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/]
-    actual['rubygems'] = `gem --version`.chomp
-    actual['ruby'] = `ruby --version`[/[0-9]+\.[0-9]+\.[0-9]+/]
+  desc "check [PROJECT]", "check PROJECT or environment for missing dependencies"
+  def check(project = nil)
+    return check_project(project) if project
+    puts ENV['ASDF']
+
+    required = {
+      'bard'     => `gem list bard --remote`[/[0-9]+\.[0-9]+\.[0-9]+/],
+      'git'      => '1.6.0',
+      'rubygems' => '1.3.4',
+      'ruby'     => '1.8.6'
+    }
+    actual = {
+      'bard'     => `gem list bard`[/[0-9]+\.[0-9]+\.[0-9]+/],
+      'git'      => `git --version`[/[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+/],
+      'rubygems' => `gem --version`.chomp,
+      'ruby'     => `ruby --version`[/[0-9]+\.[0-9]+\.[0-9]+/]
+    }
 
     %w(bard git rubygems ruby).each do |pkg|
       if actual[pkg] < required[pkg]
@@ -128,4 +133,40 @@ class Bard < Thor
       system "touch tmp/restart.txt"
     end
   end
+
+  private
+    def check_project(project)
+      errors = []
+      warnings = []
+      Dir.chdir project do
+        status, stdout, stderr = systemu "rake db:abort_if_pending_migrations"
+        errors << "missing config/database.yml" if stderr.include? "config/database.yml"
+        errors << "missing database" if stderr.include? "Unknown database"
+        errors << "pending migrations" if stdout.include? "pending migrations"
+
+        errors << "missing submodule" if `git submodule status` =~ /^-/
+        errors << "missing gems" if `rake gems` =~ /\[ \]/
+        errors << "you shouldn't be working on the master branch" if `cat .git/HEAD`.include? "refs/heads/master"
+        errors << "missing integration branch" if `git branch` !~ /\bintegration\b/
+
+        if ENV['RAILS_ENV'] == "staging"
+          if File.exist? ".git/hooks/post-receive" 
+            errors << "unexecutable git hook" unless File.executable? ".git/hooks/post-receive" 
+            errors << "improper git hook" unless File.read(".git/hooks/post-receive").include? "bard stage $@"
+          else
+            errors << "missing git hook" 
+          end
+        end
+
+        warnings << "RAILS_ENV is not set" if ENV['RAILS_ENV'].nil? or ENV['RAILS_ENV'].empty?
+      end
+
+      if not errors.empty?
+        fatal "#{errors.length} problems detected:\n  #{errors.join("\n  ")}"
+      elsif not warnings.empty?
+        warn "#{warnings.length} potential problems detected:\n  #{warnings.join("\n  ")}"
+      else
+        puts green("No problems detected in project: #{project}")
+      end
+    end
 end

data/spec/bard_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Bard" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+describe Bard do
+  it "should work" do
+    true
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'bard'
 require 'spec'
 require 'spec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bard
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Micah Geisel
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-30 00:00:00 -07:00
+date: 2009-10-05 00:00:00 -07:00
 default_executable: bard
 dependencies: 
 - !ruby/object:Gem::Dependency