funkenplate 0.0.5 → 0.1.1

data/README.textile

@@ -1,37 +0,0 @@
-h3. What is it?
-
-A Rails 3 template for funkensturm. applications.
-
-h3. Requirements
-
-* Ruby >= @1.8.7@
-* Rails >= @3.0.0@
-
-h3. Installation
-
-<pre>
-  gem install funkenplate
-</pre>
-
-h3. Online Usage
-
-<pre>
-  rails myapp --template http://github.com/funkensturm/funkenplate/raw/master/funkenplate.rb
-</pre>
-
-h3. Offline Usage
-
-Just hit this into your console and you will get the path to your local funkenplate template:
-
-<pre>
-  funkenplate
-</pre>
-
-h3. Design guidelines
-
-* Funkenplate works even when you are offline
-
-h3. Assumptions
-
-* The application is deployed to @/u/apps/APP@ where @APP@ stands for the name of the application you just created using funkenplate. If you need to change this, it is _safe_ to modify @deploy.rb@ afterwards without breaking any dependencies.
-

data/funkenplate.rb

@@ -1,263 +0,0 @@
-# ––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
-# This template initializes a Rails app with git and capistrano
-# for a repository located on the application server or github.
-#
-# Installation:   sudo gem install funkenplate
-# Online Usage:   rails myapp --template http://github.com/funkensturm/funkenplate/raw/master/funkenplate.rb
-# Offline Usage:  rails myapp --template ~/.funkenplate/funkenplate.rb
-# Documentation:  http://github.com/funkensturm/funkenplate
-# ––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
-
-# –––––––––––––––––––––
-# Checking envirionment
-# –––––––––––––––––––––
-
-unless defined?(Rails)
-  puts %(This is not a standalone application, it is to be used as a template for Rails.)
-  exit 1
-end
-
-unless Gem.available?('funkenplate')
-  say_status :error, 'Please install the funkenplate gem first with "gem install funkenplate".', :red
-  exit 1
-end
-
-say_status :WELCOME, 'Welcome to funkenplate', :green
-
-# –––––––––––––––––––––––––––
-# OBTAINING GEM PATH AND LIBS
-# –––––––––––––––––––––––––––
-
-# Main paths
-gem_path       = Gem.source_index.find_name('funkenplate').last.full_gem_path
-gem_version    = Gem.source_index.find_name('funkenplate').last.version.version
-templates_path = File.join(gem_path, 'templates')
-
-# This is where we will search for funkenplate.yml containing individual secrets
-secret_files = []
-directories  = ['..', ENV['HOME'], File.join(ENV['HOME'], '.ssh')]
-files        = ['funkenplate.yml', '.funkenplate.yml']
-directories.each { |directory| files.each { |file| secret_files << File.expand_path(File.join(directory, file)) } }
-
-# ––––––––––––––
-# HELPER METHODS
-# ––––––––––––––
-
-def shout_status(*args)
-  puts
-  say_status(*args)
-  puts
-end
-
-def ask(question)
-  puts
-  say_status :QUESTION, question, :blue
-  print ' ' * 16
-  $stdin.gets.strip
-end
-
-def yes?(question)
-  answer = ask("#{question} (ENTER: yes)").downcase
-  puts
-  answer == '' or answer == "\n" or answer == 'y' or answer == 'yes' or answer == 'j' or answer == 'ja'
-end
-
-def read_template(file)
-  File.new(file).read
-end
-
-def apply_template(file)
-  read_template(file).
-    gsub('~app_name~', app_name).
-    gsub('~github_account~', @secrets[:deploy][:app_server][:user].to_s).
-    gsub('~domain~', @secrets[:deploy][:app_server][:domain].to_s).
-    gsub('~user~', @secrets[:deploy][:app_server][:user].to_s).
-    gsub('~port~',  @secrets[:deploy][:app_server][:port].to_s).
-    gsub('~keys~', @secrets[:deploy][:app_server][:keys].to_s)
-end
-
-# –––––––––––––––
-# DEFAULT SECRETS
-# –––––––––––––––
-
-# Default secrets
-default_secrets = {
-  :version => gem_version,
-  :deploy => {
-    :app_server => {
-      :user   => ENV['USER'].downcase,
-      :domain => 'YOUR_SERVER_DOMAIN_OR_IP_GOES_HERE',
-      :port   => 22,
-      :keys => File.expand_path(File.join(ENV['HOME'], '.ssh', 'YOUR_PRIVATE_KEY'))
-    },
-    :github => {
-      :account => 'YOUR_GITHUB_ACCOUNT_NAME_GOES_HERE'
-    }
-  }
-}
-
-# –––––––––––––––––
-# OBTAINING SECRETS
-# –––––––––––––––––
-
-@secrets = default_secrets
-if secret_file = secret_files.find { |file| File.file? file }
-  @secrets = YAML.load_file secret_file
-else
-  shout_status :error, "I could not find funkenplate.yml anywhere but I created one for you. You must edit it and then re-apply this template.", :red
-  say_status :info, "Note that you can put that yml file into any of these locations (top ones with higher priority):", :yellow
-  secret_files.each { |location| say_status '', "  #{location}" }
-  shout_status :create, secret_files.first
-  File.open(secret_files.first, 'w') { |file| file.write YAML::dump(default_secrets) }
-  exit 1
-end
-
-shout_status :ENVIRONMENT, "These is the stuff we're working with here:", :yellow
-print_table [
-  ['Application name:', app_name],
-  ['Application location:', destination_root],
-  ['Funkenplate gem:', gem_path],
-  ['Secret file:', secret_file],
-], :ident => 16
-
-shout_status :SECRETS, "I was able to obtain these secrets from the secret file:", :yellow
-print_table [
-  ['Application Server domain:', @secrets[:deploy][:app_server][:domain]],
-  ['Application Server SSH user:', @secrets[:deploy][:app_server][:user]],
-  ['Application Server SSH port:', @secrets[:deploy][:app_server][:port]],
-  ['Github account:', @secrets[:deploy][:github][:account]],
-  ['Location of your SSH key:', @secrets[:deploy][:app_server][:keys]],
-], :ident => 16
-
-unless yes?("Are these values correct?")
-  shout_status :EXITING, "OK, please edit this file first: #{secret_file}"
-  exit 1
-end
-
-# ––––––––––––––
-# TEMPLATE TASKS
-# ––––––––––––––
-
-say_status :TASKS, 'Running template tasks...', :yellow
-
-say_status :TASK, 'Clearing tmp directories...', :magenta
-['tmp/pids', 'tmp/sessions', 'tmp/sockets', 'tmp/cache'].each { |dir| remove_file dir }
-
-say_status :TASK, 'Creating additional directories...', :magenta
-['private', 'lib/core_extensions', 'lib/rails_extensions'].each { |dir| empty_directory dir }
-
-say_status :TASK, 'Deleting some boring files...', :magenta
-['public/index.html', 'public/images/rails.png'].each { |dir| remove_file dir }
-
-# ––––––––––––––
-# TEMPLATE TASKS
-# ––––––––––––––
-
-say_status :TASK, 'Doing some beauty errands...', :magenta
-run 'echo TODO > README'
-run 'mv README README.textile'
-
-say_status :TASK, 'Creating lib extensions...', :magenta
-lib 'core_extensions/object.rb', read_template(File.join(templates_path, 'lib', 'core_extensions', 'object.rb'))
-lib 'rails_extensions/active_record.rb', read_template(File.join(templates_path, 'lib', 'rails_extensions', 'active_record.rb'))
-lib 'rails_extensions/action_controller_base.rb', read_template(File.join(templates_path, 'lib', 'rails_extensions', 'action_controller_base.rb'))
-lib 'rails_extensions/application_helper.rb', read_template(File.join(templates_path, 'lib', 'rails_extensions', 'application_helper.rb'))
-lib 'gem_extensions/formtastic.rb', read_template(File.join(templates_path, 'lib', 'gem_extensions', 'formtastic.rb'))
-
-say_status :TASK, 'Creating initializer for lib extensions...', :magenta
-initializer 'extensions.rb',
-"Dir.glob(File.join(Rails.root, 'lib', 'core_extensions', '*.rb')) { |file| require file }\n
-Dir.glob(File.join(Rails.root, 'lib', 'rails_extensions', '*.rb')) { |file| require file }\n
-Dir.glob(File.join(Rails.root, 'lib', 'gem_extensions', '*.rb')) { |file| require file }\n"
-
-say_status :TASK, 'Creating initializer for the private directory...', :magenta
-initializer 'directory.rb', read_template(File.join(templates_path, 'config', 'initializers', 'directories.rb'))
-
-say_status :TASK, 'Creating sample database.yml...', :magenta
-file 'config/database.yml.sample', "
-#  HINT: If you are on the server, you might want to delete
-#  the \"development\" and \"test\" database definition in this file.
-#  This way you won't accidentally work on a development database.
-#
-\n\n#{File.new('config/database.yml').read}"
-
-say_status :TASK, 'Creating TextMate project file...', :magenta
-file "#{app_name}.tmproj", apply_template(File.join(templates_path, 'tmproj'))
-
-say_status :TASK, 'Adding backtrace silencers...', :magenta
-append_file 'config/initializers/backtrace_silencers.rb',
-  "Rails.backtrace_cleaner.add_silencer { |line| line =~ /^\s*passenger/ }"
-
-# –––––––
-#   GIT
-# –––––––
-
-say_status :GIT, 'Gitifying application...', :yellow
-
-say_status :GIT, 'Create .gitignore recursively in every empty directory...', :magenta
-run 'find . \\( -type d -empty \\) -and \\( -not -regex ./\\.git.* \\) -exec touch {}/.gitignore \\;'
-
-say_status :GIT, 'Create .gitignore in root...', :magenta
-remove_file '.gitignore'
-file '.gitignore', read_template(File.join(templates_path, 'gitignore'))
-
-say_status :GIT, 'Initial commit...', :magenta
-git :init
-git :add => '.'
-git :commit => "-a -m 'Initial commit.'"
-
-say_status :GIT, 'Adding repository remotes for the fs server ...', :magenta
-run "git remote add fs #{apply_template(File.join(templates_path, 'config', 'deploy', 'repositories', 'fs_remote_fs'))}"
-run "git remote add fs.git #{apply_template(File.join(templates_path, 'config', 'deploy', 'repositories', 'fs_remote_git'))}"
-
-# ––––––––––
-# CAPISTRANO
-# ––––––––––
-
-say_status :CAPISTRANO, 'Capifying application...', :yellow
-
-say_status :CAPISTRANO, 'Capify...', :magenta
-capify!
-
-say_status :CAPISTRANO, 'Backup original deploy.rb...', :magenta
-run 'cp config/deploy.rb config/deploy.rb.sample'
-
-deploy_header = [
-  apply_template(File.join(templates_path, 'config', 'deploy', 'header.rb')),
-  apply_template(File.join(templates_path, 'config', 'deploy', 'options.rb'))
-].join("\n")
-
-deploy_footer = [
-  apply_template(File.join(templates_path, 'config', 'deploy', 'tasks.rb')),
-  apply_template(File.join(templates_path, 'config', 'deploy', 'helper.rb'))
-].join("\n")
-
-say_status :CAPISTRANO, 'Generating deploy.fs.rb for repositories on fs server...', :magenta
-file 'config/deploy.fs.rb', deploy_header + "\n" + apply_template(File.join(templates_path, 'config', 'deploy', 'repositories', 'fs.rb')) + "\n" + deploy_footer
-
-say_status :CAPISTRANO, 'Generating deploy.github.rb for repositories on github.com...', :magenta
-file 'config/deploy.github.rb', deploy_header + "\n" + apply_template(File.join(templates_path, 'config', 'deploy', 'repositories', 'github.rb')) + "\n" + deploy_footer
-
-say_status :GIT, 'Commiting capistrano changes...', :magenta
-git :add => '.'
-git :commit => "-a -m 'Capified the app.'"
-
-# –––––––––
-#   GEMS
-# –––––––––
-
-say_status :GEMFILE, 'Adding some gems...', :magenta
-append_file "Gemfile", "
-gem 'will_paginate'
-gem 'formtastic'
-gem 'geokit'
-"
-
-say_status :GIT, 'Commiting Gemfile changes...', :magenta
-git :commit => "-a -m 'Added default gems to Gemfile.'"
-
-# ––––––
-# FINISH
-# ––––––
-
-shout_status :FINISHED, 'Congratulations.', :green

data/templates/config/deploy/header.rb

@@ -1,17 +0,0 @@
-# —————————————————————
-# CAPISTRANO QUICKSTART
-# —————————————————————
-# cap deploy:check   Dry check for permissions and so forth to mae sure you can deploy
-# cap deploy:setup   Create necessary directories
-# cap deploy:cold    Install application and run migrations
-# cap deploy         Update application
-#
-
-# ––––––––––––––––––
-# APPLICATION SERVER
-# ————————————————––
-
-set :application, "~app_name~"
-set :user,        "~user~"
-set :domain,      "~domain~"
-set :port,        ~port~

data/templates/config/deploy/helper.rb

@@ -1,53 +0,0 @@
-# ———————————–––
-# HELPER METHODS
-# ————————————––
-
-# Creates a bare git repository if needed and possible
-def git_init(path)
-  return true if test_remote? :file, File.join(path, 'HEAD')
-  return false unless test_remote? :writable, path
-  run "cd #{path}; git --bare init"
-  test_remote?(:file, File.join(path, 'HEAD')) ? true : false
-end
-
-# Creates a directory only if needed and possible
-def mkdir(path)
-  return true if test_remote? :directory, path
-  return false unless test_remote? :writable, '/' + path.split('/')[1..path.split('/').size-2].join('/')
-  run "mkdir #{path}"
-  test_remote?(:directory, path) ? true : false
-end
-
-# Performs various file tests on the remote server
-def test_remote?(type, full_path)
-  arg = case type
-    when :file then '-f'
-    when :directory then '-d'
-    when :writable then '-w'
-    when :file_with_content then '-s'
-  end
-  'true' == capture("if [ #{arg} #{full_path} ]; then echo 'true'; fi").strip
-end
-
-# Returns the repository path if it is located on the deploy server
-def repository_on_server?
-  return false unless repository =~ /^file/
-  repository.gsub('file://', '')
-end
-
-# Creates a directory in the shared path
-def mkshared(path)
-  mkdir File.join(deploy_to, 'shared', path)
-end
-
-# Creates a symlink from <tt>deploy_to/shared/...</tt> to <tt>release_path/...</tt>
-# If <tt>to</tt> is omitted, the release path mirrors in the shared path
-def symlinker(from, to='')
-  to = from if to == ''
-  run "ln -nfs #{File.join deploy_to, 'shared', from} #{File.join release_path, to}"
-end
-
-# Quick helper for the database in the shared directory
-def shared_database
-  File.join(deploy_to, 'shared', 'config', 'database.yml')
-end

data/templates/config/deploy/options.rb

@@ -1,19 +0,0 @@
-# ––––––––––––––
-# DEPLOY OPTIONS
-# —————————————–
-
-role :app, domain
-role :web, domain
-role :db,  domain, :primary => true
-
-set :scm,           :git
-set :use_sudo,      false
-set :keep_releases, 3
-set :default_run_options, { :pty => true }
-
-set :ssh_options, {
-  :forward_agent => true,
-  :paranoid => false,
-  :keys => ["~keys~"],
-  :port => port
-}

data/templates/config/deploy/repositories/fs.rb

@@ -1,7 +0,0 @@
-# ––––––––––––––
-# REPOSITORY: FS
-# ––––––––––––––
-
-set :repository,       "file:///home/git/repositories/~app_name~"
-set :local_repository, "fs.git:/home/git/repositories/~app_name~"
-set :deploy_via,       :remote_cache

data/templates/config/deploy/repositories/fs_remote_fs

@@ -1 +0,0 @@
-fs:/home/git/repositories/~app_name~

data/templates/config/deploy/repositories/fs_remote_git

@@ -1 +0,0 @@
-fs.git:/home/git/repositories/~app_name~

data/templates/config/deploy/repositories/github.rb

@@ -1,5 +0,0 @@
-# ––––––––––––––––––
-# REPOSITORY: GITHUB
-# ––––––––––––––––––
-
-set :repository,  "git://github.com/~github_account~/~app_name~.git"

data/templates/config/deploy/repositories/github_remote

@@ -1 +0,0 @@
-git://github.com/~github_account~/~app_name~.git

data/templates/config/deploy/tasks.rb

@@ -1,116 +0,0 @@
-# ———————————–––––—
-# FUNKENPLATE HOOKS
-# ————————————–––––
-
-before 'deploy:setup',       :funkenplate
-after  'deploy:setup',       'deploy:setup_additions'
-after  'deploy:update_code', 'deploy:additional_symlinks'
-
-# ———————————–
-# DEPLOY TASKS
-# ————————————
-
-namespace :quick do
-
-  # Quickly update git and deploy the app
-  desc 'Quick commit and deploy'
-  task :default do
-    system 'git add .; git add -u; git commit -m "cap quick"; git push origin master; cap deploy'
-  end
-  
-end
-
-namespace :deploy do
-
-  # Manually restart for the Rails application
-  desc 'Restart passenger'
-  task :restart, :roles => :app, :except => { :no_release => true } do
-    run "touch #{File.join(current_path,'tmp','restart.txt')}"
-  end
-  
-  # Happens after initial setup
-  desc "Add some more dirs into shared"
-  task :setup_additions do
-    mkshared 'private'
-    mkshared 'config'
-    run "touch #{shared_database}"
-    logger.important "REMEMBER TO EDIT #{shared_database} ON THE SERVER - NOT in THIS shell!" unless test_remote? :file_with_content, repository_on_server?
-  end
-  
-  # Happens with each release
-  desc "Link in critical data from shared and install bundles"
-  task :additional_symlinks do
-    symlinker 'config/database.yml'
-    symlinker 'private'
-    run "cd #{release_path} && bundle install --without test"
-  end
-  
-  # Overwriting default spin scripts
-  task :start do; end
-  task :stop  do; end
-  
-end
-
-# ———————————––––––
-# FUNKENPLATE TASKS
-# ————————————–––––
-
-namespace :funkenplate do
-  
-  # Default run for funkenplate's pre-setup
-  task :default do
-    deploy_directory
-    remote_repository if repository_on_server?  # i.e. if not github
-  end
-
-  # Creates the deploy_to directory (if possible)
-  task :deploy_directory do
-    mkdir deploy_to
-    unless test_remote? :directory, deploy_to
-      puts "\n-------------- DIRECTOY NOT FOUND --------------"
-      puts "Please run these commands as root on the server:"
-      puts "mkdir #{deploy_to}"
-      puts "chown #{user}:#{user} #{deploy_to}"
-      puts "------------------------------------------------\n\n"
-      exit
-    end
-    unless test_remote? :writable, deploy_to
-      puts "\n------------ DIRECTOY NOT WRITABLE -------------"
-      puts "Please run this command as root on the server:"
-      puts "chown #{user}:#{user} #{deploy_to} --recursive"
-      puts "------------------------------------------------\n\n"
-      exit
-    end
-  end
-  
-  # Creates the repository if it is locally on the remote server
-  task :remote_repository do
-    mkdir repository_on_server?
-    unless test_remote? :directory, repository_on_server?
-      puts "\n-------- REPOSITORY ON SERVER NOT FOUND --------"
-      puts "Please run these commands as root on the server:"
-      puts "mkdir #{repository}"
-      puts "chown git:git #{repository}"
-      puts "------------------------------------------------\n\n"
-      exit
-    end
-    unless git_init repository_on_server?
-      puts "\n----- REPOSITORY ON SERVER NOT INITIALIZED -----"
-      puts "Please run these commands as root on the server:"
-      puts "cd #{repository}; git init --bare"
-      puts "chown git:git #{repository} --recursively"
-      puts "------------------------------------------------\n\n"
-      exit
-    end
-    unless test_remote? :file, File.join(repository_on_server?, 'refs', 'heads', 'master')
-      puts "\n-------- REPOSITORY ON SERVER IS EMPTY ---------"
-      puts "You need to do a local:"
-      puts "git push fs master         (when using fs with your user)"
-      puts "git push fs.git master     (when using fs with git user)"
-      puts "git push github master     (when using github)"
-      puts "------------------------------------------------\n\n"
-      exit
-    end
-  end
-  
-end