bonethug 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,6 @@
 # Bonethug
 
-TODO: Write a gem description
+Project Skeleton Manager
 
 ## Installation
 
@@ -18,7 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Commands
+
+	$ bonethug install {rails3|silverstripe3|drupal|php|sinatra}
 
 ## Contributing
 
@@ -26,4 +28,4 @@ TODO: Write usage instructions here
 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
+5. Create new Pull Request

data/Rakefile

@@ -1,3 +1,4 @@
 require "bundler/gem_tasks"
 
-Dir.glob('lib/tasks/*.rake').each { |r| import r }
+root_path = File.expand_path(File.dirname(__FILE__))
+import root_path+"/lib/tasks/setup.rake"

data/bin/bonethug

@@ -1,13 +1,8 @@
 #!/usr/bin/env ruby
+
 root_path = File.expand_path(File.dirname(__FILE__)) + '/..'
-puts root_path
 
 require 'rubygems' unless Object.const_defined?(:Gem)
 require root_path +'/lib/bonethug'
-require 'rake'
-
-ARGV.each do|a|
-  puts "Argument: #{a}"
-end
 
-Bonethug::call_rake('setup:silverstripe31-dev')
+Bonethug::CLI.handle

data/lib/bonethug/cli.rb

@@ -0,0 +1,44 @@
+module Bonethug
+  class CLI
+
+    def self.handle
+
+      # what are we doing?
+      task = ARGV[0] || 'help'
+
+      case task
+
+      when 'help'
+
+        display_help
+
+      when 'install'
+
+        # handle args
+        type = ARGV[1]
+        location = ARGV[2] || '.'
+        puts 'Usage: bonethug install [location]' if type.empty?
+        
+        # run the installer
+        Installer.install type, location 
+      
+      when 'clean'
+
+        location = ARGV[1] || '.'
+        Installer.clean location   
+
+      else
+
+        # We didn't find a task
+        puts 'Task not found'
+
+      end
+
+    end
+
+    def self.display_help
+      puts 'Usage: bonethug task [argument]...'
+    end
+
+  end
+end

data/lib/bonethug/installer.rb

@@ -0,0 +1,202 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../../skel/base/lib/conf'
+require 'fileutils'
+require 'find'
+require 'digest/md5'
+require 'yaml'
+
+module Bonethug
+
+  class Installer
+
+    include FileUtils
+    include Digest
+
+    @@skel_dir = File.expand_path(File.dirname(__FILE__)) + '/../../skel'
+    @@conf = Conf.new.add(@@skel_dir + '/skel.yml')
+    @@project_config_files = ['backup.rb','cnf.yml','deploy.rb','schedule.rb']
+
+    def self.install(type, target = '.')
+
+      # @@conf = Conf.new.add(@@skel_dir + '/skel.yml')
+
+      # create full path
+      target = File.expand_path target
+
+      # let the user know we are installing
+      puts 'Installing '+ type + ' to ' + target + '...'
+
+      # load the configuration
+      raise "Unsupported type: " + type.to_s unless @@conf.get('project_types').has_key? type.to_s
+      conf = @@conf.node_merge 'base', 'project_types.' + type
+
+      # set the tmp dir
+      tmp_dir = File.expand_path target + '/.bonethug-tmp'
+
+      # clean up any exisitng install tmp files
+      if File.directory? tmp_dir
+        puts 'Cleaning up old installer temporary files...'
+        FileUtils.rm_rf tmp_dir
+      end
+
+      # create tmp dir
+      puts 'Creating build directory at ' + tmp_dir
+      FileUtils.mkdir tmp_dir
+      FileUtils.mkdir tmp_dir + '/.bonethug'
+
+      # build the file set
+      puts 'Building ' + type + ' skeleton...'
+      FileUtils.cp_r @@skel_dir + '/project_types/' + type + '/.', tmp_dir
+      FileUtils.cp_r @@skel_dir + '/base/.', tmp_dir
+
+      # build the manifest
+      puts 'Creating manifest...'
+      self.build_manifest tmp_dir
+
+      # modify the manifest root
+      manifest_path = tmp_dir + '/.bonethug/manifest'
+      File.open(manifest_path,'w') do |file| 
+        file.puts File.read(manifest_path).gsub(/\.bonethug-tmp/,'') 
+      end
+
+      # clean up the target dir
+      puts 'Cleaning up install directory...'
+      self.clean target
+
+      # copy the files
+      puts 'Installing build to ' + target + '...'
+      FileUtils.cp_r tmp_dir + '/.', target
+
+      # try to update the configuration files
+      puts 'Updating configs...'
+      self.update_configuration_files(target)
+
+      # try to update the configuration files
+      puts 'Updating build informtation...'
+      self.save_project_meta_data(target)
+
+      # clean up any exisitng install tmp files
+      puts 'Cleaning up temporary files...'
+      FileUtils.rm_rf tmp_dir     
+
+      puts "Installation Complete"
+
+    end
+
+    def self.clean(target)
+
+      manifest_path = target + '/.bonethug/manifest'
+
+      if File.exists? manifest_path
+        
+        puts 'Reading manifest...'
+        manifest = File.read(manifest_path).split("\n")
+        
+        puts 'Cleaning up ' + manifest.count.to_s + ' files'
+        not_removed = []
+        manifest.each do |file|
+          not_removed.push file unless self.try_delete file
+        end
+
+        if not_removed.count > 0
+
+          puts 'Retrying removal of ' + not_removed.count.to_s + ' files'
+          failed = []
+          not_removed.each do |file|
+            failed.push file unless self.try_delete file
+          end
+
+          puts 'Removal of the following' + failed.count.to_s + ' files failed'
+          puts failed.join("\n")
+
+        end 
+
+      else
+        puts 'Nothing to do'
+      end
+      self
+    end
+
+    protected
+
+    def self.try_delete(file)
+      if (File.directory?(file) and Find.find(file).empty?) or File.file?(file)
+        rm_rf file
+        return false if File.exists? file
+        return true
+      else
+        return false
+      end
+    end
+
+    def self.build_manifest(dir)
+      dir_contents = Find.find(dir).map { |p| File.expand_path(p) }
+      manifest = dir_contents - ((@@conf.get('exlcuded_paths') || []).map { |p| File.expand_path(p) })
+      File.open(dir + '/.bonethug/manifest','w') { |file| file.puts manifest.join("\n") }
+      self
+    end
+
+    def self.update_configuration_files(target)
+
+      # load the existing project's datafile if present
+      meta_data = self.get_project_meta_data target      
+      
+      @@project_config_files.each do |config|
+
+        do_copy       = true
+        example_file  = target + '/config/example.' + config
+        target_file   = target + '/config/' + config
+
+        # analyse the config file + build data file
+        file_exists           = File.exist?(target_file)
+        contents_not_modified = false
+        contents_not_modified = true if file_exists and meta_data and meta_data['config_digests'] and meta_data['config_digests']['example.' + config] == self.contents_md5(target_file) 
+
+        # meta_data_is_hash     = meta_data_exists and meta_data.class.name == 'Hash' and meta_data['config_digests'].class.name == 'Hash'
+        # config_digests_found  = meta_data_is_hash and meta_data['config_digests'].methods.include?('has_key?') and meta_data['config_digests'].has_key?('example.' + config)
+        # contents_not_modified = config_digests_found and meta_data['config_digests']['example.' + config] == self.contents_md5(target_file)
+
+        # don't copy if the file exists...
+        do_copy = false if file_exists
+
+        # unless it hasn't been modified, i.e. probably not conf.yml, but possibly some of the other ones
+
+        do_copy = true if contents_not_modified
+
+        # Copy if that's ok
+        FileUtils.cp example_file, target_file if do_copy
+
+      end
+
+      # return self for chaining
+      self
+
+    end
+
+    def self.contents_md5(file)
+      return false unless File.exist?(file)
+      MD5.digest File.read(file)
+    end
+
+    def self.save_project_meta_data(base_dir)
+
+      meta_data = {'config_digests' => {}}
+      @@project_config_files.each do |file| 
+        meta_data['config_digests']['example.' + file] = self.contents_md5(base_dir + '/config/example.' + file)
+      end
+      File.open(base_dir + '/.bonethug/data','w') { |file| file.puts meta_data.to_yaml }
+
+      # return self for chaining
+      self
+
+    end
+
+    def self.get_project_meta_data(base_dir)
+
+      data_file = base_dir + '/.bonethug/data'
+      return YAML.load_file data_file if File.exists? data_file
+      return false
+
+    end    
+  end
+
+end

data/lib/bonethug/version.rb

@@ -1,3 +1,3 @@
 module Bonethug
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/bonethug.rb

@@ -1,17 +1,7 @@
 require "bonethug/version"
+require "bonethug/installer"
+require "bonethug/cli"
 
 module Bonethug
 
-  #arguments can be for example db:migrate
-  def self.call_rake(arguments)
-    if RUBY_PLATFORM =~ /mswin/
-      rake_cmd = "rake.bat" #very important because windows will break with just "rake"
-    else
-      rake_cmd = "rake"
-    end
-    puts "calling #{rake_cmd} " + arguments
-    puts system("#{rake_cmd} " + arguments)
-    puts $?
-  end
-
-end
+end

data/lib/tasks/setup.rake

@@ -1,6 +1,6 @@
 require 'rake'
 
-namespace :setup do
+namespace :bonethug do
 
   desc "setup ss3.1-dev project"
   task :silverstripe31dev => :environment do

data/skel/base/README.md

@@ -1,5 +1,5 @@
-Insight Report Framework
-========================
+Bonethug Silverstripe Project Skeleton
+======================================
 
 
 

data/skel/base/config/{cnf.yml → example.cnf.yml}

@@ -1,6 +1,6 @@
 deploy:
   common:
-    project_type:
+    project_type: rails3 | silverstripe3 | drupal | php | sinatra
     base_dir: /var/www
     repository: git@gitlab.....
     project_slug: tradespot
@@ -12,13 +12,27 @@ deploy:
     development:
     staging:
       domain: staging.domain.com
+      default_branch: master
     production:
-      domain: production.cdomain.com
+      domain: production.domain.com
+      default_branch: stable
 dbs:
   default:
     development:
+      user: root
+      pass:
+      host: localhost
+      port: 3306
     staging:
+      user: staging_db
+      pass: passw0rd
+      host: localhost
+      port: 3306    
     production:
+      user: production_db
+      pass: passw0rd
+      host: localhost
+      port: 3306    
 backup:
   local:
     keep:2
@@ -27,6 +41,16 @@ backup:
     host: backup-host.com
     user: remote_backup
     pass: passw0rd
+  sftp:
+    keep: 10
+    host: backup-host.com
+    user: remote_backup
+    pass: passw0rd
+  s3:
+    keep: 10
+    key: key
+    secret: secret
+    bucket: bucket
 apache:
   development:
   staging:
@@ -46,14 +70,29 @@ apache:
       SS_ENVIRONMENT_TYPE: live
       RAILS_ENV: production
       APPLICATION_ENV: production
-resources:
-permissions:
+chown:
   development:
   staging:
-    www_executable:
-      - vendor/bin
   production:
-    www_executable:
-      - vendor/bin  
+    -
+      path: public/uploads
+      user: www-data
+chmod:
+  development:
+  staging:
+  production:
+    -
+      path: public/uploads
+      mode: 775
+chgrp:
+  development:
+  staging:
+  production:
+    -
+      path: public/uploads
+      group: www-data
+resources:
+  - public/assets
+  - public/uploads
 log_dirs:
   - log

data/skel/base/config/{deploy.rb → example.deploy.rb}

@@ -197,9 +197,29 @@ task :deploy => :environment do
       queue! %[cd #{deploy_to}/current/public && chown -R www-data:www-data . && chmod -R 775 .]
       queue! %[cd #{deploy_to}/shared/tmp && chown -R www-data:www-data . && chmod -R 775 .]      
       queue! %[touch #{deploy_to}/current/tmp/restart.txt]
-
-      (conf.get('permissions.'+env+'.www_executable','Array') || []).each do |dir|
-        queue! %[cd #{deploy_to}/current/#{dir} && chown -R www-data:www-data . && chmod -R 775 .]
+      
+      # apply defined permissions
+      chowns = conf.get('chown.'+env)
+      if chowns
+        chowns.each do |index, chown|
+          queue! %[cd #{deploy_to}/current/#{chown.get('path')} && chown -R chown.get('user') .]
+        end
+      end
+      
+      # apply defined permissions
+      chgrps = conf.get('chgrp.'+env)
+      if chgrps
+        chgrps.each do |index, chgrp|
+          queue! %[cd #{deploy_to}/current/#{chgrp.get('path')} && chgrp -R chgrp.get('group') .]
+        end
+      end      
+      
+      # apply defined permissions
+      chmods = conf.get('chmod.'+env)
+      if chmods
+        chmods.each do |index, chmod|
+          queue! %[cd #{deploy_to}/current/#{chmod.get('path')} && chmod -R chmod.get('mode') .]
+        end
       end
 
       queue! %[a2ensite "#{vhost}"]

data/skel/base/lib/conf.rb

@@ -14,7 +14,7 @@ class Conf
 
   def initialize(new_hash = nil, options = {})
     raise "New hash must be of type Hash" if new_hash && new_hash.class.name != 'Hash'
-    @options = {use_fallbacks: true}.merge(options)
+    @options = {use_fallbacks: true}.merge options
     @loaded_paths = []
     @paths = {}
     @config_hashes = {}
@@ -29,7 +29,7 @@ class Conf
     else
       raise "add_path only accepts stings or hashes"
     end
-    @paths.merge(path_hash)
+    @paths = @paths.merge path_hash
     self
   end
 
@@ -57,7 +57,7 @@ class Conf
       # create the other nodes
       if options and options.has_key? :root
         fragment = fragment_base
-        nodes = options[:root].split('.')
+        nodes = options[:root].split '.'
         nodes.each_with_index do |node,i|
           fragment[node] = i == nodes.length-1 ? @config_hashes[path] : {}
           fragment = fragment[node]
@@ -67,7 +67,7 @@ class Conf
       end
 
       # output
-      out = out.merge(fragment_base)
+      out = out.merge fragment_base
 
     end
     @compiled_hash = out

data/skel/project_types/drupal/.gitignore

@@ -1,22 +1,11 @@
-# project framework
-.bundle
-vendor
-bin
-logs/*
-backups/*
-db_dumps
-tmp/*
-composer.phar
+/.bundle
+/vendor
+/bin
+/logs/*
+/backups/*
+/db_dumps
 
-# components tracked by composer
-public/silverstripe-cache
-public/themes/simple
-public/vendor
-public/assets/*
-public/bootstrap_forms
-public/cms
-public/framework
-public/html5
-public/widgets
-public/compass
-composer.phar
+# project ignores - might need review
+/public/sites/*/files
+/public/sites/*/private
+/public/sites/all/modules/filemanager/files

data/skel/project_types/drupal/composer.json

@@ -1,31 +1,5 @@
 {
-  "name" : "insight/report-framework",
-  "require" : {
-    "symfony/yaml"                  : "2.3.*@dev",     
-    "silverstripe/framework"        : "3.1.*@dev",
-    "silverstripe/cms"              : "3.1.*@dev",
-    "silverstripe-themes/simple"    : "dev-master",
-    "silverstripe/installer"        : "3.1.*@dev",
-    "silverstripe/bootstrap-forms"  : "dev-master",
-    "silverstripe/html5"            : "dev-master",
-    "silverstripe/widgets"          : "dev-master",
-    "silverstripe/compass"          : "dev-master"
-  },
-  "extra": {
-    "installer-paths": {
-        "public/vendor/{$name}": [
-      ],
-      "public/themes/{$name}": [
-        "silverstripe-themes/simple"
-      ],      
-      "public/{$name}": [
-        "silverstripe/framework",
-        "silverstripe/cms",
-        "silverstripe/bootstrap-forms",        
-        "silverstripe/html5",
-        "silverstripe/widgets",
-        "silverstripe/compass"
-      ]
+    "require": {
+        "symfony/yaml" : "2.3.*@dev"
     }
-  }
 }