foodcritic 10.2.2 → 10.3.0

data/features/support/command_helpers.rb

@@ -79,6 +79,9 @@ module FoodCritic
       "FC066" => "Ensure chef_version is set in metadata",
       "FC067" => "Ensure at least one platform supported in metadata",
       "FC068" => "Ensure license is set in metadata",
+      "FC069" => "Ensure standardized license defined in metadata",
+      "FC070" => "Ensure supports metadata defines valid platforms",
+      "FC071" => "Missing LICENSE file",
       "FCTEST001" => "Test Rule",
     }
 

data/foodcritic.gemspec

@@ -11,6 +11,14 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   s.executables << "foodcritic"
   s.required_ruby_version = ">= 2.2.2"
+
+  s.files = Dir["chef_dsl_metadata/*.json"] +
+    Dir["lib/**/*.rb"] +
+    Dir["misc/**/*"]
+  s.files += Dir["Rakefile"] + Dir["Gemfile"] + Dir["*.gemspec"]
+  s.files += Dir["spec/**/*"] + Dir["features/**/*"]
+  s.files += Dir["*.md"] + Dir["LICENSE"] + Dir["man/*"]
+
   s.add_dependency("cucumber-core", ">= 1.3")
   s.add_dependency("nokogiri", ">= 1.5", "< 2.0")
   s.add_dependency("rake")
@@ -18,10 +26,8 @@ Gem::Specification.new do |s|
   s.add_dependency("yajl-ruby", "~> 1.1")
   s.add_dependency("erubis")
   s.add_dependency("rufus-lru", "~> 1.0")
-  s.files = Dir["chef_dsl_metadata/*.json"] +
-    Dir["lib/**/*.rb"] +
-    Dir["misc/**/*"]
-  s.files += Dir["Rakefile"] + Dir["Gemfile"] + Dir["*.gemspec"]
-  s.files += Dir["spec/**/*"] + Dir["features/**/*"]
-  s.files += Dir["*.md"] + Dir["LICENSE"] + Dir["man/*"]
+
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "fuubar", "~> 2.0"
+  s.add_development_dependency "rspec-command", "~> 1.0"
 end

data/lib/foodcritic/api.rb

@@ -12,6 +12,18 @@ module FoodCritic
 
     class RecursedTooFarError < StandardError; end
 
+    # Match unless a file exists using the basepath of the cookbook and the filepath
+    #
+    # @author Joseph Holsten - joseph@josephholsten.com
+    # @since 10.3
+    # @param basepath [String] base path of the cookbook
+    # @param filepath [String] path to the file within the cookbook
+    # @return [String] the absolute path to the base of the cookbook
+    def ensure_file_exists(basepath, filepath)
+      path = File.join(basepath, filepath)
+      [file_match(path)] unless File.exist?(path)
+    end
+
     # Find attribute access by type.
     def attribute_access(ast, options = {})
       options = { type: :any, ignore_calls: false }.merge!(options)
@@ -37,7 +49,7 @@ module FoodCritic
     # @deprecated chef-solo functionality in Chef has been replaced with local-mode
     #  so this helper is no longer necessary and will be removed in Foodcritic 11.0
     def checks_for_chef_solo?(ast)
-      puts "the checks_for_chef_solo? helper is deprecated and will be removed from the next release of Foodcritic"
+      $stderr.puts "the checks_for_chef_solo? helper is deprecated and will be removed from the next release of Foodcritic"
       raise_unless_xpath!(ast)
       # TODO: This expression is too loose, but also will fail to match other
       # types of conditionals.
@@ -61,7 +73,7 @@ module FoodCritic
     # @deprecated chef-solo functionality in Chef has been replaced with local-mode
     #  so this helper is no longer necessary and will be removed in Foodcritic 11.0
     def chef_solo_search_supported?(recipe_path)
-      puts "the chef_solo_search_supported? helper is deprecated and will be removed from the next release of Foodcritic"
+      $stderr.puts "the chef_solo_search_supported? helper is deprecated and will be removed from the next release of Foodcritic"
       return false if recipe_path.nil? || !File.exist?(recipe_path)
 
       # Look for the chef-solo-search library.

data/lib/foodcritic/command_line.rb

@@ -1,6 +1,14 @@
 module FoodCritic
   # Command line parsing.
   class CommandLine
+    def self.main(argv = ARGV, out = $stdout)
+      cmd_line = CommandLine.new(argv)
+      review, status = Linter.run(cmd_line)
+      printer = cmd_line.show_context? ? ContextOutput.new(out) : SummaryOutput.new(out)
+      printer.output(review)
+      status.to_i
+    end
+
     # Create a new instance of CommandLine
     #
     # @param [Array] args The command line arguments

data/lib/foodcritic/linter.rb

@@ -257,7 +257,7 @@ module FoodCritic
 
           if File.directory?(dir)
             glob = if path_type == :cookbook
-                     "{metadata.rb,{attributes,definitions,libraries,"\
+                     "{metadata.rb,attributes.rb,recipe.rb,{attributes,definitions,libraries,"\
                      "providers,recipes,resources}/*.rb,templates/*/*.erb}"
                    else
                      "*.rb"

data/lib/foodcritic/output.rb

@@ -1,8 +1,22 @@
 require "set"
 
 module FoodCritic
+  class Output
+    # Create Output writer.
+    #
+    # @param out [File] File-like object to output to.
+    def initialize(out)
+      @out = out
+    end
+
+    # Write a line of output.
+    def puts(*args)
+      @out.puts(*args)
+    end
+  end
+
   # Default output showing a summary view.
-  class SummaryOutput
+  class SummaryOutput < Output
     # Output a summary view only listing the matching rules, file and line
     # number.
     #
@@ -13,7 +27,7 @@ module FoodCritic
   end
 
   # Display rule matches with surrounding context.
-  class ContextOutput
+  class ContextOutput < Output
     # Output the review showing matching lines with context.
     #
     # @param [Review] review The review to output.
@@ -101,7 +115,7 @@ module FoodCritic
     # @param bg [String] background color
     # @param attr [String] any formatting options
     def ansi_print(text, fg, bg = nil, attr = nil)
-      unless STDOUT.tty?
+      unless @out.tty?
         puts text
         return
       end

data/lib/foodcritic/rules/fc008.rb

@@ -1,12 +1,14 @@
 rule "FC008", "Generated cookbook metadata needs updating" do
   tags %w{metadata supermarket}
   metadata do |ast, filename|
-    {
-      "maintainer" => "YOUR_COMPANY_NAME",
-      "maintainer_email" => "YOUR_EMAIL",
-    }.map do |field, value|
-      ast.xpath(%Q{//command[ident/@value='#{field}']/
-                   descendant::tstring_content[@value='#{value}']})
+    [
+      { "maintainer" => "YOUR_COMPANY_NAME" },
+      { "maintainer" => "The Authors" },
+      { "maintainer_email" => "YOUR_EMAIL" },
+      { "maintainer_email" => "you@example.com" },
+    ].map do |metadata_hash|
+      ast.xpath(%Q{//command[ident/@value='#{metadata_hash.keys[0]}']/
+                   descendant::tstring_content[@value='#{metadata_hash.values[0]}']})
     end
   end
 end

data/lib/foodcritic/rules/fc024.rb

@@ -1,6 +1,6 @@
 rule "FC024", "Consider adding platform equivalents" do
   tags %w{portability}
-  RHEL = %w{amazon centos redhat scientific oracle}
+  RHEL = %w{centos redhat scientific oracle}
   recipe do |ast, filename|
     next if Pathname.new(filename).basename.to_s == "metadata.rb"
     metadata_path = Pathname.new(

data/lib/foodcritic/rules/fc045.rb

@@ -1,13 +1,6 @@
 rule "FC045", "Metadata does not contain cookbook name" do
   tags %w{correctness metadata chef12}
   metadata do |ast, filename|
-    unless ast.xpath('descendant::stmts_add/command/ident/@value="name"')
-      [file_match(filename)]
-    end
-  end
-  cookbook do |filename|
-    if !File.exist?(File.join(filename, "metadata.rb"))
-      [file_match(File.join(filename, "metadata.rb"))]
-    end
+    [file_match(filename)] unless field(ast, "name").any?
   end
 end

data/lib/foodcritic/rules/fc068.rb

@@ -1,5 +1,5 @@
 rule "FC068", "Ensure license is set in metadata" do
-  tags %w{metadata supermarket}
+  tags %w{metadata supermarket license}
   metadata do |ast, filename|
     [file_match(filename)] unless field(ast, "license").any?
   end

data/lib/foodcritic/rules/fc069.rb

@@ -0,0 +1,365 @@
+rule "FC069", "Ensure standardized license defined in metadata" do
+  tags %w{metadata supermarket license}
+  metadata do |ast, filename|
+    begin
+      license = ast.xpath(%Q{//command[ident/@value='license']/
+                            descendant::tstring_content}).attribute("value").to_s
+
+      # list of valid SPDX.org license strings. To build an array run this:
+      # require 'json'
+      # require 'net/http'
+      # json_data = JSON.parse(Net::HTTP.get(URI('https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json')))
+      # licenses = json_data['licenses'].map {|l| l['licenseId'] }
+      #
+      valid = %w{
+      Glide
+      Abstyles
+      AFL-1.1
+      AFL-1.2
+      AFL-2.0
+      AFL-2.1
+      AFL-3.0
+      AMPAS
+      APL-1.0
+      Adobe-Glyph
+      APAFML
+      Adobe-2006
+      AGPL-1.0
+      Afmparse
+      Aladdin
+      ADSL
+      AMDPLPA
+      ANTLR-PD
+      Apache-1.0
+      Apache-1.1
+      Apache-2.0
+      AML
+      APSL-1.0
+      APSL-1.1
+      APSL-1.2
+      APSL-2.0
+      Artistic-1.0
+      Artistic-1.0-Perl
+      Artistic-1.0-cl8
+      Artistic-2.0
+      AAL
+      Bahyph
+      Barr
+      Beerware
+      BitTorrent-1.0
+      BitTorrent-1.1
+      BSL-1.0
+      Borceux
+      BSD-2-Clause
+      BSD-2-Clause-FreeBSD
+      BSD-2-Clause-NetBSD
+      BSD-3-Clause
+      BSD-3-Clause-Clear
+      BSD-3-Clause-No-Nuclear-License
+      BSD-3-Clause-No-Nuclear-License-2014
+      BSD-3-Clause-No-Nuclear-Warranty
+      BSD-4-Clause
+      BSD-Protection
+      BSD-Source-Code
+      BSD-3-Clause-Attribution
+      0BSD
+      BSD-4-Clause-UC
+      bzip2-1.0.5
+      bzip2-1.0.6
+      Caldera
+      CECILL-1.0
+      CECILL-1.1
+      CECILL-2.0
+      CECILL-2.1
+      CECILL-B
+      CECILL-C
+      ClArtistic
+      MIT-CMU
+      CNRI-Jython
+      CNRI-Python
+      CNRI-Python-GPL-Compatible
+      CPOL-1.02
+      CDDL-1.0
+      CDDL-1.1
+      CPAL-1.0
+      CPL-1.0
+      CATOSL-1.1
+      Condor-1.1
+      CC-BY-1.0
+      CC-BY-2.0
+      CC-BY-2.5
+      CC-BY-3.0
+      CC-BY-4.0
+      CC-BY-ND-1.0
+      CC-BY-ND-2.0
+      CC-BY-ND-2.5
+      CC-BY-ND-3.0
+      CC-BY-ND-4.0
+      CC-BY-NC-1.0
+      CC-BY-NC-2.0
+      CC-BY-NC-2.5
+      CC-BY-NC-3.0
+      CC-BY-NC-4.0
+      CC-BY-NC-ND-1.0
+      CC-BY-NC-ND-2.0
+      CC-BY-NC-ND-2.5
+      CC-BY-NC-ND-3.0
+      CC-BY-NC-ND-4.0
+      CC-BY-NC-SA-1.0
+      CC-BY-NC-SA-2.0
+      CC-BY-NC-SA-2.5
+      CC-BY-NC-SA-3.0
+      CC-BY-NC-SA-4.0
+      CC-BY-SA-1.0
+      CC-BY-SA-2.0
+      CC-BY-SA-2.5
+      CC-BY-SA-3.0
+      CC-BY-SA-4.0
+      CC0-1.0
+      Crossword
+      CrystalStacker
+      CUA-OPL-1.0
+      Cube
+      curl
+      D-FSL-1.0
+      diffmark
+      WTFPL
+      DOC
+      Dotseqn
+      DSDP
+      dvipdfm
+      EPL-1.0
+      ECL-1.0
+      ECL-2.0
+      eGenix
+      EFL-1.0
+      EFL-2.0
+      MIT-advertising
+      MIT-enna
+      Entessa
+      ErlPL-1.1
+      EUDatagrid
+      EUPL-1.0
+      EUPL-1.1
+      Eurosym
+      Fair
+      MIT-feh
+      Frameworx-1.0
+      FreeImage
+      FTL
+      FSFAP
+      FSFUL
+      FSFULLR
+      Giftware
+      GL2PS
+      Glulxe
+      AGPL-3.0
+      GFDL-1.1
+      GFDL-1.2
+      GFDL-1.3
+      GPL-1.0
+      GPL-2.0
+      GPL-3.0
+      LGPL-2.1
+      LGPL-3.0
+      LGPL-2.0
+      gnuplot
+      gSOAP-1.3b
+      HaskellReport
+      HPND
+      IBM-pibs
+      IPL-1.0
+      ICU
+      ImageMagick
+      iMatix
+      Imlib2
+      IJG
+      Info-ZIP
+      Intel-ACPI
+      Intel
+      Interbase-1.0
+      IPA
+      ISC
+      JasPer-2.0
+      JSON
+      LPPL-1.0
+      LPPL-1.1
+      LPPL-1.2
+      LPPL-1.3a
+      LPPL-1.3c
+      Latex2e
+      BSD-3-Clause-LBNL
+      Leptonica
+      LGPLLR
+      Libpng
+      libtiff
+      LAL-1.2
+      LAL-1.3
+      LiLiQ-P-1.1
+      LiLiQ-Rplus-1.1
+      LiLiQ-R-1.1
+      LPL-1.02
+      LPL-1.0
+      MakeIndex
+      MTLL
+      MS-PL
+      MS-RL
+      MirOS
+      MITNFA
+      MIT
+      Motosoto
+      MPL-1.0
+      MPL-1.1
+      MPL-2.0
+      MPL-2.0-no-copyleft-exception
+      mpich2
+      Multics
+      Mup
+      NASA-1.3
+      Naumen
+      NBPL-1.0
+      Net-SNMP
+      NetCDF
+      NGPL
+      NOSL
+      NPL-1.0
+      NPL-1.1
+      Newsletr
+      NLPL
+      Nokia
+      NPOSL-3.0
+      NLOD-1.0
+      Noweb
+      NRL
+      NTP
+      Nunit
+      OCLC-2.0
+      ODbL-1.0
+      PDDL-1.0
+      OCCT-PL
+      OGTSL
+      OLDAP-2.2.2
+      OLDAP-1.1
+      OLDAP-1.2
+      OLDAP-1.3
+      OLDAP-1.4
+      OLDAP-2.0
+      OLDAP-2.0.1
+      OLDAP-2.1
+      OLDAP-2.2
+      OLDAP-2.2.1
+      OLDAP-2.3
+      OLDAP-2.4
+      OLDAP-2.5
+      OLDAP-2.6
+      OLDAP-2.7
+      OLDAP-2.8
+      OML
+      OPL-1.0
+      OSL-1.0
+      OSL-1.1
+      OSL-2.0
+      OSL-2.1
+      OSL-3.0
+      OpenSSL
+      OSET-PL-2.1
+      PHP-3.0
+      PHP-3.01
+      Plexus
+      PostgreSQL
+      psfrag
+      psutils
+      Python-2.0
+      QPL-1.0
+      Qhull
+      Rdisc
+      RPSL-1.0
+      RPL-1.1
+      RPL-1.5
+      RHeCos-1.1
+      RSCPL
+      RSA-MD
+      Ruby
+      SAX-PD
+      Saxpath
+      SCEA
+      SWL
+      SMPPL
+      Sendmail
+      SGI-B-1.0
+      SGI-B-1.1
+      SGI-B-2.0
+      OFL-1.0
+      OFL-1.1
+      SimPL-2.0
+      Sleepycat
+      SNIA
+      Spencer-86
+      Spencer-94
+      Spencer-99
+      SMLNJ
+      SugarCRM-1.1.3
+      SISSL
+      SISSL-1.2
+      SPL-1.0
+      Watcom-1.0
+      TCL
+      TCP-wrappers
+      Unlicense
+      TMate
+      TORQUE-1.1
+      TOSL
+      Unicode-DFS-2015
+      Unicode-DFS-2016
+      Unicode-TOU
+      UPL-1.0
+      NCSA
+      Vim
+      VOSTROM
+      VSL-1.0
+      W3C-20150513
+      W3C-19980720
+      W3C
+      Wsuipa
+      Xnet
+      X11
+      Xerox
+      XFree86-1.1
+      xinetd
+      xpp
+      XSkat
+      YPL-1.0
+      YPL-1.1
+      Zed
+      Zend-2.0
+      Zimbra-1.3
+      Zimbra-1.4
+      Zlib
+      zlib-acknowledgement
+      ZPL-1.1
+      ZPL-2.0
+      ZPL-2.1
+      eCos-2.0
+      GPL-1.0+
+      GPL-2.0+
+      GPL-2.0-with-autoconf-exception
+      GPL-2.0-with-bison-exception
+      GPL-2.0-with-classpath-exception
+      GPL-2.0-with-font-exception
+      GPL-2.0-with-GCC-exception
+      GPL-3.0+
+      GPL-3.0-with-autoconf-exception
+      GPL-3.0-with-GCC-exception
+      LGPL-2.1+
+      LGPL-3.0+
+      LGPL-2.0+
+      StandardML-NJ
+      WXwindows
+      }
+      valid << "All Rights Reserved" # Chef-DK's non-standard extra value
+      [file_match(filename)] unless valid.include?(license)
+    rescue NoMethodError # no license in the metadata
+      [file_match(filename)]
+    end
+  end
+end