omg-actionpack 8.0.0.alpha1

data/lib/action_controller/metal/renderers.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "set"
+
+module ActionController
+  # See Renderers.add
+  def self.add_renderer(key, &block)
+    Renderers.add(key, &block)
+  end
+
+  # See Renderers.remove
+  def self.remove_renderer(key)
+    Renderers.remove(key)
+  end
+
+  # See `Responder#api_behavior`
+  class MissingRenderer < LoadError
+    def initialize(format)
+      super "No renderer defined for format: #{format}"
+    end
+  end
+
+  module Renderers
+    extend ActiveSupport::Concern
+
+    # A Set containing renderer names that correspond to available renderer procs.
+    # Default values are `:json`, `:js`, `:xml`.
+    RENDERERS = Set.new
+
+    included do
+      class_attribute :_renderers, default: Set.new.freeze
+    end
+
+    # Used in ActionController::Base and ActionController::API to include all
+    # renderers by default.
+    module All
+      extend ActiveSupport::Concern
+      include Renderers
+
+      included do
+        self._renderers = RENDERERS
+      end
+    end
+
+    # Adds a new renderer to call within controller actions. A renderer is invoked
+    # by passing its name as an option to AbstractController::Rendering#render. To
+    # create a renderer pass it a name and a block. The block takes two arguments,
+    # the first is the value paired with its key and the second is the remaining
+    # hash of options passed to `render`.
+    #
+    # Create a csv renderer:
+    #
+    #     ActionController::Renderers.add :csv do |obj, options|
+    #       filename = options[:filename] || 'data'
+    #       str = obj.respond_to?(:to_csv) ? obj.to_csv : obj.to_s
+    #       send_data str, type: Mime[:csv],
+    #         disposition: "attachment; filename=#{filename}.csv"
+    #     end
+    #
+    # Note that we used [Mime](:csv) for the csv mime type as it comes with Rails.
+    # For a custom renderer, you'll need to register a mime type with
+    # `Mime::Type.register`.
+    #
+    # To use the csv renderer in a controller action:
+    #
+    #     def show
+    #       @csvable = Csvable.find(params[:id])
+    #       respond_to do |format|
+    #         format.html
+    #         format.csv { render csv: @csvable, filename: @csvable.name }
+    #       end
+    #     end
+    def self.add(key, &block)
+      define_method(_render_with_renderer_method_name(key), &block)
+      RENDERERS << key.to_sym
+    end
+
+    # This method is the opposite of add method.
+    #
+    # To remove a csv renderer:
+    #
+    #     ActionController::Renderers.remove(:csv)
+    def self.remove(key)
+      RENDERERS.delete(key.to_sym)
+      method_name = _render_with_renderer_method_name(key)
+      remove_possible_method(method_name)
+    end
+
+    def self._render_with_renderer_method_name(key)
+      "_render_with_renderer_#{key}"
+    end
+
+    module ClassMethods
+      # Adds, by name, a renderer or renderers to the `_renderers` available to call
+      # within controller actions.
+      #
+      # It is useful when rendering from an ActionController::Metal controller or
+      # otherwise to add an available renderer proc to a specific controller.
+      #
+      # Both ActionController::Base and ActionController::API include
+      # ActionController::Renderers::All, making all renderers available in the
+      # controller. See Renderers::RENDERERS and Renderers.add.
+      #
+      # Since ActionController::Metal controllers cannot render, the controller must
+      # include AbstractController::Rendering, ActionController::Rendering, and
+      # ActionController::Renderers, and have at least one renderer.
+      #
+      # Rather than including ActionController::Renderers::All and including all
+      # renderers, you may specify which renderers to include by passing the renderer
+      # name or names to `use_renderers`. For example, a controller that includes only
+      # the `:json` renderer (`_render_with_renderer_json`) might look like:
+      #
+      #     class MetalRenderingController < ActionController::Metal
+      #       include AbstractController::Rendering
+      #       include ActionController::Rendering
+      #       include ActionController::Renderers
+      #
+      #       use_renderers :json
+      #
+      #       def show
+      #         render json: record
+      #       end
+      #     end
+      #
+      # You must specify a `use_renderer`, else the `controller.renderer` and
+      # `controller._renderers` will be `nil`, and the action will fail.
+      def use_renderers(*args)
+        renderers = _renderers + args
+        self._renderers = renderers.freeze
+      end
+      alias use_renderer use_renderers
+    end
+
+    # Called by `render` in AbstractController::Rendering which sets the return
+    # value as the `response_body`.
+    #
+    # If no renderer is found, `super` returns control to
+    # `ActionView::Rendering.render_to_body`, if present.
+    def render_to_body(options)
+      _render_to_body_with_renderer(options) || super
+    end
+
+    def _render_to_body_with_renderer(options)
+      _renderers.each do |name|
+        if options.key?(name)
+          _process_options(options)
+          method_name = Renderers._render_with_renderer_method_name(name)
+          return send(method_name, options.delete(name), options)
+        end
+      end
+      nil
+    end
+
+    add :json do |json, options|
+      json = json.to_json(options) unless json.kind_of?(String)
+
+      if options[:callback].present?
+        if media_type.nil? || media_type == Mime[:json]
+          self.content_type = Mime[:js]
+        end
+
+        "/**/#{options[:callback]}(#{json})"
+      else
+        self.content_type = Mime[:json] if media_type.nil?
+        json
+      end
+    end
+
+    add :js do |js, options|
+      self.content_type = Mime[:js] if media_type.nil?
+      js.respond_to?(:to_js) ? js.to_js(options) : js
+    end
+
+    add :xml do |xml, options|
+      self.content_type = Mime[:xml] if media_type.nil?
+      xml.respond_to?(:to_xml) ? xml.to_xml(options) : xml
+    end
+  end
+end

data/lib/action_controller/metal/rendering.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module ActionController
+  module Rendering
+    extend ActiveSupport::Concern
+
+    RENDER_FORMATS_IN_PRIORITY = [:body, :plain, :html]
+
+    module ClassMethods
+      # Documentation at ActionController::Renderer#render
+      delegate :render, to: :renderer
+
+      # Returns a renderer instance (inherited from ActionController::Renderer) for
+      # the controller.
+      attr_reader :renderer
+
+      def setup_renderer! # :nodoc:
+        @renderer = Renderer.for(self)
+      end
+
+      def inherited(klass)
+        klass.setup_renderer!
+        super
+      end
+    end
+
+    # Renders a template and assigns the result to `self.response_body`.
+    #
+    # If no rendering mode option is specified, the template will be derived from
+    # the first argument.
+    #
+    #     render "posts/show"
+    #     # => renders app/views/posts/show.html.erb
+    #
+    #     # In a PostsController action...
+    #     render :show
+    #     # => renders app/views/posts/show.html.erb
+    #
+    # If the first argument responds to `render_in`, the template will be rendered
+    # by calling `render_in` with the current view context.
+    #
+    #     class Greeting
+    #       def render_in(view_context)
+    #         view_context.render html: "<h1>Hello, World</h1>"
+    #       end
+    #
+    #       def format
+    #         :html
+    #       end
+    #     end
+    #
+    #     render(Greeting.new)
+    #     # => "<h1>Hello, World</h1>"
+    #
+    #     render(renderable: Greeting.new)
+    #     # => "<h1>Hello, World</h1>"
+    #
+    # #### Rendering Mode
+    #
+    # `:partial`
+    # :   See ActionView::PartialRenderer for details.
+    #
+    #         render partial: "posts/form", locals: { post: Post.new }
+    #         # => renders app/views/posts/_form.html.erb
+    #
+    # `:file`
+    # :   Renders the contents of a file. This option should **not** be used with
+    #     unsanitized user input.
+    #
+    #         render file: "/path/to/some/file"
+    #         # => renders /path/to/some/file
+    #
+    # `:inline`
+    # :   Renders an ERB template string.
+    #
+    #         @name = "World"
+    #         render inline: "<h1>Hello, <%= @name %>!</h1>"
+    #         # => renders "<h1>Hello, World!</h1>"
+    #
+    # `:body`
+    # :   Renders the provided text, and sets the content type as `text/plain`.
+    #
+    #         render body: "Hello, World!"
+    #         # => renders "Hello, World!"
+    #
+    # `:plain`
+    # :   Renders the provided text, and sets the content type as `text/plain`.
+    #
+    #         render plain: "Hello, World!"
+    #         # => renders "Hello, World!"
+    #
+    # `:html`
+    # :   Renders the provided HTML string, and sets the content type as
+    #     `text/html`. If the string is not `html_safe?`, performs HTML escaping on
+    #     the string before rendering.
+    #
+    #         render html: "<h1>Hello, World!</h1>".html_safe
+    #         # => renders "<h1>Hello, World!</h1>"
+    #
+    #         render html: "<h1>Hello, World!</h1>"
+    #         # => renders "&lt;h1&gt;Hello, World!&lt;/h1&gt;"
+    #
+    # `:json`
+    # :   Renders the provided object as JSON, and sets the content type as
+    #     `application/json`. If the object is not a string, it will be converted to
+    #     JSON by calling `to_json`.
+    #
+    #         render json: { hello: "world" }
+    #         # => renders "{\"hello\":\"world\"}"
+    #
+    # `:renderable`
+    # :   Renders the provided object by calling `render_in` with the current view
+    #     context. The response format is determined by calling `format` on the
+    #     renderable if it responds to `format`, falling back to `text/html` by
+    #     default.
+    #
+    #         render renderable: Greeting.new
+    #         # => renders "<h1>Hello, World</h1>"
+    #
+    #
+    # By default, when a rendering mode is specified, no layout template is
+    # rendered.
+    #
+    # #### Options
+    #
+    # `:assigns`
+    # :   Hash of instance variable assignments for the template.
+    #
+    #         render inline: "<h1>Hello, <%= @name %>!</h1>", assigns: { name: "World" }
+    #         # => renders "<h1>Hello, World!</h1>"
+    #
+    # `:locals`
+    # :   Hash of local variable assignments for the template.
+    #
+    #         render inline: "<h1>Hello, <%= name %>!</h1>", locals: { name: "World" }
+    #         # => renders "<h1>Hello, World!</h1>"
+    #
+    # `:layout`
+    # :   The layout template to render. Can also be `false` or `true` to disable or
+    #     (re)enable the default layout template.
+    #
+    #         render "posts/show", layout: "holiday"
+    #         # => renders app/views/posts/show.html.erb with the app/views/layouts/holiday.html.erb layout
+    #
+    #         render "posts/show", layout: false
+    #         # => renders app/views/posts/show.html.erb with no layout
+    #
+    #         render inline: "<h1>Hello, World!</h1>", layout: true
+    #         # => renders "<h1>Hello, World!</h1>" with the default layout
+    #
+    # `:status`
+    # :   The HTTP status code to send with the response. Can be specified as a
+    #     number or as the status name in Symbol form. Defaults to 200.
+    #
+    #         render "posts/new", status: 422
+    #         # => renders app/views/posts/new.html.erb with HTTP status code 422
+    #
+    #         render "posts/new", status: :unprocessable_entity
+    #         # => renders app/views/posts/new.html.erb with HTTP status code 422
+    #
+    #--
+    # Check for double render errors and set the content_type after rendering.
+    def render(*args)
+      raise ::AbstractController::DoubleRenderError if response_body
+      super
+    end
+
+    # Similar to #render, but only returns the rendered template as a string,
+    # instead of setting `self.response_body`.
+    #--
+    # Override render_to_string because body can now be set to a Rack body.
+    def render_to_string(*)
+      result = super
+      if result.respond_to?(:each)
+        string = +""
+        result.each { |r| string << r }
+        string
+      else
+        result
+      end
+    end
+
+    def render_to_body(options = {}) # :nodoc:
+      super || _render_in_priorities(options) || " "
+    end
+
+    private
+      # Before processing, set the request formats in current controller formats.
+      def process_action(*) # :nodoc:
+        self.formats = request.formats.filter_map(&:ref)
+        super
+      end
+
+      def _process_variant(options)
+        if defined?(request) && !request.nil? && request.variant.present?
+          options[:variant] = request.variant
+        end
+      end
+
+      def _render_in_priorities(options)
+        RENDER_FORMATS_IN_PRIORITY.each do |format|
+          return options[format] if options.key?(format)
+        end
+
+        nil
+      end
+
+      def _set_html_content_type
+        self.content_type = Mime[:html].to_s
+      end
+
+      def _set_rendered_content_type(format)
+        if format && !response.media_type
+          self.content_type = format.to_s
+        end
+      end
+
+      def _set_vary_header
+        if response.headers["Vary"].blank? && request.should_apply_vary_header?
+          response.headers["Vary"] = "Accept"
+        end
+      end
+
+      # Normalize both text and status options.
+      def _normalize_options(options)
+        _normalize_text(options)
+
+        if options[:html]
+          options[:html] = ERB::Util.html_escape(options[:html])
+        end
+
+        if options[:status]
+          options[:status] = Rack::Utils.status_code(options[:status])
+        end
+
+        super
+      end
+
+      def _normalize_text(options)
+        RENDER_FORMATS_IN_PRIORITY.each do |format|
+          if options.key?(format) && options[format].respond_to?(:to_text)
+            options[format] = options[format].to_text
+          end
+        end
+      end
+
+      # Process controller specific options, as status, content-type and location.
+      def _process_options(options)
+        status, content_type, location = options.values_at(:status, :content_type, :location)
+
+        self.status = status if status
+        self.content_type = content_type if content_type
+        headers["Location"] = url_for(location) if location
+
+        super
+      end
+  end
+end