inspecstyle 0.1.1 → 0.1.6

data/lib/rubocop/cop/inspecstyle/deprecated_attributes.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-# TODO: when finished, run `rake generate_cops_documentation` to update the docs
 module RuboCop
   module Cop
     module InSpecStyle
+      # Checks if deprecated method attribute is used.
       #
-      # @example EnforcedStyle: input (default)
+      # @example EnforcedStyle: InSpecStyle (default)
       #   # Attributes have been deprecated for inputs
       #   # https://github.com/inspec/inspec/issues/3802
       #
@@ -18,7 +18,8 @@ module RuboCop
       class DeprecatedAttributes < Cop
         include RangeHelp
 
-        MSG = 'Use `#input` instead of `#attribute`.'
+        MSG = 'Use `#input` instead of `#attribute`. This will be removed in '\
+              'InSpec 5'
 
         def_node_matcher :attribute?, <<~PATTERN
           (send nil? :attribute ...)
@@ -26,24 +27,25 @@ module RuboCop
 
         def on_send(node)
           return unless attribute?(node)
-          add_offense(node, location: range(node))
+
+          add_offense(node, location: node.loc.selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(offense_range(node), preferred_replacement)
+          end
         end
 
         private
 
-        def range(node)
-          # Only highlights the method 'attribute'
-          range_between(node.source_range.begin_pos,
-            node.source_range.begin_pos+9
-          )
+        def offense_range(node)
+          node.loc.selector
         end
 
-        # def autocorrect
-        #   ->(corrector) do
-        #     corrector.insert_before(node.source_range, 'input')
-        #     corrector.remove(node.source_range, 'attribute')
-        #   end
-        # end
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
       end
     end
   end

data/lib/rubocop/cop/inspecstyle/first_cop.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# TODO: when finished, run `rake generate_cops_documentation` to update the docs
 module RuboCop
   module Cop
     module InSpecStyle

data/lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # Description of the `bar` style.
+      #
+      #   # bad
+      #   sql = oracledb_session(user: 'my_user', pass: 'password')
+      #
+      #   # good
+      #   sql = oracledb_session(user: 'my_user', password: 'password')
+      class OracleDbSessionPass < Cop
+        include MatchRange
+        MSG = 'Use `:password` instead of `:pass`. This will be removed in '\
+              'InSpec 5'
+
+        def_node_matcher :oracledb_session_pass?, <<~PATTERN
+          (send _ :oracledb_session
+            (hash
+              ...
+              (pair
+                (sym $:pass)
+                ...)))
+        PATTERN
+
+        # Getting location was a bit tricky on this one, looking at docs perhaps
+        # convention does allow highlighting an entire line.
+        def on_send(node)
+          return unless result = oracledb_session_pass?(node)
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/shadow_properties.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# NOTE TO SELF - this one works BUT not if other its statements are defined. Needs
+# to work in any arrangement. This is a powerful one to crack as this pattern
+# will be used in a LOT of other cops. 
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # Shadow resource property user is deprecated in favor of `users`
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # Use users instead
+      #
+      #   # bad
+      #   describe shadow('/etc/my-custom-place/shadow') do
+      #     its('user') { should eq 'user' }
+      #   end
+      #
+      #   # good
+      #   describe shadow('/etc/my-custom-place/shadow') do
+      #     its('users') { should eq 'user' }
+      #   end
+      #
+      class ShadowProperties < Cop
+        # TODO: Implement the cop in here.
+        #
+        # In many cases, you can use a node matcher for matching node pattern.
+        # See https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/node_pattern.rb
+        #
+        # For example
+        MSG = 'Use `:%<modifier>ss` instead of `:%<modifier>s` as a property ' \
+        'for the `shadow` resource. This property will be removed in InSpec 5'
+
+        def_node_matcher :shadow_resource_user_property?, <<~PATTERN
+          (block
+            (send _ :describe
+              (send _ :shadow ...) ...)
+            (args ...)
+            (block
+              (send _ :its
+                (str ${"user" "password" "last_change" "expiry_date" "line"} ...) ...) ...) ...)
+        PATTERN
+
+        def on_block(node)
+          return unless shadow_resource_user_property?(node) do |modifier|
+            message = format(MSG, modifier: modifier)
+            range = locate_range(modifier, node)
+            add_offense(node, message: message, location: range)
+          end
+        end
+
+        private
+
+        def locate_range(modifier, node)
+          node.children.find { |child| child.type == :block }.children.first.children.find{|x| x == s(:str, modifier)}.source_range
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle_cops.rb

@@ -1,3 +1,6 @@
 # frozen_string_literal: true
 require_relative 'inspecstyle/first_cop'
 require_relative 'inspecstyle/deprecated_attributes'
+require_relative 'inspecstyle/azure_generic_resource'
+require_relative 'inspecstyle/shadow_properties'
+require_relative 'inspecstyle/oracle_db_session_pass'

data/lib/rubocop/inspecstyle/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module InSpecStyle
-    VERSION = "0.1.1"
+    VERSION = "0.1.6"
   end
 end

data/notes-for-development.md

@@ -42,4 +42,7 @@ node = source.ast
 node.type
 node.children
 node.source
+NodePattern.new('(send ...)').match(node) # => true
 ```
+
+Correction docs at rubocop's: lib/rubocop/cop/corrector.rb

data/tasks/cops_documentation.rake

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rubocop'
+
+YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
+  task.files = ['lib/rubocop/cop/*/*.rb']
+  task.options = ['--no-output']
+end
+
+desc 'Generate docs of all cops departments'
+task generate_cops_documentation: :yard_for_generate_documentation do
+  def cops_of_department(cops, department)
+    cops.with_department(department).sort!
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def cops_body(config, cop, description, examples_objects, pars)
+    content = h2(cop.cop_name)
+    content << required_ruby_version(cop)
+    content << properties(cop.new(config))
+    content << "#{description}\n"
+    content << examples(examples_objects) if examples_objects.count.positive?
+    content << configurations(pars)
+    content << references(config, cop)
+    content
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def examples(examples_object)
+    examples_object.each_with_object(h3('Examples').dup) do |example, content|
+      content << "\n" unless content.end_with?("\n\n")
+      content << h4(example.name) unless example.name == ''
+      content << code_example(example)
+    end
+  end
+
+  def required_ruby_version(cop)
+    return '' unless cop.respond_to?(:required_minimum_ruby_version)
+
+    "NOTE: Required Ruby version: #{cop.required_minimum_ruby_version}\n\n"
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def properties(cop_instance)
+    header = [
+      'Enabled by default', 'Safe', 'Supports autocorrection', 'VersionAdded',
+      'VersionChanged'
+    ]
+    autocorrect = if cop_instance.support_autocorrect?
+                    "Yes#{' (Unsafe)' unless cop_instance.safe_autocorrect?}"
+                  else
+                    'No'
+                  end
+    cop_config = cop_instance.cop_config
+    content = [[
+      cop_status(cop_config.fetch('Enabled')),
+      cop_config.fetch('Safe', true) ? 'Yes' : 'No',
+      autocorrect,
+      cop_config.fetch('VersionAdded', '-'),
+      cop_config.fetch('VersionChanged', '-')
+    ]]
+    to_table(header, content) + "\n"
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def h2(title)
+    content = +"\n"
+    content << "== #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def h3(title)
+    content = +"\n"
+    content << "=== #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def h4(title)
+    content = +"==== #{title}\n"
+    content << "\n"
+    content
+  end
+
+  def code_example(ruby_code)
+    content = +"[source,ruby]\n----\n"
+    content << ruby_code.text.gsub('@good', '# good')
+                        .gsub('@bad', '# bad').strip
+    content << "\n----\n"
+    content
+  end
+
+  def configurations(pars)
+    return '' if pars.empty?
+
+    header = ['Name', 'Default value', 'Configurable values']
+    configs = pars
+              .each_key
+              .reject { |key| key.start_with?('Supported') }
+              .reject { |key| key.start_with?('AllowMultipleStyles') }
+    content = configs.map do |name|
+      configurable = configurable_values(pars, name)
+      default = format_table_value(pars[name])
+      [name, default, configurable]
+    end
+
+    h3('Configurable attributes') + to_table(header, content)
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
+  def configurable_values(pars, name)
+    case name
+    when /^Enforced/
+      supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
+      format_table_value(pars[supported_style_name])
+    when 'IndentationWidth'
+      'Integer'
+    when 'Database'
+      format_table_value(pars['SupportedDatabases'])
+    else
+      case pars[name]
+      when String
+        'String'
+      when Integer
+        'Integer'
+      when Float
+        'Float'
+      when true, false
+        'Boolean'
+      when Array
+        'Array'
+      else
+        ''
+      end
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity,Metrics/MethodLength
+
+  def to_table(header, content)
+    table = [
+      '|===',
+      "| #{header.join(' | ')}\n\n"
+    ].join("\n")
+    marked_contents = content.map do |plain_content|
+      plain_content.map { |c| "| #{c}" }.join("\n")
+    end
+    table << marked_contents.join("\n\n")
+    table << "\n|===\n"
+  end
+
+  def format_table_value(val)
+    value =
+      case val
+      when Array
+        if val.empty?
+          '`[]`'
+        else
+          val.map { |config| format_table_value(config) }.join(', ')
+        end
+      else
+        wrap_backtick(val.nil? ? '<none>' : val)
+      end
+    value.gsub("#{Dir.pwd}/", '').rstrip
+  end
+
+  def wrap_backtick(value)
+    if value.is_a?(String)
+      # Use `+` to prevent text like `**/*.gemspec` from being bold.
+      value.start_with?('*') ? "`+#{value}+`" : "`#{value}`"
+    else
+      "`#{value}`"
+    end
+  end
+
+  def references(config, cop)
+    cop_config = config.for_cop(cop)
+    urls = RuboCop::Cop::MessageAnnotator.new(
+      config, cop.name, cop_config, {}
+    ).urls
+    return '' if urls.empty?
+
+    content = h3('References')
+    content << urls.map { |url| "* #{url}" }.join("\n")
+    content << "\n"
+    content
+  end
+
+  def print_cops_of_department(cops, department, config)
+    selected_cops = cops_of_department(cops, department)
+    content = +"= #{department}\n"
+    selected_cops.each do |cop|
+      content << print_cop_with_doc(cop, config)
+    end
+    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/cops_#{department.downcase}.adoc"
+    File.open(file_name, 'w') do |file|
+      puts "* generated #{file_name}"
+      file.write(content.strip + "\n")
+    end
+  end
+
+  def print_cop_with_doc(cop, config)
+    t = config.for_cop(cop)
+    non_display_keys = %w[
+      Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
+      VersionChanged
+    ]
+    pars = t.reject { |k| non_display_keys.include? k }
+    description = 'No documentation'
+    examples_object = []
+    cop_code(cop) do |code_object|
+      description = code_object.docstring unless code_object.docstring.blank?
+      examples_object = code_object.tags('example')
+    end
+    cops_body(config, cop, description, examples_object, pars)
+  end
+
+  def cop_code(cop)
+    YARD::Registry.all(:class).detect do |code_object|
+      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
+
+      yield code_object
+    end
+  end
+
+  def table_of_content_for_department(cops, department)
+    type_title = department[0].upcase + department[1..-1]
+    filename = "cops_#{department.downcase}.adoc"
+    content = +"=== Department xref:#{filename}[#{type_title}]\n\n"
+    cops_of_department(cops, department.to_sym).each do |cop|
+      anchor = cop.cop_name.sub('/', '').downcase
+      content << "* xref:#{filename}##{anchor}[#{cop.cop_name}]\n"
+    end
+
+    content
+  end
+
+  def print_table_of_contents(cops)
+    path = "#{Dir.pwd}/docs/modules/ROOT/pages/cops.adoc"
+    original = File.read(path)
+    content = +"// START_COP_LIST\n\n"
+
+    content << table_contents(cops)
+
+    content << "\n// END_COP_LIST"
+
+    content = original.sub(
+      %r{// START_COP_LIST.+// END_COP_LIST}m, content
+    )
+    File.write(path, content)
+  end
+
+  def table_contents(cops)
+    cops
+      .departments
+      .map(&:to_s)
+      .sort
+      .map { |department| table_of_content_for_department(cops, department) }
+      .join("\n")
+  end
+
+  def cop_status(status)
+    return 'Disabled' unless status
+
+    status == 'pending' ? 'Pending' : 'Enabled'
+  end
+
+  def assert_docs_synchronized
+    # Do not print diff and yield whether exit code was zero
+    sh('git diff --quiet docs') do |outcome, _|
+      return if outcome
+
+      # Output diff before raising error
+      sh('GIT_PAGER=cat git diff docs')
+
+      warn 'The docs directory is out of sync. ' \
+        'Run `rake generate_cops_documentation` and commit the results.'
+      exit!
+    end
+  end
+
+  def main
+    cops   = RuboCop::Cop::Cop.registry
+    config = RuboCop::ConfigLoader.default_configuration
+
+    YARD::Registry.load!
+    cops.departments.sort!.each do |department|
+      print_cops_of_department(cops, department, config)
+    end
+
+    print_table_of_contents(cops)
+
+    assert_docs_synchronized if ENV['CI'] == 'true'
+  ensure
+    RuboCop::ConfigLoader.default_configuration = nil
+  end
+
+  main
+end