rubocop-github 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601fcd9953677e8b83264571ab930fb673ce9308
-  data.tar.gz: 7cb82de90efa33ab5bd9f2123938f49a131cb448
+  metadata.gz: ab0b671ded0342a09ab6abaed49ead04d5e8d998
+  data.tar.gz: 3f7fba786bcab859beab172f8cd873b31053a816
 SHA512:
-  metadata.gz: 0ac31931fe1edf63b4ecb4bf2f1177ea2b7a68a7db69e3ffdb802aaac8be2c4f122c88ac755a9d197d8fa4676b1d3ec2a4717e615b66e1afb07d385f96ed99e8
-  data.tar.gz: a7da9a85c62522bfdee8e3f9a97b4c303ae49af3baf97ab1a647e9b4e3d44042f53a3c646f3b47f5689ce844fee212bda37bc1fae27e574da7eca52834f6af51
+  metadata.gz: 64db71077a7663685feaeb399caf49fce7b190471f1df6a17b5f40623134bf3edf1aded0bd10bcdb913a57c85e32c43d966232cf6ff42adbb58b0fa76a471950
+  data.tar.gz: 823c96ff8f71694450d79de94cb5479a92c7d734646b18023f2e6044c940a8e1f1a7bf28af8e45b074b5ce80410b2985aba2a244ff7fd0144562553e8f3fc5c0

data/config/default.yml

@@ -3,6 +3,12 @@ require: rubocop/cop/github
 AllCops:
   DisabledByDefault: true
 
+Bundler/DuplicatedGem:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: true
+
 Lint/BlockAlignment:
   Enabled: true
 

data/config/rails.yml

@@ -23,6 +23,62 @@ Rails/UniqBeforePluck:
 GitHub/RailsApplicationRecord:
   Enabled: true
 
+GitHub/RailsControllerRenderActionSymbol:
+  Enabled: true
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderInline:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-inline.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsControllerRenderShorthand:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-controller-render-shorthand.md
+  Include:
+    - 'app/controllers/**/*.rb'
+
+GitHub/RailsRenderObjectCollection:
+  Enabled: false
+
+GitHub/RailsViewRenderLiteral:
+  Enabled: true
+  StyleGuide: https://github.com/github/rubocop-github/blob/master/guides/rails-render-literal.md
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsViewRenderPathsExist:
+  Enabled: true
+  ViewPath:
+    - 'app/views'
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
+
+GitHub/RailsViewRenderShorthand:
+  Enabled: true
+  Include:
+    - 'app/helpers/**/*.rb'
+    - 'app/view_models/**/*.rb'
+    - 'app/views/**/*.erb'
 
 # Exclude Rails ERB files from incompatible cops
 

data/lib/rubocop/cop/github.rb

@@ -1 +1,10 @@
 require "rubocop/cop/github/rails_application_record"
+require "rubocop/cop/github/rails_controller_render_action_symbol"
+require "rubocop/cop/github/rails_controller_render_inline"
+require "rubocop/cop/github/rails_controller_render_literal"
+require "rubocop/cop/github/rails_controller_render_paths_exist"
+require "rubocop/cop/github/rails_controller_render_shorthand"
+require "rubocop/cop/github/rails_render_object_collection"
+require "rubocop/cop/github/rails_view_render_literal"
+require "rubocop/cop/github/rails_view_render_paths_exist"
+require "rubocop/cop/github/rails_view_render_shorthand"

data/lib/rubocop/cop/github/rails_application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubocop"
 
 module RuboCop

data/lib/rubocop/cop/github/rails_controller_render_action_symbol.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderActionSymbol < Cop
+        MSG = "Prefer `render` with string instead of symbol"
+
+        def_node_matcher :render_sym?, <<-PATTERN
+          (send nil :render $(sym _))
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :action_key?, <<-PATTERN
+          (pair (sym {:action :template}) $(sym _))
+        PATTERN
+
+        def on_send(node)
+          if sym_node = render_sym?(node)
+            add_offense(sym_node, :expression)
+          elsif option_pairs = render_with_options?(node)
+            option_pairs.each do |pair|
+              if sym_node = action_key?(pair)
+                add_offense(sym_node, :expression)
+              end
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, "\"#{node.children[0]}\"")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_controller_render_inline.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderInline < Cop
+        MSG = "Avoid `render inline:`"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :inline_key?, <<-PATTERN
+          (pair (sym :inline) $_)
+        PATTERN
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            if option_pairs.detect { |pair| inline_key?(pair) }
+              add_offense(node, :expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_controller_render_literal.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderLiteral < Cop
+        MSG = "render must be used with a string literal"
+
+        def_node_matcher :literal?, <<-PATTERN
+          ({str sym true false nil} ...)
+        PATTERN
+
+        def_node_matcher :render?, <<-PATTERN
+          (send nil :render ...)
+        PATTERN
+
+        def_node_matcher :render_literal?, <<-PATTERN
+          (send nil :render ({str sym} $_) $...)
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :ignore_key?, <<-PATTERN
+          (pair (sym {
+            :body
+            :file
+            :html
+            :js
+            :json
+            :nothing
+            :plain
+            :text
+            :xml
+          }) $_)
+        PATTERN
+
+        def_node_matcher :template_key?, <<-PATTERN
+          (pair (sym {
+            :action
+            :partial
+            :template
+          }) $_)
+        PATTERN
+
+        def_node_matcher :layout_key?, <<-PATTERN
+          (pair (sym :layout) $_)
+        PATTERN
+
+        def_node_matcher :options_key?, <<-PATTERN
+          (pair (sym {
+            :content_type
+            :location
+            :status
+            :formats
+          }) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless render?(node)
+
+          if render_literal?(node)
+          elsif option_pairs = render_with_options?(node)
+            option_pairs = option_pairs.reject { |pair| options_key?(pair) }
+
+            if option_pairs.any? { |pair| ignore_key?(pair) }
+              return
+            end
+
+            if template_node = option_pairs.map { |pair| template_key?(pair) }.compact.first
+              if !literal?(template_node)
+                add_offense(node, :expression)
+              end
+            else
+              add_offense(node, :expression)
+            end
+
+            if layout_node = option_pairs.map { |pair| layout_key?(pair) }.compact.first
+              if !literal?(layout_node)
+                add_offense(node, :expression)
+              end
+            end
+          else
+            add_offense(node, :expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_controller_render_paths_exist.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderPathsExist < Cop
+        def_node_matcher :render?, <<-PATTERN
+          (send nil :render $...)
+        PATTERN
+
+        def_node_matcher :render_str?, <<-PATTERN
+          (send nil :render $({str sym} $_) ...)
+        PATTERN
+
+        def_node_matcher :render_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :render_key?, <<-PATTERN
+          (pair (sym ${:action :partial :template}) $({str sym} $_))
+        PATTERN
+
+        def on_send(node)
+          return unless cop_config["ViewPath"]
+
+          if args = render_str?(node)
+            node, path = args
+            unless resolve_template(path.to_s)
+              add_offense(node, :expression, "Template could not be found")
+            end
+          elsif pairs = render_options?(node)
+            if pair = pairs.detect { |p| render_key?(p) }
+              key, node, path = render_key?(pair)
+
+              case key
+              when :action, :template
+                unless resolve_template(path.to_s)
+                  add_offense(node, :expression, "Template could not be found")
+                end
+              when :partial
+                unless resolve_partial(path.to_s)
+                  add_offense(node, :expression, "Partial template could not be found")
+                end
+              end
+            end
+          end
+        end
+
+        def resolve_template(path)
+          cop_config["ViewPath"].each do |view_path|
+            if m = Dir[File.join(config.path_relative_to_config(view_path), path) + "*"].first
+              return m
+            end
+          end
+          nil
+        end
+
+        def resolve_partial(path)
+          parts = path.split(File::SEPARATOR)
+          parts << "_#{parts.pop}"
+          path = parts.join(File::SEPARATOR)
+          resolve_template(path)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_controller_render_shorthand.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsControllerRenderShorthand < Cop
+        MSG = "Prefer `render` template shorthand"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :action_key?, <<-PATTERN
+          (pair (sym {:action :template}) $({str sym} _))
+        PATTERN
+
+        def_node_matcher :str, <<-PATTERN
+          ({str sym} $_)
+        PATTERN
+
+        def investigate(*)
+          @autocorrect = {}
+        end
+
+        def autocorrect(node)
+          @autocorrect[node]
+        end
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            option_pairs.each do |pair|
+              if value_node = action_key?(pair)
+                comma = option_pairs.length > 1 ? ", " : ""
+                corrected_source = node.source
+                  .sub(/#{pair.source}(,\s*)?/, "")
+                  .sub("render ", "render \"#{str(value_node)}\"#{comma}")
+
+                @autocorrect[node] = lambda do |corrector|
+                  corrector.replace(node.source_range, corrected_source)
+                end
+                add_offense(node, :expression, "Use `#{corrected_source}` instead")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_render_object_collection.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsRenderObjectCollection < Cop
+        MSG = "Avoid `render object:`"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...) ...)
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym :partial) $_)
+        PATTERN
+
+        def_node_matcher :object_key?, <<-PATTERN
+          (pair (sym ${:object :collection :spacer_template}) $_)
+        PATTERN
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            partial_pair = option_pairs.detect { |pair| partial_key?(pair) }
+            object_pair  = option_pairs.detect { |pair| object_key?(pair) }
+
+            if partial_pair && object_pair
+              partial_name = partial_key?(partial_pair)
+              object_sym, object_node = object_key?(object_pair)
+
+              case object_sym
+              when :object
+                if partial_name.children[0].is_a?(String)
+                  suggestion = ", instead `render partial: #{partial_name.source}, locals: { #{File.basename(partial_name.children[0], '.html.erb')}: #{object_node.source} }`"
+                end
+                add_offense(node, :expression, "Avoid `render object:`#{suggestion}")
+              when :collection, :spacer_template
+                add_offense(node, :expression, "Avoid `render collection:`")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_view_render_literal.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsViewRenderLiteral < Cop
+        MSG = "render must be used with a string literal"
+
+        def_node_matcher :literal?, <<-PATTERN
+          ({str sym true false nil} ...)
+        PATTERN
+
+        def_node_matcher :render?, <<-PATTERN
+          (send nil :render $...)
+        PATTERN
+
+        def_node_matcher :render_literal?, <<-PATTERN
+          (send nil :render ({str sym} $_) $...)
+        PATTERN
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym {
+            :file
+            :layout
+            :partial
+          }) $_)
+        PATTERN
+
+        def on_send(node)
+          return unless render?(node)
+
+          if render_literal?(node)
+          elsif option_pairs = render_with_options?(node)
+            if partial_node = option_pairs.map { |pair| partial_key?(pair) }.compact.first
+              if !literal?(partial_node)
+                add_offense(node, :expression)
+              end
+            else
+              add_offense(node, :expression)
+            end
+          else
+            add_offense(node, :expression)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_view_render_paths_exist.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsViewRenderPathsExist < Cop
+        def_node_matcher :render?, <<-PATTERN
+          (send nil :render $...)
+        PATTERN
+
+        def_node_matcher :render_str?, <<-PATTERN
+          (send nil :render $(str $_) ...)
+        PATTERN
+
+        def_node_matcher :render_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym :partial) $(str $_))
+        PATTERN
+
+        def on_send(node)
+          return unless cop_config["ViewPath"]
+
+          if args = render_str?(node)
+            node, path = args
+            unless resolve_partial(path.to_s)
+              add_offense(node, :expression, "Partial template could not be found")
+            end
+          elsif pairs = render_options?(node)
+            if pair = pairs.detect { |p| partial_key?(p) }
+              node, path = partial_key?(pair)
+
+              unless resolve_partial(path.to_s)
+                add_offense(node, :expression, "Partial template could not be found")
+              end
+            end
+          end
+        end
+
+        def resolve_partial(path)
+          parts = path.split(File::SEPARATOR)
+          parts << "_#{parts.pop}"
+          path = parts.join(File::SEPARATOR)
+
+          cop_config["ViewPath"].each do |view_path|
+            if m = Dir[File.join(config.path_relative_to_config(view_path), path) + "*"].first
+              return m
+            end
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/github/rails_view_render_shorthand.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module GitHub
+      class RailsViewRenderShorthand < Cop
+        MSG = "Prefer `render` partial shorthand"
+
+        def_node_matcher :render_with_options?, <<-PATTERN
+          (send nil :render (hash $...))
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym :partial) $(str _))
+        PATTERN
+
+        def_node_matcher :locals_key?, <<-PATTERN
+          (pair (sym :locals) $_)
+        PATTERN
+
+        def on_send(node)
+          if option_pairs = render_with_options?(node)
+            partial_key = option_pairs.map { |pair| partial_key?(pair) }.compact.first
+            locals_key = option_pairs.map { |pair| locals_key?(pair) }.compact.first
+
+            if option_pairs.length == 1 && partial_key
+              add_offense(node, :expression, "Use `render #{partial_key.source}` instead")
+            elsif option_pairs.length == 2 && partial_key && locals_key
+              add_offense(node, :expression, "Use `render #{partial_key.source}, #{locals_key.source}` instead")
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-github
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +79,15 @@ files:
 - config/rails.yml
 - lib/rubocop/cop/github.rb
 - lib/rubocop/cop/github/rails_application_record.rb
+- lib/rubocop/cop/github/rails_controller_render_action_symbol.rb
+- lib/rubocop/cop/github/rails_controller_render_inline.rb
+- lib/rubocop/cop/github/rails_controller_render_literal.rb
+- lib/rubocop/cop/github/rails_controller_render_paths_exist.rb
+- lib/rubocop/cop/github/rails_controller_render_shorthand.rb
+- lib/rubocop/cop/github/rails_render_object_collection.rb
+- lib/rubocop/cop/github/rails_view_render_literal.rb
+- lib/rubocop/cop/github/rails_view_render_paths_exist.rb
+- lib/rubocop/cop/github/rails_view_render_shorthand.rb
 homepage: https://github.com/github/rubocop-github
 licenses:
 - MIT