pronto-golang 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85e017e9fa5d4b0b5ac4ae463c6e0a7bfe18e1c6
+  data.tar.gz: 670a418d1c9090b2baed18a9a365a55d4677d941
+SHA512:
+  metadata.gz: 2490baa9b58080974e677abe5f5ce152442c04b86b2cfaa416f75d5fff81c4e912e201526b92530c64f36f0a58b74fa5f4dbc719cca7848a74b61879fc848ef6
+  data.tar.gz: 2ffaaeed2fa0806eb2fb943b61dcac3855519236b4a3a33301f965adb3aa60149b8d2fc45c1b1a3643574bb408eba070f85becd06fac2484b81ae924aaf929f7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018 Cash Payment Solutions GmbH
+
+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 @@
+# Pronto runner for Golang
+
+Pronto runner for [Golang](https://golang.org) tools
+
+## Tools
+
+|  Tool    | Install  |
+|----------|----------|
+| golint   | go get -u github.com/golang/lint/golint |
+| gosimple | go get -u honnef.co/go/tools/cmd/gosimple |
+| go vet   | - |
+| unused   | go get -u honnef.co/go/tools/cmd/unused |
+| unparam  | go get -u mvdan.cc/unparam |
+| errcheck | go get -u github.com/kisielk/errcheck |
+
+## Enabling only certain tools
+
+In order to only enable certain tools for execution it is possible to provide a `.golangtools.yml` file in the directory of execution.
+
+It looks as follows:
+```yaml
+enabled_tools:
+  - errcheck
+  - gosimple
+  # ...
+```
+
+If the `enabled_tools` is available only the tools in the list will be executed. Note that the tool in question should match the value returned by `base_command`.
+
+## Implementing additional tools
+
+It is possible to add additional tools by adding a new class in the `Pronto::GolangTools` namespace.
+
+It is expected that it reponds to the following methods:
+
+| Method | Description |
+|--------|-------------|
+| `command(file_path)` | Executes the command and receives the file_path to allow checking only the current file |
+| `base_command` | Returns the name/basic command that will be invoked. Is also used for enabling and disabling it via `.golangtools.yml` |
+| `installed?` | Returns true if the tool can be found, e.g. through `which #{base_command}` |
+| `parse_line(line)` | Receives the line returned from the tool for parsing. REturns `absolute_path`, `line_number`, `level`, `message text` |

data/lib/pronto/golang.rb

@@ -0,0 +1,101 @@
+require 'open3'
+require 'pronto'
+require 'yaml'
+
+require_relative './golang/tools'
+
+module Pronto
+  class Golang < Runner
+    CONFIG_FILE = '.golangtools.yml'
+    GOLANG_FILE_EXTENSIONS = ['.go'].freeze
+
+    def run
+      return [] unless @patches
+
+      @patches
+        .select { |patch| valid_patch?(patch) }
+        .map { |patch| inspect(patch) }
+        .flatten
+        .compact
+    end
+
+    def valid_patch?(patch)
+      patch.additions > 0 && go_file?(patch.new_file_full_path)
+    end
+
+    def inspect(patch)
+      escaped_path = Shellwords.escape(patch.new_file_full_path.to_s)
+
+      messages = []
+
+      available_tools.each do |tool|
+        Open3.popen3("#{tool.command(escaped_path)}") do |stdin, stdout, stderr, wait_thr|
+          [stdout, stderr].each do |result_text|
+            while output_line = result_text.gets
+              next if output_line.strip == 'exit status 1'
+
+              messages << process_line(patch, tool, output_line)
+            end
+          end
+
+
+
+          while output_line = stderr.gets
+            process_line(patch, tool, output_line)
+          end
+        end
+      end
+
+      return messages
+    end
+
+    def process_line(patch, tool, output_line)
+      file_path, line_number, severity, message = tool.parse_line(output_line)
+
+      patch.added_lines.each do |line|
+        if line_number.to_s == line.new_lineno.to_s &&
+           patch.new_file_full_path.to_s == file_path
+
+          return Message.new(
+            file_path, line, severity, message, line.commit_sha, self.class
+          )
+        end
+      end
+
+      return nil
+    end
+
+    def available_tools
+      if @tools == nil
+        config = dotconfig
+
+        @tools = GolangTools.constants.map do |constant|
+          tool = Object.const_get("Pronto::GolangTools::#{constant}").new
+
+          if tool.installed? &&
+             (!config.key?('enabled_tools') ||
+              config['enabled_tools'].include?(tool.base_command))
+
+            tool
+          else
+            nil
+          end
+        end.compact
+      end
+
+      return @tools
+    end
+
+    def dotconfig
+      if File.exist?(CONFIG_FILE)
+        return YAML.load_file(CONFIG_FILE)
+      end
+
+      return {}
+    end
+
+    def go_file?(path)
+      GOLANG_FILE_EXTENSIONS.include?(File.extname(path))
+    end
+  end
+end

data/lib/pronto/golang/tools.rb

@@ -0,0 +1,11 @@
+module Pronto
+  module GolangTools
+  end
+end
+
+require_relative './tools/errcheck'
+require_relative './tools/golint'
+require_relative './tools/gosimple'
+require_relative './tools/govet'
+require_relative './tools/unparam'
+require_relative './tools/unused'

data/lib/pronto/golang/tools/errcheck.rb

@@ -0,0 +1,27 @@
+module Pronto
+  module GolangTools
+    class Errcheck
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'errcheck'
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, _ = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message
+      end
+
+      def message
+        'Error response given but not checked'
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools/golint.rb

@@ -0,0 +1,23 @@
+module Pronto
+  module GolangTools
+    class Golint
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'golint'
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, message = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message.strip
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools/gosimple.rb

@@ -0,0 +1,23 @@
+module Pronto
+  module GolangTools
+    class Gosimple
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'gosimple'
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, message = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message.strip
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools/govet.rb

@@ -0,0 +1,23 @@
+module Pronto
+  module GolangTools
+    class Govet
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'go vet'
+      end
+
+      def installed?
+        true
+      end
+
+      def parse_line(line)
+        file_path, line_number, message = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message.strip
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools/unparam.rb

@@ -0,0 +1,23 @@
+module Pronto
+  module GolangTools
+    class Unparam
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'unparam'
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, message = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message.strip
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools/unused.rb

@@ -0,0 +1,23 @@
+module Pronto
+  module GolangTools
+    class Unused
+      def command(file_path)
+        "#{base_command} ./..."
+      end
+
+      def base_command
+        'unused'
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, message = line.split(':')
+
+        return File.expand_path(file_path), line_number, :warning, message.strip
+      end
+    end
+  end
+end

data/lib/pronto/golang/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module GolangVersion
+    VERSION = '0.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: pronto-golang
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobias Schoknecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: tobias.schoknecht@barzahlen.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/pronto/golang.rb
+- lib/pronto/golang/tools.rb
+- lib/pronto/golang/tools/errcheck.rb
+- lib/pronto/golang/tools/golint.rb
+- lib/pronto/golang/tools/gosimple.rb
+- lib/pronto/golang/tools/govet.rb
+- lib/pronto/golang/tools/unparam.rb
+- lib/pronto/golang/tools/unused.rb
+- lib/pronto/golang/version.rb
+homepage: https://github.com/Barzahlen/pronto-golang
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Pronto runner for golang tools
+test_files: []