cookstyle 4.0.0 → 5.0.0

data/lib/cookstyle.rb

@@ -1,5 +1,8 @@
 require 'cookstyle/version'
 
+require 'pathname'
+require 'yaml'
+
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
@@ -21,9 +24,19 @@ end
 # Cookstyle patches the RuboCop tool to set a new default configuration that
 # is vendored in the Cookstyle codebase.
 module Cookstyle
-  # @return [String] the absolute path to the main RuboCop configuration YAML
-  #   file
+  # @return [String] the absolute path to the main RuboCop configuration YAML file
   def self.config
     RuboCop::ConfigLoader::DEFAULT_FILE
   end
 end
+
+require 'rubocop/chef'
+require 'rubocop/chef/cookbook_only'
+
+# Chef specific cops
+require 'rubocop/cop/chef/attribute_keys'
+require 'rubocop/cop/chef/file_mode'
+require 'rubocop/cop/chef/service_resource'
+require 'rubocop/cop/chef/comments_format'
+require 'rubocop/cop/chef/comments_copyright_format'
+require 'rubocop/cop/chef/tmp_path'

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "4.0.0".freeze # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.62.0'.freeze
+  VERSION = '5.0.0'.freeze
+  RUBOCOP_VERSION = '0.72.0'.freeze
 end

data/lib/rubocop/chef.rb

@@ -0,0 +1,10 @@
+module RuboCop
+  # RuboCop Chef project namespace
+  module Chef
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'cookstyle.yml').freeze
+    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(*constants(false))
+  end
+end

data/lib/rubocop/chef/cookbook_only.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Chef
+    # Mixin for cops that skips non-cookbook files
+    #
+    # The criteria for whether rubocop-rspec analyzes a certain ruby file
+    # is configured via `AllCops/RSpec`. For example, if you want to
+    # customize your project to scan all files within a `test/` directory
+    # then you could add this to your configuration:
+    #
+    # @example configuring analyzed paths
+    #
+    #   AllCops:
+    #     RSpec:
+    #       Patterns:
+    #       - '_spec.rb$'
+    #       - '(?:^|/)spec/'
+    #
+    module CookbookOnly
+      DEFAULT_CONFIGURATION = CONFIG.fetch('AllCops')
+      COOKBOOK_SEGMENTS = %w(attributes definitions libraries metadata providers recipes resources).freeze
+
+      def relevant_file?(file)
+        cookbook_pattern =~ file && super
+      end
+
+      private
+
+      def cookbook_pattern
+        patterns = []
+        COOKBOOK_SEGMENTS.each do |segment|
+          next unless self.class.cookbook_only_segments[segment.to_sym]
+          cookbook_pattern_config(segment).each do |pattern|
+            patterns << Regexp.new(pattern)
+          end
+        end
+        Regexp.union(patterns)
+      end
+
+      def cookbook_pattern_config(segment)
+        config_key = "Chef#{segment.capitalize}"
+        config
+          .for_all_cops
+          .fetch(config_key, DEFAULT_CONFIGURATION.fetch(config_key))
+          .fetch('Patterns')
+      end
+
+      module ClassMethods
+        attr_writer :cookbook_only_segments
+
+        def cookbook_only_segments
+          @cookbook_only_segments || Hash.new(true)
+        end
+
+        def included(klass)
+          super
+          klass.extend(ClassMethods)
+        end
+      end
+
+      extend ClassMethods
+    end
+
+    def self.CookbookOnly(segments) # rubocop: disable Naming/MethodName
+      Module.new do |mod|
+        mod.define_singleton_method(:included) do |klass|
+          super(klass)
+          klass.include(CookbookOnly)
+          klass.cookbook_only_segments = segments
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/attribute_keys.rb

@@ -0,0 +1,92 @@
+#
+# Copyright:: 2016, Noah Kantrowitz
+#
+# 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
+      # Check which style of keys are used to access node attributes.
+      #
+      # There are two supported styles: "symbols" and "strings".
+      #
+      # @example when configuration is `EnforcedStyle: symbols`
+      #
+      #   # bad
+      #   node['foo']
+      #   node["foo"]
+      #
+      #   # good
+      #   node[:foo]
+      #
+      # @example when configuration is `EnforcedStyle: strings`
+      #
+      #   # bad
+      #   node[:foo]
+      #
+      #   # good
+      #   node['foo']
+      #   node["foo"]
+      #
+      class AttributeKeys < Cop
+        include RuboCop::Cop::ConfigurableEnforcedStyle
+
+        MSG = 'Use %s to access node attributes'.freeze
+
+        def_node_matcher :node_attribute_access?, <<-PATTERN
+          (send (send _ :node) :[] _)
+        PATTERN
+
+        def_node_matcher :node_level_attribute_access?, <<-PATTERN
+          (send (send {(send _ :node) nil} {:default :role_default :env_default :normal :override :role_override :env_override :force_override :automatic}) :[] _)
+        PATTERN
+
+        def on_send(node)
+          if node_attribute_access?(node) || node_level_attribute_access?(node)
+            # node is first child for #[], need to look for the outermost parent too.
+            outer_node = node
+            while outer_node.parent && outer_node.parent.type == :send && outer_node.parent.children[1] == :[]
+              on_node_attribute_access(outer_node.children[2])
+              outer_node = outer_node.parent
+            end
+            # One last time for the outer-most access.
+            on_node_attribute_access(outer_node.children[2])
+          end
+        end
+
+        def on_node_attribute_access(node)
+          if node.type == :str
+            style_detected(:strings)
+            add_offense(node, location: :expression, message: MSG % style, severity: :warning) if style == :symbols
+          elsif node.type == :sym
+            style_detected(:symbols)
+            add_offense(node, location: :expression, message: MSG % style, severity: :warning) if style == :strings
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            key_string = node.children.first.to_s
+            key_replacement = if style == :symbols
+                                key_string.to_sym.inspect
+                              else # strings
+                                key_string.inspect
+                              end
+            corrector.replace(node.loc.expression, key_replacement)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/comments_copyright_format.rb

@@ -0,0 +1,99 @@
+#
+# Copyright:: 2016, Tim Smith
+#
+# 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
+      # Checks for incorrectly formatted copyright comments.
+      #
+      # @example
+      #
+      #   # bad (assuming current year is 2016)
+      #   Copyright:: 2013-2016 Opscode, Inc.
+      #   Copyright:: 2013-2016 Chef Inc.
+      #   Copyright:: 2013-2016 Chef Software Inc.
+      #   Copyright:: 2009-2010 2013-2016 Chef Software Inc.
+      #   Copyright:: Chef Software Inc.
+      #   Copyright:: Tim Smith
+      #   Copyright:: Copyright (c) 2015-2016 Chef Software, Inc.
+      #
+      #   # good (assuming current year is 2016)
+      #   Copyright:: 2013-2016 Chef Software, Inc.
+      #   Copyright:: 2013-2016 Tim Smith
+      #   Copyright:: 2016 37Signals, Inc.
+      #
+      class CopyrightCommentFormat < Cop
+        require 'date'
+
+        MSG = 'Properly format copyrights header comments'.freeze
+
+        def investigate(processed_source)
+          return unless processed_source.ast
+          processed_source.comments.each do |comment|
+            next unless comment.inline? # headers aren't in blocks
+
+            if invalid_copyright_comment?(comment)
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :warning)
+            end
+          end
+        end
+
+        def autocorrect(comment)
+          correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+          ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
+        end
+
+        private
+
+        def copyright_date_range(comment)
+          dates = comment.text.scan(/([0-9]{4})/)
+
+          # no copyright year present so return this year
+          return Time.new.year if dates.empty?
+          oldest_date = dates.min[0].to_i
+
+          # Avoid returning THIS_YEAR - THIS_YEAR
+          if oldest_date == Time.new.year
+            oldest_date
+          else
+            "#{oldest_date}-#{Time.new.year}"
+          end
+        end
+
+        def copyright_holder(comment)
+          # Grab just the company / individual name w/o :: or dates
+          match = /(?:.*[0-9]{4}|Copyright\W*)(?:,)?(?:\s)?(.*)/.match(comment.text)
+          marketing_sanitizer(match.captures[0])
+        end
+
+        # Flush Opscode down the memory hole and Chef Inc is not a company
+        def marketing_sanitizer(name)
+          name.gsub('Opscode', 'Chef Software').gsub(/Chef(?:,)? Inc.*/, 'Chef Software, Inc.')
+        end
+
+        def invalid_copyright_comment?(comment)
+          match = /# (?:Copyright\W*)(.*)/.match(comment.text)
+          return false unless match # it's not even a copyright
+
+          current_text = match.captures[0]
+          desired_text = "#{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+
+          return true unless current_text == desired_text
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/comments_format.rb

@@ -0,0 +1,75 @@
+#
+# Copyright 2016, Tim Smith
+#
+# 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
+      # Checks for incorrectly formatted headers
+      #
+      # @example
+      #
+      #   # bad
+      #   Copyright 2013-2016 Chef Software, Inc.
+      #   Recipe default.rb
+      #   Attributes default.rb
+      #   License Apache2
+      #   Cookbook tomcat
+      #   Cookbook Name:: Tomcat
+      #   Attributes File:: default
+      #
+      #   # good
+      #   Copyright:: 2013-2016 Chef Software, Inc.
+      #   Recipe:: default.rb
+      #   Attributes:: default.rb
+      #   License:: Apache License, Version 2.0
+      #   Cookbook:: Tomcat
+      #
+      class CommentFormat < Cop
+        MSG = 'Properly format header comments'.freeze
+
+        def investigate(processed_source)
+          return unless processed_source.ast
+          processed_source.comments.each do |comment|
+            next unless comment.inline? # headers aren't in blocks
+
+            if invalid_comment?(comment)
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :warning)
+            end
+          end
+        end
+
+        def autocorrect(comment)
+          # Extract the type and the actual value. Strip out "Name" or "File"
+          # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
+          match = /^# ?([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
+          comment_type, value = match.captures
+          correct_comment = "# #{comment_type}:: #{value}"
+
+          ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
+        end
+
+        private
+
+        def invalid_comment?(comment)
+          comment_types = %w(Author Cookbook Library Attribute Copyright Recipe Resource Definition License)
+          comment_types.any? do |comment_type|
+            /^#\s*#{comment_type}\s+/.match(comment.text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/file_mode.rb

@@ -0,0 +1,63 @@
+#
+# Copyright:: 2016, Noah Kantrowitz
+#
+# 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
+      # Check the file modes are given as strings instead of integers.
+      #
+      # @example
+      #
+      #   # bad
+      #   mode 644
+      #   mode 0644
+      #
+      #   # good
+      #   mode '644'
+      #
+      class FileMode < Cop
+        MSG = 'Use strings for file modes'.freeze
+
+        def_node_matcher :resource_mode?, <<-PATTERN
+          (send nil :mode $int)
+        PATTERN
+
+        def on_send(node)
+          resource_mode?(node) do |mode_int|
+            # for post April 2020
+            # add_offense(mode_int, location: :expression, message: MSG, severity: octal?(mode_int) ? :warning : :error)
+            add_offense(mode_int, location: :expression, message: MSG, severity: :warning)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            # If it was an octal literal, make sure we write out the right number.
+            replacement_base = octal?(node) ? 8 : 10
+            replacement_mode = node.children.first.to_s(replacement_base)
+            corrector.replace(node.loc.expression, replacement_mode.inspect)
+          end
+        end
+
+        private
+
+        def octal?(node)
+          node.source =~ /^0o?\d+/i
+        end
+      end
+    end
+  end
+end