rubocop-sketchup 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c09ed3075037d8889fc6b7d95d6ecfcd7875c515
-  data.tar.gz: 84d80e94029644080c343153d6f4f02b0543bf6e
+  metadata.gz: 6a682a986a80b22c8a6a1a4882e7ccf730306dc2
+  data.tar.gz: f883dfc7ba5d0100b447ac77364078a475c2a770
 SHA512:
-  metadata.gz: e782b7b399274d823d23ea3c8e3830eb5fc2c5452b91b2f5a1bd6a08aba38afde38374d781a6b57a8d7ad0206318b2bc0ed7a472cb4d62e1f201ea5390c8db34
-  data.tar.gz: 4a8acc757c7a38faf5b2d2e35a8c3afdb9df83d53ad2280e8efe8815ccbc4959e25642f4d94a89f73a4bd91e254c677c267cd415cdb0eba0fb0548409b8e60c6
+  metadata.gz: e763bf2331404f463e0d9d46ff19fadd9d642066eaf8b0606e108f089af006670e7fce3d3efb3eaa1abf14870e6bae732e353aa88fdd17632c0fff0f1364ac92
+  data.tar.gz: e550faed872bb4308a3658e42cb08aa2bc4880787ca6b01aca53fea0bebfa5291411ee6052ed8feb62466a20c00f66de21567f80b3e0736ee4290fa62e487812

data/config/default.yml

@@ -1,37 +1,92 @@
 ---
+SketchupDeprecations/OperationNextTransparent:
+  Description: Third argument in `model.start_operation` is deprecated.
+  Details: >-
+              It is not possible to predict what operation will come next. Avoid
+              making the next operation transparent.
+  Enabled: true
+
+SketchupPerformance/OpenSSL:
+  Description: Avoid using Ruby's OpenSSL within SketchUp.
+  Details: >-
+              A flaw in how it obtain random bits under Windows can severely
+              affect performance, freezing SketchUp for many minutes.
+              This also affects SecureRandom and anything else that depend on
+              OpenSSL. Net::HTTP is affected if connecting via HTTPS. Connecting
+              via plain HTTP is unaffected.
+  Enabled: true
+
+SketchupPerformance/OperationDisableUI:
+  Description: Operations should disable the UI for performance gain.
+  Enabled: true
+
 SketchupPerformance/SelectionBulkChanges:
   Description: >-
                  Avoid modifying the selection set within loops. It's much
                  faster to change the selection in bulk.
   Enabled: true
 
-SketchupPerformance/OpenSSL:
-  Description: >-
-                 Avoid using Ruby's OpenSSL within SketchUp. A flaw in how it
-                 obtain random bits under Windows can severely affect
-                 performance, freezing SketchUp for many minutes.
-                 This also affects SecureRandom and anything else
-                 that depend on OpenSSL. Net::HTTP is affected if connecting via
-                 HTTPS. Connecting via plain HTTP is unaffected.
+SketchupPerformance/Typename:
+  Description: Using `.typename` is very slow, prefer `.is_a?` instead.
+  Enabled: true
+
+
+SketchupRequirements/ApiNamespace:
+  Description: Don't modify the SketchUp API namespace.
+  Details: >-
+              Modifying the API namespace could affect other extensions - making
+              it hard for other developers to determine what is going on.
   Enabled: true
 
 SketchupRequirements/Exit:
   Description: Exit attempts to kill the Ruby interpreter.
+  Details: >-
+             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` or `break` instead.
+  Enabled: true
+
+SketchupRequirements/ExtensionNamespace:
+  Description: Confine extensions to a single root namespace.
+  Details: >-
+             To avoid clashing with other extensions a single root namespace
+             should all the extension's code.
   Enabled: true
 
 SketchupRequirements/FileStructure:
-  Description: >-
-                 Check that the extension conform to expected file structure
-                 with a single root .rb file and a support folder with matching
-                 name.
+  Description: Expected extension file structure not found.
+  Details: >-
+             Check that the extension conform to expected file structure with a
+             single root .rb file and a support folder with matching name.
   Enabled: true
   SourcePath: src
 
+SketchupRequirements/GlobalConstants:
+  Description: Do not introduce global constants.
+  Enabled: true
+
+SketchupRequirements/GlobalMethods:
+  Description: Extensions should not define global methods.
+  Enabled: true
+
+SketchupRequirements/GlobalVariables:
+  Description: Do not introduce global variables.
+  Enabled: true
+
 SketchupRequirements/LanguageHandlerGlobals:
-  Description: >-
-                 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.
+  Description: Don't use other known global variables.
+  Details: >-
+             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.
+  Enabled: true
+
+SketchupRequirements/LoadPath:
+  Description: Do not modify the load path.
+  Details: >-
+             This can cause other extensions from not loading correctly. Always
+             load files relative to the installation path for the extension.
   Enabled: true
 
 SketchupRequirements/MinimalRegistration:
@@ -47,8 +102,16 @@ SketchupRequirements/RegisterExtension:
                  might confuse users to think the extension isn't working.
   Enabled: true
 
+SketchupRequirements/RubyCoreNamespace:
+  Description: Do not modify Ruby core functionality.
+  Enabled: true
+
+SketchupRequirements/RubyStdLibNamespace:
+  Description: Do not modify Ruby stdlib functionality.
+  Enabled: true
+
 SketchupRequirements/ShippedExtensionsNamespace:
-  Description: ShippedExtensionsNamespace
+  Description: Don't use the namespace of SketchUp's shipped extensions.
   Enabled: true
 
 SketchupRequirements/SketchupExtension:
@@ -57,40 +120,57 @@ SketchupRequirements/SketchupExtension:
                  This should be done by the root .rb file in the extension
                  package.
   Enabled: true
+  SourcePath: src
 
-SketchupSuggestions/FileEncoding:
+
+SketchupSuggestions/DynamicComponentInternals:
   Description: >-
-                 When using __FILE__ and __dir__, beware that Ruby doesn't apply
-                 the correct encoding to the strings under Windows. When they
-                 contain non-english characters it will lead to exceptions being
-                 raised when the strings are used. Force encoding to work around
-                 this.
+                 Avoid relying on internal logic of Dynamic Components. It's
+                 behavior might change between versions.
   Enabled: true
 
-SketchupSuggestions/SketchupExtension:
-  Description: Check that extension registers a SketchupExtension object.
+SketchupSuggestions/FileEncoding:
+  Description: Beware encoding bug in Ruby when using `__FILE__` and `__dir__`.
+  Details: >-
+             When using `__FILE__` and `__dir__`, beware that Ruby doesn't apply
+             the correct encoding to the strings under Windows. When they
+             contain non-english characters it will lead to exceptions being
+             raised when the strings are used. Force encoding to work around
+             this.
   Enabled: true
-  SourcePath: src
 
-SketchupSuggestions/DynamicComponentInternals:
+SketchupSuggestions/ModelEntities:
   Description: >-
-                 Avoid relying on internal logic of Dynamic Components. It's
-                 behavior might change between versions.
+                 Typically one should use `model.active_entities` instead
+                 of `model.entities`.
+  Details: >-
+             In SketchUp the norm is that editing is performed in the opened
+             instance (`model.active_entities`). `model.entities` refer to the
+             model root.
   Enabled: true
 
 SketchupSuggestions/OperationName:
-  Description: Check that operation names are human friendly and consistent with SketchUp.
+  Description: >-
+                 Check that operation names are human friendly and consistent
+                 with SketchUp.
+  Details: >-
+             This check is very naive and might produce false positives. Use
+             as guidance only.
   Enabled: true
   Max: 25
 
 SketchupSuggestions/SketchupFindSupportFile:
   Description: >-
-                 Avoid Sketchup.find_support_file to find your extension's files.
-                 Extensions might be installed outside the SketchUp Plugins folder.
-                 Use __FILE__ and __dir__ to locate your files relative to the
-                 executing file.
+                 Avoid `Sketchup.find_support_file` to find your extension's
+                 files.
+  Details: >-
+             Extensions might be installed outside the SketchUp Plugins folder.
+             Use `__FILE__` and `__dir__` to locate your files relative to the
+             executing file.
   Enabled: true
 
 SketchupSuggestions/SketchupRequire:
-  Description: Omit file extensions when using Sketchup.require to allow encrypted files to be loaded.
+  Description: >-
+                 Omit file extensions when using `Sketchup.require` to allow
+                 encrypted files to be loaded.
   Enabled: true

data/lib/rubocop/sketchup/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module SketchUp
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sketchup
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-06 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop