pronto-golang 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd44117d6f62bc383eee9e2bc20067d620a4bd76
-  data.tar.gz: b46b34cdb4cc5ab13d8e800bb8c748c075bb7fe1
+  metadata.gz: 44322a5abe5e297a8aca4dcbcaf6cadcc281aece
+  data.tar.gz: 5e3a4285833911a46405d0ca87b52f4328917374
 SHA512:
-  metadata.gz: f4fbe3cef82de8eaa8e831f6bb60b629a89ec0e1c9eef99483c9be9c131b266e18a96df1b679c0fb9c2f4461a23a714cc7a55624042d36b22fa27542069c4cd3
-  data.tar.gz: 09aa51442577934e76e8912c6b66433d1d6866a29001cd649179508188df9da525964b0aea3f706d01e26ce10900f5c97c50245b5c47341a7d073a47d953d166
+  metadata.gz: cc3dc687d363a3a91ca82ab729aa548f8dcae82ab2999e7c239355674eaaf3661bf40ac67979e0dd099a59d25be3cd6d1e78a7106bb154ffda91cefa9c79b23c
+  data.tar.gz: 2338419e929ff992ce3751d8fb546704d219e23b2e00dc8a5034de2200591d9bded52c60fe28b56d91345149ad64bbe11f4582580b9e7cad5856b82eb0eba1e2

data/README.md

@@ -8,26 +8,26 @@ Pronto runner for [Golang](https://golang.org) tools
 
 |  Tool    | Install  |
 |----------|----------|
-| golint   | go get -u golang.org/x/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 |
+| go vet   | - |
+| golint   | go get -u golang.org/x/lint/golint |
+| staticcheck | go get -u honnef.co/go/tools/cmd/staticcheck |
 
-## Enabling only certain tools
+## Configuring tools
 
-In order to only enable certain tools for execution it is possible to provide a `.golangtools.yml` file in the directory of execution.
+In order to configure certain tools for execution it is possible to provide a `.golangtools.yml` file in the directory of execution, any parent directory or `$HOME`.
 
 It looks as follows:
 ```yaml
-enabled_tools:
-  - errcheck
-  - gosimple
-  # ...
+tools:
+  <tool base command>:
+    enabled: true
+    parameters: './...'
 ```
 
-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`.
+If a tool is not listed here, it will automatically be enabled with the parameters `./...`.
+In order to specifically disable a tool, it has to be listed and `enabled` has to be set to `false`.
+If either of the keys is not provided the default will be assumed.
 
 ## Implementing additional tools
 
@@ -37,11 +37,14 @@ It is expected that it reponds to the following methods:
 
 | Method | Description |
 |--------|-------------|
+| `initialize` | Configuration hash from the `.golangtools.yml` config |
 | `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}` |
+| `self.base_command` | Returns the name/basic command that will be invoked. Is also used for enabling and disabling it via `.golangtools.yml` |
+| `available?` | 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` |
 
+It is possible to inherit from `Pronto::GolangTools::Base`, in which case only `self.base_command` and `parse_line` need to be implemented.
+
 ## License
 
 [MIT](LICENSE)

data/lib/pronto/golang.rb

@@ -3,10 +3,13 @@ require 'pronto'
 require 'yaml'
 require 'shellwords'
 
+require_relative './golang/file_finder'
 require_relative './golang/tools'
 
 module Pronto
   class Golang < Runner
+    include ::Pronto::GolangSupport::FileFinder
+
     CONFIG_FILE = '.golangtools.yml'
     GOLANG_FILE_EXTENSIONS = ['.go'].freeze
 
@@ -75,12 +78,13 @@ module Pronto
         config = dotconfig
 
         @tools = GolangTools.constants.sort.map do |constant|
-          tool = Object.const_get("Pronto::GolangTools::#{constant}").new
+          next if constant.to_s == 'Base'
+
+          tool_class = Object.const_get("Pronto::GolangTools::#{constant}")
 
-          if tool.installed? &&
-             (!config.key?('enabled_tools') ||
-              config['enabled_tools'].include?(tool.base_command))
+          tool = tool_class.new(config.fetch('tools').fetch(tool_class.base_command))
 
+          if tool.available?
             tool
           else
             nil
@@ -92,11 +96,17 @@ module Pronto
     end
 
     def dotconfig
-      if File.exist?(CONFIG_FILE)
-        return YAML.load_file(CONFIG_FILE)
+      file = find_file_upwards(CONFIG_FILE, Dir.pwd, use_home: true)
+
+      base = {
+        'tools' => {}
+      }
+
+      if file
+        return base.merge(YAML.load_file(file))
       end
 
-      return {}
+      return base
     end
 
     def go_file?(path)

data/lib/pronto/golang/file_finder.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+
+module Pronto
+  module GolangSupport
+    module FileFinder
+      def self.root_level=(level)
+        @root_level = level
+      end
+
+      def self.root_level?(path)
+        @root_level == path.to_s
+      end
+
+      def find_file_upwards(filename, start_dir, use_home: false)
+        traverse_files_upwards(filename, start_dir, use_home) do |file|
+          # minimize iteration for performance
+          return file if file
+        end
+      end
+
+      def find_files_upwards(filename, start_dir, use_home: false)
+        files = []
+        traverse_files_upwards(filename, start_dir, use_home) do |file|
+          files << file
+        end
+        files
+      end
+
+      private
+
+      def traverse_files_upwards(filename, start_dir, use_home)
+        Pathname.new(start_dir).expand_path.ascend do |dir|
+          break if FileFinder.root_level?(dir)
+
+          file = dir + filename
+          yield(file.to_s) if file.exist?
+        end
+
+        return unless use_home && ENV.key?('HOME')
+
+        file = File.join(Dir.home, filename)
+        yield(file) if File.exist?(file)
+      end
+    end
+  end
+end

data/lib/pronto/golang/tools.rb

@@ -3,9 +3,9 @@ module Pronto
   end
 end
 
+require_relative './tools/base'
+
 require_relative './tools/errcheck'
 require_relative './tools/golint'
-require_relative './tools/gosimple'
 require_relative './tools/govet'
-require_relative './tools/unparam'
-require_relative './tools/unused'
+require_relative './tools/staticcheck'

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

@@ -0,0 +1,43 @@
+module Pronto
+  module GolangTools
+    class Base
+      def self.base_command
+        raise 'base_command needs to be overwritten in inheritance'
+      end
+
+      def base_command
+        self.class.base_command
+      end
+
+      def initialize(config)
+        @config = config
+      end
+
+      def command(file_path)
+        "#{base_command} #{parameters}"
+      end
+
+      def parameters
+        @config.fetch('parameters', './...') # Default to './...' if the key is not configured
+      end
+
+      def available?
+        installed? && enabled?
+      end
+
+      def installed?
+        `which #{base_command}` != ""
+      end
+
+      def enabled?
+        @config.fetch('enabled', true) # Default to true if the key is not configured
+      end
+
+      def parse_line(line)
+        file_path, line_number, _, message = line.split(':')
+
+        return file_path, line_number, :warning, message.to_s.strip
+      end
+    end
+  end
+end

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

@@ -1,18 +1,10 @@
 module Pronto
   module GolangTools
-    class Errcheck
-      def command(file_path)
-        "#{base_command} ./..."
-      end
-
-      def base_command
+    class Errcheck < Base
+      def self.base_command
         'errcheck'
       end
 
-      def installed?
-        `which #{base_command}` != ""
-      end
-
       def parse_line(line)
         file_path, line_number, _, _ = line.split(':')
 

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

@@ -1,18 +1,10 @@
 module Pronto
   module GolangTools
-    class Golint
-      def command(file_path)
-        "#{base_command} ./..."
-      end
-
-      def base_command
+    class Golint < Base
+      def self.base_command
         'golint'
       end
 
-      def installed?
-        `which #{base_command}` != ""
-      end
-
       def parse_line(line)
         file_path, line_number, _, message = line.split(':')
 

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

@@ -1,16 +1,12 @@
 module Pronto
   module GolangTools
-    class Govet
-      def command(file_path)
-        "#{base_command} ./..."
-      end
-
-      def base_command
+    class Govet < Base
+      def self.base_command
         'go vet'
       end
 
-      def installed?
-        true
+      def available?
+        enabled?
       end
 
       def parse_line(line)

data/lib/pronto/golang/tools/{unused.rb → staticcheck.rb}

@@ -1,16 +1,8 @@
 module Pronto
   module GolangTools
-    class Unused
-      def command(file_path)
-        "#{base_command} ./..."
-      end
-
-      def base_command
-        'unused'
-      end
-
-      def installed?
-        `which #{base_command}` != ""
+    class Staticcheck < Base
+      def self.base_command
+        'staticcheck'
       end
 
       def parse_line(line)

data/lib/pronto/golang/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module GolangVersion
-    VERSION = '0.0.6'.freeze
+    VERSION = '0.0.7'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-golang
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -63,13 +63,13 @@ files:
 - LICENSE
 - README.md
 - lib/pronto/golang.rb
+- lib/pronto/golang/file_finder.rb
 - lib/pronto/golang/tools.rb
+- lib/pronto/golang/tools/base.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/tools/staticcheck.rb
 - lib/pronto/golang/version.rb
 homepage: https://github.com/Barzahlen/pronto-golang
 licenses:

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

@@ -1,23 +0,0 @@
-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_path, line_number, :warning, message.to_s.strip
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-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_path, line_number, :warning, message.to_s.strip
-      end
-    end
-  end
-end