rubocop-standard 1.12.0

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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, location: :expression, message: "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, location: :expression, message: "Template could not be found")
+                end
+              when :partial
+                unless resolve_partial(path.to_s)
+                  add_offense(node, location: :expression, message: "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/standard/rails_controller_render_shorthand.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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, location: :expression, message: "Use `#{corrected_source}` instead")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/standard/rails_render_inline.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      class RailsRenderInline < 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, location: :expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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, location: :expression, message: "Avoid `render object:`#{suggestion}")
+              when :collection, :spacer_template
+                add_offense(node, location: :expression, message: "Avoid `render collection:`")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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 :ignore_key?, <<-PATTERN
+          (pair (sym {
+            :inline
+          }) $_)
+        PATTERN
+
+        def_node_matcher :partial_key?, <<-PATTERN
+          (pair (sym {
+            :file
+            :template
+            :layout
+            :partial
+          }) $_)
+        PATTERN
+
+        def on_send(node)
+          return unless render?(node)
+
+          if render_literal?(node)
+          elsif option_pairs = render_with_options?(node)
+            if option_pairs.any? { |pair| ignore_key?(pair) }
+              return
+            end
+
+            if partial_node = option_pairs.map { |pair| partial_key?(pair) }.compact.first
+              if !literal?(partial_node)
+                add_offense(node, location: :expression)
+              end
+            else
+              add_offense(node, location: :expression)
+            end
+          else
+            add_offense(node, location: :expression)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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, location: :expression, message: "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, location: :expression, message: "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/standard/rails_view_render_shorthand.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Standard
+      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, location: :expression, message: "Use `render #{partial_key.source}` instead")
+            elsif option_pairs.length == 2 && partial_key && locals_key
+              add_offense(node, location: :expression, message: "Use `render #{partial_key.source}, #{locals_key.source}` instead")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/standard.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rubocop/cop/standard/rails_application_record"
+require "rubocop/cop/standard/rails_controller_render_action_symbol"
+require "rubocop/cop/standard/rails_controller_render_literal"
+require "rubocop/cop/standard/rails_controller_render_paths_exist"
+require "rubocop/cop/standard/rails_controller_render_shorthand"
+require "rubocop/cop/standard/rails_render_inline"
+require "rubocop/cop/standard/rails_render_object_collection"
+require "rubocop/cop/standard/rails_view_render_literal"
+require "rubocop/cop/standard/rails_view_render_paths_exist"
+require "rubocop/cop/standard/rails_view_render_shorthand"

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-standard
+version: !ruby/object:Gem::Version
+  version: 1.12.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Code style checking for Ruby repositories starting with GitHub defaults
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- 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/standard.rb
+- lib/rubocop/cop/standard/rails_application_record.rb
+- lib/rubocop/cop/standard/rails_controller_render_action_symbol.rb
+- lib/rubocop/cop/standard/rails_controller_render_literal.rb
+- lib/rubocop/cop/standard/rails_controller_render_paths_exist.rb
+- lib/rubocop/cop/standard/rails_controller_render_shorthand.rb
+- lib/rubocop/cop/standard/rails_render_inline.rb
+- lib/rubocop/cop/standard/rails_render_object_collection.rb
+- lib/rubocop/cop/standard/rails_view_render_literal.rb
+- lib/rubocop/cop/standard/rails_view_render_paths_exist.rb
+- lib/rubocop/cop/standard/rails_view_render_shorthand.rb
+homepage: https://github.com/gjtorikian/rubocop-standard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: RuboCop Standard
+test_files: []