funkenplate 0.0.5 → 0.1.1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 funkensturm.
+Copyright (c) 2011 funkensturm.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/funkenplate

@@ -5,9 +5,6 @@ require 'rubygems'
 puts
 puts "Version: #{Gem.source_index.find_name('funkenplate').last.version.version}"
 puts
-puts "Online Usage:"
-puts "rails myapp --template http://github.com/funkensturm/funkenplate/raw/master/funkenplate.rb"
-puts
-puts "Offline Usage:"
-puts "rails myapp --template #{Gem.source_index.find_name('funkenplate').last.full_gem_path}/funkenplate.rb"
-puts 
+puts "Usage:"
+puts "rails new myapp --template #{Gem.source_index.find_name('funkenplate').last.full_gem_path}/lib/funkenplate.rb"
+puts

data/lib/funkenplate.rb

@@ -0,0 +1,49 @@
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
+# 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
+# Documentation:  http://github.com/funkensturm/funkenplate
+# Usage:          Run "funkenplate" in your Terminal for instructions
+# –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
+
+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
+
+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
+
+say_status :WELCOME, 'Welcome to funkenplate', :green
+
+modules_path = "#{Gem.source_index.find_name('funkenplate').last.full_gem_path}/lib/modules"
+
+apply "#{modules_path}/secrets.rb"
+apply "#{modules_path}/general.rb"
+apply "#{modules_path}/extensions.rb"
+apply "#{modules_path}/database.rb"
+apply "#{modules_path}/git.rb"
+apply "#{modules_path}/capistrano.rb"
+apply "#{modules_path}/finished.rb"

data/lib/modules/capistrano.rb

@@ -0,0 +1,123 @@
+say_status :CAPISTRANO, 'Capifying application...', :yellow
+
+deploy_header = <<-END
+# ——————————————
+# Setting up RVM
+# ——————————————
+$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
+require 'rvm/capistrano'
+require 'bundler/capistrano'
+
+# ––––––––––––––––––
+# APPLICATION SERVER
+# ————————————————––
+set :application, "~app_name~"
+set :user,        "~user~"
+set :domain,      "~domain~"
+set :port,        ~port~
+set :deploy_to,   '/apps/~app_name~'
+
+# ––––––––––––––
+# 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
+}
+
+END
+
+deploy_github = <<-END
+# ––––––––––––––––––
+# REPOSITORY: GITHUB
+# ––––––––––––––––––
+set :repository,  "git://github.com/~github_account~/~app_name~.git"
+
+END
+
+deploy_fs = <<-END
+# ––––––––––––––
+# 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
+
+END
+
+deploy_footer = <<-END
+# ———————————–––––—
+# FUNKENPLATE HOOKS
+# ————————————–––––
+after  'deploy:setup',       'deploy:setup_additions'
+after  'deploy:update_code', 'deploy:additional_symlinks'
+
+# ———————————–
+# DEPLOY TASKS
+# ————————————
+namespace :deploy do
+  
+  # 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'
+  end
+  
+  # Overwriting default spin scripts
+  desc 'Restart passenger'
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    run "touch \#{File.join(current_path,'tmp','restart.txt')}"
+  end
+  task :start do; end
+  task :stop  do; end
+  
+end
+
+# ———————————–––
+# HELPER METHODS
+# ————————————––
+
+# 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.blank?
+  run "ln -nfs \#{File.join deploy_to, 'shared', from} \#{File.join release_path, to}"
+end
+
+END
+
+
+say_status :CAPISTRANO, 'Capify...', :magenta
+capify!
+
+say_status :CAPISTRANO, 'Backup original deploy.rb...', :magenta
+run 'cp config/deploy.rb config/deploy.rb.sample'
+
+say_status :CAPISTRANO, 'Generating deploy.fs.rb for repositories on fs server...', :magenta
+file 'config/deploy.fs.rb', deploy_header.personalize(app_name, @secrets) + deploy_fs.personalize(app_name, @secrets) + deploy_footer
+
+say_status :CAPISTRANO, 'Generating deploy.github.rb for repositories on github.com...', :magenta
+file 'config/deploy.github.rb', deploy_header.personalize(app_name, @secrets) + deploy_github.personalize(app_name, @secrets) + deploy_footer
+
+say_status :GIT, 'Commiting capistrano changes...', :magenta
+git :add => '.'
+git :commit => "-a -m 'Capified the app.'"

data/lib/modules/database.rb

@@ -0,0 +1,10 @@
+say_status :TASK, 'Creating sample database.yml...', :magenta
+file 'config/database.yml.sample', <<-END
+#  HINT: If you are on the server, you might want to delete
+#  the "development" and "test" database definitions in this file.
+#  This way you won't accidentally work on a development database.
+#
+
+
+#{File.read('config/database.yml')}
+END

data/lib/modules/extensions.rb

@@ -0,0 +1,17 @@
+say_status :TASK, 'Creating example extension...', :magenta
+lib 'core_extensions/object.rb', <<-END
+module ObjectExtensions
+
+end
+
+class Object #:nodoc:
+  include ObjectExtensions
+end
+END
+
+say_status :TASK, 'Creating initializer for lib extensions...', :magenta
+initializer 'extensions.rb', <<-END
+Dir.glob(File.join(Rails.root, 'lib', 'core_extensions', '*.rb')) { |file| require file }
+Dir.glob(File.join(Rails.root, 'lib', 'rails_extensions', '*.rb')) { |file| require file }
+Dir.glob(File.join(Rails.root, 'lib', 'gem_extensions', '*.rb')) { |file| require file }
+END

data/lib/modules/finished.rb

@@ -0,0 +1 @@
+shout_status :FINISHED, 'Congratulations.', :green

data/lib/modules/general.rb

@@ -0,0 +1,14 @@
+say_status :TASKS, 'Running general 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/#{app_name}", 'lib/core_extensions', 'lib/rails_extensions'].each { |dir| empty_directory dir }
+
+say_status :TASK, 'Deleting boring files...', :magenta
+['public/index.html', 'public/images/rails.png'].each { |dir| remove_file dir }
+
+say_status :TASK, 'Doing some beauty errands...', :magenta
+run 'echo TODO > README'
+run 'mv README README.textile'

data/lib/modules/git.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', 'string')
+
+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', <<-END
+.DS_Store
+.bundle
+.tmproj
+tmtags
+log/*.log
+log/*.pid
+db/*.db
+db/*.sqlite3
+db/schema.rb
+tmp/*
+tmp/**/*
+doc/api
+doc/app
+config/database.yml
+config/deploy*.rb
+private
+pkg
+END
+
+say_status :GIT, 'Initial commit...', :magenta
+git :init
+git :add => '.'
+git :commit => "-a -m 'Initial commit.'"
+
+say_status :GIT, 'Adding repository remote aliases for the fs server ...', :magenta
+run 'git remote add fs fs:/home/git/repositories/~app_name~'.personalize(app_name, @secrets)
+run 'git remote add fs.git fs.git:/home/git/repositories/~app_name~'.personalize(app_name, @secrets)

data/lib/modules/secrets.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+require File.join(File.dirname(__FILE__), '..', 'string')
+
+# 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)) } }
+
+# –––––––––––––––
+# DEFAULT SECRETS
+# –––––––––––––––
+
+# Default secrets
+default_secrets = {
+  :version => Gem.source_index.find_name('funkenplate').last.version.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 3
+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.source_index.find_name('funkenplate').last.full_gem_path],
+  ['Secret file:', secret_file],
+], :ident => 18
+
+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 => 18
+
+unless yes?("Are these values correct?")
+  shout_status :EXITING, "OK, please edit this file first: #{secret_file}"
+  exit 1
+end

data/lib/string.rb

@@ -0,0 +1,17 @@
+module StringExtensions
+  
+  def personalize(app_name, hash)
+    self.
+      gsub('~app_name~', app_name).
+      gsub('~github_account~', hash[:deploy][:app_server][:user].to_s).
+      gsub('~domain~', hash[:deploy][:app_server][:domain].to_s).
+      gsub('~user~', hash[:deploy][:app_server][:user].to_s).
+      gsub('~port~',  hash[:deploy][:app_server][:port].to_s).
+      gsub('~keys~', hash[:deploy][:app_server][:keys].to_s)
+  end
+  
+end
+
+class String #:nodoc:
+  include StringExtensions
+end

metadata

@@ -1,86 +1,105 @@
 --- !ruby/object:Gem::Specification 
 name: funkenplate
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
-  - 0
-  - 5
-  version: 0.0.5
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
-- Captain Future
+- funkensturm.
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-01 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: "    funkenplate is a Rails Template according to the funkensturm. standards.\n"
+date: 2011-04-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  prerelease: false
+  type: :development
+  requirement: *id002
+description: funkenplate is a Rails Template according to the funkensturm. standards.
 email: 
 executables: 
 - funkenplate
 extensions: []
 
-extra_rdoc_files: 
-- README.textile
+extra_rdoc_files: []
+
 files: 
-- init.rb
-- funkenplate.rb
 - MIT-LICENSE
-- README.textile
-- templates/config/deploy/header.rb
-- templates/config/deploy/helper.rb
-- templates/config/deploy/options.rb
-- templates/config/deploy/repositories/fs.rb
-- templates/config/deploy/repositories/fs_remote_fs
-- templates/config/deploy/repositories/fs_remote_git
-- templates/config/deploy/repositories/github.rb
-- templates/config/deploy/repositories/github_remote
-- templates/config/deploy/tasks.rb
-- templates/config/initializers/directories.rb
-- templates/gitignore
-- templates/lib/core_extensions/array.rb
-- templates/lib/core_extensions/object.rb
-- templates/lib/core_extensions/string.rb
-- templates/lib/gem_extensions/formtastic.rb
-- templates/lib/rails_extensions/action_controller_base.rb
-- templates/lib/rails_extensions/action_controller_restful_test_case.rb
-- templates/lib/rails_extensions/active_record.rb
-- templates/lib/rails_extensions/application_helper.rb
-- templates/lib/restful.rb
-- templates/tmproj
-- lib/dummy
 - bin/funkenplate
-has_rdoc: true
+- init.rb
+- lib/funkenplate.rb
+- lib/modules/capistrano.rb
+- lib/modules/database.rb
+- lib/modules/extensions.rb
+- lib/modules/finished.rb
+- lib/modules/general.rb
+- lib/modules/git.rb
+- lib/modules/secrets.rb
+- lib/string.rb
 homepage: http://github.com/funkensturm/funkenplate
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Rails Template used by funkensturm.