capistrano-dirty 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b13040de6aa2aeba42516f5ed39789a2a341995dac53b934e5f4a8d135363c17
+  data.tar.gz: 19fbf1f9ec96d7bbf28ac0ca3ec79ebef2135403a22e81647b27d7d9a3b75fcc
+SHA512:
+  metadata.gz: c33c464f37998e370cbf2d9f938eca9d21ec27ca86170a5273b39d23e538712dcf0a551be42c81995a947ef7fab46de65ab6c34484694dd217261b26b20cf620
+  data.tar.gz: ddeca26bcac57423c9f48487f5e476d0956e161425739037b1055e00a524a8aaf8745f3a1133f8c0079dfa5a9a8bf14995fab316ab17bc375338ac0cc4c9cc3c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-dirty.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    capistrano-dirty (0.0.1)
+      capistrano (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.3.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.10.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sshkit (1.16.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  capistrano-dirty!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jamie Schembri
+
+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,41 @@
+# Capistrano::Dirty
+
+A little capistrano task for checking if a codebase is dirty, against a couple of patterns (e.g. FIXMEs, git conflict markers...).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-dirty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-dirty
+
+
+To expose the Capistrano task, add the following to your Capfile:
+
+```ruby
+require 'capistrano_dirty'
+load 'capistrano_dirty/tasks.rake'
+```
+
+Finally, to fail deploys when something is found, you can do something like this in your Capfile:
+
+```ruby
+before 'deploy:check', 'capistrano_dirty:check'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bluerail/capistrano-dirty
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/dirty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-dirty.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano_dirty/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-dirty"
+  spec.version       = CapistranoDirty::VERSION
+  spec.authors       = ["Jamie Schembri"]
+  spec.email         = ["jamie@lico.nl"]
+
+  spec.summary       = %q{Checks for dirty strings in a codebase}
+  spec.description   = "Checks for dirty strings in a codebase based on a list of patterns. "\
+                       "This may be used to prevent deployment if found."
+  spec.homepage      = "https://github.com/bluerail/capistrano-dirty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "capistrano", ">= 3.0.0"
+end

data/lib/capistrano_dirty.rb

@@ -0,0 +1,29 @@
+module CapistranoDirty
+  require 'capistrano_dirty/pattern_finder'
+  require 'capistrano_dirty/pattern_match'
+
+  PATTERNS = {
+    'Git conflict markers' => /^[<>=]{7}/,
+    'FIXME' => /FIXME/,
+    'Pry' => /binding\.pry/
+  }.freeze
+
+  def self.dirty?(path = nil)
+    path ||= Dir.pwd
+
+    Dir["#{path}/**/*"].each do |filename|
+      next unless File.file?(filename) # skip directories
+
+      file = File.read(filename)
+      PATTERNS.each do |name, pattern|
+        matches = CapistranoDirty::PatternFinder.match(file, pattern)
+
+        relative_filename = filename.sub(%r{\A#{path}/?}, '')
+
+        return PatternMatch.new(name, relative_filename) if matches
+      end
+    end
+
+    false
+  end
+end

data/lib/capistrano_dirty/pattern_finder.rb

@@ -0,0 +1,20 @@
+module CapistranoDirty::PatternFinder
+  # Adding a line with this string and the name of the pattern above
+  # the line on which the pattern matches will ignore it.
+  DISABLE_STRING_LOOKAHEAD = /(?! # capistrano-dirty:disable)/
+
+  # If there is a match in the file, return the filename
+  def self.match(file, pattern)
+    regex = build_regex(pattern)
+
+    file.match(regex)
+  end
+
+  def self.build_regex(pattern)
+    Regexp.new([pattern, DISABLE_STRING_LOOKAHEAD].map(&:source).join)
+  end
+
+  def self.disable_string(name)
+    [DISABLE_STRING_PREFIX, name].join(' ')
+  end
+end

data/lib/capistrano_dirty/pattern_match.rb

@@ -0,0 +1,18 @@
+class CapistranoDirty::PatternMatch
+  attr_reader :pattern_name, :file_path
+
+  def initialize(pattern_name, file_path)
+    @pattern_name = pattern_name
+    @file_path = file_path
+  end
+
+  def to_s
+    "#{@pattern_name} found in #{@file_path}"
+  end
+
+  def ==(other)
+    other.is_a?(CapistranoDirty::PatternMatch) &&
+      @pattern_name == other.pattern_name &&
+      @file_path == other.file_path
+  end
+end

data/lib/capistrano_dirty/tasks.rake

@@ -0,0 +1,8 @@
+namespace :capistrano_dirty do
+  desc 'checks for dirty strings in the codebase'
+  task :check do
+    pattern_match = CapistranoDirty.dirty?
+
+    raise pattern_match.to_s if pattern_match
+  end
+end

data/lib/capistrano_dirty/version.rb

@@ -0,0 +1,3 @@
+module CapistranoDirty
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-dirty
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jamie Schembri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Checks for dirty strings in a codebase based on a list of patterns. This
+  may be used to prevent deployment if found.
+email:
+- jamie@lico.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-dirty.gemspec
+- lib/capistrano_dirty.rb
+- lib/capistrano_dirty/pattern_finder.rb
+- lib/capistrano_dirty/pattern_match.rb
+- lib/capistrano_dirty/tasks.rake
+- lib/capistrano_dirty/version.rb
+homepage: https://github.com/bluerail/capistrano-dirty
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Checks for dirty strings in a codebase
+test_files: []