123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Routing::RouteSet::Generator

Do not use. This class is for internal use only.
Relationships & Source Files
Inherits: Object
Defined in: actionpack/lib/action_dispatch/routing/route_set.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(named_route, options, recall, set) ⇒ Generator

[ GitHub ] 

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 690



def initialize(named_route, options, recall, set)
  @named_route = named_route
  @options     = options
  @recall      = recall
  @set         = set

  normalize_options!
  normalize_controller_action_id!
  use_relative_controller!
  normalize_controller!
end


  







Instance Attribute Details



  

    #different_controller?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 777



def different_controller?
  return false unless current_controller
  controller.to_param != current_controller.to_param
end


  








  

    #named_route   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 688



attr_reader :options, :recall, :set, :named_route


  








  

    #named_route_exists?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 783



def named_route_exists?
  named_route && set.named_routes[named_route]
end


  








  

    #options   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 688



attr_reader :options, :recall, :set, :named_route


  








  

    #recall   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 688



attr_reader :options, :recall, :set, :named_route


  








  

    #set   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 688



attr_reader :options, :recall, :set, :named_route


  







Instance Method Details



  

    #controller  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 702



def controller
  @options[:controller]
end


  








  

    #current_controller  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 706



def current_controller
  @recall[:controller]
end


  








  

    #generate  
  



  

    

Generates a path from routes, returns a RouteWithParams or MissingRoute. MissingRoute will raise ::ActionController::UrlGenerationError.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 773



def generate
  @set.formatter.generate(named_route, options, recall)
end


  








  

    #normalize_controller!  
  



  

    

Remove leading slashes from controllers


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 761



def normalize_controller!
  if controller
    if controller.start_with?("/")
      @options[:controller] = controller[1..-1]
    else
      @options[:controller] = controller
    end
  end
end


  








  

    #normalize_controller_action_id!  
  



  

    

This pulls :controller, :action, and :id out of the recall. The recall key is only used if there is no key in the options or if the key in the options is identical. If any of :controller, :action or :id is not found, don’t pull any more keys from the recall.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 743



def normalize_controller_action_id!
  use_recall_for(:controller) || return
  use_recall_for(:action) || return
  use_recall_for(:id)
end


  








  

    #normalize_options!  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 718



def normalize_options!
  # If an explicit :controller was given, always make :action explicit
  # too, so that action expiry works as expected for things like
  #
  #   generate({controller: 'content'}, {controller: 'content', action: 'show'})
  #
  # (the above is from the unit tests). In the above case, because the
  # controller was explicitly given, but no action, the action is implied to
  # be "index", not the recalled action of "show".

  if options[:controller]
    options[:action]     ||= "index"
    options[:controller]   = options[:controller].to_s
  end

  if options.key?(:action)
    options[:action] = (options[:action] || "index").to_s
  end
end


  








  

    #segment_keys   (private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 787



def segment_keys
  set.named_routes[named_route].segment_keys
end


  








  

    #use_recall_for(key)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 710



def use_recall_for(key)
  if @recall[key] && (!@options.key?(key) || @options[key] == @recall[key])
    if !named_route_exists? || segment_keys.include?(key)
      @options[key] = @recall[key]
    end
  end
end


  








  

    #use_relative_controller!  
  



  

    

if the current controller is “foo/bar/baz” and controller: “baz/bat” is specified, the controller becomes “foo/baz/bat”


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/routing/route_set.rb', line 751



def use_relative_controller!
  if !named_route && different_controller? && !controller.start_with?("/")
    old_parts = current_controller.split("/")
    size = controller.count("/") + 1
    parts = old_parts[0...-size] << controller
    @options[:controller] = parts.join("/")
  end
end