rubocop-itamae 0.1.0.alpha1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b0711e43b2fe39e6b0b5115686d402e602801b3df7be1cdf397d4007ba4ad8
-  data.tar.gz: de4843a38e16ab19b2f4867d866a0a97ac1e23ace11742cada1d55b287bf7e4b
+  metadata.gz: cb63640ad762db35c994b12f23659776f327c7438ce5b54cc256ca7610b785f2
+  data.tar.gz: 33a51ae10a510c3bc23c7c7398b8b679bf0ae9afd08ee8e58d1a25a2cba011b4
 SHA512:
-  metadata.gz: a684ebe47004196a3e0e203478207171f20deb418e7d0ca3afdbd503c77fa3a0bccd8bcb265cff9109efb4dc2d944aae2e30cd9d92f83e2b8c348b18092595eb
-  data.tar.gz: fe327d5b6f73761648e04f54510aef76332887f3eda1470880e473f614e49af26483f857244cf37834952433b3f891ad9e2c3224eae08c73a69d780a6f070c04
+  metadata.gz: f54fbdd0c2d8853dcc261aba5e6dc5082cfff91d87d4d51764c5030aa521692885f36ce01f25b2c2778afb59ded3d22c4cbe5df8c03afc6f3209baf10e62d2ee
+  data.tar.gz: 24bef86116fb59ab749e567ac3cb103369d37ebea55d508043c6dc35c43a81df3a6b1fdc646e39b0dcd32af5bfb4ed711697a9cd030887d3dda78511ba6dd66f

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: vkR421tHTHWp8ptygFoT5Uc3mV1qR3Rxb

data/.github/workflows/test.yml

@@ -0,0 +1,109 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "0 10 * * 5" # JST 19:00 (Fri)
+
+env:
+  CI: "true"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    container: ${{ matrix.ruby }}
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - ruby:2.4
+          - ruby:2.5
+          - ruby:2.6
+          - ruby:2.7
+          - rubylang/ruby:master-nightly-bionic
+        include:
+          - ruby: rubylang/ruby:master-nightly-bionic
+            allow_failures: "true"
+
+    steps:
+      - uses: actions/checkout@v2
+
+
+      - name: Cache vendor/bundle
+        uses: actions/cache@v1
+        id: cache_gem
+        with:
+          path: vendor/bundle
+          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ github.sha }}
+          restore-keys: |
+            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - name: Setup Code Climate Test Reporter
+        uses: aktions/codeclimate-test-reporter@v1
+        with:
+          codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
+          command: before-build
+        if: matrix.ruby >= 'ruby:2.4'
+        continue-on-error: true
+
+      - name: Run test
+        run: |
+          set -xe
+          bundle exec rspec
+          bundle exec rubocop -P
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - name: Teardown Code Climate Test Reporter
+        uses: aktions/codeclimate-test-reporter@v1
+        with:
+          codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
+          command: after-build
+        if: matrix.ruby >= 'ruby:2.4' && always()
+        continue-on-error: true
+
+      - name: Slack Notification (not success)
+        uses: homoluctus/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*build* ({0})', matrix.ruby) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  notify:
+    needs:
+      - test
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Slack Notification (success)
+        uses: homoluctus/slatify@master
+        if: always()
+        continue-on-error: true
+        with:
+          job_name: '*build*'
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -1,15 +1,21 @@
 AllCops:
-  # rubocop requires ruby 2.1+ since v0.51.0
-  # https://github.com/rubocop-hq/rubocop/commit/753227914c1ad311e6116311fc1ef76d9b0904dc
-  TargetRubyVersion: 2.1
+  NewCops: enable
+
+  # rubocop 0.82.0+ requires ruby 2.4+
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Exclude:
+    - "spec/spec_helper.rb"
 
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*.rb"
 
-Metrics/LineLength:
+Naming/FileName:
   Exclude:
-    - "spec/spec_helper.rb"
+    - "lib/rubocop-itamae.rb"
+    - "rubocop-itamae.gemspec"
 
 Style/HashSyntax:
   Exclude:

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## master
-[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.0...master)
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.3...master)
+
+## v0.1.3
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.2...v0.1.3)
+
+* Fixed. failed spec since rubocop v0.87.0
+  * https://github.com/sue445/rubocop-itamae/pull/47
+* Migrate to rubocop v1 syntax
+  * https://github.com/sue445/rubocop-itamae/pull/46
+
+## v0.1.2
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.1...v0.1.2)
+
+* Upgrade rubocop and drop ruby 2.3
+  * https://github.com/sue445/rubocop-itamae/pull/43
+
+## v0.1.1
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.0...v0.1.1)
+
+* Fix can't load `RangeHelp` error
+  * https://github.com/sue445/rubocop-itamae/pull/16
 
 ## v0.1.0
 * first release

data/README.md

@@ -1,8 +1,11 @@
 # RuboCop::Itamae
 
-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/rubocop/itamae`. To experiment with that code, run `bin/console` for an interactive prompt.
+Code style checking for [itamae](https://github.com/itamae-kitchen/itamae) recipes
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/rubocop-itamae.svg)](https://badge.fury.io/rb/rubocop-itamae)
+[![Build Status](https://github.com/sue445/rubocop-itamae/workflows/test/badge.svg?branch=master)](https://github.com/sue445/rubocop-itamae/actions?query=workflow%3Atest)
+[![Coverage Status](https://coveralls.io/repos/github/sue445/rubocop-itamae/badge.svg?branch=master)](https://coveralls.io/github/sue445/rubocop-itamae?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bf2f4b2cbf9c2cfc0e92/maintainability)](https://codeclimate.com/github/sue445/rubocop-itamae/maintainability)
 
 ## Installation
 
@@ -21,8 +24,11 @@ Or install it yourself as:
     $ gem install rubocop-itamae
 
 ## Usage
+Add this line to your application's `.rubocop.yml`
 
-TODO: Write usage instructions here
+```yml
+require: rubocop-itamae
+```
 
 ## Development
 
@@ -32,7 +38,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-itamae.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/rubocop-itamae.
 
 ## License
 

data/config/default.yml

@@ -7,3 +7,13 @@ Itamae/CommandEqualsToName:
   Description: Check that `command` doesn't equals to name of `execute`.
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-itamae/RuboCop/Cop/Itamae/CommandEqualsToName
+
+Itamae/NeedlessDefaultAction:
+  Description: Checks whether default action is written for resource.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-itamae/RuboCop/Cop/Itamae/NeedlessDefaultAction
+
+Itamae/RecipePath:
+  Description: Checks whether the recipe is placed under `cookbooks` dir or `roles` dir.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-itamae/RuboCop/Cop/Itamae/RecipePath

data/lib/rubocop/cop/itamae/cd_in_execute.rb

@@ -13,8 +13,8 @@ module RuboCop
       #   execute 'rm -rf /tmp/*' do
       #     cwd '/tmp'
       #   end
-      class CdInExecute < Cop
-        MSG = "Insert `cwd '%<dir>s'` and remove this.".freeze
+      class CdInExecute < Base
+        MSG = "Insert `cwd '%<dir>s'` and remove this."
 
         def_node_search :find_execute_with_block, <<-PATTERN
           (block
@@ -51,14 +51,13 @@ module RuboCop
         end
 
         def on_send(node)
-          return if node.parent && node.parent.block_type?
+          return if node.parent&.block_type?
 
           find_execute_without_block(node) do |name|
             add_offense_for_execute_name(node, name)
           end
         end
 
-        # rubocop:disable Metrics/LineLength
         # def autocorrect(node)
         #   if node.block_type?
         #     lambda do |corrector|
@@ -103,7 +102,6 @@ module RuboCop
         #     end
         #   end
         # end
-        # rubocop:enable Metrics/LineLength
 
         private
 
@@ -112,7 +110,7 @@ module RuboCop
           return unless dir
 
           loc = cd_location(node.child_nodes.first, name)
-          add_offense(node, message: format(MSG, dir: dir), location: loc)
+          add_offense(loc, message: format(MSG, dir: dir))
         end
 
         def add_offence_for_execute_block_name(node, name)
@@ -120,7 +118,7 @@ module RuboCop
           return unless dir
 
           loc = cd_location(node.child_nodes.first.child_nodes.first, name)
-          add_offense(node, message: format(MSG, dir: dir), location: loc)
+          add_offense(loc, message: format(MSG, dir: dir))
         end
 
         def add_offense_for_command_param(param_node, command)
@@ -135,7 +133,7 @@ module RuboCop
             end
 
           loc = cd_location(command_node, command)
-          add_offense(param_node, message: format(MSG, dir: dir), location: loc)
+          add_offense(loc, message: format(MSG, dir: dir))
         end
 
         def cd_dir_in_command(command)

data/lib/rubocop/cop/itamae/command_equals_to_name.rb

@@ -17,11 +17,12 @@ module RuboCop
       #   execute 'Remove temporary files' do
       #     command 'rm -rf /tmp/*'
       #   end
-      class CommandEqualsToName < Cop
+      class CommandEqualsToName < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Prefer to omit `command` if `command` equals to ' \
-              'name of `execute`'.freeze
+              'name of `execute`'
 
         def_node_search :find_execute, <<-PATTERN
           (block
@@ -45,27 +46,27 @@ module RuboCop
               find_command(param_node) do |command|
                 next unless name == command
 
-                add_offense(param_node, location: :expression)
+                add_param_node_offense(param_node)
               end
             end
           end
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            if node.begin_type?
-              node.each_child_node do |param_node|
-                remove_command_param(corrector, node.parent, param_node)
+        private
+
+        def add_param_node_offense(param_node)
+          add_offense(param_node.loc.expression) do |corrector|
+            if param_node.begin_type?
+              param_node.each_child_node do |child_param_node|
+                remove_command_param(corrector, param_node.parent, child_param_node)
               end
 
-            elsif node.send_type?
-              remove_command_param(corrector, node.parent, node)
+            elsif param_node.send_type?
+              remove_command_param(corrector, param_node.parent, param_node)
             end
           end
         end
 
-        private
-
         def remove_command_param(corrector, parent_node, param_node)
           find_execute(parent_node) do |name|
             find_command(param_node) do |command|

data/lib/rubocop/cop/itamae/needless_default_action.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Itamae
+      # Checks whether default action is written for resource.
+      #
+      # @example
+      #   # bad
+      #   package 'git' do
+      #     action :install
+      #   end
+      #
+      #   # good
+      #   package 'git' do
+      #   end
+      #
+      #   package 'git'
+      #
+      class NeedlessDefaultAction < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Prefer to omit the default action.'
+
+        RESOURCE_DEFAULT_ACTIONS = {
+          directory: :create,
+          execute: :run,
+          file: :create,
+          gem_package: :install,
+          git: :sync,
+          group: :create,
+          http_request: :create,
+          link: :create,
+          local_ruby_block: :run,
+          package: :install,
+          remote_directory: :create,
+          remote_file: :create,
+          service: :nothing,
+          template: :create,
+          user: :create
+        }.freeze
+
+        def_node_search :find_resource, <<-PATTERN
+          (block
+            (send nil? ${:directory :execute :file :gem_package :git :group :http_request :link :local_ruby_block :package :remote_directory :remote_file :service :template :user}
+              (...)
+            )
+            args
+            $...
+          )
+        PATTERN
+
+        def_node_search :find_action, <<-PATTERN
+          (send nil? :action
+            (sym $_)
+          )
+        PATTERN
+
+        def on_block(node)
+          find_resource(node) do |resource, param_nodes|
+            param_nodes.compact.each do |param_node|
+              find_action(param_node) do |action|
+                next unless action == RESOURCE_DEFAULT_ACTIONS[resource]
+
+                add_offense(param_node.loc.expression) do |corrector|
+                  remove_action_param(corrector, param_node.parent, param_node) if param_node.send_type?
+                end
+              end
+            end
+          end
+        end
+
+        private
+
+        def remove_action_param(corrector, parent_node, param_node)
+          find_resource(parent_node) do |resource|
+            find_action(param_node) do |action|
+              next unless action == RESOURCE_DEFAULT_ACTIONS[resource]
+
+              corrector.remove(node_range(param_node))
+            end
+          end
+        end
+
+        def node_range(node)
+          range_by_whole_lines(node.source_range, include_final_newline: true)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/itamae/recipe_path.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Itamae
+      # Checks whether the recipe is placed under `cookbooks` dir
+      # or `roles` dir.
+      #
+      # @see https://github.com/itamae-kitchen/itamae/wiki/Best-Practice#directory-structure
+      #
+      # @example
+      #   # bad
+      #   default.rb
+      #   hoge/web.rb
+      #
+      #   # good
+      #   cookbooks/nginx/default.rb
+      #   roles/web.rb
+      #
+      class RecipePath < Base
+        include RangeHelp
+
+        MSG = 'Prefer recipe to placed under `cookbooks` dir' \
+              ' or `roles` dir.'
+
+        def on_new_investigation
+          file_path = processed_source.file_path
+          return if config.file_to_include?(file_path)
+
+          add_global_offense if bad_filename?(file_path)
+        end
+
+        private
+
+        def bad_filename?(file_path)
+          return unless File.extname(file_path) == '.rb'
+
+          !file_path.match?(%r{/(cookbooks|roles)/})
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/itamae_cops.rb

@@ -2,3 +2,5 @@
 
 require_relative 'itamae/cd_in_execute'
 require_relative 'itamae/command_equals_to_name'
+require_relative 'itamae/needless_default_action'
+require_relative 'itamae/recipe_path'

data/lib/rubocop/itamae/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Itamae
-    VERSION = '0.1.0.alpha1'.freeze
+    VERSION = '0.1.3'
   end
 end

data/rubocop-itamae.gemspec

@@ -22,10 +22,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop'
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry-byebug'
+  spec.add_dependency 'rubocop', '>= 0.87.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '>= 11.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '>= 0.84.0'
+  spec.add_development_dependency 'rubocop_auto_corrector'
+  spec.add_development_dependency 'simplecov', '< 0.18.0'
+  spec.add_development_dependency 'yard'
 end

data/tasks/new_cop.rake

@@ -20,7 +20,7 @@ task :new_cop, [:cop] do |_task, args|
 
   begin
     generator.inject_config(config_file_path: 'config/default.yml')
-  rescue TypeError # rubocop:disable Lint/HandleExceptions
+  rescue TypeError
     # nop
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-itamae
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha1
+  version: 0.1.3
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2020-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.87.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.87.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: pry-byebug
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+- !ruby/object:Gem::Dependency
+  name: rubocop_auto_corrector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Code style checking for itamae recipes
 email:
 - sue445@sue445.net
@@ -87,10 +143,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -102,6 +160,8 @@ files:
 - lib/rubocop-itamae.rb
 - lib/rubocop/cop/itamae/cd_in_execute.rb
 - lib/rubocop/cop/itamae/command_equals_to_name.rb
+- lib/rubocop/cop/itamae/needless_default_action.rb
+- lib/rubocop/cop/itamae/recipe_path.rb
 - lib/rubocop/cop/itamae_cops.rb
 - lib/rubocop/itamae.rb
 - lib/rubocop/itamae/version.rb
@@ -119,15 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Code style checking for itamae recipes

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1