foodcritic 10.4.0 → 10.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d188b03aeb991046c706c71cbebe4862c1dc56dd
-  data.tar.gz: c401c48d43ea472d45fc24c849202f33c5c6297f
+  metadata.gz: 6be21ce54a9247d8ab5fb96fa65056e1b4031a32
+  data.tar.gz: 2de7963ef01d1170af9ca58bf88ba381d057391f
 SHA512:
-  metadata.gz: 2505ff285da8b29cd42dd8884954c9b47ec01c1213e4c2fe6ea6a8efff71a58c52db0ef665629c0b236f318819ada2d023e566c0bf5f4573c3c3ace4bdd81046
-  data.tar.gz: 011375b9f658bc3afb31ae51ae84ac3e4742b38e0d20ff2fce7b04024f42425edb1feff5cf358cbda3da5860893f45c38f7cb1bfd19c72c98dccf030ad6cfeff
+  metadata.gz: 194e8fb9cdc2e0372cddedd2290c14608a1395c9f7669fc256d4570ed20494ea0d2236b5ce9469a4f0811410a09308c6332e1773c8317366d0840d97156a5601
+  data.tar.gz: bf129cbbab3b85414d432e64ee7c04edcf413158494cf076ab3323c89442df3290221973844e2d4c9eaf7af0f2212e885d58a389b89d523c2d8cbe9103727205

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Foodcritic Changelog:
 
+## [10.4.0](https://github.com/acrmp/foodcritic/tree/v10.4.1) (2017-04-17)
+
+[Full Changelog](https://github.com/acrmp/foodcritic/compare/v10.4.0...v10.4.1)
+
+**Implemented enhancements:**
+
+- Removed the development dependency on github_changelog_generator
+
+**Fixed bugs:**
+
+- Fixed running cucumber tests using the cucumber CLI command
+- Fixed FC016 incorrectly firing on custom resources that have no properties. FC016 will now skip over resources that have any actions as those are custom resources and custom resources don't need to declare a default_action.
+- Added the missing chef13 tag to FC018
+- Updated FC028 to detect both `node.platform_family?` in addition to the existing `node.platform?` usage. This rule has also been renamed and tags updated since the use of `node.platform?` is a style issue and not a correctness issue. Both `node.platform?` and `platform?` are acceptable in cookbooks.
+- Fixed FC071 to not alert for cookbooks where the license is 'all rights reserved' in addition to the existing allowed 'All Rights Reserved' string
+- Fixed FC071 to detect the LICENSE file if foodcritic is not running in the root of the cookbook
+- Fixed FC070 to not alert when platform supports is defined through an array of platforms
+
 ## [10.4.0](https://github.com/acrmp/foodcritic/tree/v10.4.0) (2017-04-13)
 
 [Full Changelog](https://github.com/acrmp/foodcritic/compare/v10.3.1...v10.4.0)
@@ -53,7 +71,7 @@
 
 **Implemented enhancements:**
 
-- Align rake setup better with CLI options to resolve bugs with tags in Rake [\#533](https://github.com/acrmp/foodcritic/pull/533) ([tas50](https://github.com/tas50))
+- Align rake setup better with CLI options to resolve bugs with tags in Rake [#533](https://github.com/acrmp/foodcritic/pull/533) ([tas50](https://github.com/tas50))
 
 ## [v10.2.1](https://github.com/acrmp/foodcritic/tree/v10.2.1) (2017-03-31)
 
@@ -61,7 +79,7 @@
 
 **Implemented enhancements:**
 
-- Add supermarket tag to FC067 and FC068 [\#532](https://github.com/acrmp/foodcritic/pull/532) ([tas50](https://github.com/tas50))
+- Add supermarket tag to FC067 and FC068 [#532](https://github.com/acrmp/foodcritic/pull/532) ([tas50](https://github.com/tas50))
 
 ## [v10.2.0](https://github.com/acrmp/foodcritic/tree/v10.2.0) (2017-03-30)
 

data/Gemfile

@@ -15,8 +15,3 @@ group :development do
   gem "ronn", "~> 0.7"
   gem "pry"
 end
-
-group :changelog do
-  # This fork has many fixes we want to use. Once this gets merged upstream we can use the gem again
-  gem "github_changelog_generator", git: "https://github.com/tduffield/github-changelog-generator", branch: "adjust-tag-section-mapping"
-end

data/Rakefile

@@ -34,22 +34,6 @@ RuboCop::RakeTask.new do |task|
   task.options << "--display-cop-names"
 end
 
-begin
-  require "github_changelog_generator/task"
-  require_relative "../lib/foodcritic/version"
-
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.header = "# Foodcritic Changelog:"
-    config.future_release = FoodCritic::VERSION
-    config.add_issues_wo_labels = false
-    config.enhancement_labels = "enhancement,Enhancement,Enhancements,New Feature,Feature".split(",")
-    config.bug_labels = "bug,Bug,Improvement,Upstream Bug".split(",")
-    config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Discussion,Tech Cleanup".split(",")
-  end
-rescue LoadError
-  puts "github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs"
-end
-
 desc "Build the manpage"
 task(:man) do
   sh "ronn -w --roff man/*.ronn"

data/features/step_definitions/cookbook_steps.rb

@@ -190,14 +190,6 @@ Given "a cookbook recipe that refers to an attribute with a bare keyword" do
   }
 end
 
-Given /^a cookbook recipe that wraps a platform\-specific resource in a (.*) conditional$/ do |conditional|
-  write_recipe %Q{
-    if #{conditional}
-      Chef::Log.info('We matched the platform')
-    end
-  }
-end
-
 Given "a cookbook provider that declares execute resources varying only in the command in separate actions" do
   write_provider "site", %q{
     action :start do
@@ -253,30 +245,6 @@ Given /^a cookbook recipe that declares a resource called ([^ ]+) with the condi
   }
 end
 
-Given /^a cookbook recipe that declares (a resource|multiple resources) nested in a ([a-z_]+) condition with (.*)$/ do |arity, wrapping_condition, condition_attribute|
-  blk = "{ File.exists?('/etc/passwd') }"
-  str = "'test -f /etc/passwd'"
-  conds = wrapping_condition.split("_")
-  write_recipe %Q{
-    #{conds.first} node['foo'] == 'bar'
-      service "apache" do
-        action :enable
-        #{case condition_attribute
-            when /(only_if|not_if) block/ then "#{$1} #{blk}"
-            when /(only_if|not_if) string/ then "#{$1} #{str}"
-          end}
-      end
-      #{if arity.include?('multiple')
-          %q{service "httpd" do
-          action :enable
-      end}
-        end}
-    #{"elsif true\nlog 'bar'" if conds.include? 'elsif'}
-    #{"else\nlog 'foo'" if conds.include? 'else'}
-    end
-  }
-end
-
 Given /^a cookbook recipe that declares a resource with a (.*)$/ do |conditional|
   write_recipe %Q{
     template "/tmp/foo" do
@@ -441,29 +409,6 @@ Given 'a cookbook recipe that has a confusingly named local variable "default"'
   }
 end
 
-Given "a cookbook recipe that has a wrapping condition containing a resource with no condition attribute and a Ruby statement" do
-  write_recipe %q{
-    if node['foo'] == 'bar'
-      Chef::Log.info "Enabling apache to start at boot"
-      service "apache" do
-        action :enable
-      end
-    end
-  }
-end
-
-Given "a cookbook recipe that has a wrapping condition containing a resource with no condition attribute within a loop" do
-  write_recipe %q{
-    unless node['bar'].include? 'something'
-      bars.each do |bar|
-        service bar['name'] do
-          action :enable
-        end
-      end
-    end
-  }
-end
-
 Given /^a cookbook recipe that includes a local recipe(.*)$/ do |diff_name|
   cookbook = diff_name.empty? ? "example" : "foo"
   write_recipe %Q{
@@ -1003,12 +948,6 @@ Given "a cookbook that does not have defined metadata" do
   }
 end
 
-Given /^a cookbook that downloads a file to (.*)$/ do |path|
-  recipe_downloads_file({ "/tmp" => :tmp_dir, "/tmp with an expression" => :tmp_dir_expr,
-                          "the Chef file cache" => :chef_file_cache_dir,
-                          "a users home directory" => :home_dir }[path])
-end
-
 Given /^a cookbook that has ([^ ]+) problems$/ do |problems|
   cookbook_that_matches_rules(
     problems.split(",").map do |problem|
@@ -1021,10 +960,6 @@ Given /^a cookbook that has ([^ ]+) problems$/ do |problems|
   )
 end
 
-Given "a cookbook that has the default boilerplate metadata generated by knife" do
-  cookbook_with_maintainer("YOUR_COMPANY_NAME", "YOUR_EMAIL")
-end
-
 Given /^a cookbook that matches rules (.*)$/ do |rules|
   cookbook_that_matches_rules(rules.split(","))
 end
@@ -1077,10 +1012,6 @@ Given "a cookbook with a single recipe that accesses multiple node attributes vi
   }
 end
 
-Given "a cookbook with a single recipe that accesses nested node attributes via symbols" do
-  write_recipe %q{node[:foo][:foo2] = 'bar'}
-end
-
 Given "a cookbook with a single recipe that reads node attributes via symbols and quoted_symbols" do
   write_recipe %q{default[:foo][:'bar-baz']}
 end
@@ -1119,18 +1050,6 @@ Given /^a cookbook with a single recipe that explicitly calls a node method( wit
   }
 end
 
-Given "a cookbook with a single recipe that passes node attributes accessed via symbols to a template" do
-  write_recipe %q{
-    template "/etc/foo" do
-      source "foo.erb"
-      variables({
-        :port => node[:foo][:port],
-        :user => node[:foo][:user]
-      })
-    end
-  }.strip
-end
-
 Given "a cookbook with a single recipe that uses a hash value to access a node attribute" do
   write_recipe %q{
     some_hash = {
@@ -1173,12 +1092,6 @@ Given /a(nother)? cookbook with a single recipe that (reads|updates|ignores)(nes
 
 end
 
-Given "a cookbook with a single recipe that searches based on a node attribute accessed via strings" do
-  write_recipe %q{
-    remote = search(:node, "name:#{node['drbd']['remote_host']}")[0]
-  }.strip
-end
-
 Given "a cookbook with a single recipe which accesses node attributes with symbols on lines 2 and 10" do
   write_recipe %q{
     # Here we access the node attributes via a symbol
@@ -1194,10 +1107,6 @@ Given "a cookbook with a single recipe which accesses node attributes with symbo
   }
 end
 
-Given "a cookbook with a single recipe that assigns node attributes accessed via symbols to a local variable" do
-  write_recipe %q{baz = node[:foo]}
-end
-
 Given /^a cookbook with a single recipe that creates a directory resource with (.*)$/ do |path_type|
   recipe_with_dir_path({ "an interpolated name" => :interpolated_symbol,
                          "an interpolated name from a string" => :interpolated_string,
@@ -1215,73 +1124,6 @@ Given "a cookbook with a single recipe that logs an interpolated string heredoc"
   )
 end
 
-Given "a cookbook with a single recipe that searches but checks first (alternation) to see if this is server" do
-  write_recipe %q{
-    if Chef::Config[:solo] || we_dont_want_to_use_search
-      # set up stuff from attributes
-    else
-      # set up stuff from search
-      nodes = search(:node, "hostname:[* TO *] AND chef_environment:#{node.chef_environment}")
-    end
-  }
-end
-
-Given /^a cookbook with a single recipe that searches but checks first( \(string\))? to see if this is server$/ do |str|
-  write_recipe %Q{
-    if Chef::Config[#{str ? "'solo'" : ":solo"}]
-      Chef::Log.warn("This recipe uses search. Chef Solo does not support search.")
-    else
-      nodes = search(:node, "hostname:[* TO *] AND chef_environment:#\{node.chef_environment\}")
-    end
-  }
-end
-
-Given "a cookbook with a single recipe that searches but checks first (ternary) to see if this is server" do
-  write_recipe %Q{
-    required_node = Chef::Config[:solo] ? node : search(:node, query).first
-  }
-end
-
-Given /^a cookbook with a single recipe that searches but checks with a negative first to see if this is server$/ do
-  write_recipe %q{
-    unless Chef::Config['solo']
-      nodes = search(:node, "hostname:[* TO *]")
-    else
-      Chef::Log.warn("This recipe uses search. Chef Solo does not support search.")
-    end
-  }
-end
-
-Given /^a cookbook with a single recipe that searches but checks first \(method\) to see if this is server$/ do
-  write_recipe %Q{
-    if Chef::Config.solo
-      Chef::Log.warn("This recipe uses search. Chef Solo does not support search.")
-    else
-      nodes = search(:node, "hostname:[* TO *] AND chef_environment:#\{node.chef_environment\}")
-    end
-  }
-end
-
-Given /^a cookbook with a single recipe that searches but returns first \((oneline|multiline)\) if search is not supported$/ do |format|
-  if format == "oneline"
-    write_recipe %q{
-      return Chef::Log.warn("This recipe uses search. Chef Solo does not support search.") if Chef::Config[:solo]
-      nodes = search(:node, "hostname:[* TO *] AND chef_environment:#{node.chef_environment}")
-    }
-  else
-    write_recipe %q{
-      if Chef::Config[:solo]
-        return Chef::Log.warn("This recipe uses search. Chef Solo does not support search.")
-      end
-      nodes = search(:node, "hostname:[* TO *] AND chef_environment:#{node.chef_environment}")
-    }
-  end
-end
-
-Given "a cookbook with a single recipe that searches without checking if this is server" do
-  write_recipe %q{nodes = search(:node, "hostname:[* TO *] AND chef_environment:#{node.chef_environment}")}
-end
-
 Given "a cookbook with five recipes" do
 
 end
@@ -1547,32 +1389,6 @@ Given "access to the man page documentation" do
 
 end
 
-Given /^another cookbook that has (an older )?chef-solo-search installed$/ do |older|
-  if older.nil?
-    write_library "search", %q{
-      class Chef
-        module Mixin
-          module Language
-            def search(bag_name, query=nil, sort=nil, start=0, rows=1000, &block)
-              # https://github.com/edelight/chef-solo-search
-            end
-          end
-        end
-      end
-    }
-  else
-    write_library "search", %q{
-      class Chef
-        class Recipe
-          def search(bag_name, query=nil, sort=nil, start=0, rows=1000, &block)
-            # https://github.com/edelight/chef-solo-search
-          end
-        end
-      end
-    }
-  end
-end
-
 Given "I have installed the lint tool" do
 
 end
@@ -1654,15 +1470,6 @@ Given "unit tests under a top-level test directory" do
   minitest_spec_attributes
 end
 
-Given "a recipe that installs a gem with 5 retries" do
-  write_recipe %q{
-    gem_package "foo" do
-      retries 5
-      action :install
-    end
-  }
-end
-
 Given "a recipe that creates a raid array with mdadm specifying layout" do
   write_recipe %q{
     mdadm '/dev/md0' do
@@ -1774,10 +1581,6 @@ Given /^the cookbook directory has a \.foodcritic file specifying tags (.*)$/ do
   run_lint(["--no-progress", "cookbooks/example"])
 end
 
-When "I check both cookbooks specified as arguments" do
-  run_lint(["--no-progress", "cookbooks/another_example", "cookbooks/example"])
-end
-
 When /^I check both cookbooks with the command-line (.*)$/ do |command_line|
   cmds = command_line.split(" ").map do |c|
     if c.end_with?("example")
@@ -1992,10 +1795,6 @@ Then /^the lint task will be listed( under the different name)?$/ do |diff_name|
   build_tasks.must_include([expected_name, "Lint Chef cookbooks"])
 end
 
-Then "no error should have occurred" do
-  assert_no_error_occurred
-end
-
 Then /^(no )?warnings will be displayed against the tests$/ do |no_display|
   if no_display.nil?
     assert_test_warnings
@@ -2004,13 +1803,6 @@ Then /^(no )?warnings will be displayed against the tests$/ do |no_display|
   end
 end
 
-Then "the attribute consistency warning 019 should warn on lines 2 and 10 in that order" do
-  expected_warnings = [2, 10].map do |line|
-    "FC019: Access node attributes in a consistent manner: cookbooks/example/recipes/default.rb:#{line}"
-  end
-  expect_output(expected_warnings.join("\n"))
-end
-
 Then "the attribute consistency warning 019 should be displayed for the recipe" do
   expect_warning("FC019", :line => 2)
 end
@@ -2097,10 +1889,6 @@ Then /^the warning (\d+) should be (valid|invalid)$/ do |code, valid|
   valid == "valid" ? expect_no_warning(code) : expect_warning(code)
 end
 
-Then /^the incorrect platform usage warning 028 should be (not )?shown$/ do |should_not|
-  expect_warning("FC028", :line => nil, :expect_warning => should_not.nil?)
-end
-
 Then /^the line number and line of code that triggered the warning(s)? should be displayed$/ do |multiple|
   if multiple.nil?
     expect_line_shown 1, "log node[:foo]"
@@ -2221,22 +2009,6 @@ Given(/^a cookbook with an? (.*) file with an interpolated name$/) do |file_type
   write_library "lib", content if file_type == "library"
 end
 
-Then /^the metadata missing maintainer warning 055 should be (shown|not shown) against the metadata file$/ do |show_warning|
-  expect_warning("FC055", :file => "metadata.rb", :expect_warning => show_warning == "shown")
-end
-
-Then /^the metadata missing maintainer email warning 056 should be (shown|not shown) against the metadata file$/ do |show_warning|
-  expect_warning("FC056", :file => "metadata.rb", :expect_warning => show_warning == "shown")
-end
-
-Then /^the metadata using suggests warning 052 should be (shown|not shown) against the metadata file$/ do |show_warning|
-  expect_warning("FC052", :file => "metadata.rb", :line => 2, :expect_warning => show_warning == "shown")
-end
-
-Then /^the metadata using recommends warning 053 should be (shown|not shown) against the metadata file$/ do |show_warning|
-  expect_warning("FC053", :file => "metadata.rb", :line => 2, :expect_warning => show_warning == "shown")
-end
-
 Given /^a cookbook that contains a LWRP provider (with|without) use_inline_resources( and uses def action_create)?$/ do |with_use_inline_resources, uses_def|
   write_resource("site", %q{
     actions :create

data/features/support/command_helpers.rb

@@ -5,6 +5,7 @@ module FoodCritic
   # Unless the environment variable FC_FORK_PROCESS is set to 'true' then the features will be run in the same process.
   module CommandHelpers
 
+    require "minitest"
     include MiniTest::Assertions
 
     attr_writer :assertions

data/lib/foodcritic/api.rb

@@ -393,7 +393,7 @@ module FoodCritic
       platforms.map do |platform|
         versions = platform.xpath('ancestor::args_add[position() > 1]/
 	  string_literal/descendant::tstring_content/@value').map { |v| v.to_s }
-        { platform: platform["value"], versions: versions }
+        { platform: platform["value"].lstrip, versions: versions }
       end.sort { |a, b| a[:platform] <=> b[:platform] }
     end
 

data/lib/foodcritic/rules/fc016.rb

@@ -2,7 +2,7 @@ rule "FC016", "LWRP does not declare a default action" do
   tags %w{correctness lwrp}
   resource do |ast, filename|
     # See if we're in a custom resource not an LWRP. Only LWRPs need the default_action
-    next if ast.xpath("//ident/@value='property'")
+    next if ast.xpath("//ident/@value='action'")
     unless ["//ident/@value='default_action'",
      "//def/bodystmt/descendant::assign/
       var_field/ivar/@value='@action'"].any? { |expr| ast.xpath(expr) }