bam 0.0.7 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6133090fcc988d9ea1c9c3168aea68b8a05addc
+  data.tar.gz: f303d8b78d31fabbe5a9d317b66443ccc976259e
+SHA512:
+  metadata.gz: 4e7ed579472c196bf94d58d9be094894f2000843664f1e875d971cb8fe97f5000f07c2e25c8b26d1c30eae3ed051fde2909539689ad503f5aa2840dc79b34117
+  data.tar.gz: 4fe3931c07e71081dfa42a28a04244b876e3dbed4bf75a6ee7985f923433fab2999c6d7991a3c716a3a66bccf9473349e49c57cc31d3f7aca3f34f96b894be47

data/.gitignore

@@ -1,5 +1,5 @@
 pkg/*
 *.gem
 .bundle
-deploy.bam
+deploy.bam.rb
 bam/*

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    bam (0.0.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bam!
+
+BUNDLED WITH
+   1.10.6

data/README.mdown

@@ -1,26 +1,23 @@
-Bam
-===
+## Bam
 
 A super simple deployment utility, it's basically an opinionated abstraction of rsync served in a capistrano fashion. Capistrano is a super cool utility, I love it, I use it all the time. But for smaller projects (websites, sinatra apps, etc), I think it's simply overkill. The great thing about bam is that you don't need to learn another DSL, it's simply just ruby that you need to edit in the deploy file to configure your deployment recipe.
 
-Installation
-============
+### Installation
 
     gem install bam
     
-Usage
-=====
+### Usage
+
 
     cd into/your/project/root
     bamify
-    # update the @server and @to variables in deploy.bam file
+    # update the @server and @to variables in deploy.bam.rb file
     # work on your project
     bam
 
-How deploy.bam works
-====================
+### How deploy.bam.rb works
 
-After you run <code>bamify</code>, it generates a <code>deploy.bam</code> file, which looks like:
+After you run <code>bamify</code>, it generates a <code>deploy.bam.rb</code> file, which looks like:
 
     # Bam Deploy File
     # ---------------
@@ -30,31 +27,80 @@ After you run <code>bamify</code>, it generates a <code>deploy.bam</code> file,
     #   - username@host
     @server = 'login@yourhost.com'
     # the location on the server don't forget to append the slash/
+    # make sure that it's the parent folder that you are uploading to,
+    # for example:
+    #   instead of...
+    #     @to = '~/public_html/your_site/'
+    #   do...
+    #     @to = '~/public_html/'
     @to = '~/location/to/your/web/site/or/app/'
 
+    # add list of file to always include in deployments
+    @always_include = %w()
+
+    # remote tasks : these are tasks that you want to run on the server
+    # @remote_tasks = { :restart_app => 'touch /my/cool/app/restart.txt' }
+    @remote_tasks = {}
+
     # pre_deploy_tasks : These are things that you can run locally before deployment
     # @pre_deploy_tasks = ['rm -rf cache/*']
-    # @pre_deploy_tasks = []
+    @pre_deploy_tasks = []
 
     # post_deploy_tasks : These are things that you can run locally before deployment
     # @post_deploy_tasks = ['rm -rf cache/*']
-    # @post_deploy_tasks = []
+    @post_deploy_tasks = []
 
 Simply set <code>@server</code> to your hostname or ip of your server and set <code>@to</code> to the location
 on the server where the your project is located, make sure that it's the parent folder (and don't forget to
 append the slash '/'), so instead of <code>~/public_html/project_name/</code> you would do <code>~/public_html/</code>
 
-Pre and Post Deployment Tasks
-=============================
+### Command line options
 
-You can run pre and post deployment tasks by assigning or setting the @pre_deploy_tasks or @post_deploy_tasks variables. For now, you can only run tasks locally, but remember since it's just a ruby file, you can require in Net::SSH and write your own methods to run remote tasks, if it comes down to it, I might just write in that ability myself... we'll see, otherwise feel free to fork it and add it yourself :)
-    
-TODO
-====
+```
+# pass the --help flag for all options
+bam --help
+```
+
+* --dry : execute a dry run
+* --deploy : runs the deployment, this is the default task
+* --version : prints the current version
+* --remote : execute a remote command, split multiple tasks with a ':'
+
+### Pre, Post and Remote Deployment Tasks
+
+You can run pre, post and remote deployment tasks by assigning or setting the `@pre_deploy_tasks`, `@post_deploy_tasks` and `@remote_tasks` variables. Here's an example, note that `@remote_tasks` is a Hash:
+
+```
+@pre_deploy_tasks = ['rm -rf cache/*']
+@post_deploy_tasks = ['rm -rf log/*']
+@remote_tasks = {
+    :restart_app => "touch /path/to/app/restart.txt"
+}
+
+# run remote tasks in your pre or post tasks array by adding a remote:[task_name] in your array like:
+@post_deploy_tasks = ['rm-rf log/*', 'remote:restart_app']
+
+# execute remote tasks like:
+bam --remote restart_app
+```
+
+### Ignoring Files and Directories on Deployment
+
+What if you don't want to push certain files or directories to your host? Say you have log or tmp files that would otherwise take up space. Well if you use git, you don't have to worry simply add them to .gitignore and bam is smart enough to ignore those files on deploy as well. 
+
+### Add exceptions to ignore list
+
+There could be some situations where you wouldn't want to exclude all the entries in `.gitignore`, if that's the case, simply add those entries to the `@always_include` variable. Here's an example:
+
+```
+@always_include = %w(app.min.js dist.min.js)
+```
+
+### TODO
 
 - Add static revision history for integrated rollbacks
 - Maybe use choice or highline to prompt to fill in values?
-- Maybe add in remote tasks
+- Maybe add in remote tasks : DONE!
 
 
 Copyright (c) 2010 Vann Ek., released under the MIT license

data/bin/bam

@@ -1,24 +1,58 @@
 #!/usr/bin/env ruby -wKU
 
 begin 
+  require "optparse"
   require "bam_helpers"
   require "bam"
+  require "bam/version"
 rescue LoadError
+  require "optparse"
   require "rubygems"
   require "bam_helpers"
   require "bam"
+  require "bam/version"
 end
 
+include BamHelpers
+
+options = {
+  :deploy => true
+}
 pwd = Dir.pwd
-bampath = File.join(pwd, "deploy.bam")
+bampath = File.join(pwd, "deploy.bam.rb")
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: bam [options]"
+
+  opts.on("-t", "--dry", "Do a dry run") { |v| options[:dry_run] = true }
+  opts.on("-d", "--deploy", "Deploy project (DEFAULT)") { |v| options[:deploy] = true }
+  opts.on("-v", "--version", "Display version") { |v| puts "Version: #{Bam::VERSION}"; exit }   
+  opts.on('-r', '--remote TASKS', "Run a remote task, split multiple tasks with ':'") do |task|
+    options[:remote_tasks] = task.split(":")
+  end
+
+end.parse!
+
 if File.exists?(bampath)
-  @pre_deploy_tasks, @post_deploy_tasks = nil
-  deployfile = File.read(File.join(pwd,"deploy.bam"))
+  deployfile = File.read(File.join(pwd,"deploy.bam.rb"))
+  # this will give use access to @pre_deploy_tasks, @post_deploy_tasks, @always_include, @remote_tasks 
   eval deployfile
-  ready_to = Bam::Deployment.new @server, @to, pwd
-  ready_to.deploy_tasks(@pre_deploy_tasks) unless @pre_deploy_tasks.nil?
-  ready_to.deploy
-  ready_to.deploy_tasks(@post_deploy_tasks) unless @post_deploy_tasks.nil?
+  task_config = {
+    :pre => @pre_deploy_tasks,
+    :post => @post_deploy_tasks,
+    :always_include => @always_include,
+    :remote => @remote_tasks
+  }
+  ready_to = Bam::Deployment.new @server, @to, pwd, options[:dry_run], task_config
+  
+  puts wrap_borders("Executing DRY RUN") if options[:dry_run] 
+  if options[:remote_tasks]
+    options[:remote_tasks].each do |task|
+      ready_to.remote_exec task 
+    end
+  else
+    ready_to.deploy
+  end  
 else
-  puts "No deploy.bam file found, run bamify to generate one."
+  puts "No deploy.bam.rb file found, run bamify to generate one."
 end

data/bin/bamify

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby -wKU
 
-# Bamify : generates the deploy.bam file for deploying using bam
+# Bamify : generates the deploy.bam.rb file for deploying using bam
 # USAGE :
 # bamify [path_to_project]
 begin 
@@ -30,31 +30,44 @@ def template
 #     @to = '~/public_html/'
 @to = '~/location/to/your/web/site/or/app/'
 
+# add list of file to always include in deployments
+@always_include = %w()
+
+# remote tasks : these are tasks that you want to run on the server
+# @remote_tasks = { :restart_app => 'touch /my/cool/app/restart.txt' }
+@remote_tasks = {}
+
 # pre_deploy_tasks : These are things that you can run locally before deployment
 # @pre_deploy_tasks = ['rm -rf cache/*']
-# @pre_deploy_tasks = []
+@pre_deploy_tasks = []
 
 # post_deploy_tasks : These are things that you can run locally before deployment
 # @post_deploy_tasks = ['rm -rf cache/*']
-# @post_deploy_tasks = []
+@post_deploy_tasks = []
 "
 end
 
 def add_ignore_bam
   `touch .gitignore` unless File.exists?(".gitignore")
-  no_bam_found = (`cat .gitignore | grep deploy.bam` == "")
-  `echo deploy.bam >> .gitignore` if no_bam_found
+  no_bam_found = (`cat .gitignore | grep deploy.bam.rb` == "")
+  `echo deploy.bam.rb >> .gitignore` if no_bam_found
+end
+
+def help_message
+  <<-help
+bamify [path_to_project]
+  --ignore-bam: add bam.deploy file to .gitignore list
+  help
 end
 
 if ARGV[0] == "--help"
-  puts "bamify [path_to_project]"
+  puts help_message
 else
   path = ARGV[0] == "" ? ARGV[0] : Dir.pwd
-  bam_path = File.join(path, "deploy.bam")
+  bam_path = File.join(path, "deploy.bam.rb")
   File.open File.join(bam_path), "w+" do |file|
     file << template
   end
-  add_ignore_bam
-  puts wrap_borders("Bam! you're done! bam.deploy generated to : #{bam_path}")
-  # TODO : add editor options 
+  add_ignore_bam if ARGV[0] == "--ignore-bam"
+  puts wrap_borders("Bam! you're done! deploy.bam.rb generated to : #{bam_path}")
 end

data/lib/bam/version.rb

@@ -1,3 +1,3 @@
 module Bam
-  VERSION = "0.0.7"
+  VERSION = "1.0.0"
 end

data/lib/bam.rb

@@ -3,10 +3,12 @@ module Bam
     include BamHelpers
     PWD = Dir.pwd
 
-    def initialize(server, to, from)
+    def initialize(server, to, from, dry_run, task_config)
       @from = from
       @server = server
       @to = to
+      @dry_run = dry_run || false
+      @task_config = task_config
     end
 
     def has_git?
@@ -17,30 +19,56 @@ module Bam
       File.exists?(File.join PWD, ".gitignore")
     end
 
-    def exclusions
-      return "" if !has_git_ignores? || !has_git?
+    # gets a list of exclusions - exceptions
+    def get_exclusions
+      return "" if !has_git_ignores? || !has_git?   
       git_ignore = File.join PWD, ".gitignore"
-      exclusions = `cat #{git_ignore}`.split("\n")
-      exclude_list = exclusions.map { |e| "--exclude '#{e}' " }
+      exclusions = `cat #{git_ignore}`.split("\n") 
+      exclusions - @task_config[:always_include] 
+    end
+
+    def exclusions
+      exclude_list = get_exclusions.map { |e| "--exclude '#{e}' " }
       exclude_list = exclude_list.join
     end
 
+    def remote_exec(name)
+      remote_task = @task_config[:remote][name.to_sym]
+      if remote_task.nil?
+        puts "[REMOTE] TASK: #{name} does not exist"
+      else
+        exec_cmd = "ssh #{@server} '#{remote_task}'"
+        puts @dry_run ? "[REMOTE] #{name} : #{remote_task}" : "[REMOTE] #{name}"
+        system exec_cmd unless @dry_run
+      end
+    end
+
     def deploy
-      puts("Starting deployment...")
+      puts "PRE-DEPLOYMENT TASKS: \n\n"
+      deploy_tasks @task_config[:pre]
+      puts(wrap_top("STARTING DEPLOYMENT:"))
       # use -avzC to exclude .git and .svn repositories
       cmd = "rsync -avzC #{@from} #{@server}:#{@to} #{exclusions}"
       output = "OUTPUT: #{cmd}"
       puts(wrap_borders(output))
-      system(cmd)
+      puts "POST-DEPLOYMENT TASKS: \n\n"
+      deploy_tasks @task_config[:post]
+      system(cmd) unless @dry_run
     end
     
     def deploy_tasks(tasks)
       if tasks.length > 0
         tasks.each do |task|
-          puts "  - Executing deployment task: #{task}"
-          `#{task}`
+          remote_task = task.split("remote:")
+          if remote_task.length > 1
+            remote_exec remote_task[1]
+          else 
+            puts "[LOCAL] #{task}"
+            `#{task}` unless @dry_run
+          end
         end
       end
+      puts "\n"
     end
     
   end

data/lib/bam_helpers.rb

@@ -8,6 +8,10 @@ module BamHelpers
     "="*col_width
   end
   
+  def wrap_top(content)
+    "#{border}\n#{content}"
+  end 
+
   def wrap_borders(content)
     "#{border}\n#{content}\n#{border}"
   end

metadata

@@ -1,37 +1,27 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bam
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Vann Ek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-20 00:00:00 -05:00
-default_executable: 
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies: []
-
 description: A super simple deployment utility using rsync and git
-email: 
+email:
 - vann@innerfusion.net
-executables: 
+executables:
 - bam
 - bamify
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
+- Gemfile.lock
 - README.mdown
 - Rakefile
 - bam.gemspec
@@ -40,39 +30,27 @@ files:
 - lib/bam.rb
 - lib/bam/version.rb
 - lib/bam_helpers.rb
-has_rdoc: true
 homepage: http://github.com/vanntastic/bam
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: bam
-rubygems_version: 1.3.7
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A super simple deployment utility
 test_files: []
-