rubocop-itamae 0.1.0.alpha2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a6dcc9ca91e8578aacc2f1392c3c6980248910bf23ef70344444f08bf0c8845
-  data.tar.gz: 74b0f1f90551217e6e3f28f85cf903e90d2beedb9472a91a7b5fc3c11890ebf9
+  metadata.gz: c0545cb256f4f5641e6587cf42e66b4a86593ee93309b6427d82aae32144d5ff
+  data.tar.gz: 05addbf3baaac6c8c6746a2357754533daddec4e4bb01db38208abd8fbc377a9
 SHA512:
-  metadata.gz: 741d394a7a7c555c7098ee4e99438cfcf742b1ecc61d20098c823b0ac888bba8f71d3f88d4a978274d885125fee3f985f29fa57f793ebbcab532b3b2bcfd789e
-  data.tar.gz: 0e362de43e270348505adf76d17e42cac8b22e6022f1a5299e5f96880064ab317362ab00d4bee54346d47e1ce19f11f7e96a5c4ffb0a80c4112486adccf9406b
+  metadata.gz: a573df0167945879e173318f7c6e305bc31864a36fa269bf98792e09f29add35cb24bfe73ebc1d766db0436e0b148c6cb6f3a0819ddac984967f414cd65c17a2
+  data.tar.gz: a643297e792c09258e0855686c7ed071492c2a1e51a8730ae68fc9cb2f1ff2c29483c192f4879baeb05d6f4a5b27f5d164a2cd4dd695f7c040eec144148c47b1

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.5
+          - ruby:2.6
+          - ruby:2.7
+          - ruby:3.0
+          - 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: lazy-actions/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: lazy-actions/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,22 @@
 AllCops:
-  # rubocop requires ruby 2.2+
-  # https://github.com/rubocop-hq/rubocop/pull/5990
-  TargetRubyVersion: 2.2
+  NewCops: enable
+  SuggestExtensions: false
+
+  # rubocop 1.13.0+ requires ruby 2.5+
+  TargetRubyVersion: 2.5
+
+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/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## 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.4...master)
+
+## v0.1.4
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.3...v0.1.4)
+
+* Requires rubocop 1.13.0+ and drop ruby 2.4
+  * https://github.com/sue445/rubocop-itamae/pull/51
+
+## 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

@@ -3,7 +3,7 @@
 Code style checking for [itamae](https://github.com/itamae-kitchen/itamae) recipes
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-itamae.svg)](https://badge.fury.io/rb/rubocop-itamae)
-[![Build Status](https://travis-ci.org/sue445/rubocop-itamae.svg?branch=master)](https://travis-ci.org/sue445/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)
 
@@ -27,9 +27,7 @@ Or install it yourself as:
 Add this line to your application's `.rubocop.yml`
 
 ```yml
-inherit_gem:
-  rubocop-itamae:
-    - config/default.yml
+require: rubocop-itamae
 ```
 
 ## Development

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

@@ -17,27 +17,28 @@ module RuboCop
       #
       #   package 'git'
       #
-      class NeedlessDefaultAction < Cop
+      class NeedlessDefaultAction < Base
         include RangeHelp
+        extend AutoCorrector
 
-        MSG = 'Prefer to omit the default action.'.freeze
+        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,
+          directory: :create,
+          execute: :run,
+          file: :create,
+          gem_package: :install,
+          git: :sync,
+          group: :create,
+          http_request: :create,
+          link: :create,
           local_ruby_block: :run,
-          package:          :install,
+          package: :install,
           remote_directory: :create,
-          remote_file:      :create,
-          service:          :nothing,
-          template:         :create,
-          user:             :create
+          remote_file: :create,
+          service: :nothing,
+          template: :create,
+          user: :create
         }.freeze
 
         def_node_search :find_resource, <<-PATTERN
@@ -62,18 +63,14 @@ module RuboCop
               find_action(param_node) do |action|
                 next unless action == RESOURCE_DEFAULT_ACTIONS[resource]
 
-                add_offense(param_node, location: :expression)
+                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
 
-        def autocorrect(node)
-          lambda do |corrector|
-            remove_action_param(corrector, node.parent, node) if node.send_type?
-          end
-        end
-
         private
 
         def remove_action_param(corrector, parent_node, param_node)

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

@@ -6,6 +6,8 @@ module RuboCop
       # 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
@@ -15,28 +17,25 @@ module RuboCop
       #   cookbooks/nginx/default.rb
       #   roles/web.rb
       #
-      class RecipePath < Cop
+      class RecipePath < Base
         include RangeHelp
 
         MSG = 'Prefer recipe to placed under `cookbooks` dir' \
-              ' or `roles` dir.'.freeze
+              ' or `roles` dir.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           file_path = processed_source.file_path
           return if config.file_to_include?(file_path)
 
-          for_bad_filename(file_path) do |range, msg|
-            add_offense(nil, location: range, message: msg)
-          end
+          add_global_offense if bad_filename?(file_path)
         end
 
         private
 
-        def for_bad_filename(file_path)
+        def bad_filename?(file_path)
           return unless File.extname(file_path) == '.rb'
-          return if file_path =~ %r{/(cookbooks|roles)/}
 
-          yield source_range(processed_source.buffer, 1, 0), MSG
+          !file_path.match?(%r{/(cookbooks|roles)/})
         end
       end
     end

data/lib/rubocop/itamae/version.rb

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

data/rubocop-itamae.gemspec

@@ -22,14 +22,15 @@ 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.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+  spec.add_dependency 'rubocop', '>= 1.13.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 11.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov'
+  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.alpha2
+  version: 0.1.4
 platform: ruby
 authors:
 - sue445
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,42 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.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: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop_auto_corrector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +94,20 @@ dependencies:
     - - ">="
       - !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
@@ -144,10 +130,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -171,7 +157,7 @@ homepage: https://github.com/sue445/rubocop-itamae
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,16 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.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
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Code style checking for itamae recipes
 test_files: []

data/.travis.yml

@@ -1,30 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-- ruby-head
-bundler_args: "--jobs=4"
-cache: bundler
-before_install:
-- gem update --system --no-document
-- gem install bundler --no-document
-before_script:
-- export CODECLIMATE_REPO_TOKEN=7e9993b9f657bb33552e76a7b9c8292541cf9a5d8d6811f585f6cfbc0785c820
-before_script:
-script:
-- bundle exec rspec
-- bundle exec codeclimate-test-reporter
-- bundle exec rubocop
-branches:
-  only:
-  - master
-notifications:
-  email: false
-  slack:
-    secure: eKV6s6mQEb3T9qeatHvUMvAQPVOn+hjvdPl+v+1RYQaC/kgTMpLkCwRPokrDYiK51/HgMSH1cPGVl6QfoqaJvdHKdZtuAmikVeqhygablFPdLYuseMTHTr9zT9MOoEzSbyzO9tUTL3jIHeLIrXdBhVJ/YCw/9uWIlA10iFDE0KZ8WiPIIAJ34GORnzIqIASHY5zGKhiIqer1xeNecXXhTBcnUYzOhN7qBYCRl0yYL11NIy7xh50DLcKSYYAIUr6oBYOI6QeSe/0cZGOGst0JfHE5jQvT/3O6wMK2lGnrXovXuL4JIbFT6bODo9XyzSSkyy/P1wqPe8hpY7Thh4qyt1r+tRdO8oBdkxdzQTopRgemyc3wOa/5mE7keEXJh8V1TPCi4yfa/rfXxLSXmXYGXa3q8TBwDkxmWFd1Ej2KV3e3c1AVVqp7cqflq12HH6v2XHPXHyX6zZszOKpDjELCc2SZ49jx+D1tg15YHJ+Q8FIyUVAvyjD1bW7z+v8fsXqViyhwrue11jVsdpfSy0ZaXwtiSC7RyUwX7u/TdnHbMKRaGNQ9GHyqfirT+f7tcnHxGqBIpR5oqnnFnNEfVTxm+k1YmX4VY5q2kVn0jT8GDyRygUHAhFMOxGg2g85/sFxSx1bJD9pRUDTX3cHgxMhmEj7z0aI7gfEZW+NrqJO5AX8=
-matrix:
-  allow_failures:
-  - rvm: ruby-head