rubocop-sketchup 0.6.0 → 0.7.0

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

@@ -1,161 +1,161 @@
-# frozen_string_literal: true
-
-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
-        include RangeHelp
-
-        MSG = 'Observers should create transparent operations.'.freeze
-
-        def_node_search :start_operation, <<-PATTERN
-          (send
-            _ :start_operation
-            ...)
-        PATTERN
-
-        OBSERVER_METHODS = %i[
-          onActivateModel
-          onNewModel
-          onOpenModel
-          onQuit
-          onUnloadExtension
-
-          onComponentInstanceAdded
-          onComponentInstanceRemoved
-
-          onComponentAdded
-          onComponentPropertiesChanged
-          onComponentRemoved
-          onComponentTypeChanged
-
-          onTextChanged
-
-          onActiveSectionPlaneChanged
-          onElementAdded
-          onElementModified
-          onElementRemoved
-          onEraseEntities
-
-          onChangeEntity
-          onEraseEntity
-
-          onClose
-          onOpen
-
-          onCurrentLayerChanged
-          onLayerAdded
-          onLayerChanged
-          onLayerRemoved
-          onRemoveAllLayers
-
-          onMaterialAdd
-          onMaterialChange
-          onMaterialRefChange
-          onMaterialRemove
-          onMaterialSetCurrent
-          onMaterialUndoRedo
-
-          onActivePathChanged
-          onAfterComponentSaveAs
-          onBeforeComponentSaveAs
-          onDeleteModel
-          onEraseAll
-          onExplode
-          onPidChanged
-          onPlaceComponent
-          onPostSaveModel
-          onPreSaveModel
-          onSaveModel
-          onTransactionAbort
-          onTransactionCommit
-          onTransactionEmpty
-          onTransactionRedo
-          onTransactionStart
-          onTransactionUndo
-
-          onOptionsProviderChanged
-
-          onContentsModified
-          onElementAdded
-          onElementRemoved
-
-          onRenderingOptionsChanged
-
-          onSelectionAdded
-          onSelectionBulkChange
-          onSelectionCleared
-          onSelectionRemoved
-
-          onShadowInfoChanged
-
-          onActiveToolChanged
-          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)
-          }
-        end
-
-        private
-
-        def range(node)
-          range_between(node.begin_pos, node.end_pos)
-        end
-
-        def operation_location(node)
-          # Highlight the fourth argument if it's used. Fall back to the method
-          # name.
-          transparent_argument = node.arguments[3]
-          if transparent_argument
-            range(transparent_argument.loc.expression)
-          else
-            :selector
-          end
-        end
-
-        def observer_event?(node)
-          OBSERVER_METHODS.include?(node.method_name)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+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
+        include RangeHelp
+
+        MSG = 'Observers should create transparent operations.'.freeze
+
+        def_node_search :start_operation, <<-PATTERN
+          (send
+            _ :start_operation
+            ...)
+        PATTERN
+
+        OBSERVER_METHODS = %i[
+          onActivateModel
+          onNewModel
+          onOpenModel
+          onQuit
+          onUnloadExtension
+
+          onComponentInstanceAdded
+          onComponentInstanceRemoved
+
+          onComponentAdded
+          onComponentPropertiesChanged
+          onComponentRemoved
+          onComponentTypeChanged
+
+          onTextChanged
+
+          onActiveSectionPlaneChanged
+          onElementAdded
+          onElementModified
+          onElementRemoved
+          onEraseEntities
+
+          onChangeEntity
+          onEraseEntity
+
+          onClose
+          onOpen
+
+          onCurrentLayerChanged
+          onLayerAdded
+          onLayerChanged
+          onLayerRemoved
+          onRemoveAllLayers
+
+          onMaterialAdd
+          onMaterialChange
+          onMaterialRefChange
+          onMaterialRemove
+          onMaterialSetCurrent
+          onMaterialUndoRedo
+
+          onActivePathChanged
+          onAfterComponentSaveAs
+          onBeforeComponentSaveAs
+          onDeleteModel
+          onEraseAll
+          onExplode
+          onPidChanged
+          onPlaceComponent
+          onPostSaveModel
+          onPreSaveModel
+          onSaveModel
+          onTransactionAbort
+          onTransactionCommit
+          onTransactionEmpty
+          onTransactionRedo
+          onTransactionStart
+          onTransactionUndo
+
+          onOptionsProviderChanged
+
+          onContentsModified
+          onElementAdded
+          onElementRemoved
+
+          onRenderingOptionsChanged
+
+          onSelectionAdded
+          onSelectionBulkChange
+          onSelectionCleared
+          onSelectionRemoved
+
+          onShadowInfoChanged
+
+          onActiveToolChanged
+          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)
+          }
+        end
+
+        private
+
+        def range(node)
+          range_between(node.begin_pos, node.end_pos)
+        end
+
+        def operation_location(node)
+          # Highlight the fourth argument if it's used. Fall back to the method
+          # name.
+          transparent_argument = node.arguments[3]
+          if transparent_argument
+            range(transparent_argument.loc.expression)
+          else
+            :selector
+          end
+        end
+
+        def observer_event?(node)
+          OBSERVER_METHODS.include?(node.method_name)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    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
-
-        MSG = 'Always register extensions to load by default.'.freeze
-
-        def_node_search :sketchup_register_extension, <<-PATTERN
-          (send
-            (const nil? :Sketchup) :register_extension
-            $...)
-        PATTERN
-
-        def on_send(node)
-          sketchup_register_extension(node).each { |args|
-            if args.size < 2
-              add_offense(node, location: :selector)
-              next
-            end
-            load_arg = args[1]
-            next if load_arg.true_type?
-
-            add_offense(load_arg)
-          }
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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
+
+        MSG = 'Always register extensions to load by default.'.freeze
+
+        def_node_search :sketchup_register_extension, <<-PATTERN
+          (send
+            (const nil? :Sketchup) :register_extension
+            $...)
+        PATTERN
+
+        def on_send(node)
+          sketchup_register_extension(node).each { |args|
+            if args.size < 2
+              add_offense(node, location: :selector)
+              next
+            end
+            load_arg = args[1]
+            next if load_arg.true_type?
+
+            add_offense(load_arg)
+          }
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,291 +1,291 @@
-# frozen_string_literal: true
-
-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
-        include SketchUp::NamespaceChecker
-
-        MSG = 'Do not modify Ruby core functionality.'.freeze
-
-        # 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[
-          ArgumentError
-          Array
-          Bignum
-          Binding
-          Class
-          Comparable
-          Continuation
-          Data
-          Dir
-          EOFError
-          Enumerable
-          Errno
-          Exception
-          FalseClass
-          File
-          FileTest
-          Fixnum
-          Float
-          FloatDomainError
-          GC
-          Hash
-          IO
-          IOError
-          IndexError
-          Integer
-          Interrupt
-          Kernel
-          LoadError
-          LocalJumpError
-          Marshal
-          MatchData
-          Math
-          Method
-          Module
-          NameError
-          NilClass
-          NoMemoryError
-          NoMethodError
-          NotImplementedError
-          Numeric
-          Object
-          ObjectSpace
-          Precision
-          Proc
-          Process
-          Range
-          RangeError
-          Regexp
-          RegexpError
-          RuntimeError
-          ScriptError
-          SecurityError
-          Signal
-          SignalException
-          StandardError
-          String
-          Struct
-          Symbol
-          SyntaxError
-          SystemCallError
-          SystemExit
-          SystemStackError
-          Thread
-          ThreadError
-          ThreadGroup
-          Time
-          TrueClass
-          TypeError
-          UnboundMethod
-          ZeroDivisionError
-        ].freeze
-
-        NAMESPACES_RUBY_200 = %w[
-          ARGF
-          ArgumentError
-          Array
-          BasicObject
-          Bignum
-          Binding
-          Class
-          Comparable
-          Complex
-          Continuation
-          Data
-          Dir
-          ENV
-          EOFError
-          Encoding
-          EncodingError
-          Enumerable
-          Enumerator
-          Errno
-          Exception
-          FalseClass
-          Fiber
-          FiberError
-          File
-          FileTest
-          Fixnum
-          Float
-          FloatDomainError
-          GC
-          Hash
-          IO
-          IOError
-          IndexError
-          Integer
-          Interrupt
-          Kernel
-          KeyError
-          LoadError
-          LocalJumpError
-          Marshal
-          MatchData
-          Math
-          Method
-          Module
-          Mutex
-          NameError
-          NilClass
-          NoMemoryError
-          NoMethodError
-          NotImplementedError
-          Numeric
-          Object
-          ObjectSpace
-          Proc
-          Process
-          Random
-          Range
-          RangeError
-          Rational
-          Regexp
-          RegexpError
-          RubyVM
-          RuntimeError
-          ScriptError
-          SecurityError
-          Signal
-          SignalException
-          StandardError
-          StopIteration
-          String
-          Struct
-          Symbol
-          SyntaxError
-          SystemCallError
-          SystemExit
-          SystemStackError
-          Thread
-          ThreadError
-          ThreadGroup
-          Time
-          TracePoint
-          TrueClass
-          TypeError
-          UnboundMethod
-          ZeroDivisionError
-        ].freeze
-
-        NAMESPACES_RUBY_220 = %w[
-          ArgumentError
-          Array
-          BasicObject
-          Bignum
-          Binding
-          Class
-          Comparable
-          Complex
-          ConditionVariable
-          Continuation
-          Data
-          Dir
-          ENV
-          EOFError
-          Encoding
-          EncodingError
-          Enumerable
-          Enumerator
-          Errno
-          Exception
-          FalseClass
-          Fiber
-          FiberError
-          File
-          FileTest
-          Fixnum
-          Float
-          FloatDomainError
-          GC
-          Hash
-          IO
-          IOError
-          IndexError
-          Integer
-          Interrupt
-          Kernel
-          KeyError
-          LoadError
-          LocalJumpError
-          Marshal
-          MatchData
-          Math
-          Method
-          Module
-          Mutex
-          NameError
-          NilClass
-          NoMemoryError
-          NoMethodError
-          NotImplementedError
-          Numeric
-          Object
-          ObjectSpace
-          Proc
-          Process
-          Queue
-          Random
-          Range
-          RangeError
-          Rational
-          Regexp
-          RegexpError
-          RubyVM
-          RuntimeError
-          ScriptError
-          SecurityError
-          Signal
-          SignalException
-          SizedQueue
-          StandardError
-          StopIteration
-          String
-          Struct
-          Symbol
-          SyntaxError
-          SystemCallError
-          SystemExit
-          SystemStackError
-          Thread
-          ThreadError
-          ThreadGroup
-          Time
-          TracePoint
-          TrueClass
-          TypeError
-          UnboundMethod
-          UncaughtThrowError
-          ZeroDivisionError
-        ].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.
-          ) - ['Object']
-        ).freeze
-
-        def namespaces
-          NAMESPACES
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+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
+        include SketchUp::NamespaceChecker
+
+        MSG = 'Do not modify Ruby core functionality.'.freeze
+
+        # 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[
+          ArgumentError
+          Array
+          Bignum
+          Binding
+          Class
+          Comparable
+          Continuation
+          Data
+          Dir
+          EOFError
+          Enumerable
+          Errno
+          Exception
+          FalseClass
+          File
+          FileTest
+          Fixnum
+          Float
+          FloatDomainError
+          GC
+          Hash
+          IO
+          IOError
+          IndexError
+          Integer
+          Interrupt
+          Kernel
+          LoadError
+          LocalJumpError
+          Marshal
+          MatchData
+          Math
+          Method
+          Module
+          NameError
+          NilClass
+          NoMemoryError
+          NoMethodError
+          NotImplementedError
+          Numeric
+          Object
+          ObjectSpace
+          Precision
+          Proc
+          Process
+          Range
+          RangeError
+          Regexp
+          RegexpError
+          RuntimeError
+          ScriptError
+          SecurityError
+          Signal
+          SignalException
+          StandardError
+          String
+          Struct
+          Symbol
+          SyntaxError
+          SystemCallError
+          SystemExit
+          SystemStackError
+          Thread
+          ThreadError
+          ThreadGroup
+          Time
+          TrueClass
+          TypeError
+          UnboundMethod
+          ZeroDivisionError
+        ].freeze
+
+        NAMESPACES_RUBY_200 = %w[
+          ARGF
+          ArgumentError
+          Array
+          BasicObject
+          Bignum
+          Binding
+          Class
+          Comparable
+          Complex
+          Continuation
+          Data
+          Dir
+          ENV
+          EOFError
+          Encoding
+          EncodingError
+          Enumerable
+          Enumerator
+          Errno
+          Exception
+          FalseClass
+          Fiber
+          FiberError
+          File
+          FileTest
+          Fixnum
+          Float
+          FloatDomainError
+          GC
+          Hash
+          IO
+          IOError
+          IndexError
+          Integer
+          Interrupt
+          Kernel
+          KeyError
+          LoadError
+          LocalJumpError
+          Marshal
+          MatchData
+          Math
+          Method
+          Module
+          Mutex
+          NameError
+          NilClass
+          NoMemoryError
+          NoMethodError
+          NotImplementedError
+          Numeric
+          Object
+          ObjectSpace
+          Proc
+          Process
+          Random
+          Range
+          RangeError
+          Rational
+          Regexp
+          RegexpError
+          RubyVM
+          RuntimeError
+          ScriptError
+          SecurityError
+          Signal
+          SignalException
+          StandardError
+          StopIteration
+          String
+          Struct
+          Symbol
+          SyntaxError
+          SystemCallError
+          SystemExit
+          SystemStackError
+          Thread
+          ThreadError
+          ThreadGroup
+          Time
+          TracePoint
+          TrueClass
+          TypeError
+          UnboundMethod
+          ZeroDivisionError
+        ].freeze
+
+        NAMESPACES_RUBY_220 = %w[
+          ArgumentError
+          Array
+          BasicObject
+          Bignum
+          Binding
+          Class
+          Comparable
+          Complex
+          ConditionVariable
+          Continuation
+          Data
+          Dir
+          ENV
+          EOFError
+          Encoding
+          EncodingError
+          Enumerable
+          Enumerator
+          Errno
+          Exception
+          FalseClass
+          Fiber
+          FiberError
+          File
+          FileTest
+          Fixnum
+          Float
+          FloatDomainError
+          GC
+          Hash
+          IO
+          IOError
+          IndexError
+          Integer
+          Interrupt
+          Kernel
+          KeyError
+          LoadError
+          LocalJumpError
+          Marshal
+          MatchData
+          Math
+          Method
+          Module
+          Mutex
+          NameError
+          NilClass
+          NoMemoryError
+          NoMethodError
+          NotImplementedError
+          Numeric
+          Object
+          ObjectSpace
+          Proc
+          Process
+          Queue
+          Random
+          Range
+          RangeError
+          Rational
+          Regexp
+          RegexpError
+          RubyVM
+          RuntimeError
+          ScriptError
+          SecurityError
+          Signal
+          SignalException
+          SizedQueue
+          StandardError
+          StopIteration
+          String
+          Struct
+          Symbol
+          SyntaxError
+          SystemCallError
+          SystemExit
+          SystemStackError
+          Thread
+          ThreadError
+          ThreadGroup
+          Time
+          TracePoint
+          TrueClass
+          TypeError
+          UnboundMethod
+          UncaughtThrowError
+          ZeroDivisionError
+        ].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.
+          ) - ['Object']
+        ).freeze
+
+        def namespaces
+          NAMESPACES
+        end
+
+      end
+    end
+  end
+end