railblazer 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*~

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Stack Builders inc.
+
+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.md

@@ -0,0 +1,75 @@
+# Railblazer - spend less time setting up apps locally and on CI servers
+
+Railblazer helps you to spend less time setting up Rails apps by providing three scripts:
+
+1. `app_adapter`: given a Gemfile, detects whether the application runs on mysql, mysql2, or postgres
+2. `build`: build script that can be used by Jenkins
+3. `db_config`: outputs a database.yml when given an adapter and app name.
+
+In other words, Railblazer tries to take the work out of setting up things like builds on CI servers, assuming you're using RVM and bundler in your applications.
+
+# Installation
+
+You can install railblazer via the gem, but since gems that you install are limited to a particular gemset or Ruby version (assuming you're running rvm), you can just clone this repository. In order to 
+run the scripts in this package, just add the `bin` directory in this repository to your path. 
+
+# app_adapter
+
+`app_adapter` detects the database adapter used in a Rails application when given a Gemfile path
+as an argument:
+
+```
+app_adapter ~/Code/project/Gemfile
+```
+
+This will return a string like `mysql2` without a trailing newline (for easier inclusion in other scripts). The program will raise an error if exactly one adapter is not found. It currently only 
+works with applications that use the mysql, mysql2, or postgres (pg) adapters.
+
+# build
+
+`build` is a shell script that can be used by Jenkins. It assumes that for your build you don't want to run migrations, and that instead we should just drop the test db, re-create it, and load the schema.rb file.
+
+It also does the following, which we find useful in our CI builds:
+
+1. Load the RVM environment
+2. Run bundle (excluding the production environment)
+3. Run the tests with xvfb-run, autodetecting an available buffer (for simultaneous builds that need to open windows, for things like Selenium)
+4. Auto-generate a database.yml (requires `app_adapter` to be in the `$PATH`)
+
+The script uses variables like ${WORKSPACE} and ${JOB_NAME}, which are passed by default to scripts
+invoked from Jenkins.
+
+Example usage:
+
+```
+build
+```
+
+# db_config
+
+`db_config` automatically generates a database.yml file when given an adapter and application name. This is generated from a template for mysql, mysql2, and postgres included with this gem.  If you want, you can also override the default templates by including templates in a directory named `~/.blaze/templates`.
+
+Example usage:
+
+```
+db_config mysql2 myapp
+```
+
+# Summary
+
+Railblazer helps with configuration of database connections in Rails apps, and provides scripts which can help with configuraiton of Rails apps for CI server builds. 
+
+Instead of relying on the database.sample.yml files included in many Rails apps, I find that it's often easier to just copy a working database.yml from another project on my computer. These settings reflect things like the correct host and username / password configuration for my local workstation. I think that we can move towards slightly less configuration work for new Rails apps on workstations that are already in use by developers by building up frameworks that: 
+
+1. use local templates for database configuration and 
+2. auto-detect the database adapter from the Rails application configuration. 
+
+Railblazer provides a first pass at automating this type of configuration, and provides a script showing how this is useful in the context of auto-configuring apps for Jenkins CI server.
+
+# Author
+
+Justin Leitgeb <justin@stackbuilders.com>
+
+# License
+
+See the LICENSE file included with the program.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :test

data/bin/app_adapter

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# Detects the database adapter used in a Rails application from a Gemfile.
+# If more than one adapter is found, an exception will be raised, since the 
+# ultimate purpose of this script is to help generate a database.yml. Our 
+# assumption is that something weird is going on if there is more than one 
+# adapter gem listed in the Gemfile, so we throw up our hands.
+
+# *Note that this evaluates the Gemfile as a ruby script, so it's possible
+# for someone to do something nasty in this file*
+
+require "#{File.dirname(__FILE__)}/../lib/railblazer"
+
+if ARGV.empty?
+  puts "Usage is app_adapter GEMFILE_PATH"
+  exit 1
+end
+
+gemfile = Railblazer::MinimalGemfile.new(File.new(ARGV[0]))
+print Railblazer::AdapterDetection.new(gemfile).run

data/bin/build

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# A script for running a build for CI using RVM.
+
+PATH=$PATH:$HOME/.rvm/bin:/usr/bin:`dirname $0`
+
+[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"
+
+export RAILS_ENV=test
+
+db_config `app_adapter ${WORKSPACE}/Gemfile` ${JOB_NAME} > ${WORKSPACE}/config/database.yml && \
+    cd ${WORKSPACE} && \
+    bundle --without production && \
+    bundle exec rake db:drop db:create db:schema:load && \
+    xvfb-run -a rspec spec
+    

data/bin/db_config

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# Generates a database.yml from a template. Templates in 
+# ~/.blaze/templates override those in the application.
+# Templates are included for mysql, mysql2, and pg.
+
+require "#{File.dirname(__FILE__)}/../lib/railblazer"
+
+if ARGV.empty?
+  puts "Usage is db_config db_adapter app_name"
+  exit 1
+end
+
+raise ArgumentError, "App name must be specified as second parameter" if ARGV[1].nil?
+
+puts Railblazer::ConfigGenerator.new(ARGV[0], ARGV[1])
+

data/lib/railblazer/adapter_detection.rb

@@ -0,0 +1,30 @@
+module Railblazer
+  class AdapterDetection
+    ADAPTERS = {
+      'mysql'  => 'mysql',
+      'mysql2' => 'mysql2',
+      'pg'     => 'postgresql'
+    }.freeze
+
+    attr_reader :gems
+
+    def initialize minimal_gemfile
+      @gems = minimal_gemfile.gems
+    end
+
+    def run
+      ADAPTERS[adapter_gem]
+    end
+
+    private
+
+    def adapter_gem
+      adapter_gems = gems & ADAPTERS.keys.to_set
+
+      raise "More than one adapter gem found in Gemfile! #{gems.to_a.join(', ')}" if adapter_gems.count > 1
+      raise "Unable to detect any database adapters in database.yml" if adapter_gems.empty?
+
+      adapter_gems.first
+    end
+  end
+end

data/lib/railblazer/config_generator.rb

@@ -0,0 +1,32 @@
+require 'erb'
+require 'etc'
+
+module Railblazer
+  class ConfigGenerator
+
+    HOME_TEMPLATE_PATH = "#{Etc.getpwuid.dir}/.blaze/templates"
+
+    attr_reader :db_adapter, :app_name
+    def initialize db_adapter, app_name
+      @db_adapter = db_adapter
+      @app_name   = app_name
+    end
+
+    def to_s
+      ERB.new(template).result(binding)
+    end
+
+    private
+    def template
+      selected_template = File.join(template_path, "#{db_adapter}.yml.erb")
+      raise "Template file not found for #{db_adapter}" unless File.exist?(selected_template)
+      template = File.read(selected_template)
+    end
+
+    def template_path
+      File.directory?(HOME_TEMPLATE_PATH) ? 
+        HOME_TEMPLATE_PATH :
+        File.join(File.dirname(__FILE__), '../../templates')
+    end
+  end
+end

data/lib/railblazer/minimal_gemfile.rb

@@ -0,0 +1,22 @@
+require 'set'
+
+module Railblazer
+  class MinimalGemfile
+    attr_reader :gems
+
+    def initialize gemfile
+      @gems = Set.new
+      instance_eval gemfile.read
+    end
+
+    def gem name, *args
+      @gems << name
+    end
+
+    def group *args, &block
+      yield
+    end
+
+    def method_missing name, *args ; end
+  end
+end

data/lib/railblazer/version.rb

@@ -0,0 +1,3 @@
+module Railblazer
+  VERSION = "0.0.1"
+end

data/lib/railblazer.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+
+require 'railblazer/adapter_detection'
+require 'railblazer/minimal_gemfile'
+require 'railblazer/config_generator'

data/railblazer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/railblazer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin S. Leitgeb"]
+  gem.email         = ["justin@stackbuilders.com"]
+  gem.summary       = %q{Tools to automate builds for Stack Builders CI server}
+  gem.description   = <<-EOS
+    Contains tools to automate the build for the Stack Builders CI server.
+    Includes
+  EOS
+
+  gem.homepage      = "http://github.com/stackbuilders"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "railblazer"
+  gem.require_paths = ["lib"]
+  gem.version       = Railblazer::VERSION
+end

data/spec/railblazer/adapter_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Railblazer::AdapterDetection do
+  describe "#detect" do
+    FauxGemfile = Struct.new(:gems)
+
+    it "should detect mysql" do
+      gemfile = FauxGemfile.new(%w[mysql othergem].to_set)
+      Railblazer::AdapterDetection.new(gemfile).run.must_equal 'mysql'
+    end
+
+    it "should detect postgres" do
+      gemfile = FauxGemfile.new(%w[othergem pg].to_set)
+      Railblazer::AdapterDetection.new(gemfile).run.must_equal 'postgresql'
+    end
+
+    it "should raise an exception when more than one db gem is detected" do
+      gemfile = FauxGemfile.new(%w[mysql2 pg].to_set)
+
+      assert_raises RuntimeError do
+        Railblazer::AdapterDetection.new(gemfile).run
+      end
+    end
+
+    it "should raise an exception when there was no db gem detected" do
+      gemfile = FauxGemfile.new(%w[thor rails].to_set)
+
+      assert_raises RuntimeError do
+        Railblazer::AdapterDetection.new(gemfile).run
+      end
+    end
+  end
+end

data/spec/railblazer/config_generator_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Railblazer::ConfigGenerator do
+  describe "#to_s" do
+    it "should generate a valid configuration for mysql2" do
+      desired = <<EOS
+test:
+  adapter: mysql2
+  database: fooapp_test
+  username: root
+  host: 127.0.0.1
+EOS
+      Railblazer::ConfigGenerator.new('mysql2', 'fooapp').to_s.must_equal desired
+    end
+  end
+end

data/spec/railblazer/minimal_gemfile_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'set'
+require 'stringio'
+
+describe Railblazer::MinimalGemfile do
+  describe "#gems" do
+    it "should read a flat list of gems" do
+      mysql_gemfile = <<-EOF
+        gem 'mysql'
+        gem 'othergem'
+      EOF
+
+      Railblazer::MinimalGemfile.new(StringIO.new(mysql_gemfile)).gems.must_equal %w[mysql othergem].to_set
+    end
+
+    it "should detect gems inside of group blocks" do
+      mysql_gemfile = <<-EOF
+        gem 'mysql'
+        group 'development' do
+          gem 'othergem'  
+        end
+      EOF
+
+      Railblazer::MinimalGemfile.new(StringIO.new(mysql_gemfile)).gems.must_equal %w[mysql othergem].to_set
+    end
+
+    it "should ignore other methods in the Gemfile" do
+      mysql_gemfile = <<-EOF
+        gem 'mysql'
+        funky_method
+      
+        group 'development' do
+          gem 'othergem'  
+        end
+      EOF
+
+      Railblazer::MinimalGemfile.new(StringIO.new(mysql_gemfile)).gems.must_equal %w[mysql othergem].to_set
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require "#{File.dirname(__FILE__)}/../lib/railblazer"

data/templates/mysql.yml.erb

@@ -0,0 +1,5 @@
+test:
+  adapter: mysql
+  database: <%= app_name %>_test
+  username: root
+  host: 127.0.0.1

data/templates/mysql2.yml.erb

@@ -0,0 +1,5 @@
+test:
+  adapter: mysql2
+  database: <%= app_name %>_test
+  username: root
+  host: 127.0.0.1

data/templates/postgresql.yml.erb

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  min_messages: WARNING
+  database: <%= app_name %>_test

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: railblazer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin S. Leitgeb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-08 00:00:00.000000000 Z
+dependencies: []
+description: ! "    Contains tools to automate the build for the Stack Builders CI
+  server.\n    Includes\n"
+email:
+- justin@stackbuilders.com
+executables:
+- app_adapter
+- build
+- db_config
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- bin/app_adapter
+- bin/build
+- bin/db_config
+- lib/railblazer.rb
+- lib/railblazer/adapter_detection.rb
+- lib/railblazer/config_generator.rb
+- lib/railblazer/minimal_gemfile.rb
+- lib/railblazer/version.rb
+- railblazer.gemspec
+- spec/railblazer/adapter_spec.rb
+- spec/railblazer/config_generator_spec.rb
+- spec/railblazer/minimal_gemfile_spec.rb
+- spec/spec_helper.rb
+- templates/mysql.yml.erb
+- templates/mysql2.yml.erb
+- templates/postgresql.yml.erb
+homepage: http://github.com/stackbuilders
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Tools to automate builds for Stack Builders CI server
+test_files:
+- spec/railblazer/adapter_spec.rb
+- spec/railblazer/config_generator_spec.rb
+- spec/railblazer/minimal_gemfile_spec.rb
+- spec/spec_helper.rb