rubocop-sketchup 1.3.0 → 1.4.0

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.'
-
-        # 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.'
+
+        # 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

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

@@ -1,46 +1,46 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Avoid using globals in general, but especially these which are known to
-      # be in use by other extensions made by SketchUp.
-      # They are still in use due to compatibility reasons.
-      class LanguageHandlerGlobals < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-
-        MSG = 'Avoid globals in general, but especially these which are known '\
-              'to be in use.'
-
-        LH_GLOBALS = %i[
-          $dc_strings
-          $devl_strings
-          $exStrings
-          $fs_strings
-          $make_pano_string
-          $oceanStrings
-          $sn_strings
-          $ssf_strings
-          $suStrings
-          $tStrings
-          $unitsStrings
-          $uStrings
-          $wt_strings
-        ].freeze
-
-        def hl_global_var?(global_var)
-          LH_GLOBALS.include?(global_var)
-        end
-
-        def on_gvasgn(node)
-          global_var, = *node
-          return unless hl_global_var?(global_var)
-
-          add_offense(node, location: :name)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Avoid using globals in general, but especially these which are known to
+      # be in use by other extensions made by SketchUp.
+      # They are still in use due to compatibility reasons.
+      class LanguageHandlerGlobals < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+
+        MSG = 'Avoid globals in general, but especially these which are ' \
+              'known to be in use.'
+
+        LH_GLOBALS = %i[
+          $dc_strings
+          $devl_strings
+          $exStrings
+          $fs_strings
+          $make_pano_string
+          $oceanStrings
+          $sn_strings
+          $ssf_strings
+          $suStrings
+          $tStrings
+          $unitsStrings
+          $uStrings
+          $wt_strings
+        ].freeze
+
+        def hl_global_var?(global_var)
+          LH_GLOBALS.include?(global_var)
+        end
+
+        def on_gvasgn(node)
+          global_var, = *node
+          return unless hl_global_var?(global_var)
+
+          add_offense(node, location: :name)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,83 +1,83 @@
-# frozen_string_literal: true
-
-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
-
-        MSG = 'Do not modify the load path.'
-
-        def_node_matcher :load_path_mutator?, <<-PATTERN
-          (send
-            (gvar #load_path?) $#mutator?
-            ...
-          )
-        PATTERN
-
-        LOAD_PATH_ALIASES = %i[
-          $: $LOAD_PATH
-        ].freeze
-
-        MUTATORS = %i[
-          <<
-          []=
-          clear
-          collect!
-          compact!
-          concat
-          delete
-          delete_at
-          delete_if
-          drop
-          drop_while
-          fill
-          flatten!
-          insert
-          keep_if
-          map!
-          pop
-          push
-          reject!
-          replace
-          reverse!
-          rotate!
-          select!
-          shift
-          shuffle!
-          slice!
-          sort!
-          sort_by!
-          uniq!
-          unshift
-        ].freeze
-
-        def load_path?(sym)
-          LOAD_PATH_ALIASES.include?(sym)
-        end
-
-        def mutator?(sym)
-          MUTATORS.include?(sym)
-        end
-
-        def on_gvasgn(node)
-          global_var, = *node
-          return unless 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)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+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
+
+        MSG = 'Do not modify the load path.'
+
+        def_node_matcher :load_path_mutator?, <<-PATTERN
+          (send
+            (gvar #load_path?) $#mutator?
+            ...
+          )
+        PATTERN
+
+        LOAD_PATH_ALIASES = %i[
+          $: $LOAD_PATH
+        ].freeze
+
+        MUTATORS = %i[
+          <<
+          []=
+          clear
+          collect!
+          compact!
+          concat
+          delete
+          delete_at
+          delete_if
+          drop
+          drop_while
+          fill
+          flatten!
+          insert
+          keep_if
+          map!
+          pop
+          push
+          reject!
+          replace
+          reverse!
+          rotate!
+          select!
+          shift
+          shuffle!
+          slice!
+          sort!
+          sort_by!
+          uniq!
+          unshift
+        ].freeze
+
+        def load_path?(sym)
+          LOAD_PATH_ALIASES.include?(sym)
+        end
+
+        def mutator?(sym)
+          MUTATORS.include?(sym)
+        end
+
+        def on_gvasgn(node)
+          global_var, = *node
+          return unless 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)
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,73 +1,73 @@
-# frozen_string_literal: true
-
-require 'pathname'
-
-module RuboCop
-  module Cop
-    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.'
-
-        # Reference: http://rubocop.readthedocs.io/en/latest/node_pattern/
-        def_node_matcher :require_filename, <<-PATTERN
-          {
-            (send {(const nil? :Sketchup) nil?} {:require :load} (str $_))
-            (send nil? :require_relative (str $_))
-          }
-        PATTERN
-
-        def investigate(processed_source)
-          if root_file?(processed_source)
-            filename = processed_source.buffer.name
-            @extension_basename = File.basename(filename, '.*')
-          end
-        end
-
-        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)
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RuboCop
+  module Cop
+    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.'
+
+        # Reference: http://rubocop.readthedocs.io/en/latest/node_pattern/
+        def_node_matcher :require_filename, <<-PATTERN
+          {
+            (send {(const nil? :Sketchup) nil?} {:require :load} (str $_))
+            (send nil? :require_relative (str $_))
+          }
+        PATTERN
+
+        def investigate(processed_source)
+          if root_file?(processed_source)
+            filename = processed_source.buffer.name
+            @extension_basename = File.basename(filename, '.*')
+          end
+        end
+
+        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)
+        end
+
+      end
+    end
+  end
+end