rubocop-sketchup 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a682a986a80b22c8a6a1a4882e7ccf730306dc2
-  data.tar.gz: f883dfc7ba5d0100b447ac77364078a475c2a770
+  metadata.gz: 4d7b803688f7c17a0b11ab8b6ac5452d1a4fa925
+  data.tar.gz: 3b0c7b2667761ea2d5a298f9906aeb5c0dd90c93
 SHA512:
-  metadata.gz: e763bf2331404f463e0d9d46ff19fadd9d642066eaf8b0606e108f089af006670e7fce3d3efb3eaa1abf14870e6bae732e353aa88fdd17632c0fff0f1364ac92
-  data.tar.gz: e550faed872bb4308a3658e42cb08aa2bc4880787ca6b01aca53fea0bebfa5291411ee6052ed8feb62466a20c00f66de21567f80b3e0736ee4290fa62e487812
+  metadata.gz: bb8900616392157c20a242834e96163a94aa73a98179679e518b4882297b9875916431383e90ff2883fe109de663783b78d6d274f6f3be338575c2cf83986396
+  data.tar.gz: 0ac20236f7f5e6046dd072ae3722861f3e008709fa9e4e39b5b9f93036124710718c8bfb170df2c8c5a73ecad9f949dc6b7efcbf455214eee1dc4d3138f3c880

data/Gemfile

@@ -3,6 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rake', '~> 10.0', require: false
-  gem 'rspec', '~> 3.4', require: false
+  gem 'rake', '~> 12.0', require: false
+  gem 'rspec', '~> 3.7', require: false
+end
+
+group :development do
+  gem 'nokogiri', '~> 1.8', require: false
 end

data/config/default.yml

@@ -1,4 +1,8 @@
 ---
+AllCops:
+  SketchUp:
+    SourcePath: src
+
 SketchupDeprecations/OperationNextTransparent:
   Description: Third argument in `model.start_operation` is deprecated.
   Details: >-
@@ -60,7 +64,6 @@ SketchupRequirements/FileStructure:
              Check that the extension conform to expected file structure with a
              single root .rb file and a support folder with matching name.
   Enabled: true
-  SourcePath: src
 
 SketchupRequirements/GlobalConstants:
   Description: Do not introduce global constants.
@@ -102,6 +105,14 @@ SketchupRequirements/RegisterExtension:
                  might confuse users to think the extension isn't working.
   Enabled: true
 
+SketchupRequirements/RequireToolsRubyFiles:
+  Description: >-
+                 Due to how require and Sketchup.require checks whether a file
+                 has been loaded, files from SketchUp's Tools folder should be
+                 required in using `require` and with their file extension to
+                 avoid duplicate loading.
+  Enabled: true
+
 SketchupRequirements/RubyCoreNamespace:
   Description: Do not modify Ruby core functionality.
   Enabled: true
@@ -120,7 +131,6 @@ SketchupRequirements/SketchupExtension:
                  This should be done by the root .rb file in the extension
                  package.
   Enabled: true
-  SourcePath: src
 
 
 SketchupSuggestions/DynamicComponentInternals:

data/lib/rubocop-sketchup.rb

@@ -3,6 +3,9 @@ require 'rubocop/sketchup'
 require 'rubocop/sketchup/version'
 require 'rubocop/sketchup/inject'
 
+require 'rubocop/sketchup/formatter/extension_review'
+require 'rubocop/sketchup/config'
+require 'rubocop/sketchup/dc_globals'
 require 'rubocop/sketchup/extension_project'
 require 'rubocop/sketchup/namespace'
 require 'rubocop/sketchup/namespace_checker'
@@ -10,6 +13,21 @@ require 'rubocop/sketchup/no_comment_disable'
 
 RuboCop::SketchUp::Inject.defaults!
 
+# Monkey patching the built in formatter list to add a short alias for custom
+# formatters. Naughty! Naughty!
+class RuboCop::Formatter::FormatterSet
+  formatters = BUILTIN_FORMATTERS_FOR_KEYS.dup
+  formatters['extension_review'] =
+      RuboCop::Formatter::ExtensionReviewFormatter
+  verbose = $VERBOSE
+  begin
+    $VERBOSE = nil
+    BUILTIN_FORMATTERS_FOR_KEYS = formatters.freeze
+  ensure
+    $VERBOSE = verbose
+  end
+end
+
 # Load all custom cops.
 pattern = File.join(__dir__, 'rubocop', 'sketchup', '**/*rb')
 Dir.glob(pattern) { |file|

data/lib/rubocop/sketchup/config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module SketchUp
+    module Config
+
+      DEFAULT_CONFIGURATION =
+        RuboCop::SketchUp::CONFIG.fetch('AllCops').fetch('SketchUp')
+
+      private
+
+      def all_cops_config
+        config.for_all_cops
+      end
+
+      def sketchup_cops_config
+        config.for_all_cops.fetch('SketchUp', DEFAULT_CONFIGURATION)
+      end
+
+      def sketchup_source_path_config?
+        return unless all_cops_config.key?('SketchUp')
+        all_cops_config.fetch('SketchUp').key?('SourcePath')
+      end
+
+      def sketchup_source_path_config
+        sketchup_cops_config.fetch('SourcePath')
+      end
+
+    end
+  end
+end

data/lib/rubocop/sketchup/dc_globals.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module SketchUp
+    module DynamicComponentGlobals
+
+      DC_GLOBALS = %i[
+        $dc_strings
+        $dc_extension
+        $dc_CONFIGURATOR_NAME
+        $dc_REPORTER_NAME
+        $dc_MANAGER_NAME
+        $dc_observers
+      ]
+
+      private
+
+      def dc_global_var?(global_var)
+        DC_GLOBALS.include?(global_var)
+      end
+
+    end
+  end
+end

data/lib/rubocop/sketchup/extension_project.rb

@@ -3,46 +3,46 @@
 require 'pathname'
 
 module RuboCop
-  module Cop
-    module Sketchup
-      module ExtensionProject
-
-        # @return [Pathname]
-        def config_path
-          path = config.instance_variable_get(:@loaded_path)
-          if path
-            Pathname.new(path).expand_path.dirname
-          else
-            Pathname.new(Dir.pwd).expand_path
-          end
-        end
-
-        # @return [Pathname]
-        def relative_source_path
-          Pathname.new(cop_config['SourcePath'] || 'src')
+  module SketchUp
+    module ExtensionProject
+
+      include SketchUp::Config
+
+      # @return [Pathname]
+      def config_path
+        path = config.instance_variable_get(:@loaded_path)
+        if path
+          Pathname.new(path).expand_path.dirname
+        else
+          Pathname.new(Dir.pwd).expand_path
         end
+      end
 
-        # @return [Pathname]
-        def source_path
-          config_path.join(relative_source_path)
-        end
+      # @return [Pathname]
+      def relative_source_path
+        Pathname.new(sketchup_source_path_config)
+      end
 
-        # @param [RuboCop::ProcessedSource] processed_source
-        def path_relative_to_source(processed_source)
-          source_filename = processed_source.buffer.name
-          rel_path = config.path_relative_to_config(source_filename)
-          path = Pathname.new(rel_path).expand_path
-          path.relative_path_from(source_path)
-        end
+      # @return [Pathname]
+      def source_path
+        config_path.join(relative_source_path)
+      end
 
-        # @param [RuboCop::ProcessedSource] processed_source
-        def root_file?(processed_source)
-          filename = path_relative_to_source(processed_source)
-          filename.extname.downcase == '.rb' &&
-            filename.parent.to_s == '.'
-        end
+      # @param [RuboCop::ProcessedSource] processed_source
+      def path_relative_to_source(processed_source)
+        source_filename = processed_source.buffer.name
+        rel_path = config.path_relative_to_config(source_filename)
+        path = Pathname.new(rel_path).expand_path
+        path.relative_path_from(source_path)
+      end
 
+      # @param [RuboCop::ProcessedSource] processed_source
+      def root_file?(processed_source)
+        filename = path_relative_to_source(processed_source)
+        filename.extname.downcase == '.rb' &&
+          filename.parent.to_s == '.'
       end
+
     end
   end
 end

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

@@ -0,0 +1,239 @@
+# 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>'.freeze
+      TEMPLATE_PATH =
+        File.expand_path('../../../../../assets/output.html.erb', __FILE__)
+
+      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 = OpenStruct.new(path: file, offense: offense)
+          categories[offense.cop_name] ||= []
+          categories[offense.cop_name] << report
+        }
+        summary.offense_count += offenses.count
+      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, nil, '-')
+        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(0xED, 0x9C, 0x28, 1.0),
+          convention: Color.new(0xED, 0x9C, 0x28, 1.0),
+          warning:    Color.new(0x96, 0x28, 0xEF, 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', __FILE__)
+
+        SORT_ORDER = %w[
+          SketchupRequirements
+          SketchupDeprecations
+          SketchupPerformance
+          SketchupSuggestions
+        ]
+
+        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
+        }
+
+        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('/')
+            n = SORT_ORDER.index(a_department) <=> SORT_ORDER.index(b_department)
+            n == 0 ? a_name <=> b_name : n
+          }.to_h
+        end
+
+        # Make Kernel#binding public.
+        def binding
+          super
+        end
+
+        def decorated_message(offense)
+          offense.message.gsub(/`(.+?)`/) do
+            "<code>#{Regexp.last_match(1)}</code>"
+          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..-1])
+        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(s)
+          CGI.escapeHTML(s)
+        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/inject.rb

@@ -7,7 +7,7 @@ module RuboCop
       def self.defaults!
         path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, 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)

data/lib/rubocop/sketchup/namespace.rb

@@ -1,48 +1,46 @@
 # frozen_string_literal: true
 
 module RuboCop
-  module Cop
-    module SketchUp
-      class Namespace
-
-        attr_reader :namespace
-
-        SEPARATOR = '::'.freeze
-
-        # @param [String] namespace
-        def initialize(namespace)
-          raise TypeError unless namespace.is_a?(String)
-          @namespace = namespace
-        end
-
-        # Get the first component of a namespace relative to Object.
-        # May return 'Object' if the namespace is in the global namespace.
-        def first
-          parts.find { |name| name != 'Object' } || 'Object'
-        end
-
-        # Get a namespace string that is relative to Object.
-        def from_root
-          items = parts
-          items.shift if items.size > 1 && items.first == 'Object'
-          items.join(SEPARATOR)
-        end
-
-        def join(other)
-          self.class.new("#{@namespace}#{SEPARATOR}#{other}")
-        end
-
-        # Get the first component of a namespace relative to Object.
-        # May return 'Object' if the namespace is in the global namespace.
-        def parts
-          namespace.split(SEPARATOR)
-        end
-
-        def top_level?
-          parts.last == 'Object'
-        end
+  module SketchUp
+    class Namespace
 
+      attr_reader :namespace
+
+      SEPARATOR = '::'.freeze
+
+      # @param [String] namespace
+      def initialize(namespace)
+        raise TypeError unless namespace.is_a?(String)
+        @namespace = namespace
+      end
+
+      # Get the first component of a namespace relative to Object.
+      # May return 'Object' if the namespace is in the global namespace.
+      def first
+        parts.find { |name| name != 'Object' } || 'Object'
       end
+
+      # Get a namespace string that is relative to Object.
+      def from_root
+        items = parts
+        items.shift if items.size > 1 && items.first == 'Object'
+        items.join(SEPARATOR)
+      end
+
+      def join(other)
+        self.class.new("#{@namespace}#{SEPARATOR}#{other}")
+      end
+
+      # Get the first component of a namespace relative to Object.
+      # May return 'Object' if the namespace is in the global namespace.
+      def parts
+        namespace.split(SEPARATOR)
+      end
+
+      def top_level?
+        parts.last == 'Object'
+      end
+
     end
   end
 end

data/lib/rubocop/sketchup/namespace_checker.rb

@@ -1,45 +1,43 @@
 # frozen_string_literal: true
 
 module RuboCop
-  module Cop
-    module Sketchup
-      module NamespaceChecker
-
-        def on_class(node)
-          check_namespace(node)
-        end
-
-        def on_module(node)
-          check_namespace(node)
-        end
-
-        def on_def(node)
-          check_namespace(node)
-        end
-        alias on_defs on_def
-
-        # Constant assignment.
-        def on_casgn(node)
-          check_namespace(node)
-        end
-
-        def check_namespace(node)
-          add_offense(node, location:  :name, severity: :error) if in_namespace?(node)
-        end
-
-        def in_namespace?(node)
-          # parent_module_name might return nil if for instance a method is
-          # defined within a block. (Apparently that is possible...)
-          return false if node.parent_module_name.nil?
-          namespace = SketchUp::Namespace.new(node.parent_module_name)
-          namespaces.include?(namespace.first)
-        end
-
-        def namespaces
-          raise NotImplementedError
-        end
+  module SketchUp
+    module NamespaceChecker
 
+      def on_class(node)
+        check_namespace(node)
       end
+
+      def on_module(node)
+        check_namespace(node)
+      end
+
+      def on_def(node)
+        check_namespace(node)
+      end
+      alias on_defs on_def
+
+      # Constant assignment.
+      def on_casgn(node)
+        check_namespace(node)
+      end
+
+      def check_namespace(node)
+        add_offense(node, location:  :name, severity: :error) if in_namespace?(node)
+      end
+
+      def in_namespace?(node)
+        # parent_module_name might return nil if for instance a method is
+        # defined within a block. (Apparently that is possible...)
+        return false if node.parent_module_name.nil?
+        namespace = SketchUp::Namespace.new(node.parent_module_name)
+        namespaces.include?(namespace.first)
+      end
+
+      def namespaces
+        raise NotImplementedError
+      end
+
     end
   end
 end

data/lib/rubocop/sketchup/no_comment_disable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  module Cop
+  module SketchUp
     module NoCommentDisable
 
       private

data/lib/rubocop/sketchup/performance/typename.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module SketchupPerformance
       class Typename < Cop
-        MSG = '.typename is very slow, prefer .is_a? instead.'.freeze
+        MSG = '`.typename` is very slow, prefer `.is_a?` instead.'.freeze
 
         def on_send(node)
           _, method_name = *node

data/lib/rubocop/sketchup/requirements/api_namespace.rb

@@ -5,8 +5,8 @@ module RuboCop
     module SketchupRequirements
       class ApiNamespace < Cop
 
-        include NoCommentDisable
-        include Sketchup::NamespaceChecker
+        include SketchUp::NoCommentDisable
+        include SketchUp::NamespaceChecker
 
         MSG = 'Do not modify the SketchUp API.'.freeze
 

data/lib/rubocop/sketchup/requirements/exit.rb

@@ -10,7 +10,7 @@ module RuboCop
       # Use `return`, `next` or `break` instead.
       class Exit < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
 
         MSG = 'Exit attempts to kill the Ruby interpreter. Use return, next or break instead.'.freeze
 
@@ -20,7 +20,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          add_offense(node, location: :expression) if exit?(node)
+          add_offense(node, location: :expression, severity: :error) if exit?(node)
         end
       end
     end

data/lib/rubocop/sketchup/requirements/extension_namespace.rb

@@ -9,7 +9,7 @@ module RuboCop
     module SketchupRequirements
       class ExtensionNamespace < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
         include SketchUp
 
         def on_class(node)
@@ -55,7 +55,7 @@ module RuboCop
 
         def message(node)
           namespace = Namespace.new(node.defined_module_name).from_root
-          format('Use a single root namespace. (Found %s; Previously found %s)', namespace, @@namespace)
+          format('Use a single root namespace. (Found `%s`; Previously found `%s`)', namespace, @@namespace)
         end
 
       end

data/lib/rubocop/sketchup/requirements/file_structure.rb

@@ -7,8 +7,8 @@ module RuboCop
       # single root .rb file and a support folder with matching name.
       class FileStructure < Cop
 
-        include Sketchup::ExtensionProject
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
+        include SketchUp::ExtensionProject
 
         IGNORED_DIRECTORIES = %w[
           __MACOSX
@@ -27,7 +27,10 @@ module RuboCop
           # Ensure there is only one root Ruby file.
           if root_ruby_files.size != 1
             msg = "Extensions must have exactly one root Ruby (.rb) file. Found: %d"
-            add_offense(nil, location: range, message: format(msg, root_ruby_files.size))
+            add_offense(nil,
+                location: range,
+                message: format(msg, root_ruby_files.size),
+                severity: :error)
             return
           end
 
@@ -42,7 +45,10 @@ module RuboCop
           # Ensure there is only one sub-directory.
           if sub_folders.size != 1
             msg = "Extensions must have exactly one support directory. Found %d"
-            add_offense(nil, location: range, message: format(msg, sub_folders.size))
+            add_offense(nil,
+                location: range,
+                message: format(msg, sub_folders.size),
+                severity: :error)
             return
           end
 
@@ -51,7 +57,10 @@ module RuboCop
           unless support_directory.basename.to_s == extension_basename
             msg = 'Extensions must have a support directory matching the name of the root Ruby file. Expected %s, found %s'
             msg = format(msg, extension_basename, support_directory.basename)
-            add_offense(nil, location: range, message: msg)
+            add_offense(nil,
+                location: range,
+                message: msg,
+                severity: :error)
           end
         end
 

data/lib/rubocop/sketchup/requirements/global_constants.rb

@@ -5,7 +5,7 @@ module RuboCop
     module SketchupRequirements
       class GlobalConstants < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
         include SketchUp
 
         MSG = 'Do not introduce global constants.'.freeze

data/lib/rubocop/sketchup/requirements/global_methods.rb

@@ -5,7 +5,7 @@ module RuboCop
     module SketchupRequirements
       class GlobalMethods < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
         include SketchUp
 
         MSG = 'Do not introduce global methods.'.freeze

data/lib/rubocop/sketchup/requirements/global_variables.rb

@@ -10,12 +10,15 @@ module RuboCop
       #
       # Note that backreferences like $1, $2, etc are not global variables.
       class GlobalVariables < Cop
-        include NoCommentDisable
+
+        include SketchUp::NoCommentDisable
+        include SketchUp::DynamicComponentGlobals
+
         MSG = 'Do not introduce global variables.'.freeze
 
         # predefined global variables their English aliases
         # http://www.zenspider.com/Languages/Ruby/QuickRef.html
-        BUILT_IN_VARS = %w(
+        BUILT_IN_VARS = %i[
           $: $LOAD_PATH
           $" $LOADED_FEATURES
           $0 $PROGRAM_NAME
@@ -42,21 +45,30 @@ module RuboCop
           $DEBUG $FILENAME $VERBOSE $SAFE
           $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
           $CLASSPATH $JRUBY_VERSION $JRUBY_REVISION $ENV_JAVA
-        ).map(&:to_sym)
+        ]
 
-        # TODO: This should probably be read only.
-        SKETCHUP_VARS = %w(
+        SKETCHUP_VARS = %i[
           $loaded_files
-        ).map(&:to_sym)
+        ]
+
+        # Some globals, like DC's, are being read from so often that it's better
+        # to ignore these to reduce noise.
+        READ_ONLY_VARS = DC_GLOBALS
 
         ALLOWED_VARS = BUILT_IN_VARS | SKETCHUP_VARS
 
+
         def allowed_var?(global_var)
           ALLOWED_VARS.include?(global_var)
         end
 
+        def read_allowed?(global_var)
+          READ_ONLY_VARS.include?(global_var)
+        end
+
         def on_gvar(node)
-          check(node)
+          global_var, = *node
+          check(node) unless read_allowed?(global_var)
         end
 
         def on_gvasgn(node)

data/lib/rubocop/sketchup/requirements/language_handler_globals.rb

@@ -8,6 +8,8 @@ module RuboCop
       # They are still in use due to compatibility reasons.
       class LanguageHandlerGlobals < Cop
 
+        include SketchUp::NoCommentDisable
+
         MSG = "Avoid globals in general, but especially these which are known to be in use.".freeze
 
         LH_GLOBALS = %i[

data/lib/rubocop/sketchup/requirements/load_path.rb

@@ -5,7 +5,7 @@ module RuboCop
     module SketchupRequirements
       class LoadPath < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
 
         MSG = 'Do not modify the load path.'.freeze
 

data/lib/rubocop/sketchup/requirements/minimal_registration.rb

@@ -9,8 +9,8 @@ module RuboCop
       # Extensions should not load additional files when it's disabled.
       class MinimalRegistration < Cop
 
-        include Sketchup::ExtensionProject
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
+        include SketchUp::ExtensionProject
 
         MSG = "Don't load extension files in the root file registering the extension.".freeze
 
@@ -39,7 +39,7 @@ module RuboCop
           filename = require_filename(node)
           return if filename.nil?
           return unless extension_file?(filename)
-          add_offense(node)
+          add_offense(node, severity: :error)
         end
 
       end

data/lib/rubocop/sketchup/requirements/register_extension.rb

@@ -7,7 +7,7 @@ module RuboCop
       # confuse users to think the extension isn't working.
       class RegisterExtension < Cop
 
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
 
         MSG = 'Always register extensions to load by default.'.freeze
 
@@ -20,12 +20,12 @@ module RuboCop
         def on_send(node)
           sketchup_register_extension(node).each { |args|
             if args.size < 2
-              add_offense(node)
+              add_offense(node, severity: :error)
               next
             end
             load_arg = args[1]
             next if load_arg.true_type?
-            add_offense(load_arg)
+            add_offense(load_arg, severity: :error)
           }
         end
 

data/lib/rubocop/sketchup/requirements/require_tools_ruby_files.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Due to how require and Sketchup.require checks whether a file has been
+      # loaded, files from SketchUp's Tools folder should be required in using
+      # `require` and with their file extension to avoid duplicate loading.
+      class RequireToolsRubyFiles < Cop
+
+        include SketchUp::NoCommentDisable
+
+        MSG = "Require files from SketchUp's Tools directory with require.".freeze
+
+        RUBY_FILES = %w[extensions.rb langhandler.rb sketchup.rb]
+
+
+        def_node_matcher :ruby_require, <<-PATTERN
+          (send nil? :require (str $_))
+        PATTERN
+
+        def_node_matcher :ruby_require?, <<-PATTERN
+          (send nil? :require (str _))
+        PATTERN
+
+
+        def_node_matcher :sketchup_require, <<-PATTERN
+          (send
+            (const nil? :Sketchup) :require
+            (str $_)
+          )
+        PATTERN
+
+        def_node_matcher :sketchup_require?, <<-PATTERN
+          (send
+            (const nil? :Sketchup) :require
+            (str _)
+          )
+        PATTERN
+
+
+        def on_send(node)
+          if ruby_require?(node)
+            # The Tools folder Ruby files should be loaded using `require` and
+            # include the ".rb" file extension.
+            filename = ruby_require(node)
+            return unless tools_file_required?(filename)
+            return if expected_require_syntax?(filename)
+            add_offense(node, location: :expression, severity: :error)
+          elsif sketchup_require?(node)
+            # The Tools folder Ruby files should not be loaded using
+            # `Sketchup.require`.
+            filename = sketchup_require(node)
+            return unless tools_file_required?(filename)
+            add_offense(node, location: :expression, severity: :error)
+          end
+        end
+
+        private
+
+        def tools_file_required?(filename)
+          ext = File.extname(filename)
+          full_filename = ext.empty? ? "#{filename}.rb" : filename
+          RUBY_FILES.include?(full_filename.downcase)
+        end
+
+        def expected_require_syntax?(filename)
+          RUBY_FILES.include?(filename)
+        end
+
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/requirements/ruby_core_namespace.rb

@@ -5,8 +5,8 @@ module RuboCop
     module SketchupRequirements
       class RubyCoreNamespace < Cop
 
-        include NoCommentDisable
-        include Sketchup::NamespaceChecker
+        include SketchUp::NoCommentDisable
+        include SketchUp::NamespaceChecker
 
         MSG = 'Do not modify Ruby core functionality.'.freeze
 

data/lib/rubocop/sketchup/requirements/ruby_stdlib_namespace.rb

@@ -5,8 +5,8 @@ module RuboCop
     module SketchupRequirements
       class RubyStdLibNamespace < Cop
 
-        include NoCommentDisable
-        include Sketchup::NamespaceChecker
+        include SketchUp::NoCommentDisable
+        include SketchUp::NamespaceChecker
 
         MSG = 'Do not modify Ruby stdlib functionality.'.freeze
 

data/lib/rubocop/sketchup/requirements/shipped_extensions_namespace.rb

@@ -6,8 +6,8 @@ module RuboCop
       # Don't modify SketchUp's shipped extensions.
       class ShippedExtensionsNamespace < Cop
 
-        include NoCommentDisable
-        include Sketchup::NamespaceChecker
+        include SketchUp::NoCommentDisable
+        include SketchUp::NamespaceChecker
 
         MSG = 'Do not modify shipped extensions.'.freeze
 

data/lib/rubocop/sketchup/requirements/sketchup_extension.rb

@@ -7,8 +7,8 @@ module RuboCop
       # This should be done by the root .rb file in the extension package.
       class SketchupExtension < Cop
 
-        include Sketchup::ExtensionProject
-        include NoCommentDisable
+        include SketchUp::NoCommentDisable
+        include SketchUp::ExtensionProject
 
         MSG = 'Create and register one SketchupExtension instance per extension.'.freeze
         MSG_CREATE_ONE = 'Create only SketchupExtension instance per extension.'.freeze
@@ -42,12 +42,18 @@ module RuboCop
           # Look for SketchupExtension.new.
           extension_nodes = sketchup_extension_new(source_node).to_a
           if extension_nodes.size > 1
-            add_offense(nil, location: range, message: MSG_CREATE_ONE)
+            add_offense(nil,
+                location: range,
+                message: MSG_CREATE_ONE,
+                severity: :error)
             return
           end
           extension_node = extension_nodes.first
           if extension_node.nil?
-            add_offense(nil, location: range, message: MSG_CREATE_MISSING)
+            add_offense(nil,
+                location: range,
+                message: MSG_CREATE_MISSING,
+                severity: :error)
             return
           end
 
@@ -64,13 +70,19 @@ module RuboCop
           # TODO: The offences here should probably highlight the line where
           #       Sketchup.register_extension is.
           if registered_vars.size > 1
-            add_offense(nil, location: range, message: MSG_REGISTER_ONE)
+            add_offense(nil,
+                location: range,
+                message: MSG_REGISTER_ONE,
+                severity: :error)
             return
           end
           registered_var = sketchup_register_extension(source_node).first
           unless registered_var == extension_var
             msg = MSG_REGISTER_MISSING % extension_var.to_s
-            add_offense(nil, location: range, message: msg)
+            add_offense(nil,
+                location: range,
+                message: msg,
+                severity: :error)
           end
         end
 

data/lib/rubocop/sketchup/suggestions/dc_internals.rb

@@ -7,20 +7,9 @@ module RuboCop
       # change at any time.
       class DynamicComponentInternals < Cop
 
-        MSG = "Avoid relying on internal logic of Dynamic Components.".freeze
-
-        DC_GLOBALS = %i[
-          $dc_strings
-          $dc_extension
-          $dc_CONFIGURATOR_NAME
-          $dc_REPORTER_NAME
-          $dc_MANAGER_NAME
-          $dc_observers
-        ]
+        include SketchUp::DynamicComponentGlobals
 
-        def dc_global_var?(global_var)
-          DC_GLOBALS.include?(global_var)
-        end
+        MSG = "Avoid relying on internal logic of Dynamic Components.".freeze
 
         def on_gvar(node)
           check(node)

data/lib/rubocop/sketchup/suggestions/file_encoding.rb

@@ -17,7 +17,7 @@ module RuboCop
       #   basename = File.basename(file, '.*')
       class FileEncoding < Cop
 
-        MSG = 'Beware encoding bug with __FILE__ and __dir__.'.freeze
+        MSG = 'Beware encoding bug with `__FILE__` and `__dir__`.'.freeze
 
         def_node_matcher :file_loaded?, <<-PATTERN
           (send nil? {:file_loaded? :file_loaded} ...)

data/lib/rubocop/sketchup/suggestions/model_entities.rb

@@ -4,6 +4,7 @@ module RuboCop
   module Cop
     module SketchupSuggestions
       class ModelEntities < Cop
+
         MSG = 'Typically one should use model.active_entities instead of model.entities.'.freeze
 
         # Reference: http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern

data/lib/rubocop/sketchup/suggestions/operation_name.rb

@@ -17,7 +17,7 @@ module RuboCop
           return unless operation_name.is_a?(String)
           # Check the format of the operation name.
           unless acceptable_operation_name?(operation_name)
-            msg = %[#{MSG} Expected: "#{titleize(operation_name)}"]
+            msg = %[#{MSG} Expected: `"#{titleize(operation_name)}"`]
             add_offense(args.first, location: :expression, message: msg)
           end
           # Check the length of the operation name.

data/lib/rubocop/sketchup/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module SketchUp
-    VERSION = '0.1.5'
+    VERSION = '0.2.0'
   end
 end

data/rubocop-sketchup.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.version = RuboCop::SketchUp::VERSION
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.require_paths = ['lib']
   spec.files = Dir[
@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
     'Gemfile'
   ]
 
-  spec.add_dependency 'rubocop', '~> 0.51.0'
+  # NOTE: Remember to update the README.md instructions on how to install
+  #       compatible RuboCop version.
+  spec.add_dependency 'rubocop', '~> 0.52.0'
   spec.add_development_dependency 'bundler', '~> 1.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sketchup
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -48,8 +48,11 @@ files:
 - config/default.yml
 - lib/rubocop-sketchup.rb
 - lib/rubocop/sketchup.rb
+- lib/rubocop/sketchup/config.rb
+- lib/rubocop/sketchup/dc_globals.rb
 - lib/rubocop/sketchup/deprecations/operation_next_transparent.rb
 - lib/rubocop/sketchup/extension_project.rb
+- lib/rubocop/sketchup/formatter/extension_review.rb
 - lib/rubocop/sketchup/inject.rb
 - lib/rubocop/sketchup/namespace.rb
 - lib/rubocop/sketchup/namespace_checker.rb
@@ -69,6 +72,7 @@ files:
 - lib/rubocop/sketchup/requirements/load_path.rb
 - lib/rubocop/sketchup/requirements/minimal_registration.rb
 - lib/rubocop/sketchup/requirements/register_extension.rb
+- lib/rubocop/sketchup/requirements/require_tools_ruby_files.rb
 - lib/rubocop/sketchup/requirements/ruby_core_namespace.rb
 - lib/rubocop/sketchup/requirements/ruby_stdlib_namespace.rb
 - lib/rubocop/sketchup/requirements/shipped_extensions_namespace.rb
@@ -93,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -101,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: RuboCop rules for SketchUp extensions.