pre-commit-gpg 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d78cac13ba96d71517033242ed343b70c8484a4
-  data.tar.gz: 403c5920515f1b9aeefc05c3f2e6e52fe50cb73d
+  metadata.gz: 1c5c56b6665ce9b4b2ae8acf1fac1e81e7d4758c
+  data.tar.gz: 200bb9f2b7770741063ab01c82f8be06b0486a4b
 SHA512:
-  metadata.gz: 21f8a0f9ad6310477d40db648a8b25125c42085b4129fc41309e1b5f3d308b9a7a77430dcb07df605c39cb0aa33a0daa7b8dc8fac331fa70a953bdc7499a631a
-  data.tar.gz: c8faf8791722bd584bdb03191714108d3384dc4157ff9204532808aeac4ede05ab1e9cce28ead3f5c51e61b6c3686c05b5a80d56e4f6bc24980c609156a6efcf
+  metadata.gz: ac550686a21360ca1f331b0f43b7f290ab45e930fe44f3d3e8f4f4651cd273300743f7573f5e510c9d2e73b0d15fa6937bd5b328993fb4d65d30057c36bf03cd
+  data.tar.gz: 5dff4bbdc4e214c78d250951296f933d5b5340681c8b90f3d5af0b270878a2e81602a403baaa89b750dd34e4c1317b399127083786468b11ee19638e6fb30a9a

data/README.md

@@ -1,5 +1,3 @@
-# GPG verification for pre-commit gem
-
 [![Gem Version](https://badge.fury.io/rb/pre-commit-gpg.png)](https://rubygems.org/gems/pre-commit-gpg)
 [![Build Status](https://secure.travis-ci.org/pre-commit-plugins/pre-commit-gpg.png?branch=master)](https://travis-ci.org/pre-commit-plugins/pre-commit-gpg)
 [![Dependency Status](https://gemnasium.com/pre-commit-plugins/pre-commit-gpg.png)](https://gemnasium.com/pre-commit-plugins/pre-commit-gpg)
@@ -8,3 +6,13 @@
 [![Inline docs](http://inch-ci.org/github/pre-commit-plugins/pre-commit-gpg.png)](http://inch-ci.org/github/pre-commit-plugins/pre-commit-gpg)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/pre-commit-plugins/pre-commit-gpg/master/frames)
 [![Github Code](http://img.shields.io/badge/github-code-blue.svg)](https://github.com/pre-commit-plugins/pre-commit-gpg)
+
+# GPG verification for pre-commit gem
+
+### Installation
+
+    gem install pre-commit-gpg
+
+### Usage
+
+    pre-commit enable yaml checks gpg

data/lib/plugins/pre_commit/checks/gpg.rb

@@ -1,13 +1,37 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
 require 'pre-commit/checks/shell'
+require 'pre-commit/error_list'
 
+# :nodoc:
 module PreCommit
+  # :nodoc:
   module Checks
+
+    #
+    # pre-commit gem plugin to verify GPG signatures
+    # when either the file or signature changes
+    #
     class Gpg < Shell
 
+      #
+      # description of the plugin
+      #
       def self.description
         "Finds GPG verification problems"
       end
 
+      #
+      # Finds files with signature and verifies them
+      #
+      # @param staged_files [Array<String>] list of files to check
+      #
+      # @return [nil|Array<PreCommit::ErrorList>] nil when no errors,
+      #                                           list of errors otherwise
       def call(staged_files)
         signature_files = staged_files.map { |file| get_signature(file) }.compact.uniq
         return if signature_files.empty?
@@ -15,11 +39,18 @@ module PreCommit
         errors = signature_files.map { |file| run_check(file) }.compact
         return if errors.empty?
 
-        errors.join("\n")
+        errors
       end
 
     private
 
+      #
+      # Checks if the given file is a signature or has one
+      #
+      # @param file [String] the file to check
+      #
+      # @return [nil|String] signature file when found, nil otherwise
+      #
       def get_signature(file)
         if
           File.exist?(file + ".asc")
@@ -33,20 +64,55 @@ module PreCommit
         end
       end
 
+      #
+      # Verify given file GPG signature
+      #
+      # @param file [String] path to file to verify
+      #
+      # @return [nil|PreCommit::ErrorList] nil when file verified,
+      #                                    ErrorList when no GPG found to verify
+      #                                    ErrorList when verification failed
+      #
       def run_check(file)
         if
           gpg_program
         then
-          execute(gpg_program, "--verify", file)
+          parse_error( execute(gpg_program, "--verify", file), file )
         else
-          warn "No GPG program found, skipping verification of #{file}"
+          PreCommit::ErrorList.new(PreCommit::Line.new("No GPG program found to run verification", file))
         end
       end
 
+      #
+      # convert verification failure string into ErrorList
+      #
+      # @param errors [String] Output of failed GPG verification to parse
+      # @param file   [String] File that versification failed
+      #
+      # @return [nil|PreCommit::ErrorList] nil when file verified,
+      #                                    ErrorList when verification failed
+      #
+      def parse_error(errors, file)
+        return if errors.nil?
+        PreCommit::ErrorList.new(
+          errors.split(/\n/).map do |error|
+            PreCommit::Line.new(error, file)
+          end
+        )
+      end
+
+      #
+      # @return [nil|String] path to the GPG binary or +nil+
+      #
       def gpg_program
         @gpg_program ||= find_binary(:gpg2) || find_binary(:gpg)
       end
 
+      #
+      # @param binary [String] the name of binary to find on +PATH+
+      #
+      # @return [nil|String] path to the searched binary or +nil+
+      #
       def find_binary(binary)
         result = execute_raw(
           "which #{binary}",
@@ -54,6 +120,7 @@ module PreCommit
         ) and result.strip
       end
 
-    end
+    end # class Gpg < Shell
+
   end
 end

data/lib/pre-commit/gpg/version.rb

@@ -1,5 +1,14 @@
+=begin
+Copyright 2014 Michal Papis <mpapis@gmail.com>
+
+See the file LICENSE for copying permission.
+=end
+
+# :nodoc:
 module PreCommit
+  # placeholder for gem VERSION
   module Gpg
-    VERSION = "0.9.0"
+    # the gem version
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pre-commit-gpg
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michal Papis
@@ -120,7 +120,7 @@ files:
 - lib/pre-commit/gpg/version.rb
 homepage: http://github.com/pre-commit-plugins/pre-commit-gpg
 licenses:
-- Apache 2.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []