rubocop-itamae 0.1.0.alpha1 → 0.1.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b0711e43b2fe39e6b0b5115686d402e602801b3df7be1cdf397d4007ba4ad8
-  data.tar.gz: de4843a38e16ab19b2f4867d866a0a97ac1e23ace11742cada1d55b287bf7e4b
+  metadata.gz: 8a6dcc9ca91e8578aacc2f1392c3c6980248910bf23ef70344444f08bf0c8845
+  data.tar.gz: 74b0f1f90551217e6e3f28f85cf903e90d2beedb9472a91a7b5fc3c11890ebf9
 SHA512:
-  metadata.gz: a684ebe47004196a3e0e203478207171f20deb418e7d0ca3afdbd503c77fa3a0bccd8bcb265cff9109efb4dc2d944aae2e30cd9d92f83e2b8c348b18092595eb
-  data.tar.gz: fe327d5b6f73761648e04f54510aef76332887f3eda1470880e473f614e49af26483f857244cf37834952433b3f891ad9e2c3224eae08c73a69d780a6f070c04
+  metadata.gz: 741d394a7a7c555c7098ee4e99438cfcf742b1ecc61d20098c823b0ac888bba8f71d3f88d4a978274d885125fee3f985f29fa57f793ebbcab532b3b2bcfd789e
+  data.tar.gz: 0e362de43e270348505adf76d17e42cac8b22e6022f1a5299e5f96880064ab317362ab00d4bee54346d47e1ce19f11f7e96a5c4ffb0a80c4112486adccf9406b

data/.coveralls.yml

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

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
-  # rubocop requires ruby 2.1+ since v0.51.0
-  # https://github.com/rubocop-hq/rubocop/commit/753227914c1ad311e6116311fc1ef76d9b0904dc
-  TargetRubyVersion: 2.1
+  # rubocop requires ruby 2.2+
+  # https://github.com/rubocop-hq/rubocop/pull/5990
+  TargetRubyVersion: 2.2
 
 Metrics/BlockLength:
   Exclude:

data/.travis.yml

@@ -1,5 +1,30 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1
+- 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

data/.yardopts

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

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://travis-ci.org/sue445/rubocop-itamae.svg?branch=master)](https://travis-ci.org/sue445/rubocop-itamae)
+[![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,13 @@ 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
+inherit_gem:
+  rubocop-itamae:
+    - config/default.yml
+```
 
 ## Development
 
@@ -32,7 +40,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/needless_default_action.rb

@@ -0,0 +1,95 @@
+# 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 < Cop
+        include RangeHelp
+
+        MSG = 'Prefer to omit the default action.'.freeze
+
+        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, location: :expression)
+              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)
+          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,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Itamae
+      # Checks whether the recipe is placed under `cookbooks` dir
+      # or `roles` dir.
+      #
+      # @example
+      #   # bad
+      #   default.rb
+      #   hoge/web.rb
+      #
+      #   # good
+      #   cookbooks/nginx/default.rb
+      #   roles/web.rb
+      #
+      class RecipePath < Cop
+        include RangeHelp
+
+        MSG = 'Prefer recipe to placed under `cookbooks` dir' \
+              ' or `roles` dir.'.freeze
+
+        def investigate(processed_source)
+          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
+        end
+
+        private
+
+        def for_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
+        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.0.alpha2'.freeze
   end
 end

data/rubocop-itamae.gemspec

@@ -25,7 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+  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 'yard'
 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.0.alpha2
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !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
+    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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 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"
 - ".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