meskyanichi-generators 0.0.1 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,16 @@
+
+	Meskyanichi - Generators |0.0.2| 
+-----------------------------------------------------------
+
+	- Finished "capistrano_template"
+
+-----------------------------------------------------------
+
+
+	Meskyanichi - Generators |0.0.1| 
+-----------------------------------------------------------
+
+	- Made an initial commit
+	- Pushed the unfinished core of "capistrano_template"
+
+-----------------------------------------------------------

data/README.rdoc

@@ -1,7 +1,92 @@
-= generators
+= Generators
+
+a few simple generators that might help you get your application up and running just a little bit faster!
+
+For now the gem only provides a generator for a simple capistrano template.
+
+
+== The Capistrano Template
+
+Essentially what this does, is generate a basic Capistrano deployment recipe. The recipe does a couple of things initially when you set it up.
+
+	- Create the necessary folders and files, namely the releases, current(symlink) and the shared folder
+	- Creates a log folder and generates a new production.log
+	- Creates a config folder and then syncs the database.yml from your Rails application to the remote server
+
+During every deployment, the recipe will:
+
+	- Update your remote repository before deployment to ensure all files are up to date
+	- After deployment, will restart the application for Passenger
+	- After deployment, will place the symlinks for the database and production.log files correctly
+	- Make the javascripts and stylesheets directory, located in the RAILS_ROOT/public directory, writable to avoid script caching errors
+
+If you wish to generate the simple Capistrano Template, open the terminal, go to the root of your rails application and type the following:
+	
+	script/generate capistrano_template
+	
+This will generate the capistrano template which you help you get up and running.
+
+You can also pass in additional arguments to let the generator help you fill in Capistrano recipe.
+
+	script/generate capistrano_template MyDomain.com git ssh://MyDomain.com/MyRepository.git master root /var/www/vhosts/MyDomain.com/httpdocs
+
+If you fill in the above correctly, (this also depends on your server setup / OS / etc), then it should work right out of the box.
+
+Below are the arguments which you can provide, in order:
+
+	domain_name (e.g. MyDomain.com)
+	scm (e.g. git)
+	repository (e.g. ssh://MyDomain.com/MyRepository.git)
+	branch (e.g. master)
+	user (e.g. root)
+	deploy_to (e.g. /var/www/vhosts/MyDomain.com/httpdocs)
+
+This generates the deploy.rb file with the specified settings in the RAILS_ROOT/config directory.
+
+Now the whole process in steps:
+
+	1: sudo gem install meskyanichi-generators
+	2: go to root of rails app and type "capify ."
+	3: then type "script/generate capistrano_template [arg1..arg6]"
+	4: when it prompts if you wish to overwrite, type "y" and hit return
+	5: now type "cap deploy:setup" to set up the whole directory structure and files
+	6: after the setup is finished, and assuming you have your local git repository set up correctly,
+	type "cap deploy" and your application will go live in a matter of seconds!
+	
+If you did not fill in all the arguments, or wish double check if it was all set up correctly, open the
+deploy.rb file located in the config directory and have a look. You can easily modify everything to your liking as well!
+
+
+== The Capistrano Template - Commands
+
+The recipe provides a few commands which are pretty useful. Including syncing your local database.yml file
+with the one on the server so that you are not forced to go SSH or FTP to the server to manually change it.
+
+	cap deploy:sync_database
+	
+If you wish to restart your application for Passenger without re-deploying your application, for example, after syncing the new database.yml,
+and you once again don't want to SHH manually, then you can do a:
+
+	cap deploy:restart
+	
+This will restart the application for Passenger.
+
+	cap deploy:setup
+	
+This will run the setup task, which will do everything Capistrano does out of the box,
+but also executes the tasks I mentioned at the top of this README.
+
+	cap deploy
+	
+After you've setup Capistrano correctly using the cap deploy:setup, you may now use the above command to deploy your rails application!
+
+
+
+== Git (Coming Soon!)
 
-Description goes here.
 
 == Copyright
 
 Copyright (c) 2009 Michael. See LICENSE for details.
+
+

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 0
-:patch: 1
+:minor: 1
+:patch: 0

data/rails_generators/capistrano_template/capistrano_template_generator.rb

@@ -1,7 +1,45 @@
 class CapistranoTemplateGenerator < Rails::Generator::Base
+
+	def initialize(runtime_args, runtime_options = {})
+    super
+    
+    @domain_name  = @args[0] || "MyDomain.com"
+    @scm          = @args[1] || "git"
+    @repository   = @args[2] || "ssh://MyDomain.com/MyRepository.git"
+    @branch       = @args[3] || "master"
+    @user         = @args[4] || "root"
+    @deploy_to    = @args[5] || "/var/www/vhosts/#{domain_name}/httpdocs"
+
+  end
+	
 	def manifest
 	  record do |m|
-	    m.file 'deploy.rb', 'config/deploy.rb'
+	    m.template 'deploy.rb', 'config/deploy.rb'
 	  end
 	end
+	
+	def domain_name
+	  @domain_name
+	end
+	
+	def scm
+	 @scm
+	end
+	
+	def repository
+	 @repository
+	end
+	
+	def branch
+	  @branch
+	end
+	
+	def user
+	  @user
+	end
+	
+	def deploy_to
+	 @deploy_to
+	end
+	
 end

data/rails_generators/capistrano_template/templates/deploy.rb

@@ -1 +1,79 @@
-This is a test!
+# Application Domain (MyDomain.com)
+# Convention: Make sure the correct domain name (same as the folder on the server in /var/www/vhosts/)
+set :application, "<%= domain_name %>"
+
+# Set server where the application is going to be uploaded to.
+role :web,  application
+role :app,  application
+role :db,   application
+
+# Set the user
+# :user       => Set the user that will attempt to access the remote repository
+# :deploy_to  => Set the deployment location (destination) on the remote server
+# :use_sudo   => Set to false
+set :user,      "<%= user %>" 
+set :deploy_to, "<%= deploy_to %>" 
+set :use_sudo,  false
+
+# Git Repository Location
+# :scm        => Specify the source code management tool you want to use (default is git)
+# :repository => Assign the repository location where the application resides
+# :branch     => Select the branch that capistrano should fetch from (default is master)
+set :scm,         "<%= scm %>"
+set :repository,  "<%= repository %>"
+set :branch,      "<%= branch %>"
+
+# Required: default_run_options[:pty] - This will allow the user to connect to protected repository after
+# logging in when the system prompts for the server's root password
+# default_run_options => (default is true)
+default_run_options[:pty] = true 
+
+# You can add additional deployment tasks, or alter the ones below.
+namespace :deploy do
+  
+  desc "Sets up the shared folder on the remote server"
+  task :setup_shared_folder do
+    run "touch #{shared_path}/log/production.log"
+    run "chmod 0666 #{shared_path}/log/production.log"
+  end
+  
+  desc "Syncs the database.yml to the server"
+  task :sync_database do
+    system "rsync -vr --exclude='.DS_Store' config/database.yml #{user}@#{application}:#{shared_path}/config/"
+  end
+  
+  desc "Restart Application with Passenger."
+  task :restart do
+    run "touch #{current_path}/tmp/restart.txt"
+  end
+  
+  desc "Symlink database."
+  task :symlink_database do
+    run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+  end
+  
+  desc "Make javascripts and stylesheets directories writable."
+  task :make_js_and_css_writable do
+    run "chmod 777 #{release_path}/public/javascripts" 
+    run "chmod 777 #{release_path}/public/stylesheets"
+  end
+  
+  desc "Updates repository before deployment."
+  task :update_repository do
+      system "git add ."
+      system "git commit -a -m 'Comitted for repository.'"
+      system "git push origin master"
+  end
+  
+end
+
+# Tasks that run before the deployment process
+before 'deploy', 'deploy:update_repository'
+
+# Tasks that run directly after the initial setup
+after 'deploy:setup', 'deploy:setup_shared_folder'
+after 'deploy:setup', 'deploy:sync_database'
+
+# Tasks that run directly after deployment
+after 'deploy:update_code', 'deploy:symlink_database'
+after 'deploy:update_code', 'deploy:make_js_and_css_writable'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: meskyanichi-generators
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael
@@ -30,6 +30,7 @@ files:
 - lib/generators.rb
 - test/generators_test.rb
 - test/test_helper.rb
+- CHANGELOG
 - rails_generators
 - rails_generators/capistrano_template
 - rails_generators/capistrano_template/capistrano_template_generator.rb