guard-cookstyle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa7c641c016b0f1678e8a9cb3e2c71894629d52
+  data.tar.gz: 241418cd7783dbff5556abe1112fca1cfaaf9535
+SHA512:
+  metadata.gz: 50d6c01f906309a8a4f36d64c986cd9957be4c4a48c4eff4275505100fe93b138894ef389f2f05e6c00945078a86b45e8c5de18e9362552545ca916d2739f6d5
+  data.tar.gz: d3df5e6de2cf75e3ceb56055339f6b311934e394295f9d473e819fd870918527f226348e662fd0ca3db5558a4f4527ee2124fea47de1d5af9fa09f797b90a4f3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+- release

data/README.md

@@ -0,0 +1,95 @@
+# Guard::Cookstyle
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/guard/cookstyle`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+guard-rubocop allows you to automatically check Chef cookbook style with [Cookstyle](https://github.com/chef/cookstyle) when files are modified.
+
+Cookstyle is a wrapper of rubocop, so most of the codes were based on [yujinakayama/guard-rubocop]((https://github.com/yujinakayama/guard-rubocop)).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guard-cookstyle'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install guard-cookstyle
+```
+
+Add the default Guard::Cookstyle definition to your Guardfile by running:
+
+```
+$ guard init cookstyle
+```
+
+Rules of Rubocop definition are loaded from `.cookstyle.yml` by default.
+
+## Usage
+
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+
+## Options
+
+You can pass some options in `Guardfile` like the following example:
+
+```ruby
+guard :cookstyle, all_on_start: false, cli: ['--format', 'clang'], cookbook_dirs: ['mycookbooks'], rubocop_config: '.rubocop.yml' do
+  # ...
+end
+```
+
+### Available Options
+
+```ruby
+all_on_start: true     # Check all files at Guard startup.
+                       #   default: true
+cli: '--rails'         # Pass arbitrary Cookstyle CLI arguments. (almost same of RuboCop)
+                       # An array or string is acceptable.
+                       #   default: nil
+hide_stdout: false     # Do not display console output (in case outputting to file).
+                       #   default: false
+keep_failed: true      # Keep failed files until they pass.
+                       #   default: true
+notification: :failed  # Display Growl notification after each run.
+                       #   true    - Always notify
+                       #   false   - Never notify
+                       #   :failed - Notify only when failed
+                       #   default: :failed
+launchy: nil           # Filename to launch using Launchy after RuboCop runs.
+                       #   default: nil
+cookbook_dirs: []      # Directory of Cookbooks to check.
+                       #   default: %w[cookbooks site-cookbooks]
+rubocop_config:        # Rubocop Config path.
+                       #   default: '.cookstyle.yml'
+```
+
+### Tips
+
+In order to use it with Rubocop, we recommend that `.cookstyle.yml` inherits `.rubocop.yml` and add cookbook specific rules.
+
+```
+---
+inherit_from: .rubocop.yml
+
+... rules for cookbooks
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/higanworks/guard-cookstyle.
+
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/guard-cookstyle.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "guard/cookstyle/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-cookstyle"
+  spec.version       = GuardCookstyleVersion.to_s
+  spec.authors       = ['sawanoboly']
+  spec.email         = ['sawanoboriyu@higanworks.com']
+
+  spec.summary       = 'Guard plugin for Cookstyle'
+  spec.description   = 'Guard::Cookstyle automatically checks Ruby code style with Cookstyle when files are modified.'
+  spec.homepage      = 'https://github.com/higanworks/guard-cookstyle'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = Dir['README.md','CHANGELOG.md','guard-cookstyle.gemspec','lib/**/*']
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'guard'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/guard/cookstyle.rb

@@ -0,0 +1,100 @@
+require 'guard'
+require 'guard/plugin'
+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],
+        rubocop_config: '.cookstyle.yml',
+      }.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)
+
+      return if paths.empty?
+
+      displayed_paths = paths.map { |path| smart_path(path) }
+      UI.info "Inspecting Chef Cookbook style: #{displayed_paths.join(' ')}"
+
+      inspect_with_cookstyle(paths)
+    end
+
+    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
+
+    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
+
+    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)
+      end
+    end
+
+    def smart_path(path)
+      if path.start_with?(Dir.pwd)
+        Pathname.new(path).relative_path_from(Pathname.getwd).to_s
+      else
+        path
+      end
+    end
+  end
+end

data/lib/guard/cookstyle/monkey_patch/listen.rb

@@ -0,0 +1,13 @@
+# https://github.com/guard/listen/wiki/Duplicate-directory-errors
+if Gem::Version.new(2.8) < Gem::Version.new(Listen::VERSION)
+  require 'listen/record/symlink_detector'
+  module Listen
+    class Record
+      class SymlinkDetector
+        def _fail(_, _)
+          fail Error, "Don't watch locally-symlinked directory twice"
+        end
+      end
+    end
+  end
+end

data/lib/guard/cookstyle/runner.rb

@@ -0,0 +1,145 @@
+require 'json'
+
+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', @options[:rubocop_config]])
+        command.concat(['--format', 'json', '--out', json_file_path])
+        command << '--force-exclusion'
+        command.concat(args_specified_by_user)
+
+        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'
+          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
+
+      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)
+          end
+        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

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

data/lib/guard/cookstyle/version.rb

@@ -0,0 +1,5 @@
+module GuardCookstyleVersion
+  def self.to_s
+    '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: guard-cookstyle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sawanoboly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Guard::Cookstyle automatically checks Ruby code style with Cookstyle
+  when files are modified.
+email:
+- sawanoboriyu@higanworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- guard-cookstyle.gemspec
+- lib/guard/cookstyle.rb
+- lib/guard/cookstyle/monkey_patch/listen.rb
+- lib/guard/cookstyle/runner.rb
+- lib/guard/cookstyle/templates/Guardfile
+- lib/guard/cookstyle/version.rb
+homepage: https://github.com/higanworks/guard-cookstyle
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Guard plugin for Cookstyle
+test_files: []