Generate Chef metadata rather than hard-coding.

.gitignore

@@ -1,6 +1,7 @@
 .idea
 .yardoc
 *.html
+chef_dsl_metadata.json
 coverage
 doc
 pkg

Rakefile

@@ -3,7 +3,7 @@ require 'bundler'
 require 'cucumber'
 require 'cucumber/rake/task'
 require 'yard'
-task :default => [:install, :features]
+task :default => ['chef_dsl_metadata.json', :install, :features]
 
 Bundler.setup
 Bundler::GemHelper.install_tasks
@@ -12,4 +12,4 @@ Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = ['-t', '~@repl', 'features'] if ENV.has_key?('FC_FORK_PROCESS') and ENV['FC_FORK_PROCESS'] == true.to_s
 end
 
-YARD::Rake::YardocTask.new
+YARD::Rake::YardocTask.new

foodcritic.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency('pry-doc', '~> 0.3.0')
   s.add_dependency('rak', '~> 1.4')
   s.add_dependency('treetop', '~> 1.4.10')
-  s.files = Dir['lib/**/*.rb']
+  s.add_dependency('yajl-ruby', '~> 1.1.0')
+  s.files = Dir['lib/**/*.rb'] + Dir['*.json']
   s.required_ruby_version = '>= 1.9.2'
 end

lib/foodcritic.rb

@@ -3,6 +3,7 @@
 require 'treetop'
 require 'pry'
 require 'rak'
+require 'yajl'
 
 require_relative 'foodcritic/chef'
 require_relative 'foodcritic/command_line'

lib/foodcritic/chef.rb

@@ -3,74 +3,28 @@ module FoodCritic
   # Encapsulates functions that previously were calls to the Chef gem.
   module Chef
 
+    def load_metadata
+      metadata_path = File.join(File.dirname(__FILE__), '..', '..', 'chef_dsl_metadata.json')
+      @dsl_metadata ||= Yajl::Parser.parse(IO.read(metadata_path), :symbolize_keys => true)
+    end
+
     # The set of methods in the Chef DSL
     #
     # @return [Array] Array of method symbols
     def dsl_methods
-      [:attribute, :attribute=, :attribute?, :chef_environment, :default, :default_unless, :each, :each_attribute,
-       :each_key, :each_value, :enum_for, :eql?, :equal?, :has_key?, :hash, :include_attribute, :inspect, :instance_of?,
-       :is_a?, :key?, :keys, :kind_of?, :name, :normal, :normal_attrs, :normal_attrs=, :normal_unless, :override,
-       :override_attrs, :override_attrs=, :override_unless, :platform?, :recipe?, :recipe_list, :recipe_list=, :respond_to?,
-       :respond_to_missing?, :role?, :run_list, :run_list=, :run_list?, :run_state, :run_state=, :search, :set, :set_if_args,
-       :set_or_return, :set_unless, :to_hash, :to_json, :to_s, :value_for_platform]
+      load_metadata
+      @dsl_metadata[:dsl_methods].map{|m| m.to_sym}
     end
 
-    RESOURCE_ATTRIBUTES = {
-        :apt_package => [:action, :name, :ignore_failure, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :bash => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :cookbook_file => [:action, :backup, :checksum, :content, :cookbook, :group, :ignore_failure, :mode, :name, :not_if, :notifies, :only_if, :owner, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports],
-        :cron => [:action, :command, :day, :home, :hour, :ignore_failure, :mailto, :minute, :month, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :shell, :subscribes, :supports, :user, :weekday],
-        :csh => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :deploy => [:action, :additional_remotes, :after_restart, :before_migrate, :before_restart, :before_symlink, :branch, :copy_exclude, :create_dirs_before_symlink, :current_path, :deploy_to, :depth, :destination, :enable_submodules, :environment, :git_ssh_wrapper, :group, :ignore_failure, :migrate, :migration_command, :name, :not_if, :notifies, :only_if, :provider, :purge_before_symlink, :remote, :repo, :repository, :repository_cache, :restart, :restart_command, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :role, :rollback_on_error, :scm_provider, :shallow_clone, :shared_path, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_force_export, :svn_info_args, :svn_password, :svn_username, :symlink_before_migrate, :symlinks, :user],
-        :deploy_branch => [:action, :additional_remotes, :after_restart, :before_migrate, :before_restart, :before_symlink, :branch, :copy_exclude, :create_dirs_before_symlink, :current_path, :deploy_to, :depth, :destination, :enable_submodules, :environment, :git_ssh_wrapper, :group, :ignore_failure, :migrate, :migration_command, :name, :not_if, :notifies, :only_if, :provider, :purge_before_symlink, :remote, :repo, :repository, :repository_cache, :restart, :restart_command, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :role, :rollback_on_error, :scm_provider, :shallow_clone, :shared_path, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_force_export, :svn_info_args, :svn_password, :svn_username, :symlink_before_migrate, :symlinks, :user],
-        :deploy_revision => [:action, :additional_remotes, :after_restart, :before_migrate, :before_restart, :before_symlink, :branch, :copy_exclude, :create_dirs_before_symlink, :current_path, :deploy_to, :depth, :destination, :enable_submodules, :environment, :git_ssh_wrapper, :group, :ignore_failure, :migrate, :migration_command, :name, :not_if, :notifies, :only_if, :provider, :purge_before_symlink, :remote, :repo, :repository, :repository_cache, :restart, :restart_command, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :role, :rollback_on_error, :scm_provider, :shallow_clone, :shared_path, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_force_export, :svn_info_args, :svn_password, :svn_username, :symlink_before_migrate, :symlinks, :user],
-        :directory => [:action, :group, :ignore_failure, :mode, :name, :not_if, :notifies, :only_if, :owner, :path, :provider, :recursive, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :dpkg_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :easy_install_package => [:action, :easy_install_binary, :ignore_failure, :module_name, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :python_binary, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :env => [:action, :delim, :ignore_failure, :key_name, :name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports, :value],
-        :erl_call => [:action, :code, :cookie, :distributed, :ignore_failure, :name, :name_type, :node_name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :execute => [:action, :command, :creates, :cwd, :environment, :group, :ignore_failure, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :file => [:action, :backup, :checksum, :content, :group, :ignore_failure, :mode, :name, :not_if, :notifies, :only_if, :owner, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :freebsd_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :gem_package => [:action, :gem_binary, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :git => [:action, :additional_remotes, :branch, :depth, :destination, :enable_submodules, :group, :ignore_failure, :name, :not_if, :notifies, :only_if, :provider, :reference, :remote, :repo, :repository, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_info_args, :svn_password, :svn_username, :user],
-        :group => [:action, :append, :gid, :group_name, :ignore_failure, :members, :name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports, :system, :users],
-        :http_request => [:action, :headers, :ignore_failure, :message, :name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports, :url],
-        :ifconfig => [:action, :bcast, :bootproto, :device, :hwaddr, :ignore_failure, :inet_addr, :mask, :metric, :mtu, :name, :network, :not_if, :notifies, :onboot, :only_if, :onparent, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports, :target],
-        :link => [:action, :group, :ignore_failure, :link_type, :name, :not_if, :notifies, :only_if, :owner, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports, :target_file, :to],
-        :log => [:action, :ignore_failure, :level, :name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :macports_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :mdadm => [:action, :chunk, :devices, :exists, :ignore_failure, :level, :name, :not_if, :notifies, :only_if, :provider, :raid_device, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :mount => [:action, :device, :device_type, :dump, :enabled, :fstype, :ignore_failure, :mount_point, :mounted, :name, :not_if, :notifies, :only_if, :options, :pass, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :ohai => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :plugin, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :pacman_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :perl => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :portage_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :python => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :remote_directory => [:action, :cookbook, :files_backup, :files_group, :files_mode, :files_owner, :group, :ignore_failure, :mode, :name, :not_if, :notifies, :only_if, :overwrite, :owner, :path, :purge, :provider, :recursive, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports],
-        :remote_file => [:action, :backup, :checksum, :content, :cookbook, :group, :ignore_failure, :mode, :name, :not_if, :notifies, :only_if, :owner, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports],
-        :route => [:action, :device, :domain, :domainname, :gateway, :hostname, :ignore_failure, :metric, :name, :netmask, :networking, :networking_ipv6, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :route_type, :subscribes, :supports, :target],
-        :rpm_package => [:action, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version],
-        :ruby => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :ruby_block => [:action, :block, :ignore_failure, :name, :not_if, :notifies, :only_if, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :subscribes, :supports],
-        :scm => [:action, :depth, :destination, :enable_submodules, :group, :ignore_failure, :name, :not_if, :notifies, :only_if, :provider, :remote, :repository, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_info_args, :svn_password, :svn_username, :user],
-        :script => [:action, :code, :command, :creates, :cwd, :environment, :flags, :group, :ignore_failure, :interpreter, :name, :not_if, :notifies, :only_if, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :returns, :subscribes, :supports, :timeout, :umask, :user],
-        :service => [:action, :enabled, :ignore_failure, :name, :not_if, :notifies, :only_if, :pattern, :priority, :provider, :reload_command, :restart_command, :retries, :retries=, :retry_delay, :retry_delay=, :running, :service_name, :start_command, :status_command, :stop_command, :subscribes, :supports],
-        :subversion => [:action, :depth, :destination, :enable_submodules, :group, :ignore_failure, :name, :not_if, :notifies, :only_if, :provider, :remote, :repository, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_info_args, :svn_password, :svn_username, :user],
-        :template => [:action, :backup, :checksum, :content, :cookbook, :group, :ignore_failure, :local, :mode, :name, :not_if, :notifies, :only_if, :owner, :path, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :variables],
-        :timestamped_deploy => [:action, :additional_remotes, :after_restart, :before_migrate, :before_restart, :before_symlink, :branch, :copy_exclude, :create_dirs_before_symlink, :current_path, :deploy_to, :depth, :destination, :enable_submodules, :environment, :git_ssh_wrapper, :group, :ignore_failure, :migrate, :migration_command, :name, :not_if, :notifies, :only_if, :provider, :purge_before_symlink, :remote, :repo, :repository, :repository_cache, :restart, :restart_command, :retries, :retries=, :retry_delay, :retry_delay=, :revision, :role, :rollback_on_error, :scm_provider, :shallow_clone, :shared_path, :ssh_wrapper, :subscribes, :supports, :svn_arguments, :svn_force_export, :svn_info_args, :svn_password, :svn_username, :symlink_before_migrate, :symlinks, :user],
-        :user => [:action, :comment, :gid, :group, :home, :ignore_failure, :manage_home, :name, :non_unique, :not_if, :notifies, :only_if, :password, :provider, :retries, :retries=, :retry_delay, :retry_delay=, :shell, :subscribes, :supports, :system, :uid, :username],
-        :yum_package => [:action, :allow_downgrade, :arch, :flush_cache, :ignore_failure, :name, :not_if, :notifies, :only_if, :options, :package_name, :provider, :response_file, :retries, :retries=, :retry_delay, :retry_delay=, :source, :subscribes, :supports, :version]
-    }
-
     # Is the specified attribute valid for the type of resource?
     #
     # @param [Symbol] resource_type The type of Chef resource
     # @param [Symbol] attribute_name The attribute name
     def attribute?(resource_type, attribute_name)
-      return true unless RESOURCE_ATTRIBUTES.include?(resource_type)
-      RESOURCE_ATTRIBUTES[resource_type].include?(attribute_name)
+      load_metadata
+      resource_attributes = @dsl_metadata[:attributes]
+      return true unless resource_attributes.include?(resource_type)
+      resource_attributes[resource_type].include?(attribute_name.to_s)
     end
 
     module Search

rakelib/dsl_methods.rake

@@ -0,0 +1,32 @@
+require 'chef'
+require 'chef/mixin/convert_to_class_name'
+require 'yajl'
+
+include Chef::Mixin::ConvertToClassName
+METADATA_FILE = 'chef_dsl_metadata.json'
+
+file METADATA_FILE do
+  chef_dsl_metadata = {:dsl_methods => chef_dsl_methods,
+                       :attributes => chef_resource_attributes}
+  Yajl::Encoder.encode(chef_dsl_metadata, File.open(METADATA_FILE, 'w'),
+    :pretty => true)
+end
+
+def chef_dsl_methods
+  (Chef::Node.public_instance_methods +
+   Chef::Mixin::RecipeDefinitionDSLCore.included_modules.map do |mixin|
+     mixin.public_instance_methods
+   end).flatten.sort.uniq
+end
+
+def self.chef_resource_attributes
+  resources = Chef::Resource.constants.sort.map do |resource_klazz|
+    resource = Chef::Resource.const_get(resource_klazz)
+    if resource.respond_to?(:public_instance_methods) and
+       resource.ancestors.include?(Chef::Resource)
+      [convert_to_snake_case(resource_klazz.to_s),
+       resource.public_instance_methods(true).sort]
+    end
+  end
+  Hash[resources]
+end