rubocop-sketchup 1.4.0 → 1.5.0

data/lib/rubocop/sketchup/formatter/extension_review.rb

@@ -1,269 +1,269 @@
-# frozen_string_literal: true
-
-require 'cgi'
-require 'erb'
-require 'ostruct'
-require 'base64'
-require 'rubocop/formatter/text_util'
-
-module RuboCop
-  module Formatter
-    # This formatter saves the output as an html file.
-    class ExtensionReviewFormatter < BaseFormatter
-      ELLIPSES = '<span class="extra-code">...</span>'
-      TEMPLATE_PATH =
-          File.expand_path('../../../../assets/output.html.erb', __dir__)
-
-      Color = Struct.new(:red, :green, :blue, :alpha) do
-        def to_s
-          "rgba(#{values.join(', ')})"
-        end
-
-        def fade_out(amount)
-          dup.tap do |color|
-            color.alpha -= amount
-          end
-        end
-      end
-
-      attr_reader :categories, :files, :summary
-
-      def initialize(output, options = {})
-        super
-        @categories = {}
-        @files = []
-        @summary = OpenStruct.new(offense_count: 0)
-      end
-
-      def started(target_files)
-        summary.target_files = target_files
-      end
-
-      def file_finished(file, offenses)
-        files << file
-        offenses.each { |offense|
-          # Report only SketchUp related cops.
-          next unless offense.cop_name.start_with?('Sketchup')
-
-          report = OpenStruct.new(path: file, offense: offense)
-          categories[offense.cop_name] ||= []
-          categories[offense.cop_name] << report
-          summary.offense_count += 1
-        }
-      end
-
-      def finished(inspected_files)
-        summary.inspected_files = inspected_files
-
-        render_html
-      end
-
-      def render_html
-        context = ERBContext.new(categories, files, summary)
-
-        template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
-        erb = ERB.new(template, trim_mode: '-')
-        html = erb.result(context.binding)
-
-        output.write html
-      end
-
-      # This class provides helper methods used in the ERB template.
-      class ERBContext
-        include PathUtil
-        include TextUtil
-
-        SEVERITY_COLORS = {
-          refactor:   Color.new(0x29, 0x6B, 0xF0, 1.0),
-          convention: Color.new(0x29, 0x6B, 0xF0, 1.0),
-          warning:    Color.new(0xED, 0x9C, 0x28, 1.0),
-          error:      Color.new(0xD2, 0x32, 0x2D, 1.0),
-          fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0),
-        }.freeze
-
-        LOGO_IMAGE_PATH =
-            File.expand_path('../../../../assets/logo.png', __dir__)
-
-        SORT_ORDER = %w[
-          SketchupRequirements
-          SketchupDeprecations
-          SketchupPerformance
-          SketchupSuggestions
-          SketchupBugs
-        ].freeze
-
-        DEPARTMENT_DESCRIPTIONS = {
-          'SketchupRequirements' => <<-DESCRIPTION,
-            This is the most important set of checks. They represent a large
-            part of the technical requirements an extension must pass in order
-            to be hosted on Extension Warehouse.
-
-            They have been designed to prevent extensions from conflicting with
-            each other as well as avoiding bad side-effects for the end user.
-
-            Please address these as soon as possible.
-          DESCRIPTION
-          'SketchupDeprecations' => <<-DESCRIPTION,
-            This department checks for usage of deprecated features. It's
-            recommended that you migrate your code away from deprecated features
-            of the SketchUp API.
-
-            This department is not a requirement for submission to
-            Extension Warehouse.
-          DESCRIPTION
-          'SketchupPerformance' => <<-DESCRIPTION,
-            This department looks for known patterns that have noticeable
-            performance impact on SketchUp and/or your extension. It's worth
-            looking into these warnings and investigate whether performance
-            can be improved.
-
-            This department is not a requirement for submission to
-            Extension Warehouse.
-          DESCRIPTION
-          'SketchupSuggestions' => <<-DESCRIPTION,
-            This department is a collection of suggestions for best practices
-            that aim to improve the general quality of your extension. Some of
-            these might be more noisy than the rest of the cops. Disable as
-            needed after reviewing the suggestions.
-
-            This department is not a requirement for submission to
-            Extension Warehouse.
-          DESCRIPTION
-          'SketchupBugs' => <<-DESCRIPTION,
-            This department warns about known bugs in the SketchUp API. It uses
-            the TargetSketchUpVersion configuration to determine if the bug is
-            relevant for your project. This department isn't a collection of all
-            known bugs. But only a subset which can be reasonable detected..
-
-            This department is not a requirement for submission to
-            Extension Warehouse.
-          DESCRIPTION
-        }.freeze
-
-        attr_reader :categories, :files, :summary
-
-        def initialize(categories, files, summary)
-          @categories = sort_categories(categories)
-          @files = files.sort
-          @summary = summary
-        end
-
-        def department(cop_name)
-          cop_name.split('/').first
-        end
-
-        def department_description(cop_name)
-          dep = department(cop_name)
-          text = DEPARTMENT_DESCRIPTIONS[dep] || 'MISSING DESCRIPTION'
-          format_plain_text(text)
-        end
-
-        def department_offense_count(cop_name)
-          dep = department(cop_name)
-          count = 0
-          categories.each { |category, offenses|
-            next unless department(category) == dep
-
-            count += offenses.size
-          }
-          count
-        end
-
-        def new_department?(cop_name)
-          @processed_departments ||= Set.new
-          dep = department(cop_name)
-          unless @processed_departments.include?(dep)
-            @processed_departments << dep
-            return true
-          end
-          false
-        end
-
-        def format_plain_text(text)
-          paragraphs = text.split(/(\n\r|\r\n|\r|\n){2,}/m)
-          "<p>#{paragraphs.join('</p><p>')}</p>"
-        end
-
-        def sort_categories(categories)
-          categories.sort { |a, b|
-            # First sort departments by custom ordering (of importance).
-            # Then sort by cop name.
-            a_department, a_name = a[0].split('/')
-            b_department, b_name = b[0].split('/')
-            # Sort SketchUp cops at the top, then all the rest comes after.
-            # First sorting by department.
-            sort_order_a = SORT_ORDER.index(a_department)
-            sort_order_b = SORT_ORDER.index(b_department)
-            if sort_order_a.nil? && sort_order_b.nil?
-              n = a_department <=> b_department
-            else
-              sort_order_a ||= SORT_ORDER.size
-              sort_order_b ||= SORT_ORDER.size
-              n = sort_order_a <=> sort_order_b
-            end
-            # Them sort by name if departments match.
-            n == 0 ? a_name <=> b_name : n
-          }.to_h
-        end
-
-        # Make Kernel#binding public.
-        def binding # rubocop:disable Lint/UselessMethodDefinition
-          super
-        end
-
-        def decorated_message(offense)
-          offense.message
-                 .gsub(/`(.+?)`/) do
-                   "<code>#{Regexp.last_match(1)}</code>"
-                 end
-                 .gsub(/\((http[^ ]+)\)/) do
-                   url = Regexp.last_match(1)
-                   "<br><a href=\"#{url}\">#{url}</a>"
-                 end
-        end
-
-        def highlighted_source_line(offense)
-          source_before_highlight(offense) +
-            hightlight_source_tag(offense) +
-            source_after_highlight(offense) +
-            possible_ellipses(offense.location)
-        end
-
-        def hightlight_source_tag(offense)
-          "<span class=\"highlight #{offense.severity}\">" \
-            "#{escape(offense.highlighted_area.source)}" \
-            '</span>'
-        end
-
-        def source_before_highlight(offense)
-          source_line = offense.location.source_line
-          escape(source_line[0...offense.highlighted_area.begin_pos])
-        end
-
-        def source_after_highlight(offense)
-          source_line = offense.location.source_line
-          escape(source_line[offense.highlighted_area.end_pos..])
-        end
-
-        def possible_ellipses(location)
-          location.first_line == location.last_line ? '' : " #{ELLIPSES}"
-        end
-
-        def cop_anchor(cop_name)
-          title = cop_name.downcase
-          title.tr!('/', '_')
-          "offense_#{title}"
-        end
-
-        def escape(string)
-          CGI.escapeHTML(string)
-        end
-
-        def base64_encoded_logo_image
-          image = File.read(LOGO_IMAGE_PATH, binmode: true)
-          Base64.encode64(image)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'cgi'
+require 'erb'
+require 'ostruct'
+require 'base64'
+require 'rubocop/formatter/text_util'
+
+module RuboCop
+  module Formatter
+    # This formatter saves the output as an html file.
+    class ExtensionReviewFormatter < BaseFormatter
+      ELLIPSES = '<span class="extra-code">...</span>'
+      TEMPLATE_PATH =
+          File.expand_path('../../../../assets/output.html.erb', __dir__)
+
+      Color = Struct.new(:red, :green, :blue, :alpha) do
+        def to_s
+          "rgba(#{values.join(', ')})"
+        end
+
+        def fade_out(amount)
+          dup.tap do |color|
+            color.alpha -= amount
+          end
+        end
+      end
+
+      attr_reader :categories, :files, :summary
+
+      def initialize(output, options = {})
+        super
+        @categories = {}
+        @files = []
+        @summary = OpenStruct.new(offense_count: 0)
+      end
+
+      def started(target_files)
+        summary.target_files = target_files
+      end
+
+      def file_finished(file, offenses)
+        files << file
+        offenses.each { |offense|
+          # Report only SketchUp related cops.
+          next unless offense.cop_name.start_with?('Sketchup')
+
+          report = OpenStruct.new(path: file, offense: offense)
+          categories[offense.cop_name] ||= []
+          categories[offense.cop_name] << report
+          summary.offense_count += 1
+        }
+      end
+
+      def finished(inspected_files)
+        summary.inspected_files = inspected_files
+
+        render_html
+      end
+
+      def render_html
+        context = ERBContext.new(categories, files, summary)
+
+        template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
+        erb = ERB.new(template, trim_mode: '-')
+        html = erb.result(context.binding)
+
+        output.write html
+      end
+
+      # This class provides helper methods used in the ERB template.
+      class ERBContext
+        include PathUtil
+        include TextUtil
+
+        SEVERITY_COLORS = {
+          refactor:   Color.new(0x29, 0x6B, 0xF0, 1.0),
+          convention: Color.new(0x29, 0x6B, 0xF0, 1.0),
+          warning:    Color.new(0xED, 0x9C, 0x28, 1.0),
+          error:      Color.new(0xD2, 0x32, 0x2D, 1.0),
+          fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0),
+        }.freeze
+
+        LOGO_IMAGE_PATH =
+            File.expand_path('../../../../assets/logo.png', __dir__)
+
+        SORT_ORDER = %w[
+          SketchupRequirements
+          SketchupDeprecations
+          SketchupPerformance
+          SketchupSuggestions
+          SketchupBugs
+        ].freeze
+
+        DEPARTMENT_DESCRIPTIONS = {
+          'SketchupRequirements' => <<-DESCRIPTION,
+            This is the most important set of checks. They represent a large
+            part of the technical requirements an extension must pass in order
+            to be hosted on Extension Warehouse.
+
+            They have been designed to prevent extensions from conflicting with
+            each other as well as avoiding bad side-effects for the end user.
+
+            Please address these as soon as possible.
+          DESCRIPTION
+          'SketchupDeprecations' => <<-DESCRIPTION,
+            This department checks for usage of deprecated features. It's
+            recommended that you migrate your code away from deprecated features
+            of the SketchUp API.
+
+            This department is not a requirement for submission to
+            Extension Warehouse.
+          DESCRIPTION
+          'SketchupPerformance' => <<-DESCRIPTION,
+            This department looks for known patterns that have noticeable
+            performance impact on SketchUp and/or your extension. It's worth
+            looking into these warnings and investigate whether performance
+            can be improved.
+
+            This department is not a requirement for submission to
+            Extension Warehouse.
+          DESCRIPTION
+          'SketchupSuggestions' => <<-DESCRIPTION,
+            This department is a collection of suggestions for best practices
+            that aim to improve the general quality of your extension. Some of
+            these might be more noisy than the rest of the cops. Disable as
+            needed after reviewing the suggestions.
+
+            This department is not a requirement for submission to
+            Extension Warehouse.
+          DESCRIPTION
+          'SketchupBugs' => <<-DESCRIPTION,
+            This department warns about known bugs in the SketchUp API. It uses
+            the TargetSketchUpVersion configuration to determine if the bug is
+            relevant for your project. This department isn't a collection of all
+            known bugs. But only a subset which can be reasonable detected..
+
+            This department is not a requirement for submission to
+            Extension Warehouse.
+          DESCRIPTION
+        }.freeze
+
+        attr_reader :categories, :files, :summary
+
+        def initialize(categories, files, summary)
+          @categories = sort_categories(categories)
+          @files = files.sort
+          @summary = summary
+        end
+
+        def department(cop_name)
+          cop_name.split('/').first
+        end
+
+        def department_description(cop_name)
+          dep = department(cop_name)
+          text = DEPARTMENT_DESCRIPTIONS[dep] || 'MISSING DESCRIPTION'
+          format_plain_text(text)
+        end
+
+        def department_offense_count(cop_name)
+          dep = department(cop_name)
+          count = 0
+          categories.each { |category, offenses|
+            next unless department(category) == dep
+
+            count += offenses.size
+          }
+          count
+        end
+
+        def new_department?(cop_name)
+          @processed_departments ||= Set.new
+          dep = department(cop_name)
+          unless @processed_departments.include?(dep)
+            @processed_departments << dep
+            return true
+          end
+          false
+        end
+
+        def format_plain_text(text)
+          paragraphs = text.split(/(\n\r|\r\n|\r|\n){2,}/m)
+          "<p>#{paragraphs.join('</p><p>')}</p>"
+        end
+
+        def sort_categories(categories)
+          categories.sort { |a, b|
+            # First sort departments by custom ordering (of importance).
+            # Then sort by cop name.
+            a_department, a_name = a[0].split('/')
+            b_department, b_name = b[0].split('/')
+            # Sort SketchUp cops at the top, then all the rest comes after.
+            # First sorting by department.
+            sort_order_a = SORT_ORDER.index(a_department)
+            sort_order_b = SORT_ORDER.index(b_department)
+            if sort_order_a.nil? && sort_order_b.nil?
+              n = a_department <=> b_department
+            else
+              sort_order_a ||= SORT_ORDER.size
+              sort_order_b ||= SORT_ORDER.size
+              n = sort_order_a <=> sort_order_b
+            end
+            # Them sort by name if departments match.
+            n == 0 ? a_name <=> b_name : n
+          }.to_h
+        end
+
+        # Make Kernel#binding public.
+        def binding # rubocop:disable Lint/UselessMethodDefinition
+          super
+        end
+
+        def decorated_message(offense)
+          offense.message
+                 .gsub(/`(.+?)`/) do
+                   "<code>#{Regexp.last_match(1)}</code>"
+                 end
+                 .gsub(/\((http[^ ]+)\)/) do
+                   url = Regexp.last_match(1)
+                   "<br><a href=\"#{url}\">#{url}</a>"
+                 end
+        end
+
+        def highlighted_source_line(offense)
+          source_before_highlight(offense) +
+            hightlight_source_tag(offense) +
+            source_after_highlight(offense) +
+            possible_ellipses(offense.location)
+        end
+
+        def hightlight_source_tag(offense)
+          "<span class=\"highlight #{offense.severity}\">" \
+            "#{escape(offense.highlighted_area.source)}" \
+            '</span>'
+        end
+
+        def source_before_highlight(offense)
+          source_line = offense.location.source_line
+          escape(source_line[0...offense.highlighted_area.begin_pos])
+        end
+
+        def source_after_highlight(offense)
+          source_line = offense.location.source_line
+          escape(source_line[offense.highlighted_area.end_pos..])
+        end
+
+        def possible_ellipses(location)
+          location.first_line == location.last_line ? '' : " #{ELLIPSES}"
+        end
+
+        def cop_anchor(cop_name)
+          title = cop_name.downcase
+          title.tr!('/', '_')
+          "offense_#{title}"
+        end
+
+        def escape(string)
+          CGI.escapeHTML(string)
+        end
+
+        def base64_encoded_logo_image
+          image = File.read(LOGO_IMAGE_PATH, binmode: true)
+          Base64.encode64(image)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module SketchUp
+    class Generator < RuboCop::Cop::Generator
+      def source_path
+        department = snake_case(badge.department.to_s).gsub(/^sketchup_/, '')
+        File.join(
+            'lib',
+            'rubocop',
+            'sketchup', # We have our cops nested one extra level.
+            'cop',
+            department,
+            "#{snake_case(badge.cop_name.to_s)}.rb"
+          )
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/inject.rb

@@ -1,19 +1,19 @@
-# frozen_string_literal: true
-
-module RuboCop
-  # Ripped directly from rubocop-rspec.
-  module SketchUp
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = RuboCop::Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  # Ripped directly from rubocop-rspec.
+  module SketchUp
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = RuboCop::Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end