dont_deploy_debug 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGM1OTAxZWEwM2M2Y2VlOGQ2MDI0MjE5OTA0Y2VkMmM1NzczODAwZg==
+  data.tar.gz: !binary |-
+    MTRmY2JlODhmNTRjYzkwZmE0MjRkMjY2ZWJkZGNlZTcwYjdiYmNlNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MDZkZDFhNjA2ZmU0OTA2NzQ3YzdiM2Y3MGVjODI1M2ViOWQwMThmMmEzZTFj
+    MzNiMzUzN2M4YjJkMTJiZGFlZDNkMWJjMjgxZjU2ODc0YWU3ZTAxMDgzNjk2
+    ZWQ3MDc4NDkyNTYyNzQ2MTIyNWY5MzQ5MmM2ZGI0MjA3Y2FkMjc=
+  data.tar.gz: !binary |-
+    MzZlYjM5NzE5YWFhNWJiYWM0ZmI1NGI3ZjRmMjg4NTY0YTI0YThjNTAxZTQ2
+    ODI3OWY3ZjdmOWI2OTg2NWVmYTk2OTZlYTZhNjZkYjEyNjFmMjFmMzNkMjgy
+    NTc4Y2JiMDIwMGQ5NzJjZGE3MmI1MDNjZDFkZDFmY2RhZmI3ODI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Nielsen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+# DontDeployDebug
+## A gem against brain-farts.
+
+How many times have you accidentally committed a debug statement and deployed
+it? To production? Ugh! I've been there, brothers and sisters! I've done it
+more times than I care to remember. So many that I finally decided to do
+something about it.
+
+## What?
+
+It prevents code that has debug statements included from being deployed by
+Capistrano, along with a message about what was found and where to find it.
+
+Example:
+
+```
+    triggering after callbacks for `deploy:finalize_update'
+  * 2013-11-05 16:38:44 executing `deploy:find_ruby_breakpoints'
+  * executing "find /home/deploy/app/releases/20131105233842 -name \"*.rb\" -exec grep -Hn --regex \"[debugger|binding\\.pry]\" {} \\;"
+    servers: ["server.example.org"]
+    [server.example.org] executing command
+    command finished in 621ms
+
+*** Ruby debugger breakpoint found in deployed code. Deploy halted. ***
+
+There was code found that contains debugging breakpoints:
+
+  /testfile.rb:3:require 'ruby-debug'; debugger
+
+Please remove the code, commit the change and try your deploy again.
+If you feel you have reached this message in error, please consult
+https://github.com/xunker/dont_deploy_debug to learn how to exclude
+certain files, or how to tune the detection parameters. To override
+this check, set the 'IGNORE_RUBY_BREAKPOINTS' variable to true:
+
+  $ IGNORE_RUBY_BREAKPOINTS=true cap <environment> deploy
+
+*** [deploy:update_code] rolling back
+  * executing "rm -rf /home/deploy/app/releases/20131105233842; true"
+    servers: ["server.example.org"]
+    [server.example.org] executing command
+    command finished in 159ms
+```
+
+## Why?
+
+Because even the rockstar-iest of ninjas sometimes forget to remove a 'debug'.
+
+## How?
+
+It's a gem that hooks in to your Capistrano deploy process. After the code is
+updated on the server, but before it's made "live", the gem scans the release
+path for ruby source files that have "debug" statements in them. If any are
+found, the deploy is halted and rolled back, and a list of the offending files
+is displayed to the user.
+
+By default, the gem looks for statements in `*.rb` that are like:
+
+```ruby
+require 'ruby-debug'; debugger
+
+require 'ruby-debug'
+debugger
+
+debugger;
+
+binding.pry
+```
+
+The gem will ignore `test/*`, `spec/*`, `features/*` and `config/deploy.rb`.
+
+## Ruby only?
+
+Yes, for now. But if there is any interest it could be easily modified for
+any language where the source was parsable on the deployment server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'dont_deploy_debug', :require =>  false
+
+Or from the command line if you aren't using bunder:
+
+  $ gem install dont_deploy_debug
+
+Then, add the following to your Capistrano `deploy.rb`:
+
+  require 'capistrano/dont_deploy_debug'
+
+For basic usage, this is all that is required.
+
+## Configuration
+
+### Enable or disable the check
+
+Be default, every deploy will be checked regardless of environment. This can
+be set programmatically by altering the 'skip_ruby_breakpoint_check' setting
+in your deloy.rb file:
+
+```ruby
+# turn off for all
+set :skip_ruby_breakpoint_check, true
+
+# skip on stage
+set :skip_ruby_breakpoint_check, (fetch(:rails_env) == 'stage')
+
+# on for everyone (default)
+set :skip_ruby_breakpoint_check, false
+```
+
+### Files to exclude from check
+
+By default, `test/*`, `spec/*`, `features/*` and `config/deploy.rb` are
+ignored. You can modify this behaviour by changing the
+'exclude_from_ruby_breakpoint_check' setting in your deploy.rb and adding or
+removing regular expressions:
+
+```ruby
+set :exclude_from_ruby_breakpoint_check, [
+  /^\.\/config\/deploy\.rb$/,
+  /^\.\/spec\//,
+  /^\.\/test\//,
+  /^\.\/features\//,
+  /^\.\/something_else_here\//,
+]
+```
+
+### Breakpoint patterns
+
+By default, the gem will look for variations of:
+
+```ruby
+require 'ruby-debug'; debugger
+
+binding.pry
+```
+
+This can be changed by altering the "ruby_breakpoint_patterns" setting in your
+`deploy.rb` and adding or removing regular expressions:
+
+```ruby
+set :ruby_breakpoint_patterns, [
+  /require [\'\"]ruby-debug[\'\"][;\n]\s*debugger/,
+  /^\s*debugger[;\n]/,
+  /^\s*debugger\s*$/,
+  /\bbinding\.pry\b/,
+  /some_other_debugger/
+]
+```
+
+### Server-side grep command
+
+To first find the files, the gem executes a grep() of the release path to get
+"coarse" list of files and then lets ruby do the actual check. The command
+used by default is:
+
+```
+find #{release_path} -name "*.rb" -exec grep -Hn --regex "[debugger|binding\.pry]" {} \\;
+```
+
+A find() and grep() is used instead of a recursive grep because I have no way
+of knowing if you are deploying to system with BSD, SYSV or GNU style tools.
+
+You can change this command in your `deploy.rb` with the
+"ruby_breakpoint_grep_command" setting:
+
+```ruby
+# default value is:
+#   Proc.new { "find #{release_path} -name \"*.rb\" -exec grep -Hn #{fetch(:ruby_breakpoint_trigger)} {} \\;" }
+
+# pass it a Proc object so we can read release_path and other variables
+# It MUST return a string
+set :ruby_breakpoint_grep_command, Proc.new { "some better grep here" }
+```
+
+If you only want to change the pattern that grep() uses, you can set
+"ruby_breakpoint_trigger" instead:
+
+```ruby
+# default value is '--regex "[debugger|binding\.pry]"'
+set :ruby_breakpoint_trigger, "some_other_pattern"
+```
+
+### Skipping check from command line
+
+Finally, if you just want to deploy the damn'ed thing and skip the check
+temporarily, you can set the "IGNORE_RUBY_BREAKPOINTS" shell variable:
+
+```
+$ IGNORE_RUBY_BREAKPOINTS=true cap <environment> deploy
+```
+
+## Caveats
+
+This gem has not been throughly tested in any way. Like seriously. I use it,
+but I'm the only one so far. I know it works on Redhat linux and it will likely
+work in most linuxes. It *should* work on any BSD system, but YMMV.
+
+If you find a case where it doesn't work please let me know.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dont_deploy_debug.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "dont_deploy_debug"
+  spec.version       = "0.1.1"
+  spec.authors       = ["Matthew Nielsen"]
+  spec.email         = ["xunker@pyxidis.org"]
+  spec.description   = %q{Don't allow a capistrano deploy if code contains ruby debug statements}
+  spec.summary       = %q{Don't allow a capistrano deploy if code contains ruby debug statements}
+  spec.homepage      = "https://github.com/xunker/dont_deploy_debug"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/dont_deploy_debug.rb

@@ -0,0 +1,92 @@
+require 'capistrano'
+
+module Capistrano
+  module DontDeployDebug
+    def contains_ruby_breakpoint?(ruby_code)
+      ruby_code = ruby_code.split('#').first.strip
+      return false if ruby_code.size < 1
+      fetch(:ruby_breakpoint_patterns).each do |pattern|
+        return true if ruby_code =~ pattern
+      end
+      false
+    end
+
+    def exclude_from_ruby_breakpint_check?(file_path)
+      fetch(:exclude_from_ruby_breakpoint_check).each do |pattern|
+        return true if file_path =~ pattern
+      end
+      false
+    end
+  end
+end
+
+include Capistrano::DontDeployDebug
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+  Capistrano::Configuration.instance(:must_exist) :
+  Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+  set :exclude_from_ruby_breakpoint_check, [
+    /^\.\/config\/deploy\.rb$/,
+    /^\.\/spec\//,
+    /^\.\/test\//,
+    /^\.\/features\//
+  ]
+
+  set :ruby_breakpoint_patterns, [
+    /require [\'\"]ruby-debug[\'\"][;\n]\s*debugger/,
+    /^\s*debugger[;\n]/,
+    /^\s*debugger\s*$/,
+    /\bbinding\.pry\b/
+  ]
+
+  set :ruby_breakpoint_trigger, '--regex "[debugger|binding\.pry]"'
+
+  set :ruby_breakpoint_grep_command, Proc.new { "find #{release_path} -name \"*.rb\" -exec grep -Hn #{fetch(:ruby_breakpoint_trigger)} {} \\;" }
+
+  set :skip_ruby_breakpoint_check, false
+
+  after "deploy:finalize_update", "deploy:find_ruby_breakpoints"
+
+  namespace :deploy do
+    task :find_ruby_breakpoints do
+      if fetch(:skip_ruby_breakpoint_check) || ENV['IGNORE_RUBY_BREAKPOINTS'].to_s != "true"
+        files = capture(fetch(:ruby_breakpoint_grep_command)).to_s.split("\n")
+        found = []
+        files.each do |f|
+          (file_path, line_number, ruby_code) = f.split(':', 3)
+          next if exclude_from_ruby_breakpint_check?(file_path)
+          next unless contains_ruby_breakpoint?(ruby_code)
+          found << [file_path.sub(release_path,''), line_number, ruby_code]
+        end
+
+        if found.size>0
+          message = [
+            "",
+            "*** Ruby debugger breakpoint found in deployed code. Deploy halted. ***",
+            "",
+            "There was code found that contains debugging breakpoints:",
+            ""
+          ]
+          found.each { |f| message << "\t#{f.join(':')}" }
+          message += [
+            "",
+            "Please remove the code, commit the change and try your deploy again.",
+            "If you feel you have reached this message in error, please consult",
+            "https://github.com/xunker/dont_deploy_debug to learn how to exclude",
+            "certain files, or how to tune the detection parameters. To override",
+            "this check, set the 'IGNORE_RUBY_BREAKPOINTS' variable to true:",
+            "",
+            "\t$ IGNORE_RUBY_BREAKPOINTS=true cap <environment> deploy",
+            "\n"
+          ]
+          abort(message.join("\n"))
+        end
+      end
+
+      abort("You're testing. I'm stopping now.") if ENV['TESTING_DDD']
+    end
+  end
+end

data/lib/dont_deploy_debug.rb

@@ -0,0 +1 @@
+require 'capistrano/dont_deploy_debug'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: dont_deploy_debug
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Don't allow a capistrano deploy if code contains ruby debug statements
+email:
+- xunker@pyxidis.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dont_deploy_debug.gemspec
+- lib/capistrano/dont_deploy_debug.rb
+- lib/dont_deploy_debug.rb
+homepage: https://github.com/xunker/dont_deploy_debug
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Don't allow a capistrano deploy if code contains ruby debug statements
+test_files: []