overcommit 0.36.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b67aff142df04c21f3edc1e45cb5e8e71b0f613
-  data.tar.gz: 148dede395ec550657a9d3b7c4bb9fa661784b7e
+  metadata.gz: eeddd35416c0acbfbcd95473bf9026cce4f3bf5e
+  data.tar.gz: 9f805e9ee12b8db38da383c162c61f989f8d9ab1
 SHA512:
-  metadata.gz: d9ec483cba901e73e9346682f6597f9d75dfc793bbabfc30a706cb04a633e2f33e20502d936478d34b834a53ea300402458adecee606d261dd55bf61838bc60f
-  data.tar.gz: 91ca7dd2c169bfc3ee5f464094d5decd186324bd765b7d7fd7a04f91a0335267eec065d7f21b1cf3756f64ff537d10c2dd26515d42dd9c027d77ef355ad8cf54
+  metadata.gz: 78894882777c8c82ddf27f57f3da0a502cbf7adc0360004d126b438110c974792011543cbcc4d7251561d595199d23043c230db5a2c45e2654abb51e076da371
+  data.tar.gz: 22ae853f2b0ee843890098c5364d2f30fe25e9abe4df61e9c011acbec4ace2c034673c193c55b8d3c812bfb29f1b85e658d152f5b489e69f86d5e282a4b8adda

data/config/default.yml

@@ -254,6 +254,20 @@ PreCommit:
     install_command: 'gem install fasterer'
     include: '**/*.rb'
 
+  FixMe:
+    enabled: false
+    description: 'Check for "token" strings'
+    required_executable: 'grep'
+    flags: ['-IEHnw']
+    keywords: ['BROKEN', 'BUG', 'ERROR', 'FIXME', 'HACK', 'NOTE', 'OPTIMIZE', 'REVIEW', 'TODO', 'WTF', 'XXX']
+
+  Foodcritic:
+    enabled: false
+    description: 'Analyze with Foodcritic'
+    required_executable: 'foodcritic'
+    flags: ['--epic-fail=any']
+    install_command: 'gem install foodcritic'
+
   ForbiddenBranches:
     enabled: false
     description: 'Check for commit to forbidden branch'
@@ -367,6 +381,11 @@ PreCommit:
     install_command: 'gem install json'
     include: '**/*.json'
 
+  LicenseHeader:
+    enabled: false
+    license_file: 'LICENSE.txt'
+    description: 'Check source files for license headers'
+
   LocalPathsInGemfile:
     enabled: false
     description: 'Check for local paths in Gemfile'
@@ -610,6 +629,11 @@ PreCommit:
     include:
       - '**/*.html'
 
+  LineEndings:
+    description: 'Check line endings'
+    enabled: false
+    eol: "\n" # or "\r\n" for Windows-style newlines
+
   XmlLint:
     enabled: false
     description: 'Analyze with xmllint'
@@ -627,6 +651,16 @@ PreCommit:
       - '**/*.xml'
       - '**/*.svg'
 
+  YamlLint:
+    enabled: false
+    description: 'Analyze with YAMLlint'
+    required_executable: 'yamllint'
+    flags: ['--format=parsable']
+    install_command: 'pip install yamllint'
+    include:
+      - '**/*.yaml'
+      - '**/*.yml'
+
   YamlSyntax:
     enabled: false
     description: 'Check YAML syntax'

data/lib/overcommit/hook/commit_msg/capitalized_subject.rb

@@ -4,7 +4,8 @@ module Overcommit::Hook::CommitMsg
     def run
       return :pass if empty_message?
 
-      subject = commit_message_lines[0].to_s
+      # Git treats the first non-empty line as the subject
+      subject = commit_message_lines.find { |line| !line.strip.empty? }.to_s
       first_letter = subject.match(/^[[:punct:]]*(.)/)[1]
       unless special_prefix?(subject) || first_letter =~ /[[:upper:]]/
         return :warn, 'Subject should start with a capital letter'

data/lib/overcommit/hook/pre_commit/fix_me.rb

@@ -0,0 +1,15 @@
+module Overcommit::Hook::PreCommit
+  # Check for "token" strings
+  class FixMe < Base
+    def run
+      keywords = config['keywords']
+      result = execute(command, args: [keywords.join('|')] + applicable_files)
+
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/,
+        lambda { |_type| :warning }
+      )
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/foodcritic.rb

@@ -0,0 +1,147 @@
+module Overcommit::Hook::PreCommit
+  # Runs `foodcritic` against any modified Ruby files from Chef directory structure.
+  #
+  # @see http://www.foodcritic.io/
+  #
+  # There are two "modes" you can run this hook in based on the repo:
+  #
+  # SINGLE COOKBOOK REPO MODE
+  # -------------------------
+  # The default. Use this if your repository contains just a single cookbook,
+  # i.e. the top-level repo directory contains directories called `attributes`,
+  # `libraries`, `recipes`, etc.
+  #
+  # To get this to work well, you'll want to set your Overcommit configuration
+  # for this hook to something like:
+  #
+  # PreCommit:
+  #   Foodcritic:
+  #     enabled: true
+  #     include:
+  #       - 'attributes/**/*'
+  #       - 'definitions/**/*'
+  #       - 'files/**/*'
+  #       - 'libraries/**/*'
+  #       - 'providers/**/*'
+  #       - 'recipes/**/*'
+  #       - 'resources/**/*'
+  #       - 'templates/**/*'
+  #
+  # MONOLITHIC REPO MODE
+  # --------------------
+  # Use this if you store multiple cookbooks, environments, and roles (or any
+  # combination thereof) in a single repository.
+  #
+  # There are three configuration options relevant here:
+  #
+  #   * `cookbooks_directory`
+  #     When set, hook will treat the path as a directory containing cookbooks.
+  #     Each subdirectory of this directory will be treated as a separate
+  #     cookbook.
+  #
+  #   * `environments_directory`
+  #     When set, hook will treat the path as a directory containing environment
+  #     files.
+  #
+  #   * `roles_directory`
+  #     When set, hook will treat the given path as a directory containing role
+  #     files.
+  #
+  # In order to run in monolithic repo mode, YOU MUST SET `cookbooks_directory`.
+  # The other configuration options are optional, if you happen to store
+  # environments/roles in another repo.
+  #
+  # To get this to work well, you'll want to set your Overcommit configuration
+  # for this hook to something like:
+  #
+  # PreCommit:
+  #   Foodcritic:
+  #     enabled: true
+  #     cookbooks_directory: 'cookbooks'
+  #     environments_directory: 'environments'
+  #     roles_directory: 'roles'
+  #     include:
+  #       - 'cookbooks/**/*'
+  #       - 'environments/**/*'
+  #       - 'roles/**/*'
+  #
+  # ADDITIONAL CONFIGURATION
+  # ------------------------
+  # You can disable rules using the `flags` hook option. For example:
+  #
+  # PreCommit:
+  #   Foodcritic:
+  #     enabled: true
+  #     ...
+  #     flags:
+  #       - '--epic-fail=any'
+  #       - '-t~FC011' # Missing README in markdown format
+  #       - '-t~FC064' # Ensure issues_url is set in metadata
+  #
+  # Any other command line flag supported by the `foodcritic` executable can be
+  # specified here.
+  #
+  # If you want the hook run to fail (and not just warn), set the `on_warn`
+  # option for the hook to `fail`:
+  #
+  # PreCommit:
+  #   Foodcritic:
+  #     enabled: true
+  #     on_warn: fail
+  #     ...
+  #
+  # This will treat any warnings as failures and cause the hook to exit
+  # unsuccessfully.
+  class Foodcritic < Base
+    def run
+      args = modified_cookbooks_args + modified_environments_args + modified_roles_args
+      result = execute(command, args: args)
+
+      if result.success?
+        :pass
+      else
+        return [:warn, result.stderr + result.stdout]
+      end
+    end
+
+    private
+
+    def directories_changed(dir_prefix)
+      applicable_files.
+        select    { |path| path.start_with?(dir_prefix) }.
+        map       { |path| path.gsub(%r{^#{dir_prefix}/}, '') }.
+        group_by  { |path| path.split('/').first }.
+        keys.
+        map { |path| File.join(dir_prefix, path) }
+    end
+
+    def modified_environments_args
+      modified('environments').map { |env| %W[-E #{env}] }.flatten
+    end
+
+    def modified_roles_args
+      modified('roles').map { |role| %W[-R #{role}] }.flatten
+    end
+
+    def modified_cookbooks_args
+      # Return the repo root if repository contains a single cookbook
+      if !config['cookbooks_directory'] || config['cookbooks_directory'].empty?
+        ['-B', Overcommit::Utils.repo_root]
+      else
+        # Otherwise return all modified cookbooks in the cookbook directory
+        modified('cookbooks').map { |cookbook| ['-B', cookbook] }.flatten
+      end
+    end
+
+    def modified(type)
+      return [] if !config["#{type}_directory"] || config["#{type}_directory"].empty?
+      @modified ||= {}
+      @modified[type] ||= directories_changed(full_directory_path("#{type}_directory"))
+    end
+
+    def full_directory_path(config_option)
+      return config[config_option] if config[config_option].start_with?(File::SEPARATOR)
+      File.absolute_path(File.join(Overcommit::Utils.repo_root, config[config_option]))
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/license_header.rb

@@ -0,0 +1,46 @@
+module Overcommit::Hook::PreCommit
+  # Checks for license headers in source files
+  class LicenseHeader < Base
+    def run
+      begin
+        license_contents = license_lines
+      rescue Errno::ENOENT
+        return :fail, "Unable to load license file #{license_file}"
+      end
+
+      messages = applicable_files.map do |file|
+        check_file(file, license_contents)
+      end.compact
+
+      return :fail, messages.join("\n") if messages.any?
+
+      :pass
+    end
+
+    def check_file(file, license_contents)
+      File.readlines(file).each_with_index do |l, i|
+        if i >= license_contents.length
+          break
+        end
+
+        l.chomp!
+        unless l.end_with?(license_contents[i])
+          message = "#{file} missing header contents from line #{i} of "\
+                    "#{license_file}: #{license_contents[i]}"
+          return message
+        end
+      end
+    end
+
+    def license_file
+      config['license_file']
+    end
+
+    def license_lines
+      @license_regex ||= begin
+        file_root = Overcommit::Utils.convert_glob_to_absolute(license_file)
+        File.read(file_root).split("\n")
+      end
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/line_endings.rb

@@ -0,0 +1,55 @@
+module Overcommit::Hook::PreCommit
+  # Checks for line endings in files.
+  #
+  # WARNING: Works with Git 2.10.0 or newer.
+  class LineEndings < Base
+    def run
+      messages = []
+
+      offending_files.map do |file_name|
+        file = File.open(file_name)
+        file.each_line do |line|
+          # remove configured line-ending
+          line.gsub!(/#{config['eol']}/, '')
+
+          # detect any left over line-ending characters
+          next unless line.end_with?("\n", "\r")
+
+          messages << Overcommit::Hook::Message.new(
+            :error,
+            file_name,
+            file.lineno,
+            "#{file_name}:#{file.lineno}:#{line.inspect}"
+          )
+        end
+      end
+
+      messages
+    end
+
+    private
+
+    def offending_files
+      result = execute(%w[git ls-files --eol -z --], args: applicable_files)
+      raise 'Unable to access git tree' unless result.success?
+
+      result.stdout.split("\0").map do |file_info|
+        i, _w, _attr, path = file_info.split
+        next if i == 'l/-text' # ignore binary files
+        next if i == "l/#{eol}"
+        path
+      end.compact
+    end
+
+    def eol
+      @eol ||=  case config['eol']
+                when "\n"
+                  'lf'
+                when "\r\n"
+                  'crlf'
+                else
+                  raise 'Invalid `eol` option specified: must be "\n" or "\r\n"'
+                end
+    end
+  end
+end

data/lib/overcommit/hook/pre_commit/rails_schema_up_to_date.rb

@@ -1,10 +1,13 @@
 module Overcommit::Hook::PreCommit
-  # Check to see whether the schema file is in line with the migrations
+  # Check to see whether the schema file is in line with the migrations. When a
+  # schema file is present but a migration file is not, this is usually a
+  # failure. The exception is if the schema is at version 0 (i.e before any
+  # migrations have been run). In this case it is OK if there are no migrations.
   class RailsSchemaUpToDate < Base
     def run # rubocop:disable CyclomaticComplexity, PerceivedComplexity
       if migration_files.any? && schema_files.none?
         return :fail, "It looks like you're adding a migration, but did not update the schema file"
-      elsif migration_files.none? && schema_files.any?
+      elsif migration_files.none? && schema_files.any? && non_zero_schema_version?
         return :fail, "You're trying to change the schema without adding a migration file"
       elsif migration_files.any? && schema_files.any?
         # Get the latest version from the migration filename. Use
@@ -15,7 +18,6 @@ module Overcommit::Hook::PreCommit
           File.basename(file)[/\d+/]
         end.sort.last
 
-        schema     = schema_files.map { |file| File.read(file) }.join
         up_to_date = schema.include?(latest_version)
 
         unless up_to_date
@@ -41,5 +43,13 @@ module Overcommit::Hook::PreCommit
         file.match %r{db/schema\.rb|db/structure.*\.sql}
       end
     end
+
+    def schema
+      @schema ||= schema_files.map { |file| File.read(file) }.join
+    end
+
+    def non_zero_schema_version?
+      schema =~ /\d{14}/
+    end
   end
 end

data/lib/overcommit/hook/pre_commit/yaml_lint.rb

@@ -0,0 +1,16 @@
+module Overcommit::Hook::PreCommit
+  # Runs `YAMLLint` against any modified YAML files.
+  #
+  # @see https://github.com/adrienverge/yamllint
+  class YamlLint < Base
+    def run
+      result = execute(command, args: applicable_files)
+
+      if result.success?
+        :pass
+      else
+        return [:warn, result.stdout]
+      end
+    end
+  end
+end

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.36.0'.freeze
+  VERSION = '0.37.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -117,6 +117,8 @@ files:
 - lib/overcommit/hook/pre_commit/es_lint.rb
 - lib/overcommit/hook/pre_commit/execute_permissions.rb
 - lib/overcommit/hook/pre_commit/fasterer.rb
+- lib/overcommit/hook/pre_commit/fix_me.rb
+- lib/overcommit/hook/pre_commit/foodcritic.rb
 - lib/overcommit/hook/pre_commit/forbidden_branches.rb
 - lib/overcommit/hook/pre_commit/go_lint.rb
 - lib/overcommit/hook/pre_commit/go_vet.rb
@@ -132,6 +134,8 @@ files:
 - lib/overcommit/hook/pre_commit/jscs.rb
 - lib/overcommit/hook/pre_commit/jsl.rb
 - lib/overcommit/hook/pre_commit/json_syntax.rb
+- lib/overcommit/hook/pre_commit/license_header.rb
+- lib/overcommit/hook/pre_commit/line_endings.rb
 - lib/overcommit/hook/pre_commit/local_paths_in_gemfile.rb
 - lib/overcommit/hook/pre_commit/mdl.rb
 - lib/overcommit/hook/pre_commit/merge_conflicts.rb
@@ -163,6 +167,7 @@ files:
 - lib/overcommit/hook/pre_commit/w3c_html.rb
 - lib/overcommit/hook/pre_commit/xml_lint.rb
 - lib/overcommit/hook/pre_commit/xml_syntax.rb
+- lib/overcommit/hook/pre_commit/yaml_lint.rb
 - lib/overcommit/hook/pre_commit/yaml_syntax.rb
 - lib/overcommit/hook/pre_push/base.rb
 - lib/overcommit/hook/pre_push/brakeman.rb
@@ -240,4 +245,3 @@ signing_key:
 specification_version: 4
 summary: Git hook manager
 test_files: []
-has_rdoc: