bonethug 0.0.63 → 0.0.66

data/Gemfile

@@ -28,11 +28,14 @@ gem 'uglifier'
 gem 'sass-rails'
 gem 'coffee-rails'
 
-# asset pipeline - guard coffeescript / sass
+# asset pipeline - guard not sprockets
 gem 'coffee-script'
 gem 'sass'
 gem 'guard-sass'
 gem 'guard-coffeescript'
+gem 'guard-erb'
+gem 'guard-slim'
+gem 'guard-livereload'
 
 gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
 

data/README.md

@@ -3,7 +3,22 @@ Bonethug
 
 
 
-Project Skeleton Manager
+(Project) Bones in the basement and a thug to do the things you don't want to
+dirty your hands with.
+
+
+
+Bonethug could loosely be considered a "web project meta framework".  It uses a
+single configuration file (although it merges in the database.yml file for rails
+projects) for all project types and includes adapters to interface with project
+specific configs.  This keeps you configuration in one place and has the benefit
+of being able to drive the automation of a number of other repeatitious taks
+like deployment, task scheduling, backups and asset / db synchronisation.
+
+
+
+The goal of the project is to be able to handle the complete project life cycle
+using only bonethug, git and package managers - no ssh, ftp, mysqldump etc.
 
 
 
@@ -25,7 +40,7 @@ Or install it yourself as:
 
 
 Update
-------------
+------
 
 execute:
 
@@ -48,7 +63,7 @@ Usage
 
 **Set up a project Skeleton**
 
-`thug install {rails3|silverstripe3|drupal|php|sinatra}`
+`thug install {rails3|rails4|silverstripe3|drupal|php|sinatra}`
 
 
 
@@ -87,9 +102,27 @@ the info contained in cnf.yml*
 
 
 
+**Setup local server**
+
+*You sets up the local machine (if you are on ubuntu)*
+
+`thug setup-env local`
+
+
+
+**Initialise local DB**
+
+*Uses the local mysql client to create a user and a database according to the
+settings in your config/cnf.yml file*
+
+`thug init-local-db [admin_user=root] {development|staging|production}`
+
+
+
 ### Remote Commands
 
-*UPDATE:* Bonethug now supports interactive prompts so this may no longer be necessary
+*UPDATE:* Bonethug now supports interactive prompts so this may no longer be
+necessary
 
 Most of these are piped through mina.  Mina uses SSH to send a bash script to
 the remote server where it is executed.  For these commands to work you need to
@@ -105,16 +138,32 @@ Host *
     UserKnownHostsFile=/dev/null
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+
+
 **Setup a remote server**
 
-*This wraps mina to call all the commandsThis installs all the required software on a remote server*
-`thug setup_env {development|staging|production}`
+*This installs all the required software on a remote server using mina to call
+all the commands*
+
+`thug setup-env {development|staging|production}`
+
+
+
+**Initialise remote DB**
+
+*Uses the mysql client in the remote environment to create a user and a database
+according to the settings in your config/cnf.yml file*
+
+`thug init-db [admin_user=root] {development|staging|production}`
+
+
 
 **Setup and Deploy to Remote Server**
 
 *This wraps mina and deploys using the information contained in cnf.yml*
 
-`thug setup {development|staging|production}`  
+`thug setup {development|staging|production}`
+
 `thug deploy {develoment|staging|production}`
 
 
@@ -146,14 +195,124 @@ wipe the files from your deploy copy.
 
 `thug sync-to {develoment|staging|production}`
 
-  
+
+
+Example Workflow
+----------------
+
+
+
+### New SilverStripe3 project
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# install bonethug in the global scope (or use: bundle exec thug)
+gem install bonethug
+
+# set up project bones in the current folder
+thug install silverstripe3
+bundle install --path vendor
+php composer.phar install
+bower install
+
+# --> edit the config/cnf.yml file!!
+
+# watch for changes to sass and coffeescript
+thug watch
+
+# --> actually write some code!!
+
+# commit work
+git remote add origin git@git.domain.com:namespace/project-name.git
+git add -A && git commit -am "initial commit"
+git push -u origin master
+
+# setup the deployment env and do a deploy
+thug auth staging
+thug setup-env staging
+thug init-db staging
+thug setup staging
+thug deploy staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+### Deploying an existing project
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# clone the repo and install the gems
+git clone git@git.domain.com:namespace/project-name.git .
+bundle install --path vendor
+
+# only do this if its a fresh deploy target
+thug auth staging
+thug setup-env staging
+thug init-db staging
+thug setup staging
+
+# deploy
+thug deploy staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+What isn't implemented yet?
+---------------------------
+
+
+
+### Setup an existing project and mirror a remote environment (WIP)
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# clone the repo and install the gems
+git clone git@git.domain.com:namespace/project-name.git .
+bundle install --path vendor
+
+# setup local db
+thug init-local-db staging
+
+# add ssh key
+thug auth staging
+
+# do file sync
+thug sync-from staging
+
+# do db sync
+thug sync-local-db staging development
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
+### Push local assets etc to a remote (WIP)
+
+
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# add ssh key
+thug auth staging
+
+# do file sync
+thug sync-to staging
+
+# do db sync
+thug sync-remote-db development staging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 
 
 Contributing
 ------------
 
-1.  Fork it 
-2.  Create your feature branch (`git checkout -b my-new-feature`) 
-3.  Commit your changes (`git commit -am 'Add some feature'`) 
-4.  Push to the branch (`git push origin my-new-feature`) 
+1.  Fork it
+
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+
+4.  Push to the branch (`git push origin my-new-feature`)
+
 5.  Create new Pull Request

data/TODO.txt

@@ -1,3 +1,4 @@
 - Create front end skeleton
 - Need to have project specific cnf.yml files
-- Local sync for assets
+- Local sync for assets
+- thug auth {staging|production} - this would inject your ssh pub key into the authorized_keys file

data/bonethug.gemspec

@@ -47,6 +47,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sass'
   spec.add_dependency 'guard-sass'
   spec.add_dependency 'guard-coffeescript'
+  spec.add_dependency 'guard-erb'
+  spec.add_dependency 'guard-slim'
+  spec.add_dependency 'guard-livereload'
 
   # asset pipeline guard sprockets
   spec.add_dependency 'guard-sprockets'

data/config/deploy.rb

@@ -135,9 +135,40 @@ task :setup_env => :environment do
   end
 end
 
+desc "add your ssh key to the remote"
+task :auth => :environment do
+  pub_key = File.read File.expand_path('~/.ssh/id_rsa.pub')
+  queue! %[echo "#{pub_key}" >> ~/.ssh/authourized_keys]
+end
+
+desc "init a db based on the settings in your cnf file"
+task :init_db => :environment do
+
+  conf.get('dbs').each do |name,envs|
+
+    db = envs.get env
+    cmd = Bonethug::Installer.init_mysql_db_script db, deploy_to + 'current', ENV['admin_user']
+    queue! %[#{cmd}]
+
+  end
+
+end
+
 desc "Initialises the db"
 task :init_db => :environment do
+
+  #rails
   queue! %[cd #{deploy_to}/current && bundle exec rake db:reset RAILS_ENV="#{env}"] if deploy.get('project_type') =~ /rails[0-9]?/
+  
+  # drpual
+  if deploy.get('project_type') =~ /drupal[0-9]?/
+    conf.get('dbs').each do |name,envs|
+      db = envs.get env
+      db_url = "mysql://#{db.get('user')}:#{db.get('pass')}@#{db.get('host')}/#{db.get('name')}"
+      queue! %[export APPLICATION_ENV=#{env} && cd #{deploy_to}/current/public && ../vendor/bin/drush site-install standard --account-name=admin --account-pass=admin --db-url=#{db_url}"]
+    end
+  end
+
 end
 
 desc "Restores application state to the most recent backup"

data/lib/bonethug/cli.rb

@@ -1,3 +1,5 @@
+require 'rbconfig'
+
 module Bonethug
   class CLI
 
@@ -17,6 +19,19 @@ module Bonethug
         puts 'bonethug v' + VERSION + ' - build date: ' + BUILD_DATE
         exit
 
+      when 'auth'
+
+        # handle args
+        env = ARGV[1]
+
+        # validate
+        unless env
+          puts 'Usage: ' + bin_name + ' auth [environment]'
+          return
+        end
+
+        exec "export to=#{env} && bundle exec mina -f .bonethug/deploy.rb auth --verbose"      
+
       when 'install'
 
         # handle args
@@ -32,14 +47,32 @@ module Bonethug
         # run the installer
         Installer.install type, location
 
-      when 'setup_env'
+      when 'init-db', 'init-local-db'
 
         # handle args
-        env = ARGV[1]
+        env = ARGV.last
+        admin_user = ARGV.length == 3 ? ARGV[1] : 'root'
+
+        # validate
+        unless env
+          puts 'Usage: ' + bin_name + ' ' + task + ' [admin_user] [environment]'
+          return
+        end
+
+        if task == 'init-local-db'
+          Installer.execute_init_mysql_db_script env, admin_user
+        else      
+          exec "export to=#{env} && export admin_user=#{admin_user} && bundle exec mina -f .bonethug/deploy.rb init_db --verbose"
+        end    
+
+      when 'setup-env'
+
+        # handle args
+        env = ARGV.last
 
         # validate
         unless env
-          puts 'Usage: ' + bin_name + ' setup_env environment'
+          puts 'Usage: ' + bin_name + ' setup-env [environment]'
           return
         end
 
@@ -48,11 +81,15 @@ module Bonethug
         script = gem_dir + '/scripts/ubuntu_setup.sh'        
 
         if env == 'show'
-
+          
+          puts "---------------"
           puts "Pre"
+          puts "---------------\n"
           puts File.read script
 
+          puts "\n---------------"
           puts "Parsed"
+          puts "---------------"
           puts Installer.parse_sh File.read(script)
 
         elsif env == 'local'
@@ -61,7 +98,7 @@ module Bonethug
         else
           exec "export to=#{env} && bundle exec mina -f .bonethug/deploy.rb setup_env --verbose"
 
-        end     
+        end
 
       when 'init', 'update'
 
@@ -80,6 +117,7 @@ module Bonethug
       when  'run', 
             'rake', 
             'drush', 
+            'drush-local', 
             'sake'
 
         # get env
@@ -93,19 +131,30 @@ module Bonethug
           case task
           when 'rake'
             cmd_task = 'rake'
-          when 'drush'
-            cmd_task = 'vendor/drush/drush'
+          when 'drush', 'drush-local'
+            cmd_task = File.expand_path('./vendor/drush/drush/drush') + ' -r ' + File.expand_path('./public')
           when 'sake'
             cmd_task = 'public/framework/sake'
           end
           args = ARGV[1..(ARGV.length-2)]
         end
 
-        # build command
-        run = "\"run[#{cmd_task} #{args.join(' ')}]\""
+        if task == 'drush-local'
+
+          env_cmd = RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i ? 'set' : 'export'
+          cmd = env_cmd + " APPLICATION_ENV=#{environment} && #{cmd_task} #{args.join(' ')}"
+          puts
+          exec cmd
+
+        else
+
+          # build command
+          run = "\"run[#{cmd_task} #{args.join(' ')}]\""
+
+          # do it!
+          exec "export to=#{environment} && bundle exec mina -f .bonethug/deploy.rb #{run} --verbose"
 
-        # do it!
-        exec "export to=#{environment} && bundle exec mina -f .bonethug/deploy.rb #{run} --verbose"         
+        end  
 
       when  'deploy', 
             'setup', 

data/lib/bonethug/installer.rb

@@ -130,6 +130,42 @@ module Bonethug
       self
     end
 
+    # Prepares init db scripts
+    # --------------------------    
+
+    def self.init_mysql_db_script(db, path, admin_user = 'root')
+
+      script_content = "
+        CREATE DATABASE IF NOT EXISTS " + db.get('name') + ";
+        GRANT ALL ON " + db.get('name') + ".* TO " + db.get('user') + "@" + db.get('host') + (db.get('pass') ? " IDENTIFIED BY " + db.get('pass') : "") + ";     
+        FLUSH PRIVILEGES;
+      "
+      cmd = 'cd ' + path + ' && ' +
+            'echo "' + script_content + '" > .bonethug/sql.txt && ' +
+            'mysql -h ' + db.get('host') + ' -u ' + admin_user + ' -p < .bonethug/sql.txt'
+
+    end
+
+    def self.execute_init_mysql_db_script(env, admin_user = 'root', path = '.')
+
+      exec_path = File.expand_path(path)
+      conf = Bonethug::Conf.new.add(exec_path + '/config/cnf.yml')
+      conf.add(exec_path + '/config/database.yml' => { root: 'dbs.default' }) if File.exist? exec_path + '/config/database.yml'
+
+      conf.get('dbs').each do |name,envs|
+
+        db = envs.get env
+        puts "creating: " + db.get('name')
+        system Bonethug::Installer.init_mysql_db_script(db, path, admin_user)
+
+      end 
+
+    end    
+
+
+    # Reads system setup scripts
+    # --------------------------
+    
     def self.get_setup_script
         @@bonthug_gem_dir + '/scripts/ubuntu_setup.sh'
     end
@@ -146,6 +182,10 @@ module Bonethug
         content.split("\n").select { |line| !(line =~ /^[\s\t]+$/ || line =~ /^[\s\t]*#/ || line.strip.length == 0) }
     end
 
+    # ---------
+    # Protected
+    # ---------
+
     protected
 
     def self.try_delete(file)

data/lib/bonethug/version.rb

@@ -1,6 +1,6 @@
 
         module Bonethug
-          VERSION = "0.0.63"
-          BUILD_DATE = "2013-10-17 21:55:52 +1300"
+          VERSION = "0.0.66"
+          BUILD_DATE = "2013-11-13 11:16:07 +1300"
         end
       

data/lib/bonethug/watcher.rb

@@ -19,7 +19,7 @@ module Bonethug
     include FileUtils
     include Digest
 
-    def self.watch(type = 'coffee_sass', target = '.', watch_only = nil)
+    def self.watch(type = nil, target = '.', watch_only = nil)
 
       # create full path
       target = File.expand_path target
@@ -54,8 +54,24 @@ module Bonethug
         end
       end
 
+      # erb doesn't support array based input just yet
+      erb = []
+      if erbs = conf.get('watch.erb')
+        erbs.each do |index, watch|
+          erb.push(src: watch.get('src','Array'), dest: watch.get('dest'), filter: watch.get('filter'), type: :erb)
+        end
+      end
+
+      # slim doesn't support aray based inputs just yet
+      slim = []
+      if slims = conf.get('watch.slim')
+        slims.each do |index, watch|
+          slim.push(src: watch.get('src','Array'), dest: watch.get('dest'), filter: watch.get('filter'), type: :slim)
+        end
+      end  
+
       # combine the watches
-      watches = coffee + sass
+      watches = coffee + sass + erb + slim
 
       # Generate Guardfile
       puts 'Generating Guardfile...'
@@ -83,7 +99,7 @@ module Bonethug
               #{filter}
             end
           "
-        when 'sass_coffee', 'coffee_sass'
+        else
           if watch[:type] == :coffee
             guardfile_content += "
               guard :coffeescript, :minify => true, :output => '#{watch[:dest]}', :input => #{watch[:src].to_s} do
@@ -96,6 +112,18 @@ module Bonethug
                 #{filter}
               end
             "
+          elsif watch[:type] == :erb
+            guardfile_content += "
+              guard :erb, :debug_info => true, :output => '#{watch[:dest]}', :input => #{watch[:src].to_s} do
+                #{filter}
+              end
+            "
+          elsif watch[:type] == :slim
+            guardfile_content += "
+              guard :slim, :debug_info => true, :output => '#{watch[:dest]}', :input => #{watch[:src].to_s} do
+                #{filter}
+              end
+            "
           end
         end
 

data/scripts/ubuntu_setup.sh

@@ -57,7 +57,7 @@ sudo apt-get install git ruby1.9.3 wkhtmltopdf nodejs npm
 # " > /etc/apache2/conf.d/php-fpm.conf
 # sed -i -e "s/listen = \/var\/run\/php5-fpm.sock/listen = 127.0.0.1:9000/g" /etc/php5/fpm/pool.d/www.conf
 
-sed -i -e "s/listen = \/var\/run\/php5-fpm.sock\/listen = 127.0.0.1:9000/g" /etc/php5/fpm/pool.d/www.conf
+sed -i -e "s/listen = \/var\/run\/php5-fpm.sock/listen = 127.0.0.1:9000/g" /etc/php5/fpm/pool.d/www.conf
 sudo echo -e "<IfModule mod_fastcgi.c>\n AddHandler php5-fcgi .php\n Action php5-fcgi /php5-fcgi\n Alias /php5-fcgi /usr/lib/cgi-bin/php5-fcgi\n FastCgiExternalServer /usr/lib/cgi-bin/php5-fcgi -host 127.0.0.1:9000 -idle-timeout 250 -pass-header Authorization\n </IfModule>" > /etc/apache2/conf.d/php-fpm.conf
 
 # Apache

data/skel/project_types/drupal6/.gitignore

@@ -0,0 +1,39 @@
+# project framework
+/.bundle
+/vendor
+/bin
+/log/*
+/backups/*
+/db_dumps
+/tmp/*
+/composer.phar
+.sass-cache
+
+# drupal, good times...
+# block all files in the public dir then unblock the dirs
+/public/*
+!/public/*/
+
+# block the core dirs
+/public/includes
+/public/misc
+/public/modules
+/public/profiles
+/public/scripts
+/public/themes
+
+# block some autogenerated files in the sites dir
+/public/sites/example.sites.php
+/public/sites/README.txt
+/public/sites/*/README.txt
+
+# block any modules tracked by composer
+/public/sites/all/modules/*
+
+# project files
+*.sublime-workspace
+*.sublime-project
+
+# files to keep
+!.gitkeep
+!.keep

data/skel/project_types/drupal6/composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "bonethug/drupal7-skel", 
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "git@github.com:azt3k/drupal.git"
+        }
+    ], 
+    "require": {
+        "symfony/yaml"              : "2.3.*@dev",
+        "drush/drush"               : "dev-master",
+        "thecodingmachine/drupal"   : "7.*@dev"   
+    },
+    "extra": {
+        "installer-paths": {
+            "vendor": [],
+            "public": [],
+            "public/vendor/{$name}": []      
+        }
+    }
+}

data/skel/project_types/drupal6/lib/flush_drupal_cache.php

@@ -0,0 +1,7 @@
+<?php
+$pub_dir = __DIR__ . '/../public';
+chdir($pub_dir);
+define('DRUPAL_ROOT', $pub_dir);
+require_once 'includes/bootstrap.inc';
+drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
+drupal_flush_all_caches();

data/skel/project_types/drupal7/.gitignore

@@ -0,0 +1,39 @@
+# project framework
+/.bundle
+/vendor
+/bin
+/log/*
+/backups/*
+/db_dumps
+/tmp/*
+/composer.phar
+.sass-cache
+
+# drupal, good times...
+# block all files in the public dir then unblock the dirs
+/public/*
+!/public/*/
+
+# block the core dirs
+/public/includes
+/public/misc
+/public/modules
+/public/profiles
+/public/scripts
+/public/themes
+
+# block some autogenerated files in the sites dir
+/public/sites/example.sites.php
+/public/sites/README.txt
+/public/sites/*/README.txt
+
+# block any modules tracked by composer
+/public/sites/all/modules/*
+
+# project files
+*.sublime-workspace
+*.sublime-project
+
+# files to keep
+!.gitkeep
+!.keep