tsrails 2.0.0

data/README.md

@@ -0,0 +1,137 @@
+**TSRails** is a base Rails project that you can upgrade. It is used by
+[Taylored Software][] as a foundation for their Rails development
+efforts.
+
+**TSRails** is based upon the excellent [suspenders][] gem from
+[thoughtbot][], extended and modified to include other setup tasks commonly
+performed in Taylored Software's Rails environment.
+
+Using TSRails
+-------------
+
+To create a new project first install tsrails:
+
+      gem install tsrails
+
+Then run:
+
+      tsrails create projectname
+
+or:
+
+      tsrails new projectname
+
+This will create a project in `projectname`, and will check it into version
+control (Git) using the settings specified in the configuration file (see
+below.)
+
+Configuration
+=============
+
+The **TSRails** gem requires several configuration options which define things
+like the staging server, Git username, etc. THese are defined in a
+configuration file, ~/.tsrails.yml, which is automatically generated if it
+is not present.
+
+The configuration file should contain the following keys:
+
+- **staging_server** - The hostname of the Git/staging Web server
+- **staging_ssh_user** - The ssh user to use for accessing the remote server
+- **remote_git_dir** - The root of the Git directory tree on the remote server
+- **remote_apache_dir** - The root of the Apache directory tree on the remote
+  server
+- **test_app_domain** - The domain of the remote server (used for generating
+  an Apache/mod_passenger configuration for the test site.
+
+As mentioned above, this configuration file is automatically generated if it's
+not present when `tsrails` runs. However, the generated configuration file is
+almost certainly incorrect, so tsrails will abort after generating a new
+configuration file to allow you to edit it.
+
+About TSRails
+-------------
+
+**TSRails** was created for use at [Taylored Software][] as a baseline application
+setup, with reasonable default plugins that the majority (if not all) of our
+applications used, as well as best-practice configuration options.
+
+Although **TSRails** has been packaged as a general-purpose gem, it does (at
+present) make several assumptions that are specific to Taylored Software's
+server configuration and which may not be what you want:
+
+- The Git repository and Web server live on the same server
+- The Web site is to be deployed with Apache 2.2/mod_passenger and
+  with Ruby Enterprise Edition installed in /opt/ree
+
+Included Gems
+-------------
+
+TSRails includes the following gems in the generated application along with
+their associated configuration files:
+
+- **User Login and Authentication**
+	- Clearance
+- **Template and Markup Processing**
+	- HAML
+	- RedCloth
+- **Form Enhancements**
+	- Paperclip
+	- tiny_mce
+	- flutie
+	- formtastic
+- **View Enhancements**
+	- WillPaginate
+- **Application Infrastructure**
+	- Hpricot
+	- exception_notification
+	- Nokogiri
+	- Ryan Bates's `nifty-generators`
+- **Database Adapters**
+	- SQLite3 (development and test environments)
+	- MySQL (production environment)
+- **Deployment**
+	- Capistrano
+	- Heroku
+	- Mongrel and mongrel_cluster
+
+TSRails also includes the following BDD/testing tools:
+
+- factory_girl
+- RSpec
+- Shoulda
+- capybara
+- Timecop
+
+Initializers (in config/initializers)
+-------------------------------------
+
+- `backtrace_silencers.rb`: Configured to silence backtraces from Shoulda and
+  factory_girl
+- `app_config.rb`: Loads application settings from config/app_config.yml
+- `clearance.rb`: Configuration for Clearance
+- `haml_options.rb`: Configures HAML options
+- `jquery.rb`: Substitutes jQuery for Prototype.JS
+- `noisy_attr_accessible.rb`: Logs protected attribute assignments
+- `requires.rb`: Autoloads libraries in `lib/` and `lib/extensions`
+
+Version History
+---------------
+
+- 2.0.0 - 2012 Jan 30 - Updated for Rails 3.2
+- 1.2.2 - 2011 Jan 11 - Using jquery-rails gem instead of doing the heavy lifting ourselves
+- 1.2.1 - 2010 Dec 19 - Replaced RVM Ruby 1.9.2-head with REE 1.8.7-head
+- 1.2.0 - 2010 Dec 11 - Replaced `defined_app_name` with `@app_name` throughout,
+  added `ask_with_default` helper, various fixes for Ruby 1.9.2 compatibility
+- 1.1.2 - 2010 Nov 19 - Change .rvmrc template to use Rails 1.9.2-head, and
+  update a few things in the Gemfile
+- 1.1.1 - 2010 Nov 11 - Prepare test DB after installing Clearance, change `RAILS_ROOT` to
+  `::Rails.root.to_s`
+- 1.1.0 - 2010 Nov 11 - Fixed various bugs in the code generation
+- 1.0.6 - 2010 Nov 10 - Fixed a bug with autotest failing
+- 1.0.5 - 2010 Nov 10 - Fixed a template bug and updated the readme
+- 1.0.4 - 2010 Nov 10 - Added configuration file
+- 1.0.3 - 2010 Nov 10 - Initial public version
+
+[Taylored Software]: http://www.taylored-software.com/
+[thoughtbot]: http://www.thoughtbot.com/
+[suspenders]: https://github.com/thoughtbot/suspenders

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+TSRAILS_GEM_VERSION = '2.0.0'
+
+#############################################################################
+# Helper functions
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  TSRAILS_GEM_VERSION
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+# Packaging tasks
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :default => :build

data/bin/tsrails

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/create")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/constants")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/errors")
+
+require 'rubygems'
+require 'rails'
+require 'colored'
+require 'net/http'
+require 'net/ssh'
+
+include TSRails::Errors
+
+def usage
+  "Usage: #{File.basename(__FILE__)} create new_project_name"
+end
+
+case ARGV[0]
+  when 'create', '--create', 'new', '--new'
+    if ARGV[1].nil?
+      puts usage
+    else
+      begin
+        TSRails::Create.run!(ARGV[1])
+      rescue TSRails::InvalidInput => e
+        error_with_message(e.message)
+      end
+    end
+  when 'help', '--help'
+    puts usage
+  else
+    error_with_message "Unknown subcommand: #{ARGV[0]}\n#{usage}"
+end

data/lib/constants.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'yaml'
+require 'erb'
+require 'etc'
+
+module TSRails
+  class Constants
+    def self.get(var_name)
+      tsrails_config = File.expand_path(File.join("~", ".tsrails.yml"))
+
+      unless File.exist?(tsrails_config)
+        File.open(tsrails_config, 'w') do |f|
+          f.printf "# Configuration for the TSRails gem - EDIT THIS!\n"
+          f.printf "staging_server: staging.server.com\n"
+          f.printf "staging_ssh_user: %s\n", Etc.getlogin
+          f.printf "remote_git_dir: /var/git\n"
+          f.printf "remote_apache_dir: /var/sites\n"
+          f.printf "test_app_domain: example.com\n"
+        end
+        puts "A tsrails configuration file was generated as "
+        puts "   #{tsrails_config}"
+        puts "Please edit it as appropriate and rerun the tsrails command."
+        exit 1
+      end
+      tsrails_config = YAML.load_file(tsrails_config)
+      tsrails_config[var_name.to_s]
+    end
+  end
+end

data/lib/create.rb

@@ -0,0 +1,68 @@
+# Methods needed to create a project.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/errors")
+require File.expand_path(File.dirname(__FILE__) + "/constants.rb")
+require File.expand_path(File.dirname(__FILE__) + "/helpers.rb")
+
+require 'rubygems'
+require 'rails'
+require 'colored'
+require 'net/http'
+require 'net/ssh'
+
+module TSRails
+  class Create
+    attr_accessor :project_path
+
+    def self.run!(project_path)
+      creator = self.new(project_path)
+      creator.create_project!
+    end
+
+    def initialize(project_path)
+      self.project_path = project_path
+      validate_project_path
+      validate_project_name
+    end
+
+    def create_project!
+      exec(<<-COMMAND)
+        rails new #{project_path} \
+          --template=#{template} \
+          --skip-prototype \
+          --skip-test-unit
+      COMMAND
+    end
+
+    private
+
+    def validate_project_name
+      project_name = File.basename(project_path)
+      unless project_name =~ /^[a-z0-9_]+$/
+        raise InvalidInput.new("Project name must only contain [a-z0-9_]")
+      end
+      if git_name_taken?(project_name)
+        raise InvalidInput.new("Project name \"#{project_name}\" already taken in Git")
+      end
+      if apache_name_taken?(project_name)
+        raise InvalidInput.new("Project name \"#{project_name}\" already taken in Apache")
+      end
+    end
+
+    def validate_project_path
+      base_directory = Dir.pwd
+      full_path = File.join(base_directory, project_path)
+
+      # This is for the common case for the user's convenience; the race
+      # condition can still occur.
+      if File.exists?(full_path)
+        raise InvalidInput.new("Project directory (#{project_path}) already exists")
+      end
+    end
+
+    def template
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "template", "tsrails_3_2.rb"))
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,12 @@
+# User errors
+
+module TSRails
+  class InvalidInput < Exception; end
+
+  module Errors
+    def error_with_message(msg)
+      STDERR.puts msg
+      exit 1
+    end
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'rails'
+require 'colored'
+require 'net/http'
+require 'net/ssh'
+
+#============================================================================
+# Helper functions
+#============================================================================
+
+def get_file(http_location, file)
+  uri = URI.parse(http_location)
+  contents = Net::HTTP.get(uri)
+  File.open(file, "w") { |f| f.write(contents) }
+end
+
+def msg(message)
+  msg :info, message
+end
+
+def ask_with_default(prompt, default_value)
+  msg = "#{prompt} [#{default_value}]"
+  result = ask(msg)
+  if result.nil?
+    result = default_value
+  end
+  result
+end
+
+def msg(mtype, message)
+  printf "[".white.bold
+  if (mtype.nil?)
+    printf "message".green
+  elsif (mtype.to_s.blank?)
+    printf "message".green
+  elsif (mtype.to_s.downcase == "info")
+    printf "info".cyan
+  elsif (mtype.to_s.downcase == "warning")
+    printf "warning".red
+  else
+    printf "message".green
+  end
+  printf "] ".white.bold
+  printf "#{message}\n"
+end
+
+def remote_dir_exists?(hostname, username, dir_path)
+  output = ""
+  Net::SSH.start(hostname, username) do |ssh|
+    output = ssh.exec!("ls -d #{dir_path} 2>/dev/null | wc -l").chomp.strip
+  end
+  output == "1"
+end
+
+def git_name_taken?(project_name)
+  remote_dir_exists?(TSRails::Constants.get(:staging_server), TSRails::Constants.get(:staging_ssh_user), "#{TSRails::Constants.get(:remote_git_dir)}/#{project_name}.git")
+end
+
+def apache_name_taken?(project_name)
+  remote_dir_exists?(TSRails::Constants.get(:staging_server), TSRails::Constants.get(:staging_ssh_user), "#{TSRails::Constants.get(:remote_apache_dir)}/#{project_name}.taylored-software.com")
+end
+
+def concat_file(source, destination)
+  contents = IO.read(find_in_source_paths(source))
+  append_file destination, contents
+end
+
+def replace_in_file(relative_path, find, replace)
+  path = File.join(destination_root, relative_path)
+  contents = IO.read(path)
+  unless contents.gsub!(find, replace)
+    raise "#{find.inspect} not found in #{relative_path}"
+  end
+  File.open(path, "w") { |file| file.write(contents) }
+end
+
+def action_mailer_host(rails_env, host)
+  inject_into_file(
+    "config/environments/#{rails_env}.rb",
+    "\n\n  config.action_mailer.default_url_options = { :host => '#{host}' }",
+    :before => "\nend"
+  )
+end
+
+def section(descr)
+  printf "\n"
+  msg :info, descr
+end
+
+def replace_file (filename, content)
+  remove_file filename
+  file filename, content
+end

data/template/files/Gem.gemfile

@@ -0,0 +1,56 @@
+source 'http://rubygems.org'
+
+gem 'rake', '0.9.2'
+
+gem 'rails', '3.2.1'
+gem 'sqlite3'
+gem 'bcrypt-ruby', '~> 3.0.0'
+gem 'meta_search',    '>= 1.1.0.pre'
+gem 'clearance'
+gem 'therubyracer'
+
+gem 'kaminari'
+gem 'haml'
+gem 'haml-rails', :group => :development
+gem 'simple_form'
+gem 'jquery-rails'
+gem 'prawn'
+gem 'activemerchant'
+gem 'draper'
+
+group :development do
+  gem 'growl'
+  gem 'thin'
+end
+
+group :development, :test do
+  gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+  gem 'rails3-generators'
+  gem 'annotate'
+  gem 'spork', '>= 0.9.0.rc'
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-coffeescript'
+  gem 'guard-rspec'
+  gem 'guard-sass'
+  gem 'guard-spork'
+  gem 'guard-rails'
+  gem 'guard-annotate'
+  gem 'simplecov', :require => false
+end
+
+group :test do
+  gem 'database_cleaner'
+  gem 'rails3-generators' #mainly for factory_girl & simple_form at this point
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'capybara'
+  gem 'launchy'
+  gem 'shoulda', '>= 3.0.0.beta'
+end
+
+group :assets do
+  gem 'sass-rails', "  ~> 3.2.3"
+  gem 'coffee-rails', "~> 3.2.1"
+  gem 'uglifier', '>= 1.0.3'
+end

data/template/files/Guardfile

@@ -0,0 +1,36 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'spork', cucumber_env: { 'RAILS_ENV' => 'test' }, rspec_env: { 'RAILS_ENV' => 'test' }, wait: 120 do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch(%r{^config/environments/.+\.rb$})
+  watch(%r{^config/initializers/.+\.rb$})
+
+  watch('Gemfile')
+  watch('Gemfile.lock')
+
+  watch('spec/spec_helper.rb') { :rspec }
+  watch(%r{features/support/}) { :cucumber }
+  watch(%r{^spec/support/.+\.rb$})
+end
+
+guard 'rspec', version: 2, cli: '--drb', all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/requests/.+_spec\.rb$})              { "spec/requests"}
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch(%r{^app/views/(.+)/})                         { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end

data/template/files/Termfile

@@ -0,0 +1,37 @@
+FILE_BASE = "/Users/tlcravit/code/<%= @app_name %>"
+
+window do
+  before { run "cd #{FILE_BASE}" }
+
+  run "mate ."
+  run "tab_title 'shell (bash)'"
+
+  tab "server" do
+    run "tab_title 'server (thin)'"
+    run "bundle exec thin start"
+  end
+
+  if File.exist?("#{FILE_BASE}/Guardfile")
+    tab "guard" do
+      run "tab_title 'guard'"
+      run "guard"
+    end
+  end
+
+  if File.exist?("#{FILE_BASE}/logs/development.log")
+    tab "log" do
+      run "tab_title 'development log'"
+      run "tail -f \"#{FILE_BASE}/logs/development.log\""
+    end
+  end
+
+  tab "console" do
+    run "tab_title 'console (pry)'"
+    run "pry -r ./config/environment"
+  end
+
+  tab "shell" do
+    run "tab_title 'shell (bash)'"
+    run "/usr/local/bin/bash --login"
+  end
+end

data/template/files/_flashes.html.haml

@@ -0,0 +1,3 @@
+#flashes
+  - flash.each do |key, value|
+    %div{:class => key}= h(value)

data/template/files/_footer.html.haml

@@ -0,0 +1,8 @@
+#footer
+  Copyright ©
+  = Time.now.year
+  ,
+  = "#{APP_CONFIG[:client_name]}."
+  All rights reserved. Web development by
+  %a{:href => "http://www.taylored-software.com", :target => "_blank"}
+    Taylored Software.

data/template/files/_javascript.html.haml

@@ -0,0 +1 @@
+= yield :javascript

data/template/files/_sidebar.html.haml

@@ -0,0 +1,3 @@
+%ul
+	%li
+		= render :partial => 'shared/sign_in_out'

data/template/files/_sign_in_out.html.haml

@@ -0,0 +1,4 @@
+- if signed_in?
+  = link_to "Sign out", sign_out_path, :method => :delete
+- else
+  = link_to "Sign in", sign_in_path

data/template/files/apache_config.conf

@@ -0,0 +1,18 @@
+<VirtualHost *:80>
+  ServerName <%= @app_name %>.<%= TSRails::Constants.get(:test_app_domain) %>
+  DocumentRoot <%= TSRails::Constants.get(:remote_apache_dir) %>/<%= @app_name %>.<%= TSRails::Constants.get(:test_app_domain) %>/current/public
+
+  ErrorLog <%= TSRails::Constants.get(:remote_apache_dir) %>/<%= @app_name %>.<%= TSRails::Constants.get(:test_app_domain) %>/current/log/apache_error_log
+
+  RailsSpawnMethod smart
+  PassengerMaxRequests 5000
+  PassengerStatThrottleRate 5
+  RailsAppSpawnerIdleTime 0
+  RailsFrameworkSpawnerIdleTime 0
+  PassengerPoolIdleTime 1000
+
+  <Directory "<%= TSRails::Constants.get(:remote_apache_dir) %>/<%= @app_name %>.<%= TSRails::Constants.get(:test_app_domain) %>/current/public">
+    Allow from all
+    Options -MultiViews
+  </Directory>
+</VirtualHost>

data/template/files/app_config.yml

@@ -0,0 +1,11 @@
+development:
+  domain: localhost:3000
+  client_name: <%= @client_name %>
+
+test:
+  domain: test.host
+  client_name: <%= @client_name %>
+
+production:
+  domain: <%= @app_name %>.taylored-software.com
+  client_name: <%= @client_name %>

data/template/files/application.html.haml

@@ -0,0 +1,21 @@
+!!!
+%html
+  %head
+    %meta{"http-equiv" => "Content-type", :content => "text/html; charset=utf-8"}
+    %title= @page_title || "Page Title"
+    = stylesheet_link_tag    "application"
+    = javascript_include_tag "application"
+    = csrf_meta_tags
+    = yield :head
+  %body.bp.two-col
+    #container
+      #header
+        Web Site
+      #sidebar
+        = render :partial => 'shared/sidebar'
+      #content
+        = render :partial => 'shared/flashes'
+        = yield
+        = render :partial => 'shared/javascript'
+      #footer
+        = render :partial => 'shared/footer'

data/template/files/application_helper.rb

@@ -0,0 +1,6 @@
+module ApplicationHelper
+  def body_class
+    qualified_controller_name = controller.controller_path.gsub('/','-')
+    "#{qualified_controller_name} #{qualified_controller_name}-#{controller.action_name}"
+  end
+end