rubocop-sketchup 0.4.1 → 0.5.0

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

@@ -3,6 +3,8 @@
 module RuboCop
   module Cop
     module SketchupRequirements
+      # Do not modify the load path. Modifying `$LOAD_PATH` is bad practice
+      # because it can cause extensions to inadvertently load the wrong file.
       class LoadPath < SketchUp::Cop
 
         include SketchUp::NoCommentDisable
@@ -16,11 +18,11 @@ module RuboCop
           )
         PATTERN
 
-        LOAD_PATH_ALIASES = %i(
+        LOAD_PATH_ALIASES = %i[
           $: $LOAD_PATH
-        )
+        ].freeze
 
-        MUTATORS = %i(
+        MUTATORS = %i[
           <<
           []=
           clear
@@ -51,7 +53,7 @@ module RuboCop
           sort_by!
           uniq!
           unshift
-        )
+        ].freeze
 
         def load_path?(sym)
           LOAD_PATH_ALIASES.include?(sym)
@@ -63,15 +65,16 @@ module RuboCop
 
         def on_gvasgn(node)
           global_var, = *node
+          return unless load_path?(global_var)
 
-          add_offense(node, location: :name, severity: :error) if load_path?(global_var)
+          add_offense(node, location: :expression)
         end
 
         def on_send(node)
           method_name = load_path_mutator?(node)
           return unless method_name
 
-          add_offense(node, location: :expression, severity: :error)
+          add_offense(node, location: :expression)
         end
 
       end

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

@@ -7,12 +7,33 @@ module RuboCop
     module SketchupRequirements
       # Don't load extension files in the root file registering the extension.
       # Extensions should not load additional files when it's disabled.
+      #
+      # @example Bad - Extension will always load.
+      #   module Example
+      #     require 'example/main' # BAD! This will load even when extension
+      #                            #      is disabled.
+      #     unless file_loaded?(__FILE__)
+      #       extension = SketchupExtension.new('Hello World', 'example/main')
+      #       Sketchup.register_extension(extension, true)
+      #       file_loaded(__FILE__)
+      #     end
+      #   end
+      #
+      # @example Good - Extension doesn't load anything unless its enabled.
+      #   module Example
+      #     unless file_loaded?(__FILE__)
+      #       extension = SketchupExtension.new('Hello World', 'example/main')
+      #       Sketchup.register_extension(extension, true)
+      #       file_loaded(__FILE__)
+      #     end
+      #   end
       class MinimalRegistration < SketchUp::Cop
 
         include SketchUp::NoCommentDisable
         include SketchUp::ExtensionProject
 
-        MSG = "Don't load extension files in the root file registering the extension.".freeze
+        MSG = "Don't load extension files in the root file registering the "\
+              'extension.'.freeze
 
         # Reference: http://rubocop.readthedocs.io/en/latest/node_pattern/
         def_node_matcher :require_filename, <<-PATTERN
@@ -31,16 +52,19 @@ module RuboCop
 
         def extension_file?(filename)
           return false unless filename.include?('/')
+
           first_directory = filename.split('/').first
           @extension_basename.casecmp(first_directory) == 0
         end
 
         def on_send(node)
           return unless @extension_basename
+
           filename = require_filename(node)
           return if filename.nil?
           return unless extension_file?(filename)
-          add_offense(node, severity: :error)
+
+          add_offense(node)
         end
 
       end

data/lib/rubocop/sketchup/cop/requirements/observers_start_operation.rb

@@ -3,6 +3,30 @@
 module RuboCop
   module Cop
     module SketchupRequirements
+      # Observers that perform model changes must create transparent operations
+      # to ensure the user can easily undo.
+      #
+      # An important part of SketchUp's user experience is to be able to easily
+      # undo any modification to the model. This is important to prevent
+      # accidental loss of work.
+      #
+      # If you for example have an observer that assigns a material to new faces
+      # then the user would still expect to undo this in a single operation.
+      #
+      # To achieve this, set the fourth argument in `model.start_operation` to
+      # `true` in order to chain your observer operation to the previous
+      # operation.
+      #
+      # @example
+      #   class ExampleObserver < Sketchup::EntitiesObserver
+      #     def onElementAdded(entities, entity)
+      #       return unless entity.valid?
+      #       return unless entity.is_a?(Sketchup::Face)
+      #       entity.model.start_operation('Paint Face', true, false, true)
+      #       entity.material = 'red'
+      #       entity.model.commit_operation
+      #     end
+      #   end
       class ObserversStartOperation < SketchUp::Cop
 
         include SketchUp::NoCommentDisable
@@ -95,16 +119,18 @@ module RuboCop
           onToolStateChanged
 
           onViewChanged
-        ]
+        ].freeze
 
         def on_def(node)
           return unless observer_event?(node)
+
           operations = start_operation(node)
           operations.each { |operation|
             _name, _disable_ui, _next_tr, transparent = operation.arguments
             next unless transparent.nil? || transparent.falsey_literal?
+
             location = operation_location(operation)
-            add_offense(operation, location: location, severity: :error)
+            add_offense(operation, location: location)
           }
         end
 

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

@@ -5,6 +5,15 @@ module RuboCop
     module SketchupRequirements
       # Always register extensions to load by default. Otherwise it might
       # confuse users to think the extension isn't working.
+      #
+      # @example Good - Extension will load upon first run.
+      #   module Example
+      #     unless file_loaded?(__FILE__)
+      #       extension = SketchupExtension.new('Hello World', 'example/main')
+      #       Sketchup.register_extension(extension, true)
+      #       file_loaded(__FILE__)
+      #     end
+      #   end
       class RegisterExtension < SketchUp::Cop
 
         include SketchUp::NoCommentDisable
@@ -20,12 +29,13 @@ module RuboCop
         def on_send(node)
           sketchup_register_extension(node).each { |args|
             if args.size < 2
-              add_offense(node, severity: :error)
+              add_offense(node, location: :selector)
               next
             end
             load_arg = args[1]
             next if load_arg.true_type?
-            add_offense(load_arg, severity: :error)
+
+            add_offense(load_arg)
           }
         end
 

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

@@ -3,6 +3,12 @@
 module RuboCop
   module Cop
     module SketchupRequirements
+      # Extensions in SketchUp all share the same Ruby environment on the user's
+      # machine. Because of this it's important that each extension isolate
+      # itself to avoid clashing with other extensions.
+      #
+      # Extensions submitted to Extension Warehouse is expected to not modify
+      # core Ruby functionality.
       class RubyCoreNamespace < SketchUp::Cop
 
         include SketchUp::NoCommentDisable
@@ -13,7 +19,7 @@ module RuboCop
         # We check only against the top level namespaces. The core define more
         # objects, but they are under one of the top level namespaces listed.
 
-        NAMESPACES_RUBY_186 = %w(
+        NAMESPACES_RUBY_186 = %w[
           ArgumentError
           Array
           Bignum
@@ -84,9 +90,9 @@ module RuboCop
           TypeError
           UnboundMethod
           ZeroDivisionError
-        ).freeze
+        ].freeze
 
-        NAMESPACES_RUBY_200 = %w(
+        NAMESPACES_RUBY_200 = %w[
           ARGF
           ArgumentError
           Array
@@ -172,9 +178,9 @@ module RuboCop
           TypeError
           UnboundMethod
           ZeroDivisionError
-        ).freeze
+        ].freeze
 
-        NAMESPACES_RUBY_220 = %w(
+        NAMESPACES_RUBY_220 = %w[
           ArgumentError
           Array
           BasicObject
@@ -263,15 +269,15 @@ module RuboCop
           UnboundMethod
           UncaughtThrowError
           ZeroDivisionError
-        ).freeze
+        ].freeze
 
         NAMESPACES = (
           (
             NAMESPACES_RUBY_186 |
             NAMESPACES_RUBY_200 |
             NAMESPACES_RUBY_220
-          # Remove Object because this is the global namespace and there are
-          # other checks for this.
+            # Remove Object because this is the global namespace and there are
+            # other checks for this.
           ) - ['Object']
         ).freeze