rubocop-sketchup 1.4.0 → 1.5.0

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

@@ -1,58 +1,58 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupSuggestions
-      # Prefer `model.active_entities` over `model.entities`.
-      #
-      # Most tools/actions act upon the active entities context. This could be
-      # an opened group or component instance. Because of this, prefer
-      # `model.active_entities` by default over `model.entities` unless you
-      # have an explicit reason to work in the root model context.
-      class ModelEntities < SketchUp::Cop
-
-        MSG = 'Prefer `model.active_entities` over `model.entities`.'
-
-        # Reference: http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
-        def_node_matcher :active_model_entities?, <<-PATTERN
-          (send
-            (send (const nil? :Sketchup) :active_model) :entities)
-        PATTERN
-
-        def_node_matcher :entities_receiver, <<-PATTERN
-          (send
-            ({lvar ivar cvar} $_) :entities)
-        PATTERN
-
-        MODEL_VARIABLE_NAMES = %w[model mod].freeze
-
-        def model_entities?(node)
-          return true if active_model_entities?(node)
-
-          name = entities_receiver(node)
-          name && model_variable?(name)
-        end
-
-        def on_send(node)
-          add_offense(node, location: :expression) if model_entities?(node)
-        end
-
-        private
-
-        def model_variable?(name)
-          basename = variable_basename(name)
-          MODEL_VARIABLE_NAMES.include?(basename)
-        end
-
-        def variable_basename(name)
-          # Extract the basename from variables:
-          #  model => model
-          #  @model => model
-          #  @@model => model
-          name.to_s.tr('@', '')
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupSuggestions
+      # Prefer `model.active_entities` over `model.entities`.
+      #
+      # Most tools/actions act upon the active entities context. This could be
+      # an opened group or component instance. Because of this, prefer
+      # `model.active_entities` by default over `model.entities` unless you
+      # have an explicit reason to work in the root model context.
+      class ModelEntities < SketchUp::Cop
+
+        MSG = 'Prefer `model.active_entities` over `model.entities`.'
+
+        # Reference: http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
+        def_node_matcher :active_model_entities?, <<-PATTERN
+          (send
+            (send (const nil? :Sketchup) :active_model) :entities)
+        PATTERN
+
+        def_node_matcher :entities_receiver, <<-PATTERN
+          (send
+            ({lvar ivar cvar} $_) :entities)
+        PATTERN
+
+        MODEL_VARIABLE_NAMES = %w[model mod].freeze
+
+        def model_entities?(node)
+          return true if active_model_entities?(node)
+
+          name = entities_receiver(node)
+          name && model_variable?(name)
+        end
+
+        def on_send(node)
+          add_offense(node, location: :expression) if model_entities?(node)
+        end
+
+        private
+
+        def model_variable?(name)
+          basename = variable_basename(name)
+          MODEL_VARIABLE_NAMES.include?(basename)
+        end
+
+        def variable_basename(name)
+          # Extract the basename from variables:
+          #  model => model
+          #  @model => model
+          #  @@model => model
+          name.to_s.tr('@', '')
+        end
+
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/cop/suggestions/monkey_patched_api.rb

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupSuggestions
-      # Some of the shipped extensions in SketchUp monkey-patch the API
-      # namespace. This is an unfortunate no-no that was done a long time ago
-      # before the extension best-practices were established. These functions
-      # might change or be removed at any time. They will also not work when
-      # the extensions are disabled. Avoid using these methods.
-      class MonkeyPatchedApi < SketchUp::Cop
-
-        include SketchUp::DynamicComponentMethods
-
-        def on_send(node)
-          # Only check instance methods.
-          return if node.receiver&.const_type?
-
-          name = node.method_name
-
-          dc_method = DC_METHODS.find { |m| m[:name] == name }
-          return unless dc_method
-
-          if dc_method.key?(:variables)
-            return unless node.receiver&.variable?
-
-            receiver_name = node.receiver.children.first
-            # Account for instance and class variables.
-            receiver_name = receiver_name.to_s.tr('@', '').to_sym
-            return unless dc_method[:variables].include?(receiver_name)
-          end
-
-          path = dc_method[:path]
-          message = "#{path}##{name} is not part of the official API. " \
-                    "It's a monkey-patched addition by Dynamic Components."
-          add_offense(node,
-                      location: :selector,
-                      severity: :warning,
-                      message: message)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupSuggestions
+      # Some of the shipped extensions in SketchUp monkey-patch the API
+      # namespace. This is an unfortunate no-no that was done a long time ago
+      # before the extension best-practices were established. These functions
+      # might change or be removed at any time. They will also not work when
+      # the extensions are disabled. Avoid using these methods.
+      class MonkeyPatchedApi < SketchUp::Cop
+
+        include SketchUp::DynamicComponentMethods
+
+        def on_send(node)
+          # Only check instance methods.
+          return if node.receiver&.const_type?
+
+          name = node.method_name
+
+          dc_method = DC_METHODS.find { |m| m[:name] == name }
+          return unless dc_method
+
+          if dc_method.key?(:variables)
+            return unless node.receiver&.variable?
+
+            receiver_name = node.receiver.children.first
+            # Account for instance and class variables.
+            receiver_name = receiver_name.to_s.tr('@', '').to_sym
+            return unless dc_method[:variables].include?(receiver_name)
+          end
+
+          path = dc_method[:path]
+          message = "#{path}##{name} is not part of the official API. " \
+                    "It's a monkey-patched addition by Dynamic Components."
+          add_offense(node,
+                      location: :selector,
+                      severity: :warning,
+                      message: message)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,137 +1,137 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupSuggestions
-      # Operation name should be a short capitalized description. It will be
-      # visible to the user in the Edit > Undo menu. Make sure to give it a
-      # short human readable name, similar to SketchUp's own operation names.
-      #
-      # This cop make some very naive assumptions and will have more false
-      # positives than most of the other cops. It's purpose is mainly to enable
-      # awareness.
-      #
-      # @example Bad - Ends with a punctuation. Inconsistent with SketchUp.
-      #   model.start_operation('Example.', true)
-      #
-      # @example Good - Doesn't end with a punctuation.
-      #   model.start_operation('Example', true)
-      #
-      #
-      # @example Bad - Starts with whitespace. Inconsistent with SketchUp.
-      #   model.start_operation('  Example', true)
-      #
-      # @example Good - Doesn't start with whitespace.
-      #   model.start_operation('Example', true)
-      #
-      #
-      # @example Bad - Tabs doesn't belong in operation titles.
-      #   model.start_operation("example\tName", true)
-      #
-      # @example Good - Stick to space for whitespace.
-      #   model.start_operation('Example Name', true)
-      #
-      #
-      # @example Bad - No capitalization. Inconsistent with SketchUp.
-      #   model.start_operation('example name', true)
-      #
-      # @example Good - Each word capitalized.
-      #   model.start_operation('Example Name', true)
-      #
-      #
-      # @example Bad - Underscore instead of space. Inconsistent with SketchUp.
-      #   model.start_operation('example_name', true)
-      #
-      # @example Good - Name is for human reading.
-      #   model.start_operation('Example Name', true)
-      class OperationName < SketchUp::Cop
-
-        include RangeHelp
-
-        MSG = 'Operation name should be a short capitalized description.'
-        MSG_MAX = 'Operation names should not be short and concise. [%d/%d]'
-
-        def on_send(node)
-          _, method_name, *args = *node
-          return unless method_name == :start_operation
-          return if args.empty? || !args.first.str_type?
-
-          # Ignore transparent operations.
-          return if args.size == 4 && args.last.true_type?
-
-          operation_name = args.first.str_content
-          # We can only inspect string literals.
-          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)}"`)
-            add_offense(args.first, location: :expression, message: msg)
-          end
-          # Check the length of the operation name.
-          unless operation_name.size <= max_operation_name_length
-            message = format(MSG_MAX, operation_name.size, max_operation_name_length)
-            add_offense(args.first,
-                        location: excess_range(args.first, operation_name),
-                        message: message)
-          end
-          # Ensure operation name is not empty.
-          if operation_name.empty?
-            msg = 'Operation names should not be empty.'
-            add_offense(args.first, location: :expression, message: msg)
-          end
-        end
-
-        private
-
-        def excess_range(node, operation_name)
-          string_start = node.source.index(operation_name)
-          range = node.loc.expression
-          if string_start
-            excess_start = range.begin_pos + string_start + max_operation_name_length
-            excess_end = range.begin_pos + string_start + operation_name.size
-            range_between(excess_start, excess_end)
-          else
-            range_between(range.begin_pos, range.end_pos)
-          end
-        end
-
-        def acceptable_operation_name?(name)
-          # Capitalization, no programmer name, no punctuation.
-          return false if name.end_with?('.')
-          return false if titleize(name) != name
-
-          true
-        end
-
-        def max_operation_name_length
-          length = cop_config['Max'] || 25
-          return length if length.is_a?(Integer) && length > 0
-
-          raise 'Max needs to be a positive integer!'
-        end
-
-        TITLEIZE_EXCLUDE = %w[
-          by for from in of to
-          and or if
-        ].freeze
-
-        def titleize(string)
-          string = string.gsub(/[_.]/, ' ')
-          words = string.split.map { |word|
-            unless TITLEIZE_EXCLUDE.include?(word)
-              # word.capitalize won't work here, as we want to allow words like:
-              # "HTML", "SketchUp". So instead only the first character in each
-              # word is modified.
-              char = word[0].upcase
-              word[0, 1] = char
-            end
-            word
-          }
-          words.join(' ')
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupSuggestions
+      # Operation name should be a short capitalized description. It will be
+      # visible to the user in the Edit > Undo menu. Make sure to give it a
+      # short human readable name, similar to SketchUp's own operation names.
+      #
+      # This cop make some very naive assumptions and will have more false
+      # positives than most of the other cops. It's purpose is mainly to enable
+      # awareness.
+      #
+      # @example Bad - Ends with a punctuation. Inconsistent with SketchUp.
+      #   model.start_operation('Example.', true)
+      #
+      # @example Good - Doesn't end with a punctuation.
+      #   model.start_operation('Example', true)
+      #
+      #
+      # @example Bad - Starts with whitespace. Inconsistent with SketchUp.
+      #   model.start_operation('  Example', true)
+      #
+      # @example Good - Doesn't start with whitespace.
+      #   model.start_operation('Example', true)
+      #
+      #
+      # @example Bad - Tabs doesn't belong in operation titles.
+      #   model.start_operation("example\tName", true)
+      #
+      # @example Good - Stick to space for whitespace.
+      #   model.start_operation('Example Name', true)
+      #
+      #
+      # @example Bad - No capitalization. Inconsistent with SketchUp.
+      #   model.start_operation('example name', true)
+      #
+      # @example Good - Each word capitalized.
+      #   model.start_operation('Example Name', true)
+      #
+      #
+      # @example Bad - Underscore instead of space. Inconsistent with SketchUp.
+      #   model.start_operation('example_name', true)
+      #
+      # @example Good - Name is for human reading.
+      #   model.start_operation('Example Name', true)
+      class OperationName < SketchUp::Cop
+
+        include RangeHelp
+
+        MSG = 'Operation name should be a short capitalized description.'
+        MSG_MAX = 'Operation names should not be short and concise. [%d/%d]'
+
+        def on_send(node)
+          _, method_name, *args = *node
+          return unless method_name == :start_operation
+          return if args.empty? || !args.first.str_type?
+
+          # Ignore transparent operations.
+          return if args.size == 4 && args.last.true_type?
+
+          operation_name = args.first.str_content
+          # We can only inspect string literals.
+          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)}"`)
+            add_offense(args.first, location: :expression, message: msg)
+          end
+          # Check the length of the operation name.
+          unless operation_name.size <= max_operation_name_length
+            message = format(MSG_MAX, operation_name.size, max_operation_name_length)
+            add_offense(args.first,
+                        location: excess_range(args.first, operation_name),
+                        message: message)
+          end
+          # Ensure operation name is not empty.
+          if operation_name.empty?
+            msg = 'Operation names should not be empty.'
+            add_offense(args.first, location: :expression, message: msg)
+          end
+        end
+
+        private
+
+        def excess_range(node, operation_name)
+          string_start = node.source.index(operation_name)
+          range = node.loc.expression
+          if string_start
+            excess_start = range.begin_pos + string_start + max_operation_name_length
+            excess_end = range.begin_pos + string_start + operation_name.size
+            range_between(excess_start, excess_end)
+          else
+            range_between(range.begin_pos, range.end_pos)
+          end
+        end
+
+        def acceptable_operation_name?(name)
+          # Capitalization, no programmer name, no punctuation.
+          return false if name.end_with?('.')
+          return false if titleize(name) != name
+
+          true
+        end
+
+        def max_operation_name_length
+          length = cop_config['Max'] || 25
+          return length if length.is_a?(Integer) && length > 0
+
+          raise 'Max needs to be a positive integer!'
+        end
+
+        TITLEIZE_EXCLUDE = %w[
+          by for from in of to
+          and or if
+        ].freeze
+
+        def titleize(string)
+          string = string.gsub(/[_.]/, ' ')
+          words = string.split.map { |word|
+            unless TITLEIZE_EXCLUDE.include?(word)
+              # word.capitalize won't work here, as we want to allow words like:
+              # "HTML", "SketchUp". So instead only the first character in each
+              # word is modified.
+              char = word[0].upcase
+              word[0, 1] = char
+            end
+            word
+          }
+          words.join(' ')
+        end
+
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/cop/suggestions/sketchup_find_support_file.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupSuggestions
-      # Avoid `Sketchup.find_support_file` to find your extension's files.
-      #
-      # Users might install your extension to locations other than the default
-      # Plugins directory. If you use `Sketchup.find_support_file` to build
-      # a path for files in your extension it will fail in these scenarios.
-      #
-      # Instead prefer to use `__FILE__` or `__dir__` to build paths relative
-      # to your source files. This have the added benefit of allowing you to
-      # load your extensions directly from external directories under version
-      # control.
-      class SketchupFindSupportFile < SketchUp::Cop
-
-        MSG = 'Avoid `Sketchup.find_support_file` to find your ' \
-              "extension's files."
-
-        # http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
-        # https://rubocop.readthedocs.io/en/latest/node_pattern/
-        def_node_matcher :sketchup_find_support_file?, <<-PATTERN
-          (send
-            (const nil? :Sketchup) :find_support_file
-            ...
-          )
-        PATTERN
-
-        def on_send(node)
-          return unless sketchup_find_support_file?(node)
-
-          add_offense(node, location: :expression)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupSuggestions
+      # Avoid `Sketchup.find_support_file` to find your extension's files.
+      #
+      # Users might install your extension to locations other than the default
+      # Plugins directory. If you use `Sketchup.find_support_file` to build
+      # a path for files in your extension it will fail in these scenarios.
+      #
+      # Instead prefer to use `__FILE__` or `__dir__` to build paths relative
+      # to your source files. This have the added benefit of allowing you to
+      # load your extensions directly from external directories under version
+      # control.
+      class SketchupFindSupportFile < SketchUp::Cop
+
+        MSG = 'Avoid `Sketchup.find_support_file` to find your ' \
+              "extension's files."
+
+        # http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
+        # https://rubocop.readthedocs.io/en/latest/node_pattern/
+        def_node_matcher :sketchup_find_support_file?, <<-PATTERN
+          (send
+            (const nil? :Sketchup) :find_support_file
+            ...
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless sketchup_find_support_file?(node)
+
+          add_offense(node, location: :expression)
+        end
+
+      end
+    end
+  end
+end

data/lib/rubocop/sketchup/cop/suggestions/sleep.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupSuggestions
+      # Avoid kernel `sleep` as it freezes up SketchUp.
+      # Prefer `UI.start_timer` or a callback from the resource you are waiting
+      # for.
+      class Sleep < SketchUp::Cop
+        MSG = '`sleep` freezes up SketchUp. Prefer `UI.start_timer` or a ' \
+              'callback for the resource you are waiting for.'
+
+        def_node_matcher :sleep?, <<-PATTERN
+          (send {(const nil? :Kernel) nil?} :sleep ...)
+        PATTERN
+
+        def on_send(node)
+          return unless sleep?(node)
+
+          add_offense(node, message: MSG)
+        end
+      end
+    end
+  end
+end