foodcritic 13.0.1 → 13.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4043ba45f55c8b88b96eeb28ecb5111dd92e98ba45d1c74dc3ca86bc92c57cdc
-  data.tar.gz: 2f9bd70e42c3cbdec213e727c33b568d21ed72578dca8a173110f2944375d1e6
+  metadata.gz: 3903e57cd4ed6cf6c556f4fa0081e5eace7eb2935faa088c407a5ac3df595a63
+  data.tar.gz: 4bce109b2c6ee021e420c373034bd48294f4a94cc05eef8e08ca918e000ebff6
 SHA512:
-  metadata.gz: d7d07e5748a0a19265b0d26d7347d07e90d79bd1aff1565c1c210501f1f29205e7d433cdeeea5646bdb2793e1517f78b76134639e2bab5add1433e161a65f2de
-  data.tar.gz: c17b5b064688c41d3a397202314df1938f549071dc07d1f368e730e5f795f73626d8e958524931bdf45b8d0523ce94f236c77814cd1196d5651f3d8edd3c5f85
+  metadata.gz: 48d6d18c3629a920e36f03536733078ccc1edc069ee151972cd9ba424e69f5c2470869296324ad0b10cc7155d533950e071db8b9daae86ed161535279b0267da
+  data.tar.gz: 9e8f389db7509486afd00772e675d1f1af6603fa689df3b4c59022362003437a99c4d57a73aec08715acd00eec112f23ee5d580baea9f4d4c237a2fdd2038311

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Foodcritic Changelog:
 
+## [13.1.0](https://github.com/Foodcritic/foodcritic/tree/v13.1.0) (2018-04-12)
+
+### Speed improvements
+
+Foodcritic now caches some of the information on cookbooks it previously calculated repeatedly. This results in a 10X reduction in some disk reads and a 7% improvement in runtime overall.
+
+### Rule file improvements
+
+The fetching and parsing of Foodcritic rule files (.foodcritic files) has been improved. If a non-existent file is specified on the CLI we will now fail instead of silently continuing. Additionally, if the .foodcritic file exists, but cannot be read/parsed we will also fail instead of silently continuing.
+
+### Improved file detection
+
+Several deficiencies in how Foodcritic detected files within a cookbook have been resolved. If you use the Chef 13+ root alias files such as attributes.rb or recipe.rb these will now be detected. Additionally we will detect template files not in the default directory, or deeply nested in directories within the templates directory.
+
+### New Rules
+
+- `FC116` - Cookbook depends on the deprecated compat_resource cookbook
+- `FC120` - Do not set the name property directly on a resource
+- `FC122` - Use the build_essential resource instead of the recipe
+
 ## [13.0.1](https://github.com/Foodcritic/foodcritic/tree/v13.0.1) (2018-04-11)
 
 - Properly discover templates not in templates/default/. Templates in the root of the templates directory would be skipped previously

data/lib/foodcritic/linter.rb

@@ -84,7 +84,7 @@ module FoodCritic
         relevant_tags = if options[:tags].any?
                           options[:tags]
                         else
-                          cookbook_tags(p[:filename])
+                          rule_file_tags(p[:filename])
                         end
 
         progress = "."
@@ -199,15 +199,44 @@ module FoodCritic
       rule.applies_to.yield(Gem::Version.create(version))
     end
 
-    def cookbook_tags(file)
+    # given a file in the cookbook lookup all the applicable tag rules defined in rule
+    # files. The rule file is either that specified via CLI or the .foodcritic file
+    # in the cookbook. We cache this information at the cookbook level to prevent looking
+    #  up the same thing dozens of times
+    #
+    # @param [String] file in the cookbook
+    # @return [Array] array of tag rules
+    def rule_file_tags(file)
+      cookbook = cookbook_dir(file)
+      @tag_cache ||= {}
+
+      # lookup the tags in the cache has and return that if we find something
+      cb_tags = @tag_cache[cookbook]
+      return cb_tags unless cb_tags.nil?
+
+      # if a rule file has been specified use that. Otherwise use the .foodcritic file in the CB
+      tags = if @options[:rule_file]
+               raise "ERROR: Could not find the specified rule file at #{@options[:rule_file]}" unless File.exist?(@options[:rule_file])
+               parse_rule_file(@options[:rule_file])
+             else
+               File.exist?("#{cookbook}/.foodcritic") ? parse_rule_file("#{cookbook}/.foodcritic") : []
+             end
+
+      @tag_cache[cookbook] = tags
+      tags
+    end
+
+    # given a filename parse any tag rules in that file
+    #
+    # @param [String] rule file path
+    # @return [Array] array of tag rules from the file
+    def parse_rule_file(file)
       tags = []
-      fc_file = @options[:rule_file] || "#{cookbook_dir(file)}/.foodcritic"
-      if File.exist? fc_file
-        begin
-          tag_text = File.read fc_file
-          tags = tag_text.split(/\s/)
-        rescue Errno::EACCES
-        end
+      begin
+        tag_text = File.read file
+        tags = tag_text.split(/\s/)
+      rescue
+        raise "ERROR: Could not read or parse the specified rule file at #{file}"
       end
       tags
     end
@@ -218,13 +247,46 @@ module FoodCritic
       end
     end
 
+    # provides the path to the cookbook from a file within the cookbook
+    # we cache this data in a hash because this method gets called often
+    # for the same files.
+    #
+    # @param [String] file - a file path in the cookbook
+    # @return [String] the path to the cookbook
     def cookbook_dir(file)
-      Pathname.new(File.join(File.dirname(file),
-                             case File.basename(file)
-                             when "metadata.rb" then ""
-                             when /\.erb$/ then "../.."
-                             else ".."
-                             end)).cleanpath
+      @dir_cache ||= {}
+      abs_file = File.absolute_path(file)
+
+      # lookup the file in the cache has and return that if we find something
+      cook_val = @dir_cache[abs_file]
+      return cook_val unless cook_val.nil?
+
+      if file =~ /\.erb$/
+        # split each directory into an item in the array
+        dir_array = File.dirname(file).split(File::SEPARATOR)
+
+        # walk through the array of directories backwards until we hit the templates directory
+        position = -1
+        position -= 1 until dir_array[position] == "templates"
+
+        # go back 1 more position to get to the cookbook dir
+        position -= 1
+
+        # slice from the start to the cookbook dir and then join it all back to a string
+        cook_val = dir_array.slice(0..position).join(File::SEPARATOR)
+      else
+        # determine the difference to the root of the CB from our file's directory
+        relative_difference = case File.basename(file)
+                              when "recipe.rb", "attribute.rb", "metadata.rb" then ""
+                              else # everything else is 1 directory up ie. cookbook/recipes/default.rb
+                                ".."
+                              end
+
+        cook_val = Pathname.new(File.join(File.dirname(file), relative_difference)).cleanpath
+      end
+
+      @dir_cache[abs_file] = cook_val
+      cook_val
     end
 
     def dsl_method_for_file(file)

data/lib/foodcritic/rules/fc116.rb

@@ -0,0 +1,6 @@
+rule "FC116", "Cookbook depends on the deprecated compat_resource cookbook" do
+  tags %w{deprecated}
+  metadata do |ast, filename|
+    [file_match(filename)] if declared_dependencies(ast).include?("compat_resource")
+  end
+end

data/lib/foodcritic/rules/fc120.rb

@@ -0,0 +1,6 @@
+rule "FC120", "Do not set the name property directly on a resource" do
+  tags %w{correctness}
+  recipe do |ast|
+    find_resources(ast).xpath('(.//command|.//fcall)[ident/@value="name"]')
+  end
+end

data/lib/foodcritic/rules/fc122.rb

@@ -0,0 +1,6 @@
+rule "FC122", "Use the build_essential resource instead of the recipe" do
+  tags %w{correctness}
+  recipe do |ast|
+    ast.xpath("//command[ident/@value = 'include_recipe']/descendant::tstring_content[@value='build-essential' or @value='build-essential::default']")
+  end
+end

data/lib/foodcritic/version.rb

@@ -1,4 +1,4 @@
 module FoodCritic
   # The current version of foodcritic
-  VERSION = "13.0.1"
+  VERSION = "13.1.0"
 end

data/spec/functional/fc116_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "FC116" do
+  context "with metadata depending on compat_resource" do
+    metadata_file "name 'test'\ndepends 'compat_resource'"
+    it { is_expected.to violate_rule }
+  end
+
+  context "with metadata depending on foo" do
+    metadata_file "name 'test'\ndepends 'foo'"
+    it { is_expected.to_not violate_rule }
+  end
+
+  context "with metadata depending on nothing" do
+    metadata_file "name 'test'"
+    it { is_expected.to_not violate_rule }
+  end
+end

data/spec/functional/fc120_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe "FC120" do
+  context "with a resource that sets the name property" do
+    recipe_file <<-EOF
+    foo 'bar' do
+      name 'Administrator'
+    end
+    EOF
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a resource that does not set the name property" do
+    recipe_file <<-EOF
+    foo 'bar' do
+      foo_name 'Administrator'
+    end
+    EOF
+    it { is_expected.not_to violate_rule }
+  end
+end

data/spec/functional/fc122_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "FC122" do
+  context "with a recipe that includes build-essential" do
+    recipe_file "include_recipe 'build-essential'"
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a recipe that includes build-essential::default" do
+    recipe_file "include_recipe 'build-essential::default'"
+    it { is_expected.to violate_rule }
+  end
+
+  context "with a recipe that includes build-essential-mycorp" do
+    recipe_file "include_recipe 'build-essential-mycorp'"
+    it { is_expected.to_not violate_rule }
+  end
+end

data/spec/unit/linter_spec.rb

@@ -16,6 +16,28 @@ describe FoodCritic::Linter do
     end
   end
 
+  describe "#cookbook_dir" do
+    it "given a root alias file the cookbook is correctly detected" do
+      expect(linter.send(:cookbook_dir, "./cookbook/recipe.rb").to_s).to eq "cookbook"
+    end
+
+    it "given the metadata.rb file the cookbook is correctly detected" do
+      expect(linter.send(:cookbook_dir, "./cookbook/metadata.rb").to_s).to eq "cookbook"
+    end
+
+    it "given a template nested multiple levels deep the cookbook is correctly detected" do
+      expect(linter.send(:cookbook_dir, "./cookbook/templates/foo/bar/file.erb").to_s).to eq "./cookbook"
+    end
+
+    it "given a template directly in the templates directory the cookbook is correctly detected" do
+      expect(linter.send(:cookbook_dir, "./cookbook/templates/file.erb").to_s).to eq "./cookbook"
+    end
+
+    it "given a standard recipe file the cookbook is correctly detected" do
+      expect(linter.send(:cookbook_dir, "./cookbook/recipes/default.rb").to_s).to eq "cookbook"
+    end
+  end
+
   describe "#check" do
     it "requires a cookbook_path, role_path or environment_path to be specified" do
       expect { linter.check({}) }.to raise_error ArgumentError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foodcritic
 version: !ruby/object:Gem::Version
-  version: 13.0.1
+  version: 13.1.0
 platform: ruby
 authors:
 - Andrew Crump
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-core
@@ -337,9 +337,12 @@ files:
 - lib/foodcritic/rules/fc113.rb
 - lib/foodcritic/rules/fc114.rb
 - lib/foodcritic/rules/fc115.rb
+- lib/foodcritic/rules/fc116.rb
 - lib/foodcritic/rules/fc117.rb
 - lib/foodcritic/rules/fc118.rb
 - lib/foodcritic/rules/fc119.rb
+- lib/foodcritic/rules/fc120.rb
+- lib/foodcritic/rules/fc122.rb
 - lib/foodcritic/template.rb
 - lib/foodcritic/version.rb
 - lib/foodcritic/xml.rb
@@ -429,9 +432,12 @@ files:
 - spec/functional/fc113_spec.rb
 - spec/functional/fc114_spec.rb
 - spec/functional/fc115_spec.rb
+- spec/functional/fc116_spec.rb
 - spec/functional/fc117_spec.rb
 - spec/functional/fc118_spec.rb
 - spec/functional/fc119_spec.rb
+- spec/functional/fc120_spec.rb
+- spec/functional/fc122_spec.rb
 - spec/functional/root_aliases_spec.rb
 - spec/regression/cookbooks.txt
 - spec/regression/expected/activemq.txt
@@ -548,5 +554,5 @@ rubyforge_project:
 rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
-summary: foodcritic-13.0.1
+summary: foodcritic-13.1.0
 test_files: []