Sha256: fad48760f64147b6659d268e1bf029beff88cd7369dc29ba9332c9e9d9596107

Contents?: true

Size: 1.78 KB

Versions: 12

Compression:

Stored size: 1.78 KB

Contents

#
# Copyright:: 2020, Chef Software, Inc.
# Author:: Tim Smith (<tsmith@chef.io>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module RuboCop
  module Cop
    module Chef
      module ChefModernize
        # Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
        #
        # @example
        #
        #   # bad
        #   node['roles'].include?('foo')
        #
        #   # good
        #   node.role?('foo')
        #
        class NodeRolesInclude < Cop
          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.".freeze

          def_node_matcher :node_role_include?, <<-PATTERN
          (send
            (send
              (send nil? :node) :[]
              (str "roles")) :include?
            $(...))
          PATTERN

          def on_send(node)
            node_role_include?(node) do
              add_offense(node, location: :expression, message: MSG, severity: :refactor)
            end
          end

          def autocorrect(node)
            lambda do |corrector|
              node_role_include?(node) do |val|
                corrector.replace(node.loc.expression, "node.role?(#{val.source})")
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
cookstyle-6.11.4 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.10.2 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.9.0 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.8.0 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.7.3 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.6.9 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.5.3 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.4.4 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.3.4 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.2.9 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.2.5 lib/rubocop/cop/chef/modernize/node_roles_include.rb
cookstyle-6.1.6 lib/rubocop/cop/chef/modernize/node_roles_include.rb