guard-cookstyle 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f12320c9b5e0c4747e14b1a13d274e0345e5b45
-  data.tar.gz: '03394b2dd0bb869b209e14ae38431067d958993a'
+  metadata.gz: f959bd06a4864041ef9cbd6d243727ce97b5d79b
+  data.tar.gz: 98aa10c88455e5f832ca8e00364b7f84b18906ed
 SHA512:
-  metadata.gz: 7319497e4cd71e9ad87e9ca6d2fd39057ef2e9d7cde6b43a737b4d3744292e23bbb44c5a5539a371223be371bcf24105a5632b6ce3b9046ccb64c3d7aa127bd0
-  data.tar.gz: e6211d1f4086e55ea3ffc0acc9a2bdbc0ffc7a2a9f4a2fc21171a5b50217ad7d1f0a88ac85cb1ddfb0cc3b0a0ff065320b66ef4de4db624fec4e00eb6e9030c6
+  metadata.gz: 4bde112d49d6224507022947e0ffc47fd2535cc36f02d6e9309ce816e49c6da536973d1ad36a67655b883d3729bc38d880701b431619d904d09c2a7741cd15c1
+  data.tar.gz: 6d1cc236f2fdc71b011b844e310a7eb49c69e64975430ff4924113d14d687b3f6618b2f1ef7f93dd934c7a53a5855752ebdea1ae776cd5cd2ad7472308f65188

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.3.0
+
+- use `-r cookstyle` to load `.rubocop.yml`.
+
+
 ## 0.2.0
 
 I noticed there was https://github.com/chef/cookstyle#guard-rubocop, so I adjusted usage.

data/guard-cookstyle.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'guard'
+  spec.add_runtime_dependency 'guard-rubocop'
   spec.add_runtime_dependency 'cookstyle'
 
   spec.add_development_dependency "bundler", "~> 1.16"

data/lib/guard/cookstyle.rb

@@ -1,98 +1,57 @@
 require 'guard'
 require 'guard/plugin'
+require 'guard/rubocop'
+require 'cookstyle'
 require "guard/cookstyle/version"
 require "guard/cookstyle/monkey_patch/listen"
 
 module Guard
-  class Cookstyle < Plugin
-    autoload :Runner, 'guard/cookstyle/runner'
-
-    attr_reader :options, :failed_paths
-
-    def initialize(options = {})
-      super
-
-      @options = {
-        all_on_start: true,
-        keep_failed:  true,
-        notification: :failed,
-        cli: nil,
-        hide_stdout: false,
-        cookbook_dirs: %w[cookbooks site-cookbooks]
-      }.merge(options)
-
-      @failed_paths = []
-    end
-
-    def start
-      run_all if @options[:all_on_start]
-    end
-
-    def run_all
-      UI.info 'Inspecting Chef Cookbook style of all files'
-      inspect_with_cookstyle
-    end
-
-    def run_on_additions(paths)
-      run_partially(paths)
-    end
-
-    def run_on_modifications(paths)
-      run_partially(paths)
-    end
-
-    def reload
-      @failed_paths = []
-    end
-
-    private
-
-    def run_partially(paths)
-      paths += @failed_paths if @options[:keep_failed]
-      paths = clean_paths(paths)
+  class Cookstyle < ::Guard::RuboCop
+    class_eval do
+      autoload :Runner, 'guard/cookstyle/runner'
+
+      def initialize(options = {})
+        super
+
+        @options = {
+          all_on_start: true,
+          keep_failed:  true,
+          notification: :failed,
+          cli: nil,
+          hide_stdout: false,
+          cookbook_dirs: %w[.]
+        }.merge(options)
+
+        @failed_paths = []
+      end
 
-      return if paths.empty?
+      def run_all
+        UI.info 'Inspecting Chef Cookbook style of all files'
+        inspect_with_cookstyle
+      end
 
-      displayed_paths = paths.map { |path| smart_path(path) }
-      UI.info "Inspecting Chef Cookbook style: #{displayed_paths.join(' ')}"
+      private
 
-      inspect_with_cookstyle(paths)
-    end
+      def run_partially(paths)
+        paths += @failed_paths if @options[:keep_failed]
+        paths = clean_paths(paths)
 
-    def inspect_with_cookstyle(paths = [])
-      runner = Runner.new(@options)
-      passed = runner.run(paths)
-      @failed_paths = runner.failed_paths
-      throw :task_has_failed unless passed
-    rescue StandardError => error
-      UI.error 'The following exception occurred while running guard-cookstyle: ' \
-               "#{error.backtrace.first} #{error.message} (#{error.class.name})"
-    end
+        return if paths.empty?
 
-    def clean_paths(paths)
-      paths = paths.dup
-      paths.map! { |path| File.expand_path(path) }
-      paths.uniq!
-      paths.reject! do |path|
-        next true unless File.exist?(path)
-        included_in_other_path?(path, paths)
-      end
-      paths
-    end
+        displayed_paths = paths.map { |path| smart_path(path) }
+        UI.info "Inspecting Chef Cookbook style: #{displayed_paths.join(' ')}"
 
-    def included_in_other_path?(target_path, other_paths)
-      dir_paths = other_paths.select { |path| File.directory?(path) }
-      dir_paths.delete(target_path)
-      dir_paths.any? do |dir_path|
-        target_path.start_with?(dir_path)
+        inspect_with_cookstyle(paths)
       end
-    end
 
-    def smart_path(path)
-      if path.start_with?(Dir.pwd)
-        Pathname.new(path).relative_path_from(Pathname.getwd).to_s
-      else
-        path
+      def inspect_with_cookstyle(paths = [])
+        runner = Runner.new(@options)
+        passed = runner.run(paths)
+        @failed_paths = runner.failed_paths
+        throw :task_has_failed unless passed
+      rescue StandardError => error
+        UI.error 'The following exception occurred while running guard-cookstyle: ' \
+                "#{error.backtrace.first} #{error.message} (#{error.class.name})"
       end
     end
   end

data/lib/guard/cookstyle/runner.rb

@@ -1,146 +1,33 @@
 require 'json'
 require 'cookstyle'
+require 'guard/rubocop/runner'
 
 module Guard
   class Cookstyle
     # This class runs `cookstyle` command, retrieves result and notifies.
     # An instance of this class is intended to invoke `cookstyle` only once in its lifetime.
-    class Runner
-      def initialize(options)
-        @options = options
-      end
-
-      def run(paths = [])
-        command = build_command(paths)
-        passed = system(*command)
-
-        case @options[:notification]
-        when :failed
-          notify(passed) unless passed
-        when true
-          notify(passed)
-        end
-
-        open_launchy_if_needed
-
-        passed
-      end
-
-      def build_command(paths)
-        command = ['cookstyle']
-
-        if should_add_default_formatter_for_console?
-          command.concat(%w[--format progress]) # Keep default formatter for console.
-        end
-
-        command.concat(['--config', ::Cookstyle.config])
-        command.concat(['--format', 'json', '--out', json_file_path])
-        command << '--force-exclusion'
-        command.concat(args_specified_by_user)
+    class Runner < ::Guard::RuboCop::Runner
+      class_eval do
+        def build_command(paths)
+          command = ['rubocop']
 
-        if paths.any?
-          command.concat(paths)
-        else
-          command.concat(@options[:cookbook_dirs])
-        end
-        command
-      end
-
-      def should_add_default_formatter_for_console?
-        !@options[:hide_stdout] && !include_formatter_for_console?(args_specified_by_user)
-      end
-
-      def args_specified_by_user
-        @args_specified_by_user ||= begin
-          args = @options[:cli]
-          case args
-          when Array    then args
-          when String   then args.shellsplit
-          when NilClass then []
-          else raise ArgumentError, ':cli option must be either an array or string'
+          if should_add_default_formatter_for_console?
+            command.concat(%w[--format progress]) # Keep default formatter for console.
           end
-        end
-      end
-
-      def include_formatter_for_console?(cli_args)
-        index = -1
-        formatter_args = cli_args.group_by do |arg|
-          index += 1 if arg == '--format' || arg.start_with?('-f')
-          index
-        end
-        formatter_args.delete(-1)
 
-        formatter_args.each_value.any? do |args|
-          args.none? { |a| a == '--out' || a.start_with?('-o') }
-        end
-      end
+          command.concat(['-r', 'cookstyle'])
+          command.concat(['--format', 'json', '--out', json_file_path])
+          command << '--force-exclusion'
+          command.concat(args_specified_by_user)
 
-      def json_file_path
-        @json_file_path ||= begin
-          # Just generate random tempfile path.
-          basename = self.class.name.downcase.gsub('::', '_')
-          tempfile = Tempfile.new(basename)
-          tempfile.close
-          tempfile.path
-        end
-      end
-
-      def result
-        @result ||= begin
-          File.open(json_file_path) do |file|
-            # Rubinius 2.0.0.rc1 does not support `JSON.load` with 3 args.
-            JSON.parse(file.read, symbolize_names: true)
+          if paths.any?
+            command.concat(paths)
+          else
+            command.concat(@options[:cookbook_dirs])
           end
+          command
         end
       end
-
-      def notify(passed)
-        image = passed ? :success : :failed
-        Notifier.notify(summary_text, title: 'Cookstyle results', image: image)
-      end
-
-      def summary_text
-        summary = result[:summary]
-
-        text = pluralize(summary[:inspected_file_count], 'file')
-        text << ' inspected, '
-
-        offense_count = summary[:offense_count] || summary[:offence_count]
-        text << pluralize(offense_count, 'offense', no_for_zero: true)
-        text << ' detected'
-      end
-
-      def failed_paths
-        failed_files = result[:files].reject do |file|
-          offenses = file[:offenses] || file[:offences]
-          offenses.empty?
-        end
-        failed_files.map do |file|
-          file[:path]
-        end
-      end
-
-      def pluralize(number, thing, options = {})
-        text = ''
-
-        if number.zero? && options[:no_for_zero]
-          text = 'no'
-        else
-          text << number.to_s
-        end
-
-        text << " #{thing}"
-        text << 's' unless number == 1
-
-        text
-      end
-
-      def open_launchy_if_needed
-        return unless (output_path = @options[:launchy])
-        return unless File.exist?(output_path)
-        require 'launchy'
-        ::Launchy.open(output_path)
-      end
     end
   end
 end

data/lib/guard/cookstyle/templates/Guardfile

@@ -1,6 +1,6 @@
 require "cookstyle"
 group :cookbooks do
-  guard :cookstyle do
+  guard :cookstyle, cookbook_dirs: %w[cookbooks site-cookbooks] do
     watch(/(cookbooks|site-cookbooks).+\.rb$/)
     watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
   end

data/lib/guard/cookstyle/version.rb

@@ -1,5 +1,5 @@
 module GuardCookstyleVersion
   def self.to_s
-    '0.2.0'
+    '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-cookstyle
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - sawanoboly
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cookstyle
   requirement: !ruby/object:Gem::Requirement