relevance_rails 0.0.3 → 0.1.0

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+app_for_ci
+*.swp

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use relevance_rails 

data/.travis.yml

@@ -0,0 +1,7 @@
+script: rake spec
+rvm:
+- 1.8.7
+- 1.9.3
+branches:
+  only:
+  - master

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+*v0.1.0*
+
+* Provisioning can be done on existing apps
+* Support multiple rubies - 1.9 and ree
+* Add unit tests
+* Can run acceptance tests on generated apps - rails g fixtures
+* From provision to deploy is a 2 step process - rake provision:ec2 and rails g deployment
+* Add more error handling
+* Tentative support for multiple databases - postgresql and mysql
+
+*v0.0.4*
+
+* Add support for generating EC2 deployment environments
+* 'rails g deployment <environment>' to generate a new environment
+* REQUIRES the presence of ~/.relevance_rails/aws_config.yml
+* Template aws_config.yml included with this gem.
+* Newly generates EC2 deployment environments will be wired up as new cap stages.
+
+*v0.0.3*
+
+* Add support for multiple public keys pushed to converged hosts.
+* Public keys are fetched from a git repo.
+* Git repo url is stored in ~/.relevance_rails/keys_git_url
+* Only the top level keys from the repo will be pushed to new hosts.

data/README.md

@@ -3,7 +3,7 @@ Relevance Rails
 
 Yo dawg, I heard you like automation, so I automated your automation so you can autopilot while you autopilot!
 
-Rails 3 projects with every fiddly bit convened rather than configured. Includes
+Rails 3 projects with every fiddly bit convened rather than configured. Includes:
 
 * HAML and SCSS
 * RSpec 2 with Relevance config niceties
@@ -12,18 +12,115 @@ Rails 3 projects with every fiddly bit convened rather than configured. Includes
 * Capistrano deploy recipes
 * A VM deployment target under provision
 
+[![Build Status](https://secure.travis-ci.org/relevance/relevance_rails.png?branch=master)](http://travis-ci.org/relevance/relevance_rails)
+
 Getting Started
 ---------------
 
+For new projects:
+
 ````sh
-    gem install relevance_rails
-    relevance_rails new <your new project>
+$ gem install relevance_rails
+$ relevance_rails new <your new project>
 ````
 
+For existing projects, first add to your Gemfile:
+
+    group :development, :test do
+      gem 'relevance_rails'
+    end
+
+After a `bundle install`, pull in our chef recipes into provision/:
+
+```sh
+# defaults to mysql
+$ rails g provision_config app_name
+# if using postgresql
+$ rails g provision_config app_name postgresql
+```
+
+Provisioning on EC2
+-------------------
+
+First create an aws config in ~/.relevance\_rails/aws\_config.yml.
+An example config looks like this:
+
+```yaml
+aws_credentials:
+  :aws_access_key_id: <your aws access key id>
+  :aws_secret_access_key: <your aws secret access key>
+
+server:
+  creation_config:
+    :flavor_id: <instance type, e.g. 'm1.large'>
+    :image_id: <ami to bootstrap with. Must be some UBUNTU image. e.g. "ami-fd589594">
+    :groups: <security group to place the new deployment in, e.g. "default">
+    :key_name: <name of the public/private keypair to start instance with>
+  private_key: |
+    -----BEGIN RSA PRIVATE KEY-----
+    Include the RSA private key here. This should correspond to the keypair indicated
+    by :key_name above.
+    -----END RSA PRIVATE KEY-----
+```
+
+Now just provision your instance:
+
+```sh
+$ rake provision:ec2 NAME=qa
+...
+Server IP: 1.1.1.1
+# Pass IP from previous command as second argument
+$ rails g deployment qa 1.1.1.1
+$ cap qa deploy:setup deploy
+```
+
+Provisioning with Vagrant
+-------------------------
+
+From your app's root directory:
+
+```sh
+$ cd provision
+# pull in vagrant and chef
+$ bundle install
+$ vagrant up
+```
+
+Vagrant instance should be up at 172.25.5.5.
+
+Supported Ruby Versions
+-----------------------
+
+Currently both Ruby 1.9.x and REE 1.8.7 are supported via RVM.  relevance_rails
+configures your Rails app (and Chef provisioning scripts) to require the version
+of Ruby you used to invoke the relevance_rails executable.
+
+Supported Databases
+-------------------
+
+Currently both MySQL and PostgreSQL are supported.  By default relevance_rails configures
+your Rails app (and Chef provisioning scripts) to use MySQL.  However, if you use the
+standard `--database=postgresql` Rails option, relevance_rails will use PostgreSQL.
+
+Maintainer Notes
+----------------
+
+When QAing or doing local development of this gem, the gem must be built and installed locally.
+
+In order to test deployment, use the example below to package the relevance_rails gem:
+
+    # Given a relevance_rails app "app" lives in "~/src/app"
+    # And the relevance_rails source lives in "~/src/relevance_rails"
+    ~/src/relevance_rails $ gem build relevance_rails.gemspec
+    ~/src/relevance_rails $ cd ~/src/app
+    ~/src/app $ gem install ../relevance_rails/relevance_rails-0.0.7.gem
+    ~/src/app $ bundle package
+    ~/src/app $ git commit -m "Package gems" vendor/cache
+
 Caveats
 -------
 
-Only supports REE 1.8.7, Rails 3.1 and MySQL right now.
+Currently we only support Ruby 1.9.x, REE 1.8.7, Rails 3.2, MySQL, and PostgreSQL installed on Ubuntu.
 
 Improvements
 ------------

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+desc 'Run the acceptance specs'
+task :acceptance do
+  ENV["ACCEPTANCE"] = "true"
+  Rake::Task[:spec].invoke
+end

data/aws_config.example.yml

@@ -0,0 +1,15 @@
+aws_credentials:
+  :aws_access_key_id: <your aws access key id>
+  :aws_secret_access_key: <your aws secret access key>
+
+server:
+  creation_config:
+    :flavor_id: <instance type, e.g. 'm1.large'>
+    :image_id: <ami to bootstrap with. Must be some UBUNTU image. e.g. "ami-fd589594">
+    :groups: <security group to place the new deployment in, e.g. "default">
+    :key_name: <name of the public/private keypair to start instance with>
+  private_key: |
+    -----BEGIN RSA PRIVATE KEY-----
+    Include the RSA private key here. This should correspond to the keypair indicated
+    by :key_name above.
+    -----END RSA PRIVATE KEY-----

data/bin/relevance_rails

@@ -1,21 +1,4 @@
 #!/usr/bin/env ruby
-#
-# This file was generated by RubyGems.
-#
-# The application 'railties' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
 
-require 'rubygems'
-
-version = ">= 0"
-
-if ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
-  version = $1
-  ARGV.shift
-end
-
-require 'relevance_rails/template_injector'
-
-gem 'railties', version
-load Gem.bin_path('railties', 'rails', version)
+require 'relevance_rails/runner'
+RelevanceRails::Runner.start

data/lib/generators/deployment/deployment_generator.rb

@@ -0,0 +1,31 @@
+class DeploymentGenerator < Rails::Generators::NamedBase
+  desc "Generates and updates capistrano config for a new deployment target"
+  argument :hostname, :type => :string
+
+  def write_stage_file
+    create_file "config/deploy/#{name}.rb", <<-DEPLOY_STAGE
+set :user, 'deploy'
+
+role :web, "#{hostname}"
+role :app, "#{hostname}"
+role :db,  "#{hostname}", :primary => true
+    DEPLOY_STAGE
+  end
+
+  def inject_new_deployment_to_stages
+    new_contents = ""
+    File.new(Rails.root.join('config','deploy.rb')).readlines.each do |line|
+      unless line =~ /^set :stages, (.*)$/
+        new_contents << line
+      else
+        stages = eval($1)
+        stages << name
+        stage_array_contents = stages.map{|stage| "\"#{stage}\""}.join(', ')
+        new_contents << "set :stages, [#{stage_array_contents}]\n"
+      end
+    end
+    File.open(Rails.root.join('config','deploy.rb'),'w') do |file|
+      file.write new_contents
+    end
+  end
+end

data/lib/generators/fixtures/fixtures_generator.rb

@@ -0,0 +1,44 @@
+class FixturesGenerator < Rails::Generators::Base
+  def create_controller
+    create_file "app/controllers/relevance_rails_controller.rb", <<-STR
+class RelevanceRailsController < ApplicationController
+end
+STR
+  end
+
+  def create_views
+    create_file "app/views/relevance_rails/index.html.haml", <<-STR
+%h1 WELCOME HOME
+STR
+    create_file "app/views/relevance_rails/db.html.haml", <<-STR
+%h1.database= ActiveRecord::Base.connection.current_database
+STR
+  end
+
+  def create_coffee
+    create_file "app/assets/javascripts/relevance_rails.js.coffee", <<-STR
+console.log 'Hello from Relevance, Inc!'
+STR
+  end
+
+  def create_sass
+    create_file "app/assets/stylesheets/relevance_rails.css.scss", <<-STR
+$background: blue;
+
+h1.relevance {
+    background-color: $background;
+    }
+STR
+  end
+
+  def modify_routes
+    insert_into_file "config/routes.rb", :after => "::Application.routes.draw do" do
+      <<-STR
+
+  # Required to test relevance_rails gem.
+  match '/relevance_rails' => 'relevance_rails#index'
+  match '/relevance_rails/db' => 'relevance_rails#db'
+STR
+    end
+  end
+end

data/lib/generators/provision_config/provision_config_generator.rb

@@ -0,0 +1,56 @@
+require 'relevance_rails'
+require 'rails/generators'
+
+class ProvisionConfigGenerator < Rails::Generators::NamedBase
+
+  desc "This generator configures the provision sub-directory with appropriate files."
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  argument :database, :type => :string, :default => 'mysql'
+
+  attr_reader :authorized_keys
+
+  def fetch_elzar
+    git :remote => 'add -f elzar git://github.com/relevance/elzar.git'
+    git :merge => '-s ours --no-commit elzar/master'
+    git :"read-tree" => '--prefix=provision/ -u elzar/master'
+    gsub_file 'provision/Vagrantfile', /config\.vm\.host_name(\s+)= .*$/,
+      "config.vm.host_name\\1= '#{name.gsub('_','-')}.local'"
+  end
+
+  def create_authorized_key_data_bag
+    if (@authorized_keys = fetch_keys).empty?
+      abort "No ssh keys were found! Check ssh-add -L and your keys_git_url config."
+    end
+    @authorized_keys.map! {|key| "\"#{key}\""}
+    template('authorized_keys.json.erb', 'provision/data_bags/deploy/authorized_keys.json', {:force => true})
+  end
+
+  def create_dna_json
+    path = File.expand_path('provision/dna.json', destination_root)
+    json = JSON.parse File.binread(path)
+    json['rails_app']['name'] = name
+    # This generator may not receive a working directory;
+    # and we pull data by shelling out to RVM about the ruby
+    # version. This sets the directory explicitly beforehand.
+    Dir.chdir(destination_root)
+    RelevanceRails::ChefDNA.gene_splice(json,database)
+    create_file('provision/dna.json', JSON.generate(json), {:force => true})
+  end
+
+  def commit_changes
+    git :add => 'provision/data_bags/deploy/authorized_keys.json'
+    git :add => 'provision/Vagrantfile'
+    git :add => 'provision/dna.json'
+    git :commit => '-m "Merge Elzar as our provision subdirectory"'
+  end
+
+  private
+
+  def fetch_keys
+    local_keys = `ssh-add -L`.split("\n")
+    local_keys = [] unless $?.success?
+    (local_keys + RelevanceRails::PublicKeyFetcher.public_keys).uniq
+  end
+end

data/lib/generators/provision_config/templates/authorized_keys.json.erb

@@ -0,0 +1,6 @@
+{
+  "id":"authorized_keys",
+  "keys": [
+<%= authorized_keys.join(",\n") %>
+   ]
+}

data/lib/generators/relevance_file/relevance_file_generator.rb

@@ -6,37 +6,22 @@ class RelevanceFileGenerator < Rails::Generators::NamedBase
 
   source_root File.expand_path("../templates", __FILE__)
 
+  argument :database, :type => :string, :default => 'mysql'
+
   def copy_gemfile
-    copy_file "Gemfile", "Gemfile"
+    template "Gemfile.erb", "Gemfile"
   end
 
   def create_readme_markdown
-    create_file "README.markdown", <<-README
-# #{name}
-
-## Getting Started
-
-gem install bundler
-# TODO other setup commands here
-    README
+    template "README.markdown.erb", "README.markdown"
   end
 
   def create_application_layout
-    create_file 'app/views/layouts/application.html.haml', <<-LAYOUT
-!!!
-%html
-  %head
-    %title #{name}
-  = stylesheet_link_tag :application
-  = javascript_include_tag :application
-  = csrf_meta_tag
-  %body
-    = yield
-    LAYOUT
+    template 'application.html.haml.erb', 'app/views/layouts/application.html.haml'
   end
 
   def create_rvmrc
-    create_file ".rvmrc", "rvm use ree-1.8.7-2012.02@#{name}"
+    create_file ".rvmrc", "rvm use #{RelevanceRails.rvm_version}@#{name}"
   end
 
   def create_rspec
@@ -52,64 +37,17 @@ gem install bundler
   end
 
   def create_deploy
-    create_file 'config/deploy.rb', <<-CAP_CONFIG
-require 'bundler/capistrano'
-
-set :application, "#{name}"
-set :repository,  "."
-set :deploy_via, :copy
-
-set :scm, :git
-
-set :deploy_to, "/var/www/apps/\#{application}"
-default_run_options[:pty] = true
-set :ssh_options, { :paranoid => false, :forward_agent => true }
-
-set :copy_exclude, '.git/*'
-
-set :stages, %w(vagrant)
-set :default_stage, 'vagrant'
-
-after "deploy:setup", "deploy:copy_shared_db_config"
-after "deploy:create_symlink", "deploy:symlink_shared_db_config"
-
-Dir['config/deploy/recipes/*.rb'].sort.each { |f| eval(File.read(f)) }
-    CAP_CONFIG
+    template 'deploy.rb.erb', 'config/deploy.rb'
   end
 
   def create_database_example_yml
-    create_file 'config/database.example.yml', <<-DATABASE_CONFIG
-development:
-  adapter: mysql2
-  encoding: utf8
-  database: #{name}_development
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  adapter: mysql2
-  encoding: utf8
-  database: #{name}_test
-
-production:
-  adapter: mysql2
-  encoding: utf8
-  database: #{name}_production
-    DATABASE_CONFIG
-  end
-
-  def create_authorized_key_data_bag
-    authorized_keys = (`ssh-add -L`.split("\n") + RelevanceRails::PublicKeyFetcher.public_keys).uniq
-    authorized_keys.map! {|key| "\"#{key}\""}
-    create_file 'authorized_keys.json', <<-AUTHORIZED_KEYS
-{
-  "id":"authorized_keys",
-  "keys": [
-#{authorized_keys.join(",\n")}
-   ]
-}
-    AUTHORIZED_KEYS
+    if database == 'mysql'
+      template 'database.example.yml.mysql.erb', 'config/database.example.yml'
+    elsif database == 'postgresql'
+      template 'database.example.yml.postgresql.erb', 'config/database.example.yml'
+    else
+      create_file 'database.example.yml', "Don't know how to make a template for database: #{database}"
+    end
   end
 
   def copy_deploy_recipes