rubocop-github 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 207be109d4ce7854620ccad83592f04fe8cdb06e
-  data.tar.gz: a11cca89a562cc3c7c7518a094f7f3063d400d20
+  metadata.gz: 52dfc4e189c20426f8c5cdadfd5c137c5a3bf450
+  data.tar.gz: d314b147c717c3e5cdb58a75c3cc037da0e225a9
 SHA512:
-  metadata.gz: 3f75e2f6854f25ab19a62e5e371e2d068df4ea91f0c7deb6631ea7e4f4d416f7258017f2e4cb0b06aaf00cc7e4b9c424e19ffcf16d45d7106c82505e9d1b3d63
-  data.tar.gz: c4efb68eb56ae3f49f6656437d1bb81c72b4a22b069f96a22af90077b9e8ac6d30b591eff9337609dd0c0cf6059e89a259282def47c9a0a68c2866737d16fd2a
+  metadata.gz: 69e2346a9ac0e6c9f14c847034a13ef97b4666c822d384d983e3b14d6674c734491dab0d5da8d452be5ba7a93ddf493f4dfab676376e0670b09c91fd0e6980ad
+  data.tar.gz: e56c3191cf8e50de27fc51129e3f9d8526658eed23fac0c125d8f8b74968571d45891dad504d81b2b31f653141ed62419c29ef9ed24d6f97dec49a732e864f7b

data/guides/rails-controller-render-shorthand.md

@@ -0,0 +1,9 @@
+# GitHub/RailsControllerRenderShorthand
+
+Prefer `render "path/to/template"` shorthand in controllers.
+
+``` ruby
+render template: "products/show"
+# can be written as
+render "products/show"
+```

data/guides/rails-render-inline.md

@@ -0,0 +1,27 @@
+# GitHub/RailsRenderInline
+
+tldr; Do not use `render inline:`.
+
+## Rendering plain text
+
+``` ruby
+render inline: "Just plain text" # bad
+```
+
+The `inline:` option is often misused when plain text is being returned. Instead use `render plain: "Just plain text"`.
+
+## Rendering a dynamic ERB string
+
+String `#{}` interpolation is often misused with `render inline:` instead of using `<%= %>` interpolation. This will lead to a memory leak where an ERB method will be compiled and cached for each invocation of `render inline:`.
+
+``` ruby
+render inline: "Hello #{@name}" # bad
+```
+
+## Rendering static ERB strings
+
+``` ruby
+render inline: "Hello <%= @name %>" # bad
+```
+
+If you are passing a static ERB string to `render inline:`, this string is best moved to a `.erb` template under `app/views`. Template files are able to be precompiled at boot time.

data/guides/rails-render-literal.md

@@ -0,0 +1,8 @@
+# GitHub/RailsRenderLiteral
+
+tldr; `render` MUST be passed a string literal template path.
+
+* When used in conjunction with `GitHub/RailsViewRenderPathsExist`, linters can ensure the target file exists on disk and would not crash rendering a missing template.
+* Makes it easier for humans to trace callers of a template. Simply search for the full path of the target template to find **all** call sites.
+* This same call site tracing enables automated unused template checking. If no callers are found, the template can be safely removed.
+* Enables render precompilation and inlining optimizations. Target templates can be compiled and inlined on boot time rather than deferring to first render to lazily compile templates.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-github
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -77,6 +77,9 @@ files:
 - STYLEGUIDE.md
 - config/default.yml
 - config/rails.yml
+- guides/rails-controller-render-shorthand.md
+- guides/rails-render-inline.md
+- guides/rails-render-literal.md
 - lib/rubocop/cop/github.rb
 - lib/rubocop/cop/github/rails_application_record.rb
 - lib/rubocop/cop/github/rails_controller_render_action_symbol.rb
@@ -108,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: RuboCop GitHub