RubyGems - cookstyle - Versions diffs - 7.32.2 → 7.32.7 - Mend

cookstyle 7.32.2 → 7.32.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (261) hide show

data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   platform?('redhat') || platform?('ubuntu')
         #   platform_family?('debian') || platform_family?('rhel')
         #
-        #   #### correct
+        #   ### correct
         #   platform?('redhat', 'ubuntu')
         #   platform_family?('debian', 'rhel')
         #

data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb CHANGED Viewed

@@ -51,11 +51,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :config_file, String, required: true, name_property: true
         #   attribute :config_file, String, required: true, name_attribute: true
         #
-        #   #### correct
+        #   ### correct
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Base

data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node['platform'].to_s
         #   node['platform_family'].to_s
         #   node['platform_version'].to_s
@@ -32,7 +32,7 @@ module RuboCop
         #   node['os'].to_s
         #   node['name'].to_s
         #
-        #   #### correct
+        #   ### correct
         #   node['platform']
         #   node['platform_family']
         #   node['platform_version']

data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :config_file, String, regex: /.*/
         #   attribute :config_file, String, regex: /.*/
         #
-        #   #### correct
+        #   ### correct
         #   property :config_file, String
         #   attribute :config_file, String
         #

data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb CHANGED Viewed

@@ -26,10 +26,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :bob, String, required: true, default: 'foo'
         #
-        #   #### correct
+        #   ### correct
         #   property :bob, String, required: true
         #
         class PropertyWithRequiredAndDefault < Base

data/lib/rubocop/cop/chef/redundant/provides_metadata.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect in metadata.rb:
+        #   ### incorrect in metadata.rb:
         #
         #   provides "some_thing"
         #

data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   recipe 'openldap::default', 'Install and configure OpenLDAP'
         #
         #

data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect in metadata.rb:
+        #   ### incorrect in metadata.rb:
         #
         #   replaces "another_cookbook"
         #

data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   action :nothing
         #     # let's do nothing
         #   end

data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        # #### incorrect
+        # ### incorrect
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Base

data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :config_file, String, default: nil
         #   property :config_file, [String, NilClass], default: nil
         #
-        #   #### correct
+        #   ### correct
         #   property :config_file, String
         #   property :config_file, [String, NilClass]
         #

data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect in metadata.rb:
+        #   ### incorrect in metadata.rb:
         #
         #   suggests "another_cookbook"
         #

data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :foo, String, desired_state: true
         #   attribute :foo, String, desired_state: true
         #
-        #   #### correct
+        #   ### correct
         #   property :foo, String
         #   attribute :foo, String
         #

data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :name, String
         #   property :name, String, name_property: true
         #   attribute :name, kind_of: String

data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'
@@ -41,7 +41,7 @@ module RuboCop
         #     not_if { ::File.exist?('/foo/bar') }
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'

data/lib/rubocop/cop/chef/security/ssh_private_key.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   file '/Users/bob_bobberson/.ssh/id_rsa' do
         #     content '-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----'
         #     mode '600'

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   maintainer 'YOUR_COMPANY_NAME'
         #   maintainer_email 'YOUR_EMAIL'
         #   maintainer 'The Authors'
         #   maintainer_email 'you@example.com'
-        #   #### correct
+        #   ### correct
         #   maintainer 'Bob Bobberson'
         #   maintainer_email 'bob@bobberson.com'
         #

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   license ''
         #
-        #   #### correct
+        #   ### correct
         #   license 'Apache-2.0'
         #
         class EmptyMetadataField < Base

data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :foo, String
         #
-        #   #### correct
+        #   ### correct
         #   property :foo, String, description: "Set the important thing to..."
         #
         class IncludePropertyDescriptions < Base

data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### correct
+        #   ### correct
         #   resource_name :foo
         #   description "The foo resource is used to do..."
         #

data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### correct
+        #   ### correct
         #   examples <<~DOC
         #     **Specify a global domain value**
         #

data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   source_url 'http://github.com/something/something'
         #   source_url 'http://www.github.com/something/something'
         #   source_url 'http://www.gitlab.com/something/something'
         #   source_url 'http://gitlab.com/something/something'
         #
-        #   #### correct
+        #   ### correct
         #   source_url 'http://github.com/something/something'
         #   source_url 'http://gitlab.com/something/something'
         #

data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   license 'Apache 2.0'
         #
-        #   #### correct
+        #   ### correct
         #   license 'Apache-2.0'
         #   license 'all rights reserved'
         #

data/lib/rubocop/cop/chef/style/attribute_keys.rb CHANGED Viewed

@@ -24,19 +24,19 @@ module RuboCop
         #
         # @example when configuration is `EnforcedStyle: symbols`
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node['foo']
         #   node["foo"]
         #
-        #   #### correct
+        #   ### correct
         #   node[:foo]
         #
         # @example when configuration is `EnforcedStyle: strings`
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node[:foo]
         #
-        #   #### correct
+        #   ### correct
         #   node['foo']
         #   node["foo"]
         #

data/lib/rubocop/cop/chef/style/chef_whaaat.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   Chef makes software
         #   Chef configures your systems
         #
-        #   #### correct
+        #   ### correct
         #   Chef Software makes software
         #   Chef Infra configures your systems
         #

data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb CHANGED Viewed

@@ -30,7 +30,7 @@ module RuboCop
             processed_source.comments.each do |comment|
               next unless comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
-              add_offense(comment, location: comment, severity: :refactor) do |corrector|
+              add_offense(comment, severity: :refactor) do |corrector|
                 corrector.replace(comment, comment.text.gsub('.  ', '. ').gsub('?  ', '? '))
               end
             end

data/lib/rubocop/cop/chef/style/comments_copyright_format.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   Copyright:: 2013-2022 Opscode, Inc.
         #   Copyright:: 2013-2022 Chef Inc.
         #   Copyright:: 2013-2022 Chef Software Inc.
@@ -32,7 +32,7 @@ module RuboCop
         #   Copyright:: Tim Smith
         #   Copyright:: Copyright (c) 2015-2022 Chef Software, Inc.
         #
-        #   #### correct
+        #   ### correct
         #   Copyright:: 2013-2022 Chef Software, Inc.
         #   Copyright:: 2013-2022 Tim Smith
         #   Copyright:: 2019 37Signals, Inc.

data/lib/rubocop/cop/chef/style/comments_default_copyright.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   Copyright:: 2019 YOUR_NAME
         #   Copyright:: 2019 YOUR_COMPANY_NAME
         #
-        #   #### correct
+        #   ### correct
         #   Copyright:: 2019 Tim Smith
         #   Copyright:: 2019 Chef Software, Inc.
         #

data/lib/rubocop/cop/chef/style/comments_format.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   Copyright 2013-2016 Chef Software, Inc.
         #   Recipe default.rb
         #   Attributes default.rb
@@ -32,7 +32,7 @@ module RuboCop
         #   Cookbook Name:: Tomcat
         #   Attributes File:: default
         #
-        #   #### correct
+        #   ### correct
         #   Copyright:: 2013-2016 Chef Software, Inc.
         #   Recipe:: default.rb
         #   Attributes:: default.rb

data/lib/rubocop/cop/chef/style/file_mode.rb CHANGED Viewed

@@ -22,7 +22,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   remote_directory '/etc/my.conf' do
         #     content 'some content'
         #     mode 0600
@@ -36,7 +36,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   remote_directory '/etc/my.conf' do
         #     content 'some content'
         #     mode '600'

data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediate
         #   end
         #
-        #   #### correct
+        #   ### correct
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   include_recipe('foo::bar')
         #
-        #   #### correct
+        #   ### correct
         #   include_recipe 'foo::bar'
         #
         class IncludeRecipeWithParentheses < Base

data/lib/rubocop/cop/chef/style/negating_only_if.rb CHANGED Viewed

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   package 'legacy-sysv-deps' do
         #     only_if { !systemd }
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   package 'legacy-sysv-deps' do
         #     not_if { systemd }
         #   end

data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #
         #   %w( debian ubuntu ).each do |os|
         #     supports os
@@ -33,7 +33,7 @@ module RuboCop
         #     depends cb
         #   end
         #
-        #   #### correct
+        #   ### correct
         #
         #   supports 'debian'
         #   supports 'ubuntu'

data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node['platform_version'].split('.').first
         #   node['platform_version'].split('.')[0]
         #   node['platform_version'].split('.').first.to_i
         #   node['platform_version'].split('.')[0].to_i
         #
-        #   #### correct
+        #   ### correct
         #
         #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
         #   if node['platform_version'].to_i == 7

data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   property :foo, [TrueClass, FalseClass]
         #
-        #   #### correct
+        #   ### correct
         #   property :foo, [true, false]
         #
         class TrueClassFalseClassResourceProperties < Base

data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node['os'] == 'darwin'
         #   node['os'] == 'windows'
         #   node['os'].eql?('aix')
         #   %w(netbsd openbsd freebsd).include?(node['os'])
         #
-        #   #### correct
+        #   ### correct
         #   platform_family?('mac_os_x')
         #   platform_family?('windows')
         #   platform_family?('aix')

data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   case node['platform']
         #   when 'ubuntu'
         #     log "We're on Ubuntu"
@@ -35,7 +35,7 @@ module RuboCop
         #     include_recipe 'yum'
         #   end
         #
-        #   #### correct
+        #   ### correct
         #   if platform?('ubuntu')
         #     log "We're on Ubuntu"
         #     apt_update

data/lib/rubocop/cop/chef/style/use_platform_helpers.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   #### incorrect
+        #   ### incorrect
         #   node['platform'] == 'ubuntu'
         #   node['platform_family'] == 'debian'
         #   node['platform'] != 'ubuntu'
@@ -31,7 +31,7 @@ module RuboCop
         #   %w(rhel suse).include?(node['platform_family'])
         #   node['platform'].eql?('ubuntu')
         #
-        #   #### correct
+        #   ### correct
         #   platform?('ubuntu')
         #   !platform?('ubuntu')
         #   platform_family?('debian')

data/lib/rubocop/cop/chefstyle/ruby/gemspec_license.rb ADDED Viewed

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Ruby
+        # All gemspec files should define their license.
+        #
+        # @example
+        #
+        #   # good
+        #   spec.license = "Apache-2.0"
+        #
+        class GemspecLicense < Base
+          include RangeHelp
+          MSG = 'All gemspec files should define their license.'
+          def_node_search :license, <<~PATTERN
+            (send _ {:license= :licenses=} _)
+          PATTERN
+          def_node_search :eval_method, <<~PATTERN
+            (send nil? {:eval :instance_eval} ... )
+          PATTERN
+          def on_new_investigation
+            # exit if we find a license statement or any eval since that usually happens
+            # when we have a windows platform gem that evals the main gemspec
+            return if license(processed_source.ast).first || eval_method(processed_source.ast).first
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, message: MSG, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end