rubocop-sketchup 1.2.0 → 1.4.0

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

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Don't modify SketchUp's shipped extensions.
-      class ShippedExtensionsNamespace < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp::NamespaceChecker
-
-        MSG = 'Do not modify shipped extensions.'
-
-        # 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_ADVANCED_CAMERA_TOOLS = %w[
-          ACTUtil
-          CameraAppObserver
-          CameraEntityObserver
-          CameraFrameChangeObserver
-          CameraRep
-          CameraToolModelObserver
-          CameraToolPagesObserver
-          CameraToolViewObserver
-          FilmCameraTool
-          FSCameraData
-          FSGeomUtils
-          FSValidate
-          PageNameChangeObserver
-        ].freeze
-
-        NAMESPACES_DYNAMIC_COMPONENTS = %w[
-          DCConverter
-          DCDownloader
-          DCFunctionsV1
-          DCInteractTool
-          DCObservers
-          DCProgressBar
-          DynamicComponents
-          DynamicComponentsV1
-        ].freeze
-
-        NAMESPACES_TRIMBLE_CONNECT = %w[
-          Trimble
-        ].freeze
-
-        NAMESPACES = (
-          NAMESPACES_ADVANCED_CAMERA_TOOLS |
-          NAMESPACES_DYNAMIC_COMPONENTS |
-          NAMESPACES_TRIMBLE_CONNECT
-        ).freeze
-
-        def namespaces
-          NAMESPACES
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Don't modify SketchUp's shipped extensions.
+      class ShippedExtensionsNamespace < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp::NamespaceChecker
+
+        MSG = 'Do not modify shipped extensions.'
+
+        # 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_ADVANCED_CAMERA_TOOLS = %w[
+          ACTUtil
+          CameraAppObserver
+          CameraEntityObserver
+          CameraFrameChangeObserver
+          CameraRep
+          CameraToolModelObserver
+          CameraToolPagesObserver
+          CameraToolViewObserver
+          FilmCameraTool
+          FSCameraData
+          FSGeomUtils
+          FSValidate
+          PageNameChangeObserver
+        ].freeze
+
+        NAMESPACES_DYNAMIC_COMPONENTS = %w[
+          DCConverter
+          DCDownloader
+          DCFunctionsV1
+          DCInteractTool
+          DCObservers
+          DCProgressBar
+          DynamicComponents
+          DynamicComponentsV1
+        ].freeze
+
+        NAMESPACES_TRIMBLE_CONNECT = %w[
+          Trimble
+        ].freeze
+
+        NAMESPACES = (
+          NAMESPACES_ADVANCED_CAMERA_TOOLS |
+          NAMESPACES_DYNAMIC_COMPONENTS |
+          NAMESPACES_TRIMBLE_CONNECT
+        ).freeze
+
+        def namespaces
+          NAMESPACES
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,119 +1,119 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Register a single instance of SketchupExtension per extension.
-      # This should be done by the root .rb file in the extension package.
-      #
-      # @example Good - a single SketchupExtension is registered.
-      #   module Example
-      #     unless file_loaded?(__FILE__)
-      #       extension = SketchupExtension.new('Hello World', 'example/main')
-      #       Sketchup.register_extension(extension, true)
-      #       file_loaded(__FILE__)
-      #     end
-      #   end
-      class SketchupExtension < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp::ExtensionProject
-        include RangeHelp
-
-        # rubocop:disable Layout/LineLength
-        MSG = 'Create and register one SketchupExtension instance per extension.'
-        MSG_CREATE_ONE = 'Create only SketchupExtension instance per extension.'
-        MSG_CREATE_MISSING = 'SketchupExtension.new not found.'
-        MSG_REGISTER_ONE = 'Only register one SketchupExtension instance per extension.'
-        MSG_REGISTER_MISSING = 'Registration of SketchupExtension not found. Expected %s'
-        # rubocop:enable Layout/LineLength
-
-        # Reference: http://rubocop.readthedocs.io/en/latest/node_pattern/
-        def_node_search :sketchup_extension_new, <<-PATTERN
-          (send
-            (const {nil? cbase} :SketchupExtension) :new ...)
-        PATTERN
-
-        def_node_search :sketchup_register_extension, <<-PATTERN
-          (send
-            (const {nil? cbase} :Sketchup) :register_extension
-            {({lvar ivar cvar gvar} $_)(const nil? $_)}
-            _ ?)
-        PATTERN
-
-        def investigate(processed_source)
-          return unless root_file?(processed_source)
-
-          source_node = processed_source.ast
-          # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-          range = source_range(processed_source.buffer, 1, 0)
-
-          # Look for SketchupExtension.new.
-          extension_nodes = sketchup_extension_new(source_node).to_a
-
-          # Threat instances not assigned to anything as non-existing.
-          extension_nodes.select! { |node|
-            node.parent&.assignment?
-          }
-
-          # There should not be multiple instances.
-          if extension_nodes.size > 1
-            add_offense(nil,
-                        location: range,
-                        message: MSG_CREATE_ONE)
-            return
-          end
-
-          # There should be exactly one.
-          extension_node = extension_nodes.first
-          if extension_node.nil?
-            add_offense(nil,
-                        location: range,
-                        message: MSG_CREATE_MISSING)
-            return
-          end
-
-          # Ensure it have two arguments.
-          if extension_node.arguments.size < 2
-            message = if extension_node.arguments.size == 1
-                        'Missing second argument for the path'
-                      else
-                        'Missing required name arguments'
-                      end
-            add_offense(extension_node,
-                        message: message)
-            return
-          end
-
-          # Find the name of the value SketchupExtension.new was assigned to.
-          assignment_node = extension_node.parent
-          if assignment_node.casgn_type?
-            extension_var = assignment_node.to_a[1]
-          else
-            extension_var = assignment_node.to_a[0]
-          end
-
-          # Look for Sketchup.register and make sure it register the extension
-          # object detected earlier.
-          registered_vars = sketchup_register_extension(source_node).to_a
-
-          # Make sure there is only one call to `register_extension`.
-          if registered_vars.size > 1
-            add_offense(registered_vars[1],
-                        message: MSG_REGISTER_ONE)
-            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)
-          end
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Register a single instance of SketchupExtension per extension.
+      # This should be done by the root .rb file in the extension package.
+      #
+      # @example Good - a single SketchupExtension is registered.
+      #   module Example
+      #     unless file_loaded?(__FILE__)
+      #       extension = SketchupExtension.new('Hello World', 'example/main')
+      #       Sketchup.register_extension(extension, true)
+      #       file_loaded(__FILE__)
+      #     end
+      #   end
+      class SketchupExtension < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp::ExtensionProject
+        include RangeHelp
+
+        # rubocop:disable Layout/LineLength
+        MSG = 'Create and register one SketchupExtension instance per extension.'
+        MSG_CREATE_ONE = 'Create only SketchupExtension instance per extension.'
+        MSG_CREATE_MISSING = 'SketchupExtension.new not found.'
+        MSG_REGISTER_ONE = 'Only register one SketchupExtension instance per extension.'
+        MSG_REGISTER_MISSING = 'Registration of SketchupExtension not found. Expected %s'
+        # rubocop:enable Layout/LineLength
+
+        # Reference: http://rubocop.readthedocs.io/en/latest/node_pattern/
+        def_node_search :sketchup_extension_new, <<-PATTERN
+          (send
+            (const {nil? cbase} :SketchupExtension) :new ...)
+        PATTERN
+
+        def_node_search :sketchup_register_extension, <<-PATTERN
+          (send
+            (const {nil? cbase} :Sketchup) :register_extension
+            {({lvar ivar cvar gvar} $_)(const nil? $_)}
+            _ ?)
+        PATTERN
+
+        def investigate(processed_source)
+          return unless root_file?(processed_source)
+
+          source_node = processed_source.ast
+          # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+          range = source_range(processed_source.buffer, 1, 0)
+
+          # Look for SketchupExtension.new.
+          extension_nodes = sketchup_extension_new(source_node).to_a
+
+          # Threat instances not assigned to anything as non-existing.
+          extension_nodes.select! { |node|
+            node.parent&.assignment?
+          }
+
+          # There should not be multiple instances.
+          if extension_nodes.size > 1
+            add_offense(nil,
+                        location: range,
+                        message: MSG_CREATE_ONE)
+            return
+          end
+
+          # There should be exactly one.
+          extension_node = extension_nodes.first
+          if extension_node.nil?
+            add_offense(nil,
+                        location: range,
+                        message: MSG_CREATE_MISSING)
+            return
+          end
+
+          # Ensure it have two arguments.
+          if extension_node.arguments.size < 2
+            message = if extension_node.arguments.size == 1
+                        'Missing second argument for the path'
+                      else
+                        'Missing required name arguments'
+                      end
+            add_offense(extension_node,
+                        message: message)
+            return
+          end
+
+          # Find the name of the value SketchupExtension.new was assigned to.
+          assignment_node = extension_node.parent
+          if assignment_node.casgn_type?
+            extension_var = assignment_node.to_a[1]
+          else
+            extension_var = assignment_node.to_a[0]
+          end
+
+          # Look for Sketchup.register and make sure it register the extension
+          # object detected earlier.
+          registered_vars = sketchup_register_extension(source_node).to_a
+
+          # Make sure there is only one call to `register_extension`.
+          if registered_vars.size > 1
+            add_offense(registered_vars[1],
+                        message: MSG_REGISTER_ONE)
+            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)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,149 +1,150 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Omit file extensions when using `Sketchup.require` to allow encrypted
-      # files to be loaded.
-      #
-      # Ruby C extensions, `.so`/`.bundle` libraries must always be loaded via
-      # the normal `require`.
-      #
-      # @example Bad - This will fail if extension is encrypted
-      #   Sketchup.require 'hello/world.rb'
-      #
-      # @example Good - This will work for `.rbe`, `.rbs` and `rb` files.
-      #   Sketchup.require 'hello/world'
-      #
-      # @example Bad - This will fail if extension is encrypted
-      #   extension = SketchupExtension.new("Example", "Example/main.rb")
-      #
-      # @example Good - This will work for `.rbe`, `.rbs` and `rb` files.
-      #   extension = SketchupExtension.new("Example", "Example/main")
-      class SketchupRequire < SketchUp::Cop
-
-        include SketchUp::ExtensionProject
-        include SketchUp::NoCommentDisable
-        include RangeHelp
-
-        MSG_SKETCHUP_REQUIRE_EXT_NAME = 'Do not hard code file extensions '\
-                                        'with `Sketchup.require`.'
-
-        MSG_EXTENSION_NEW_EXT_NAME = 'Do not hard code file extensions '\
-                                     'with `SketchupExtension.new`.'
-
-        MSG_REQUIRE_FOR_BINARY = 'Use `require` instead of `Sketchup.require` '\
-                                 'to load binary Ruby libraries.'
-
-        MSG_REQUIRE_ENCRYPTED = 'Use `Sketchup.require` when loading Ruby '\
-                                'files for encrypted extensions.'
-
-        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_node_matcher :sketchup_extension_new, <<-PATTERN
-          (send (const nil? :SketchupExtension) :new _ (str $_))
-        PATTERN
-
-        def_node_matcher :sketchup_extension_new?, <<-PATTERN
-          (send (const nil? :SketchupExtension) :new _ (str _))
-        PATTERN
-
-
-        TOOLS_RUBY_FILES = %w[extensions.rb langhandler.rb sketchup.rb].freeze
-
-
-        def on_send(node)
-          if sketchup_require?(node)
-            filename = sketchup_require(node)
-            return if check_binary_sketchup_require(node, filename)
-            return if check_sketchup_require_filename(node, filename)
-
-          elsif ruby_require?(node)
-            filename = ruby_require(node)
-            return if check_encrypted_require(node, filename)
-
-          elsif sketchup_extension_new?(node)
-            filename = sketchup_extension_new(node)
-            return if check_sketchup_extension_new_filename(node, filename)
-
-          end
-        end
-
-        private
-
-        def binary_require?(filename)
-          return unless extension_binaries?
-          return if extension_binaries.empty?
-
-          extension_binaries.include?(filename)
-        end
-
-        def check_binary_sketchup_require(node, filename)
-          return unless binary_require?(filename)
-
-          end_pos = node.loc.dot.end_pos
-          range = node.receiver.loc.expression.with(end_pos: end_pos)
-          add_offense(node, location: range, message: MSG_REQUIRE_FOR_BINARY)
-          true
-        end
-
-        def check_sketchup_require_filename(node, filename)
-          return if valid_filename?(filename)
-
-          add_offense(node, location: file_ext_range(node.arguments.first),
-                            message: MSG_SKETCHUP_REQUIRE_EXT_NAME)
-          true
-        end
-
-        def check_sketchup_extension_new_filename(node, filename)
-          return if valid_filename?(filename)
-
-          add_offense(node, location: file_ext_range(node.arguments.last),
-                            message: MSG_EXTENSION_NEW_EXT_NAME)
-          true
-        end
-
-        def check_encrypted_require(node, filename)
-          return unless encrypted_extension?
-          return unless extension_file?(filename)
-
-          add_offense(node, location: node.loc.selector,
-                            message: MSG_REQUIRE_ENCRYPTED)
-          true
-        end
-
-        def first_directory(path)
-          path.to_s.split(File::SEPARATOR).first.downcase
-        end
-
-        def extension_file?(filename)
-          pathname = Pathname.new(filename).cleanpath
-          return false unless pathname.relative?
-
-          first_directory(extension_directory) == first_directory(pathname)
-        end
-
-        def valid_filename?(filename)
-          File.extname(filename).empty? || TOOLS_RUBY_FILES.include?(filename)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Omit file extensions when using `Sketchup.require` to allow encrypted
+      # files to be loaded.
+      #
+      # Ruby C extensions, `.so`/`.bundle` libraries must always be loaded via
+      # the normal `require`.
+      #
+      # @example Bad - This will fail if extension is encrypted
+      #   Sketchup.require 'hello/world.rb'
+      #
+      # @example Good - This will work for `.rbe`, `.rbs` and `rb` files.
+      #   Sketchup.require 'hello/world'
+      #
+      # @example Bad - This will fail if extension is encrypted
+      #   extension = SketchupExtension.new("Example", "Example/main.rb")
+      #
+      # @example Good - This will work for `.rbe`, `.rbs` and `rb` files.
+      #   extension = SketchupExtension.new("Example", "Example/main")
+      class SketchupRequire < SketchUp::Cop
+
+        include SketchUp::ExtensionProject
+        include SketchUp::NoCommentDisable
+        include RangeHelp
+
+        MSG_SKETCHUP_REQUIRE_EXT_NAME = 'Do not hard code file extensions ' \
+                                        'with `Sketchup.require`.'
+
+        MSG_EXTENSION_NEW_EXT_NAME = 'Do not hard code file extensions ' \
+                                     'with `SketchupExtension.new`.'
+
+        MSG_REQUIRE_FOR_BINARY = 'Use `require` instead of ' \
+                                 '`Sketchup.require` to load binary Ruby ' \
+                                 'libraries.'
+
+        MSG_REQUIRE_ENCRYPTED = 'Use `Sketchup.require` when loading Ruby ' \
+                                'files for encrypted extensions.'
+
+        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_node_matcher :sketchup_extension_new, <<-PATTERN
+          (send (const nil? :SketchupExtension) :new _ (str $_))
+        PATTERN
+
+        def_node_matcher :sketchup_extension_new?, <<-PATTERN
+          (send (const nil? :SketchupExtension) :new _ (str _))
+        PATTERN
+
+
+        TOOLS_RUBY_FILES = %w[extensions.rb langhandler.rb sketchup.rb].freeze
+
+
+        def on_send(node)
+          if sketchup_require?(node)
+            filename = sketchup_require(node)
+            return if check_binary_sketchup_require(node, filename)
+            return if check_sketchup_require_filename(node, filename)
+
+          elsif ruby_require?(node)
+            filename = ruby_require(node)
+            return if check_encrypted_require(node, filename)
+
+          elsif sketchup_extension_new?(node)
+            filename = sketchup_extension_new(node)
+            return if check_sketchup_extension_new_filename(node, filename)
+
+          end
+        end
+
+        private
+
+        def binary_require?(filename)
+          return unless extension_binaries?
+          return if extension_binaries.empty?
+
+          extension_binaries.include?(filename)
+        end
+
+        def check_binary_sketchup_require(node, filename)
+          return unless binary_require?(filename)
+
+          end_pos = node.loc.dot.end_pos
+          range = node.receiver.loc.expression.with(end_pos: end_pos)
+          add_offense(node, location: range, message: MSG_REQUIRE_FOR_BINARY)
+          true
+        end
+
+        def check_sketchup_require_filename(node, filename)
+          return if valid_filename?(filename)
+
+          add_offense(node, location: file_ext_range(node.arguments.first),
+                            message: MSG_SKETCHUP_REQUIRE_EXT_NAME)
+          true
+        end
+
+        def check_sketchup_extension_new_filename(node, filename)
+          return if valid_filename?(filename)
+
+          add_offense(node, location: file_ext_range(node.arguments.last),
+                            message: MSG_EXTENSION_NEW_EXT_NAME)
+          true
+        end
+
+        def check_encrypted_require(node, filename)
+          return unless encrypted_extension?
+          return unless extension_file?(filename)
+
+          add_offense(node, location: node.loc.selector,
+                            message: MSG_REQUIRE_ENCRYPTED)
+          true
+        end
+
+        def first_directory(path)
+          path.to_s.split(File::SEPARATOR).first.downcase
+        end
+
+        def extension_file?(filename)
+          pathname = Pathname.new(filename).cleanpath
+          return false unless pathname.relative?
+
+          first_directory(extension_directory) == first_directory(pathname)
+        end
+
+        def valid_filename?(filename)
+          File.extname(filename).empty? || TOOLS_RUBY_FILES.include?(filename)
+        end
+
+      end
+    end
+  end
+end