omg-actionview 8.0.0.alpha1

data/lib/action_view/render_parser/prism_render_parser.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module ActionView
+  module RenderParser
+    class PrismRenderParser < Base # :nodoc:
+      def render_calls
+        queue = [Prism.parse(@code).value]
+        templates = []
+
+        while (node = queue.shift)
+          queue.concat(node.compact_child_nodes)
+          next unless node.is_a?(Prism::CallNode)
+
+          options = render_call_options(node)
+          next unless options
+
+          render_type = (options.keys & RENDER_TYPE_KEYS)[0]
+          template, object_template = render_call_template(options[render_type])
+          next unless template
+
+          if options.key?(:object) || options.key?(:collection) || object_template
+            next if options.key?(:object) && options.key?(:collection)
+            next unless options.key?(:partial)
+          end
+
+          if options[:spacer_template].is_a?(Prism::StringNode)
+            templates << partial_to_virtual_path(:partial, options[:spacer_template].unescaped)
+          end
+
+          templates << partial_to_virtual_path(render_type, template)
+
+          if render_type != :layout && options[:layout].is_a?(Prism::StringNode)
+            templates << partial_to_virtual_path(:layout, options[:layout].unescaped)
+          end
+        end
+
+        templates
+      end
+
+      private
+        # Accept a call node and return a hash of options for the render call.
+        # If it doesn't match the expected format, return nil.
+        def render_call_options(node)
+          # We are only looking for calls to render or render_to_string.
+          name = node.name.to_sym
+          return if name != :render && name != :render_to_string
+
+          # We are only looking for calls with arguments.
+          arguments = node.arguments
+          return unless arguments
+
+          arguments = arguments.arguments
+          length = arguments.length
+
+          # Get rid of any parentheses to get directly to the contents.
+          arguments.map! do |argument|
+            current = argument
+
+            while current.is_a?(Prism::ParenthesesNode) &&
+                  current.body.is_a?(Prism::StatementsNode) &&
+                  current.body.body.length == 1
+              current = current.body.body.first
+            end
+
+            current
+          end
+
+          # We are only looking for arguments that are either a string with an
+          # array of locals or a keyword hash with symbol keys.
+          options =
+            if (length == 1 || length == 2) && !arguments[0].is_a?(Prism::KeywordHashNode)
+              { partial: arguments[0], locals: arguments[1] }
+            elsif length == 1 &&
+                  arguments[0].is_a?(Prism::KeywordHashNode) &&
+                  arguments[0].elements.all? do |element|
+                    element.is_a?(Prism::AssocNode) && element.key.is_a?(Prism::SymbolNode)
+                  end
+              arguments[0].elements.to_h do |element|
+                [element.key.unescaped.to_sym, element.value]
+              end
+            end
+
+          return unless options
+
+          # Here we validate that the options have the keys we expect.
+          keys = options.keys
+          return if !keys.intersect?(RENDER_TYPE_KEYS)
+          return if (keys - ALL_KNOWN_KEYS).any?
+
+          # Finally, we can return a valid set of options.
+          options
+        end
+
+        # Accept the node that is being passed in the position of the template
+        # and return the template name and whether or not it is an object
+        # template.
+        def render_call_template(node)
+          object_template = false
+          template =
+            case node.type
+            when :string_node
+              path = node.unescaped
+              path.include?("/") ? path : "#{directory}/#{path}"
+            when :interpolated_string_node
+              node.parts.map do |node|
+                case node.type
+                when :string_node
+                  node.unescaped
+                when :embedded_statements_node
+                  "*"
+                else
+                  return
+                end
+              end.join("")
+            else
+              dependency =
+                case node.type
+                when :class_variable_read_node
+                  node.slice[2..]
+                when :instance_variable_read_node
+                  node.slice[1..]
+                when :global_variable_read_node
+                  node.slice[1..]
+                when :local_variable_read_node
+                  node.slice
+                when :call_node
+                  node.name.to_s
+                else
+                  return
+                end
+
+              "#{dependency.pluralize}/#{dependency.singularize}"
+            end
+
+          [template, object_template]
+        end
+    end
+  end
+end

data/lib/action_view/render_parser/ripper_render_parser.rb

@@ -0,0 +1,350 @@
+# frozen_string_literal: true
+
+module ActionView
+  module RenderParser
+    class RipperRenderParser < Base # :nodoc:
+      class Node < ::Array # :nodoc:
+        attr_reader :type
+
+        def initialize(type, arr, opts = {})
+          @type = type
+          super(arr)
+        end
+
+        def children
+          to_a
+        end
+
+        def inspect
+          typeinfo = type && type != :list ? ":" + type.to_s + ", " : ""
+          "s(" + typeinfo + map(&:inspect).join(", ") + ")"
+        end
+
+        def fcall?
+          type == :command || type == :fcall
+        end
+
+        def fcall_named?(name)
+          fcall? &&
+            self[0].type == :@ident &&
+            self[0][0] == name
+        end
+
+        def argument_nodes
+          raise unless fcall?
+          return [] if self[1].nil?
+          if self[1].last == false || self[1].last.type == :vcall
+            self[1][0...-1]
+          else
+            self[1][0..-1]
+          end
+        end
+
+        def string?
+          type == :string_literal
+        end
+
+        def variable_reference?
+          type == :var_ref
+        end
+
+        def vcall?
+          type == :vcall
+        end
+
+        def call?
+          type == :call
+        end
+
+        def variable_name
+          self[0][0]
+        end
+
+        def call_method_name
+          self[2].first
+        end
+
+        def to_string
+          raise unless string?
+
+          # s(:string_literal, s(:string_content, map))
+          self[0].map do |node|
+            case node.type
+            when :@tstring_content
+              node[0]
+            when :string_embexpr
+              "*"
+            end
+          end.join("")
+        end
+
+        def hash?
+          type == :bare_assoc_hash || type == :hash
+        end
+
+        def to_hash
+          if type == :bare_assoc_hash
+            hash_from_body(self[0])
+          elsif type == :hash && self[0] == nil
+            {}
+          elsif type == :hash && self[0].type == :assoclist_from_args
+            hash_from_body(self[0][0])
+          end
+        end
+
+        def hash_from_body(body)
+          body.to_h do |hash_node|
+            return nil if hash_node.type != :assoc_new
+
+            [hash_node[0], hash_node[1]]
+          end
+        end
+
+        def symbol?
+          type == :@label || type == :symbol_literal
+        end
+
+        def to_symbol
+          if type == :@label && self[0] =~ /\A(.+):\z/
+            $1.to_sym
+          elsif type == :symbol_literal && self[0].type == :symbol && self[0][0].type == :@ident
+            self[0][0][0].to_sym
+          else
+            raise "not a symbol?: #{self.inspect}"
+          end
+        end
+      end
+
+      class NodeParser < ::Ripper # :nodoc:
+        PARSER_EVENTS.each do |event|
+          arity = PARSER_EVENT_TABLE[event]
+          if arity == 0 && event.to_s.end_with?("_new")
+            module_eval(<<-eof, __FILE__, __LINE__ + 1)
+            def on_#{event}(*args)
+              Node.new(:list, args, lineno: lineno(), column: column())
+            end
+            eof
+          elsif event.to_s.match?(/_add(_.+)?\z/)
+            module_eval(<<-eof, __FILE__, __LINE__ + 1)
+            begin; undef on_#{event}; rescue NameError; end
+            def on_#{event}(list, item)
+              list.push(item)
+              list
+            end
+            eof
+          else
+            module_eval(<<-eof, __FILE__, __LINE__ + 1)
+            begin; undef on_#{event}; rescue NameError; end
+            def on_#{event}(*args)
+              Node.new(:#{event}, args, lineno: lineno(), column: column())
+            end
+            eof
+          end
+        end
+
+        SCANNER_EVENTS.each do |event|
+          module_eval(<<-End, __FILE__, __LINE__ + 1)
+          def on_#{event}(tok)
+            Node.new(:@#{event}, [tok], lineno: lineno(), column: column())
+          end
+          End
+        end
+      end
+
+      class RenderCallExtractor < NodeParser # :nodoc:
+        attr_reader :render_calls
+
+        METHODS_TO_PARSE = %w(render render_to_string)
+
+        def initialize(*args)
+          super
+
+          @render_calls = []
+        end
+
+        private
+          def on_fcall(name, *args)
+            on_render_call(super)
+          end
+
+          def on_command(name, *args)
+            on_render_call(super)
+          end
+
+          def on_render_call(node)
+            METHODS_TO_PARSE.each do |method|
+              if node.fcall_named?(method)
+                @render_calls << [method, node]
+                return node
+              end
+            end
+            node
+          end
+
+          def on_arg_paren(content)
+            content
+          end
+
+          def on_paren(content)
+            content.size == 1 ? content.first : content
+          end
+      end
+
+      def render_calls
+        parser = RenderCallExtractor.new(@code)
+        parser.parse
+
+        parser.render_calls.group_by(&:first).to_h do |method, nodes|
+          [ method.to_sym, nodes.collect { |v| v[1] } ]
+        end.map do |method, nodes|
+          nodes.map { |n| parse_render(n) }
+        end.flatten.compact
+      end
+
+      private
+        def resolve_path_directory(path)
+          if path.include?("/")
+            path
+          else
+            "#{directory}/#{path}"
+          end
+        end
+
+        # Convert
+        #   render("foo", ...)
+        # into either
+        #   render(template: "foo", ...)
+        # or
+        #   render(partial: "foo", ...)
+        def normalize_args(string, options_hash)
+          if options_hash
+            { partial: string, locals: options_hash }
+          else
+            { partial: string }
+          end
+        end
+
+        def parse_render(node)
+          node = node.argument_nodes
+
+          if (node.length == 1 || node.length == 2) && !node[0].hash?
+            if node.length == 1
+              options = normalize_args(node[0], nil)
+            elsif node.length == 2
+              options = normalize_args(node[0], node[1])
+            end
+
+            return nil unless options
+
+            parse_render_from_options(options)
+          elsif node.length == 1 && node[0].hash?
+            options = parse_hash_to_symbols(node[0])
+
+            return nil unless options
+
+            parse_render_from_options(options)
+          else
+            nil
+          end
+        end
+
+        def parse_hash(node)
+          node.hash? && node.to_hash
+        end
+
+        def parse_hash_to_symbols(node)
+          hash = parse_hash(node)
+
+          return unless hash
+
+          hash.transform_keys do |key_node|
+            key = parse_sym(key_node)
+
+            return unless key
+
+            key
+          end
+        end
+
+        def parse_render_from_options(options_hash)
+          renders = []
+          keys = options_hash.keys
+
+          if (keys & RENDER_TYPE_KEYS).size < 1
+            # Must have at least one of render keys
+            return nil
+          end
+
+          if (keys - ALL_KNOWN_KEYS).any?
+            # de-opt in case of unknown option
+            return nil
+          end
+
+          render_type = (keys & RENDER_TYPE_KEYS)[0]
+
+          node = options_hash[render_type]
+
+          if node.string?
+            template = resolve_path_directory(node.to_string)
+          else
+            if node.variable_reference?
+              dependency = node.variable_name.sub(/\A(?:\$|@{1,2})/, "")
+            elsif node.vcall?
+              dependency = node.variable_name
+            elsif node.call?
+              dependency = node.call_method_name
+            else
+              return
+            end
+
+            object_template = true
+            template = "#{dependency.pluralize}/#{dependency.singularize}"
+          end
+
+          return unless template
+
+          if spacer_template = render_template_with_spacer?(options_hash)
+            virtual_path = partial_to_virtual_path(:partial, spacer_template)
+            renders << virtual_path
+          end
+
+          if options_hash.key?(:object) || options_hash.key?(:collection) || object_template
+            return nil if options_hash.key?(:object) && options_hash.key?(:collection)
+            return nil unless options_hash.key?(:partial)
+          end
+
+          virtual_path = partial_to_virtual_path(render_type, template)
+          renders << virtual_path
+
+          # Support for rendering multiple templates (i.e. a partial with a layout)
+          if layout_template = render_template_with_layout?(render_type, options_hash)
+            virtual_path = partial_to_virtual_path(:layout, layout_template)
+
+            renders << virtual_path
+          end
+
+          renders
+        end
+
+        def parse_str(node)
+          node.string? && node.to_string
+        end
+
+        def parse_sym(node)
+          node.symbol? && node.to_symbol
+        end
+
+        def render_template_with_layout?(render_type, options_hash)
+          if render_type != :layout && options_hash.key?(:layout)
+            parse_str(options_hash[:layout])
+          end
+        end
+
+        def render_template_with_spacer?(options_hash)
+          if options_hash.key?(:spacer_template)
+            parse_str(options_hash[:spacer_template])
+          end
+        end
+    end
+  end
+end

data/lib/action_view/render_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActionView
+  module RenderParser # :nodoc:
+    ALL_KNOWN_KEYS = [:partial, :template, :layout, :formats, :locals, :object, :collection, :as, :status, :content_type, :location, :spacer_template]
+    RENDER_TYPE_KEYS = [:partial, :template, :layout]
+
+    class Base # :nodoc:
+      def initialize(name, code)
+        @name = name
+        @code = code
+      end
+
+      private
+        def directory
+          File.dirname(@name)
+        end
+
+        def partial_to_virtual_path(render_type, partial_path)
+          if render_type == :partial || render_type == :layout
+            partial_path.gsub(%r{(/|^)([^/]*)\z}, '\1_\2')
+          else
+            partial_path
+          end
+        end
+    end
+
+    # Check if prism is available. If it is, use it. Otherwise, use ripper.
+    begin
+      require "prism"
+    rescue LoadError
+      require "ripper"
+      require_relative "render_parser/ripper_render_parser"
+      Default = RipperRenderParser
+    else
+      require_relative "render_parser/prism_render_parser"
+      Default = PrismRenderParser
+    end
+  end
+end

data/lib/action_view/renderer/abstract_renderer.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require "concurrent/map"
+
+module ActionView
+  # This class defines the interface for a renderer. Each class that
+  # subclasses +AbstractRenderer+ is used by the base +Renderer+ class to
+  # render a specific type of object.
+  #
+  # The base +Renderer+ class uses its +render+ method to delegate to the
+  # renderers. These currently consist of
+  #
+  #   PartialRenderer - Used for rendering partials
+  #   TemplateRenderer - Used for rendering other types of templates
+  #   StreamingTemplateRenderer - Used for streaming
+  #
+  # Whenever the +render+ method is called on the base +Renderer+ class, a new
+  # renderer object of the correct type is created, and the +render+ method on
+  # that new object is called in turn. This abstracts the set up and rendering
+  # into a separate classes for partials and templates.
+  class AbstractRenderer # :nodoc:
+    delegate :template_exists?, :any_templates?, :formats, to: :@lookup_context
+
+    def initialize(lookup_context)
+      @lookup_context = lookup_context
+    end
+
+    def render
+      raise NotImplementedError
+    end
+
+    module ObjectRendering # :nodoc:
+      PREFIXED_PARTIAL_NAMES = Concurrent::Map.new do |h, k|
+        h.compute_if_absent(k) { Concurrent::Map.new }
+      end
+
+      def initialize(lookup_context, options)
+        super
+        @context_prefix = lookup_context.prefixes.first
+      end
+
+      private
+        def local_variable(path)
+          if as = @options[:as]
+            raise_invalid_option_as(as) unless /\A[a-z_]\w*\z/.match?(as.to_s)
+            as.to_sym
+          else
+            base = path.end_with?("/") ? "" : File.basename(path)
+            raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/
+            $1.to_sym
+          end
+        end
+
+        IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
+                                   "make sure your partial name starts with underscore."
+
+        OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " \
+                                   "make sure it starts with lowercase letter, " \
+                                   "and is followed by any combination of letters, numbers and underscores."
+
+        def raise_invalid_identifier(path)
+          raise ArgumentError, IDENTIFIER_ERROR_MESSAGE % path
+        end
+
+        def raise_invalid_option_as(as)
+          raise ArgumentError, OPTION_AS_ERROR_MESSAGE % as
+        end
+
+        # Obtains the path to where the object's partial is located. If the object
+        # responds to +to_partial_path+, then +to_partial_path+ will be called and
+        # will provide the path. If the object does not respond to +to_partial_path+,
+        # then an +ArgumentError+ is raised.
+        #
+        # If +prefix_partial_path_with_controller_namespace+ is true, then this
+        # method will prefix the partial paths with a namespace.
+        def partial_path(object, view)
+          object = object.to_model if object.respond_to?(:to_model)
+
+          path = if object.respond_to?(:to_partial_path)
+            object.to_partial_path
+          else
+            raise ArgumentError.new("'#{object.inspect}' is not an ActiveModel-compatible object. It must implement #to_partial_path.")
+          end
+
+          if view.prefix_partial_path_with_controller_namespace
+            PREFIXED_PARTIAL_NAMES[@context_prefix][path] ||= merge_prefix_into_object_path(@context_prefix, path.dup)
+          else
+            path
+          end
+        end
+
+        def merge_prefix_into_object_path(prefix, object_path)
+          if prefix.include?(?/) && object_path.include?(?/)
+            prefixes = []
+            prefix_array = File.dirname(prefix).split("/")
+            object_path_array = object_path.split("/")[0..-3] # skip model dir & partial
+
+            prefix_array.each_with_index do |dir, index|
+              break if dir == object_path_array[index]
+              prefixes << dir
+            end
+
+            (prefixes << object_path).join("/")
+          else
+            object_path
+          end
+        end
+    end
+
+    class RenderedCollection # :nodoc:
+      def self.empty(format)
+        EmptyCollection.new format
+      end
+
+      attr_reader :rendered_templates
+
+      def initialize(rendered_templates, spacer)
+        @rendered_templates = rendered_templates
+        @spacer = spacer
+      end
+
+      def body
+        @rendered_templates.map(&:body).join(@spacer.body).html_safe
+      end
+
+      def format
+        rendered_templates.first.format
+      end
+
+      class EmptyCollection
+        attr_reader :format
+
+        def initialize(format)
+          @format = format
+        end
+
+        def body; nil; end
+      end
+    end
+
+    class RenderedTemplate # :nodoc:
+      attr_reader :body, :template
+
+      def initialize(body, template)
+        @body = body
+        @template = template
+      end
+
+      def format
+        template.format
+      end
+
+      EMPTY_SPACER = Struct.new(:body).new
+    end
+
+    private
+      NO_DETAILS = {}.freeze
+
+      def extract_details(options) # :doc:
+        details = nil
+        LookupContext.registered_details.each do |key|
+          value = options[key]
+
+          if value
+            (details ||= {})[key] = Array(value)
+          end
+        end
+        details || NO_DETAILS
+      end
+
+      def prepend_formats(formats) # :doc:
+        formats = Array(formats)
+        return if formats.empty? || @lookup_context.html_fallback_for_js
+
+        @lookup_context.formats = formats | @lookup_context.formats
+      end
+
+      def build_rendered_template(content, template)
+        RenderedTemplate.new content, template
+      end
+
+      def build_rendered_collection(templates, spacer)
+        RenderedCollection.new templates, spacer
+      end
+  end
+end