rubocop-sketchup 0.5.0 → 0.6.0

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

@@ -1,108 +1,108 @@
-# frozen_string_literal: true
-
-require 'rubocop/sketchup/cop/requirements/api_namespace'
-require 'rubocop/sketchup/cop/requirements/ruby_core_namespace'
-require 'rubocop/sketchup/cop/requirements/ruby_stdlib_namespace'
-
-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 use only one
-      # root module.
-      #
-      # @example Good - this contains everything in the extension.
-      #   module MyExtension
-      #     class Foo
-      #     end
-      #     class Bar
-      #     end
-      #   end
-      #
-      # @example Better - this further reduce chance of clashing.
-      #   module MyCompany
-      #     module MyExtension
-      #       class Foo
-      #       end
-      #       class Bar
-      #       end
-      #     end
-      #   end
-      class ExtensionNamespace < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp
-
-        def on_class(node)
-          check_class_or_module(node)
-        end
-
-        def on_module(node)
-          check_class_or_module(node)
-        end
-
-        def check_class_or_module(node)
-          name = node.defined_module_name
-          parent = Namespace.new(node.parent_module_name)
-          namespace = parent.join(name)
-          # Don't want to process anything that aren't top level namespaces.
-          return unless parent.top_level?
-          # Don't check excluded namespaces.
-          return if exempted?(namespace)
-
-          check_namespace(node, namespace)
-        end
-
-        # Class variables are normally frowned upon since they leak through all
-        # instances. However, in this case this is exactly what we want.
-        # The Cop picks up the first top level namespace it encounters and then
-        # keep track of whether it detects more top level namespaces.
-        @@namespace = nil
-        def check_namespace(node, namespace)
-          # Make sure the namespace isn't part of reserved namespaces that other
-          # cops are checking.
-          return if reserved?(namespace)
-
-          # Remember the first namespace encountered and log an offence if
-          # more top level namespaces are registered.
-          top = namespace.first
-          @@namespace ||= top
-          return if @@namespace == top
-
-          add_offense(node, location: :name)
-        end
-
-        def reserved?(namespace)
-          top = namespace.first
-          return true if RubyCoreNamespace::NAMESPACES.include?(top)
-          return true if RubyStdLibNamespace::NAMESPACES.include?(top)
-          return true if ApiNamespace::NAMESPACES.include?(top)
-
-          false
-        end
-
-        def message(node)
-          namespace = Namespace.new(node.defined_module_name).from_root
-          format('Use a single root namespace. '\
-                 '(Found `%<found>s`; Previously found `%<expected>s`)',
-              found: namespace, expected: @@namespace)
-        end
-
-        def exempted?(namespace)
-          namespace_exceptions.include?(namespace.first)
-        end
-
-        def namespace_exceptions
-          exceptions = cop_config['Exceptions'] || []
-          return exceptions if exceptions.is_a?(Array)
-
-          raise 'exceptions needs to be an array of strings!'
-        end
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rubocop/sketchup/cop/requirements/api_namespace'
+require 'rubocop/sketchup/cop/requirements/ruby_core_namespace'
+require 'rubocop/sketchup/cop/requirements/ruby_stdlib_namespace'
+
+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 use only one
+      # root module.
+      #
+      # @example Good - this contains everything in the extension.
+      #   module MyExtension
+      #     class Foo
+      #     end
+      #     class Bar
+      #     end
+      #   end
+      #
+      # @example Better - this further reduce chance of clashing.
+      #   module MyCompany
+      #     module MyExtension
+      #       class Foo
+      #       end
+      #       class Bar
+      #       end
+      #     end
+      #   end
+      class ExtensionNamespace < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp
+
+        def on_class(node)
+          check_class_or_module(node)
+        end
+
+        def on_module(node)
+          check_class_or_module(node)
+        end
+
+        def check_class_or_module(node)
+          name = node.defined_module_name
+          parent = Namespace.new(node.parent_module_name)
+          namespace = parent.join(name)
+          # Don't want to process anything that aren't top level namespaces.
+          return unless parent.top_level?
+          # Don't check excluded namespaces.
+          return if exempted?(namespace)
+
+          check_namespace(node, namespace)
+        end
+
+        # Class variables are normally frowned upon since they leak through all
+        # instances. However, in this case this is exactly what we want.
+        # The Cop picks up the first top level namespace it encounters and then
+        # keep track of whether it detects more top level namespaces.
+        @@namespace = nil
+        def check_namespace(node, namespace)
+          # Make sure the namespace isn't part of reserved namespaces that other
+          # cops are checking.
+          return if reserved?(namespace)
+
+          # Remember the first namespace encountered and log an offence if
+          # more top level namespaces are registered.
+          top = namespace.first
+          @@namespace ||= top
+          return if @@namespace == top
+
+          add_offense(node, location: :name)
+        end
+
+        def reserved?(namespace)
+          top = namespace.first
+          return true if RubyCoreNamespace::NAMESPACES.include?(top)
+          return true if RubyStdLibNamespace::NAMESPACES.include?(top)
+          return true if ApiNamespace::NAMESPACES.include?(top)
+
+          false
+        end
+
+        def message(node)
+          namespace = Namespace.new(node.defined_module_name).from_root
+          format('Use a single root namespace. '\
+                 '(Found `%<found>s`; Previously found `%<expected>s`)',
+              found: namespace, expected: @@namespace)
+        end
+
+        def exempted?(namespace)
+          namespace_exceptions.include?(namespace.first)
+        end
+
+        def namespace_exceptions
+          exceptions = cop_config['Exceptions'] || []
+          return exceptions if exceptions.is_a?(Array)
+
+          raise 'exceptions needs to be an array of strings!'
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,97 +1,97 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # Check that the extension conform to expected file structure with a
-      # single root .rb file and a support folder with matching name.
-      #
-      # Make sure to match upper and lower case characters between the root .rb
-      # file and the support folder.
-      #
-      # @example
-      #   SketchUp/Plugins
-      #   + ex_hello_world.rb
-      #   + ex_hello_world
-      #     + main.rb
-      #     + ...
-      class FileStructure < SketchUp::Cop
-
-        include SketchUp::NoCommentDisable
-        include SketchUp::ExtensionProject
-        include RangeHelp
-
-        IGNORED_DIRECTORIES = %w[
-          __MACOSX
-        ].freeze
-
-        def investigate(processed_source)
-          return if already_run?
-
-          # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-          range = source_range(processed_source.buffer, 1, 0)
-
-          # Find all root Ruby files in the source directory.
-          pattern = "#{source_path}/*.rb"
-          root_ruby_files = Dir.glob(pattern)
-
-          # Ensure there is only one root Ruby file.
-          if root_ruby_files.size != 1
-            msg = 'Extensions must have exactly one root Ruby (.rb) file. '\
-                  'Found: %d'
-            add_offense(nil,
-                location: range,
-                message: format(msg, root_ruby_files.size))
-            return
-          end
-
-          # Find the root file and collect the sub-directories.
-          root_file = root_ruby_files.first
-          extension_basename = File.basename(root_file, '.*')
-          sub_folders = source_path.children.select(&:directory?)
-          sub_folders.reject! { |folder|
-            IGNORED_DIRECTORIES.include?(folder.basename.to_s)
-          }
-
-          # Ensure there is only one sub-directory.
-          if sub_folders.size != 1
-            msg = 'Extensions must have exactly one support directory. Found %d'
-            add_offense(nil,
-                location: range,
-                message: format(msg, sub_folders.size))
-            return
-          end
-
-          # Ensure support directory's name match the root Ruby file.
-          support_directory = sub_folders.first
-          unless support_directory.basename.to_s == extension_basename
-            msg = 'Extensions must have a support directory matching the name '\
-                  'of the root Ruby file. Expected %s, found %s'
-            msg = format(msg, extension_basename, support_directory.basename)
-            add_offense(nil,
-                location: range,
-                message: msg)
-          end
-        end
-
-        private
-
-        @@already_run = false
-
-        def already_run?
-          return true if @@already_run
-
-          @@already_run = true
-          false
-        end
-
-        # rubocop:disable Lint/IneffectiveAccessModifier
-        def self.reset
-          @@already_run = false
-        end
-        # rubocop:enable Lint/IneffectiveAccessModifier
-
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # Check that the extension conform to expected file structure with a
+      # single root .rb file and a support folder with matching name.
+      #
+      # Make sure to match upper and lower case characters between the root .rb
+      # file and the support folder.
+      #
+      # @example
+      #   SketchUp/Plugins
+      #   + ex_hello_world.rb
+      #   + ex_hello_world
+      #     + main.rb
+      #     + ...
+      class FileStructure < SketchUp::Cop
+
+        include SketchUp::NoCommentDisable
+        include SketchUp::ExtensionProject
+        include RangeHelp
+
+        IGNORED_DIRECTORIES = %w[
+          __MACOSX
+        ].freeze
+
+        def investigate(processed_source)
+          return if already_run?
+
+          # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+          range = source_range(processed_source.buffer, 1, 0)
+
+          # Find all root Ruby files in the source directory.
+          pattern = "#{source_path}/*.rb"
+          root_ruby_files = Dir.glob(pattern)
+
+          # Ensure there is only one root Ruby file.
+          if root_ruby_files.size != 1
+            msg = 'Extensions must have exactly one root Ruby (.rb) file. '\
+                  'Found: %d'
+            add_offense(nil,
+                location: range,
+                message: format(msg, root_ruby_files.size))
+            return
+          end
+
+          # Find the root file and collect the sub-directories.
+          root_file = root_ruby_files.first
+          extension_basename = File.basename(root_file, '.*')
+          sub_folders = source_path.children.select(&:directory?)
+          sub_folders.reject! { |folder|
+            IGNORED_DIRECTORIES.include?(folder.basename.to_s)
+          }
+
+          # Ensure there is only one sub-directory.
+          if sub_folders.size != 1
+            msg = 'Extensions must have exactly one support directory. Found %d'
+            add_offense(nil,
+                location: range,
+                message: format(msg, sub_folders.size))
+            return
+          end
+
+          # Ensure support directory's name match the root Ruby file.
+          support_directory = sub_folders.first
+          unless support_directory.basename.to_s == extension_basename
+            msg = 'Extensions must have a support directory matching the name '\
+                  'of the root Ruby file. Expected %s, found %s'
+            msg = format(msg, extension_basename, support_directory.basename)
+            add_offense(nil,
+                location: range,
+                message: msg)
+          end
+        end
+
+        private
+
+        @@already_run = false
+
+        def already_run?
+          return true if @@already_run
+
+          @@already_run = true
+          false
+        end
+
+        # rubocop:disable Lint/IneffectiveAccessModifier
+        def self.reset
+          @@already_run = false
+        end
+        # rubocop:enable Lint/IneffectiveAccessModifier
+
+      end
+    end
+  end
+end

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

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module SketchupRequirements
-      # It's tempting to use gems in an extension. However, there are issues if
-      # consuming them via Gem.install;
-      #
-      # * Net::HTTP is unreliable. (SSL certificate issues, OpenSSL performance
-      #   freeze under Windows)
-      # * Compiled extensions cannot be installed like this as they require
-      #   DevKit.
-      # * While downloading and installing SketchUp freezes. (Bad thing if done
-      #   automatically upon loading the extensions - especially without user
-      #   notice. It's easy to think SU have stopped working)
-      # * Version collisions. If multiple extensions want to use different
-      #   versions of a gem they will clash if the versions aren't compatible
-      #   with the features they use.
-      #
-      # They only way to ensure extensions doesn't clash is to namespace
-      # everything into extension namespace. This means making a copy of the
-      # gem you want to use and wrap it in your own namespace.
-      class GemInstall < SketchUp::Cop
-
-        include RangeHelp
-        include SketchUp::NoCommentDisable
-
-        MSG = '`Gem.install` is unreliable in SketchUp, and can cause '\
-              'extensions to clash.'.freeze
-
-        # Reference: http://rubocop.readthedocs.io/en/latest/development/
-        def_node_matcher :gem_install?, <<-PATTERN
-          (send (const nil? :Gem) :install ...)
-        PATTERN
-
-        def on_send(node)
-          return unless gem_install?(node)
-
-          range = range_with_receiver(node)
-          add_offense(node, location: range)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module SketchupRequirements
+      # It's tempting to use gems in an extension. However, there are issues if
+      # consuming them via Gem.install;
+      #
+      # * Net::HTTP is unreliable. (SSL certificate issues, OpenSSL performance
+      #   freeze under Windows)
+      # * Compiled extensions cannot be installed like this as they require
+      #   DevKit.
+      # * While downloading and installing SketchUp freezes. (Bad thing if done
+      #   automatically upon loading the extensions - especially without user
+      #   notice. It's easy to think SU have stopped working)
+      # * Version collisions. If multiple extensions want to use different
+      #   versions of a gem they will clash if the versions aren't compatible
+      #   with the features they use.
+      #
+      # They only way to ensure extensions doesn't clash is to namespace
+      # everything into extension namespace. This means making a copy of the
+      # gem you want to use and wrap it in your own namespace.
+      class GemInstall < SketchUp::Cop
+
+        include RangeHelp
+        include SketchUp::NoCommentDisable
+
+        MSG = '`Gem.install` is unreliable in SketchUp, and can cause '\
+              'extensions to clash.'.freeze
+
+        # Reference: http://rubocop.readthedocs.io/en/latest/development/
+        def_node_matcher :gem_install?, <<-PATTERN
+          (send (const nil? :Gem) :install ...)
+        PATTERN
+
+        def on_send(node)
+          return unless gem_install?(node)
+
+          range = range_with_receiver(node)
+          add_offense(node, location: range)
+        end
+      end
+    end
+  end
+end