overcommit 0.5.0 → 0.6.0

data/bin/scripts/jshint_runner.js

@@ -1,42 +0,0 @@
-/**
- * @author kamil@causes.com
- *
- * This is a script to run jshint against files passed in via
- * command line arguments
- **/
-
-if (typeof JSHINT === "undefined") {
-  print("jshint not available. Make sure it was included properly.");
-  quit();
-}
-
-// Options:
-// https://gist.github.com/1489652
-
-var i, j, file, source, result, error,
-  options = {
-    boss:   true,
-    curly:  true,
-    eqeqeq: true,
-    forin:  true,
-    newcap: true
-  };
-
-for (i = 0; i < arguments.length; i++) {
-
-  file = arguments[i];
-  source = readFile(file);
-  result = JSHINT(source, options);
-
-  if (!result) {
-    for (j = 0; j < JSHINT.errors.length; j++) {
-      error = JSHINT.errors[j];
-
-      print(file + ": line " + error.line + ", col  " + error.character + ", " +
-            error.reason);
-      print("\t" + error.evidence);
-    }
-  }
-}
-
-

data/lib/overcommit/errors.rb

@@ -1,3 +0,0 @@
-class NotAGitRepoError < StandardError
-  # Nothing to see here
-end

data/lib/overcommit/git_hook.rb

@@ -1,89 +0,0 @@
-module Overcommit
-  module GitHook
-    class BaseHook
-      def initialize
-        Overcommit.config.desired_plugins.each do |plugin|
-          require plugin
-        end
-      rescue LoadError, NameError => ex
-        log.error "Couldn't load plugin: #{ex}"
-        exit 0
-      end
-
-      def run(*args)
-        # Support 'bare' installation where we don't have any hooks yet.
-        # Silently pass.
-        exit unless (checks = registered_checks) && checks.any?
-
-        exit if requires_modified_files? && Utils.modified_files.empty?
-
-        reporter = Reporter.new(Overcommit::Utils.hook_name, checks)
-
-        reporter.print_header
-
-        checks.each do |check_class|
-          check = check_class.new(*args)
-          next if check.skip?
-
-          # Ignore a check if it only applies to a specific file type and there
-          # are no staged files of that type in the tree
-          next if check_class.filetypes && check.staged.empty?
-
-          reporter.with_status(check) do
-            run_and_filter_check(check)
-          end
-        end
-
-        reporter.print_result
-      end
-
-      def skip_checks
-        @skip_checks ||= ENV.fetch('SKIP_CHECKS', '').split(/[:, ]/)
-      end
-
-    private
-
-      def log
-        Logger.instance
-      end
-
-      # Return all loaded plugins, skipping those that are skippable and have
-      # been asked to be skipped by the environment variable SKIP_CHECKS.
-      #
-      # Note that required checks are not skipped even if
-      # `ENV['SKIP_CHECKS'] == 'all'`
-      def registered_checks
-        @registered_checks ||= begin
-          skip_all = skip_checks.include? 'all'
-          HookRegistry.checks.reject do |check|
-            hook_name = Utils.underscorize(check.name).split('/').last
-
-            check.skippable? && (skip_all || skip_checks.include?(hook_name))
-          end.sort_by(&:name)
-        end
-      end
-
-      # If true, only run this check when there are modified files.
-      def requires_modified_files?
-        false
-      end
-
-      # Filters temporary staged file names from the output of the check and
-      # replaces them with their original filenames.
-      def run_and_filter_check(check)
-        status, output = check.run_check
-
-        # Some checks output a list of lines. Join those lines together with newlines.
-        output = Array[output].flatten.join("\n")
-
-        unless output.empty?
-          check.staged.each do |staged_file|
-            output = staged_file.filter_string(output)
-          end
-        end
-
-        [status, output]
-      end
-    end
-  end
-end

data/lib/overcommit/hook_specific_check.rb

@@ -1,110 +0,0 @@
-module Overcommit
-  module GitHook
-    module HookRegistry
-      @checks = []
-      class << self
-        attr_reader :checks
-
-        def included(base)
-          @checks << base
-        end
-      end
-    end
-
-    class HookSpecificCheck
-      class << self
-        attr_accessor :filetypes, :stealth, :required
-
-        def stealth!
-          self.stealth = true
-        end
-
-        def required!
-          self.required = true
-        end
-
-        # Can the check be skipped by environment variables? This can always be
-        # overriden with `--no-verify`.
-        def skippable?
-          !required
-        end
-
-        def friendly_name
-          Overcommit::Utils.underscorize name.to_s.split('::').last
-        end
-      end
-
-      def initialize(*args)
-        @arguments = args
-      end
-
-      def name
-        self.class.friendly_name
-      end
-
-      def skip?
-        false
-      end
-
-      def stealth?
-        self.class.stealth
-      end
-
-      def staged
-        @staged ||= modified_files.map do |filename|
-          filetypes = Array(self.class.filetypes).map { |type| ".#{type}" }
-          if filetypes.empty? || filename.end_with?(*filetypes)
-            StagedFile.new(filename)
-          end
-        end.compact
-      end
-
-      def run_check
-        [:bad, 'No checks defined!']
-      end
-
-    private
-
-      def modified_files
-        Overcommit::Utils.modified_files
-      end
-
-      def in_path?(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return true if File.executable? exe
-          end
-        end
-        false
-      end
-
-      def commit_message_file
-        unless @arguments[0] && ::File.exist?(@arguments[0])
-          fail 'Not running in the context of a commit message'
-        end
-
-        @arguments[0]
-      end
-
-      def raw_commit_message
-        @raw_commit_message ||= ::IO.readlines(commit_message_file)
-      end
-
-      # Strip comments and diff (from git-commit --verbose)
-      def commit_message
-        @commit_message ||= raw_commit_message.
-          reject     { |line| line =~ /^#/ }.
-          take_while { |line| !line.start_with?('diff --git') }
-      end
-
-      class << self
-        def file_type(*types)
-          self.filetypes = types
-        end
-        alias file_types file_type
-      end
-    end
-  end
-end

data/lib/overcommit/hooks/commit_msg.rb

@@ -1,7 +0,0 @@
-module Overcommit
-  class CommitMessageHook < GitHook::BaseHook
-    # No special behavior
-  end
-
-  Utils.register_hook(CommitMessageHook)
-end

data/lib/overcommit/hooks/pre_commit.rb

@@ -1,9 +0,0 @@
-module Overcommit
-  class PreCommitHook < GitHook::BaseHook
-    def requires_modified_files?
-      true
-    end
-  end
-
-  Utils.register_hook(PreCommitHook)
-end

data/lib/overcommit/plugins/commit_msg/change_id.rb

@@ -1,15 +0,0 @@
-module Overcommit::GitHook
-  class ChangeID < HookSpecificCheck
-    include HookRegistry
-
-    stealth! # Not really a 'check', but we need it to run
-    required! # Not skipped when ENV['SKIP_CHECKS'] == 'all'
-
-    SCRIPT_LOCATION = Overcommit::Utils.script_path 'gerrit-change-id'
-
-    def run_check
-      system `#{SCRIPT_LOCATION} #{@arguments.join(' ')}`
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/commit_msg/release_note.rb

@@ -1,25 +0,0 @@
-module Overcommit::GitHook
-  class ReleaseNote < HookSpecificCheck
-    include HookRegistry
-
-    EMPTY_RELEASE_NOTE = /^release notes?\s*[:.]?\n{2,}/im
-    def run_check
-      if commit_message.join =~ EMPTY_RELEASE_NOTE
-        strip_release_note
-        return :warn, 'Empty release note found, automatically removed'
-      end
-
-      :good
-    end
-
-  private
-
-    def strip_release_note
-      stripped_message = commit_message.join.sub(EMPTY_RELEASE_NOTE, '')
-
-      ::File.open(commit_message_file, 'w') do |file|
-        file.write(stripped_message)
-      end
-    end
-  end
-end

data/lib/overcommit/plugins/commit_msg/russian_novel.rb

@@ -1,16 +0,0 @@
-module Overcommit::GitHook
-  class RussianNovel < HookSpecificCheck
-    include HookRegistry
-
-    stealth!
-
-    RUSSIAN_NOVEL_LENGTH = 30
-    def run_check
-      if commit_message.length > RUSSIAN_NOVEL_LENGTH
-        return :warn, 'You seem to have authored a Russian novel; congratulations!'
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/commit_msg/single_line_subject.rb

@@ -1,13 +0,0 @@
-module Overcommit::GitHook
-  class SingleLineSubject < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
-      unless commit_message[1].to_s.strip.empty?
-        return :warn, 'Subject should be a single line'
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/commit_msg/text_width.rb

@@ -1,20 +0,0 @@
-module Overcommit::GitHook
-  class TextWidth < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
-      if commit_message.first.size > 60
-        return :warn, 'Please keep the subject < ~60 characters'
-      end
-
-      commit_message.each do |line|
-        chomped = line.chomp
-        if chomped.size > 72
-          return :warn, "> 72 characters, please hard wrap: '#{chomped}'"
-        end
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/commit_msg/trailing_period.rb

@@ -1,13 +0,0 @@
-module Overcommit::GitHook
-  class TrailingPeriod < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
-      if commit_message[0].rstrip.end_with?('.')
-        return :warn, 'Please omit trailing period from commit message subject'
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/pre_commit/author_name.rb

@@ -1,16 +0,0 @@
-module Overcommit::GitHook
-  class AuthorName < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
-      name = `git config --get user.name`.chomp
-      unless name.split(' ').count >= 2
-        return :bad, "Author must have at least first and last name; " <<
-                     "was: '#{name}'.\n Set your name with " <<
-                     "`git config --global user.name 'Your Name'`"
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/pre_commit/causes_email.rb

@@ -1,15 +0,0 @@
-module Overcommit::GitHook
-  class CausesEmail < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
-      email = `git config --get user.email`.chomp
-      unless email =~ /@causes\.com$/
-        return :bad, "Author must use a causes.com address; was '#{email}'.\n" <<
-                     "Set user with `git config --global user.email YOUR_EMAIL@causes.com`"
-      end
-
-      :good
-    end
-  end
-end

data/lib/overcommit/plugins/pre_commit/coffee_lint.rb

@@ -1,16 +0,0 @@
-module Overcommit::GitHook
-  class CoffeeLint < HookSpecificCheck
-    include HookRegistry
-    file_type :coffee
-
-    def run_check
-      unless in_path? 'coffeelint'
-        return :warn, 'Run `npm install -g coffeelint`'
-      end
-
-      paths  = staged.collect(&:path).join(' ')
-      output = `coffeelint --quiet #{paths}`.split("\n")
-      return ($?.success? ? :good : :bad), output
-    end
-  end
-end

data/lib/overcommit/plugins/pre_commit/css_linter.rb

@@ -1,17 +0,0 @@
-module Overcommit::GitHook
-  class CssLinter < HookSpecificCheck
-    include HookRegistry
-    file_type :css
-
-    CSS_LINTER_PATH = Overcommit::Utils.script_path 'csslint-rhino.js'
-
-    def run_check
-      return :warn, "Rhino is not installed" unless in_path? 'rhino'
-
-      paths = staged.collect(&:path).join(' ')
-
-      output = `rhino #{CSS_LINTER_PATH} --quiet --format=compact #{paths} | grep 'Error - '`
-      return (output !~ /Error - (?!Unknown @ rule)/ ? :good : :bad), output
-    end
-  end
-end