rubocop-sketchup 0.5.0 → 0.6.0

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

@@ -1,95 +1,95 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Don't attempt to kill the Ruby interpreter by calling `exit` or `exit!`.
-      # SketchUp will trap `exit` and prevent that, with a message in the
-      # console. But `exit!` is not trapped and with terminate SketchUp without
-      # shutting down cleanly.
-      #
-      # Use `return`, `next`, `break` or `raise` instead.
-      class GetExtensionLicense < SketchUp::Cop
-
-        include RangeHelp
-        include SketchUp::NoCommentDisable
-
-        MSG_INVALID = 'Invalid extension GUID'.freeze
-
-        MSG_WRONG_TYPE = 'Only pass in extension GUID from local string '\
-                         'literals.'.freeze
-
-        MSG_TRAILING_SPACE = 'Extra space in extension GUID'.freeze
-
-        def_node_matcher :get_extension_license, <<-PATTERN
-          (send
-            (const
-              (const nil? :Sketchup) :Licensing) :get_extension_license
-            $_)
-        PATTERN
-
-        # rubocop:disable Metrics/LineLength
-        EXTENSION_ID_PATTERN = /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
-        # rubocop:enable Metrics/LineLength
-
-        def on_send(node)
-          argument = get_extension_license(node)
-          return unless argument
-
-          if argument.lvar_type?
-            variable_name = argument.children.first
-            assignment_node = find_assignment(node, variable_name)
-            argument = assignment_node.children.last
-          end
-
-          if argument.str_type?
-            validate_extension_id(argument)
-          else
-            location = argument.loc.expression
-            add_offense(node, location: location, message: MSG_WRONG_TYPE)
-          end
-        end
-
-        private
-
-        def find_assignment(node, variable_name)
-          scope = node
-          until scope.parent.nil?
-            scope = scope.parent
-            scope.each_child_node { |child|
-              # next unless child.is_a?(RuboCop::AST::Node)
-              next unless child.lvasgn_type?
-              next unless child.children.first == variable_name
-
-              return child
-            }
-          end
-          nil
-        end
-
-        def validate_extension_id(node)
-          extension_id = node.str_content
-
-          # Trailing spaces
-          if extension_id.rstrip.size < extension_id.size
-            end_pos = node.loc.end.begin_pos
-            begin_pos = node.loc.begin.end_pos + extension_id.rstrip.size
-            range = range_between(begin_pos, end_pos)
-            add_offense(node, location: range, message: MSG_TRAILING_SPACE)
-            return false
-          end
-
-          # Invalid format.
-          if extension_id !~ EXTENSION_ID_PATTERN
-            range = string_contents_range(node)
-            add_offense(node, location: range, message: MSG_INVALID)
-            return false
-          end
-
-          true
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Don't attempt to kill the Ruby interpreter by calling `exit` or `exit!`.
+      # SketchUp will trap `exit` and prevent that, with a message in the
+      # console. But `exit!` is not trapped and with terminate SketchUp without
+      # shutting down cleanly.
+      #
+      # Use `return`, `next`, `break` or `raise` instead.
+      class GetExtensionLicense < SketchUp::Cop
+
+        include RangeHelp
+        include SketchUp::NoCommentDisable
+
+        MSG_INVALID = 'Invalid extension GUID'.freeze
+
+        MSG_WRONG_TYPE = 'Only pass in extension GUID from local string '\
+                         'literals.'.freeze
+
+        MSG_TRAILING_SPACE = 'Extra space in extension GUID'.freeze
+
+        def_node_matcher :get_extension_license, <<-PATTERN
+          (send
+            (const
+              (const nil? :Sketchup) :Licensing) :get_extension_license
+            $_)
+        PATTERN
+
+        # rubocop:disable Metrics/LineLength
+        EXTENSION_ID_PATTERN = /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/.freeze
+        # rubocop:enable Metrics/LineLength
+
+        def on_send(node)
+          argument = get_extension_license(node)
+          return unless argument
+
+          if argument.lvar_type?
+            variable_name = argument.children.first
+            assignment_node = find_assignment(node, variable_name)
+            argument = assignment_node.children.last
+          end
+
+          if argument.str_type?
+            validate_extension_id(argument)
+          else
+            location = argument.loc.expression
+            add_offense(node, location: location, message: MSG_WRONG_TYPE)
+          end
+        end
+
+        private
+
+        def find_assignment(node, variable_name)
+          scope = node
+          until scope.parent.nil?
+            scope = scope.parent
+            scope.each_child_node { |child|
+              # next unless child.is_a?(RuboCop::AST::Node)
+              next unless child.lvasgn_type?
+              next unless child.children.first == variable_name
+
+              return child
+            }
+          end
+          nil
+        end
+
+        def validate_extension_id(node)
+          extension_id = node.str_content
+
+          # Trailing spaces
+          if extension_id.rstrip.size < extension_id.size
+            end_pos = node.loc.end.begin_pos
+            begin_pos = node.loc.begin.end_pos + extension_id.rstrip.size
+            range = range_between(begin_pos, end_pos)
+            add_offense(node, location: range, message: MSG_TRAILING_SPACE)
+            return false
+          end
+
+          # Invalid format.
+          if extension_id !~ EXTENSION_ID_PATTERN
+            range = string_contents_range(node)
+            add_offense(node, location: range, message: MSG_INVALID)
+            return false
+          end
+
+          true
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,38 +1,38 @@
-# 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 define
-      # global constants.
-      class GlobalConstants < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp
-
-        MSG = 'Do not introduce global constants.'.freeze
-
-        def_node_matcher :namespaced_constant?, <<-PATTERN
-          (casgn
-            (const _ _) ...
-          )
-        PATTERN
-
-        # Constant assignment.
-        def on_casgn(node)
-          return if namespaced_constant?(node)
-
-          namespace = Namespace.new(node.parent_module_name)
-          return unless namespace.top_level?
-
-          add_offense(node, location: :name)
-        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 define
+      # global constants.
+      class GlobalConstants < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp
+
+        MSG = 'Do not introduce global constants.'.freeze
+
+        def_node_matcher :namespaced_constant?, <<-PATTERN
+          (casgn
+            (const _ _) ...
+          )
+        PATTERN
+
+        # Constant assignment.
+        def on_casgn(node)
+          return if namespaced_constant?(node)
+
+          namespace = Namespace.new(node.parent_module_name)
+          return unless namespace.top_level?
+
+          add_offense(node, location: :name)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,42 +1,42 @@
-# 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 pollute
-      # the global namespace by including mix-in modules.
-      class GlobalInclude < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp
-
-        MSG = 'Do not include into global namespace.'.freeze
-
-        def_node_matcher :is_include?, <<-PATTERN
-          (send nil? :include ...)
-        PATTERN
-
-        def on_send(node)
-          return unless global_include?(node)
-
-          add_offense(node, location: :selector)
-        end
-
-        private
-
-        def global_include?(node)
-          is_include?(node) && global_namespace?(node)
-        end
-
-        def global_namespace?(node)
-          %w[Kernel Object].include?(node.parent_module_name)
-        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 pollute
+      # the global namespace by including mix-in modules.
+      class GlobalInclude < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp
+
+        MSG = 'Do not include into global namespace.'.freeze
+
+        def_node_matcher :is_include?, <<-PATTERN
+          (send nil? :include ...)
+        PATTERN
+
+        def on_send(node)
+          return unless global_include?(node)
+
+          add_offense(node, location: :selector)
+        end
+
+        private
+
+        def global_include?(node)
+          is_include?(node) && global_namespace?(node)
+        end
+
+        def global_namespace?(node)
+          %w[Kernel Object].include?(node.parent_module_name)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,65 +1,65 @@
-# 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 define
-      # global methods.
-      class GlobalMethods < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp
-
-        MSG = 'Do not introduce global methods.'.freeze
-
-        # Reference: http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
-        #
-        # Matchers for methods defined with this syntax:
-        #
-        # def Example.foo
-        # end
-        #
-        # def (Example::Foo).bar
-        # end
-
-        def_node_matcher :class_method?, <<-PATTERN
-          (defs
-            (const _ _) ...
-          )
-        PATTERN
-
-        def_node_matcher :class_method, <<-PATTERN
-          (defs
-            {
-              (const nil? $_)
-              (const (const nil? $_) ...)
-            }
-            ...
-          )
-        PATTERN
-
-        def on_def(node)
-          if class_method?(node)
-            class_method_parent = class_method(node)
-            namespace = Namespace.new(class_method_parent.to_s)
-          else
-            # If a method is defined inside a block then parent_module_name
-            # will return nil.
-            return if node.parent_module_name.nil?
-
-            namespace = Namespace.new(node.parent_module_name)
-          end
-          return unless namespace.top_level?
-
-          add_offense(node, location: :name)
-        end
-        alias on_defs on_def
-
-      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 define
+      # global methods.
+      class GlobalMethods < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp
+
+        MSG = 'Do not introduce global methods.'.freeze
+
+        # Reference: http://www.rubydoc.info/gems/rubocop/RuboCop/NodePattern
+        #
+        # Matchers for methods defined with this syntax:
+        #
+        # def Example.foo
+        # end
+        #
+        # def (Example::Foo).bar
+        # end
+
+        def_node_matcher :class_method?, <<-PATTERN
+          (defs
+            (const _ _) ...
+          )
+        PATTERN
+
+        def_node_matcher :class_method, <<-PATTERN
+          (defs
+            {
+              (const nil? $_)
+              (const (const nil? $_) ...)
+            }
+            ...
+          )
+        PATTERN
+
+        def on_def(node)
+          if class_method?(node)
+            class_method_parent = class_method(node)
+            namespace = Namespace.new(class_method_parent.to_s)
+          else
+            # If a method is defined inside a block then parent_module_name
+            # will return nil.
+            return if node.parent_module_name.nil?
+
+            namespace = Namespace.new(node.parent_module_name)
+          end
+          return unless namespace.top_level?
+
+          add_offense(node, location: :name)
+        end
+        alias on_defs on_def
+
+      end
+    end
+  end
+end

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

@@ -1,95 +1,95 @@
-# 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 define
-      # global variables.
-      #
-      # This cops looks for uses of global variables.
-      # It does not report offenses for built-in global variables.
-      # Built-in global variables are allowed by default. Additionally
-      # users can allow additional variables via the AllowedVariables option.
-      #
-      # Note that backreferences like `$1`, `$2`, etc are not global variables.
-      class GlobalVariables < SketchUp::Cop
-
-        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 = %i[
-          $: $LOAD_PATH
-          $" $LOADED_FEATURES
-          $0 $PROGRAM_NAME
-          $! $ERROR_INFO
-          $@ $ERROR_POSITION
-          $; $FS $FIELD_SEPARATOR
-          $, $OFS $OUTPUT_FIELD_SEPARATOR
-          $/ $RS $INPUT_RECORD_SEPARATOR
-          $\\ $ORS $OUTPUT_RECORD_SEPARATOR
-          $. $NR $INPUT_LINE_NUMBER
-          $_ $LAST_READ_LINE
-          $> $DEFAULT_OUTPUT
-          $< $DEFAULT_INPUT
-          $$ $PID $PROCESS_ID
-          $? $CHILD_STATUS
-          $~ $LAST_MATCH_INFO
-          $= $IGNORECASE
-          $* $ARGV
-          $& $MATCH
-          $` $PREMATCH
-          $' $POSTMATCH
-          $+ $LAST_PAREN_MATCH
-          $stdin $stdout $stderr
-          $DEBUG $FILENAME $VERBOSE $SAFE
-          $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
-          $CLASSPATH $JRUBY_VERSION $JRUBY_REVISION $ENV_JAVA
-        ].freeze
-
-        SKETCHUP_VARS = %i[
-          $loaded_files
-        ].freeze
-
-        # 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)
-          global_var, = *node
-          check(node) unless read_allowed?(global_var)
-        end
-
-        def on_gvasgn(node)
-          check(node)
-        end
-
-        def check(node)
-          global_var, = *node
-
-          return if allowed_var?(global_var)
-
-          add_offense(node, location: :name)
-        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 define
+      # global variables.
+      #
+      # This cops looks for uses of global variables.
+      # It does not report offenses for built-in global variables.
+      # Built-in global variables are allowed by default. Additionally
+      # users can allow additional variables via the AllowedVariables option.
+      #
+      # Note that backreferences like `$1`, `$2`, etc are not global variables.
+      class GlobalVariables < SketchUp::Cop
+
+        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 = %i[
+          $: $LOAD_PATH
+          $" $LOADED_FEATURES
+          $0 $PROGRAM_NAME
+          $! $ERROR_INFO
+          $@ $ERROR_POSITION
+          $; $FS $FIELD_SEPARATOR
+          $, $OFS $OUTPUT_FIELD_SEPARATOR
+          $/ $RS $INPUT_RECORD_SEPARATOR
+          $\\ $ORS $OUTPUT_RECORD_SEPARATOR
+          $. $NR $INPUT_LINE_NUMBER
+          $_ $LAST_READ_LINE
+          $> $DEFAULT_OUTPUT
+          $< $DEFAULT_INPUT
+          $$ $PID $PROCESS_ID
+          $? $CHILD_STATUS
+          $~ $LAST_MATCH_INFO
+          $= $IGNORECASE
+          $* $ARGV
+          $& $MATCH
+          $` $PREMATCH
+          $' $POSTMATCH
+          $+ $LAST_PAREN_MATCH
+          $stdin $stdout $stderr
+          $DEBUG $FILENAME $VERBOSE $SAFE
+          $-0 $-a $-d $-F $-i $-I $-l $-p $-v $-w
+          $CLASSPATH $JRUBY_VERSION $JRUBY_REVISION $ENV_JAVA
+        ].freeze
+
+        SKETCHUP_VARS = %i[
+          $loaded_files
+        ].freeze
+
+        # 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)
+          global_var, = *node
+          check(node) unless read_allowed?(global_var)
+        end
+
+        def on_gvasgn(node)
+          check(node)
+        end
+
+        def check(node)
+          global_var, = *node
+
+          return if allowed_var?(global_var)
+
+          add_offense(node, location: :name)
+        end
+      end
+    end
+  end
+end