123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Journey::Route

Do not use. This class is for internal use only.
Relationships & Source Files
Namespace Children
Modules:
VerbMatchers
Inherits: Object
Defined in: actionpack/lib/action_dispatch/journey/route.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false, source_location: nil) ⇒ Route

#path is a path constraint. #constraints is a hash of constraints to be applied to this route.

[ GitHub ] 

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 56



def initialize(name:, app: nil, path:, constraints: {}, required_defaults: [], defaults: {}, request_method_match: nil, precedence: 0, scope_options: {}, internal: false, source_location: nil)
  @name        = name
  @app         = app
  @path        = path

  @request_method_match = request_method_match
  @constraints = constraints
  @defaults    = defaults
  @required_defaults = nil
  @_required_defaults = required_defaults
  @required_parts    = nil
  @parts             = nil
  @precedence        = precedence
  @path_formatter    = @path.build_formatter
  @scope_options     = scope_options
  @internal          = internal
  @source_location   = source_location

  @ast = @path.ast.root
  @path.ast.route = self
end


  







Class Method Details



  

    .verb_matcher(verb)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 47



def self.verb_matcher(verb)
  VerbMatchers::VERB_TO_CLASS.fetch(verb) do
    VerbMatchers::Unknown.new verb.to_s.dasherize.upcase
  end
end


  







Instance Attribute Details



  

    #app   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #ast   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #conditions   (readonly)
  



  

    

Alias for #constraints.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 10



alias :conditions :constraints


  








  

    #constraints   (readonly)
    Also known as: #conditions
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #defaults   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #dispatcher?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 142



def dispatcher?
  @app.dispatcher?
end


  








  

    #glob?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 138



def glob?
  path.ast.glob?
end


  








  

    #internal   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #name   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #path   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #precedence   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #requires_matching_verb?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 168



def requires_matching_verb?
  !@request_method_match.all? { |x| x == VerbMatchers::All }
end


  








  

    #scope_options   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  








  

    #source_location   (readonly)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 7



attr_reader :app, :path, :defaults, :name, :precedence, :constraints,
            :internal, :scope_options, :ast, :source_location


  







Instance Method Details



  

    #eager_load!  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 78



def eager_load!
  path.eager_load!
  parts
  required_defaults
  nil
end


  








  

    #format(path_options)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 120



def format(path_options)
  @path_formatter.evaluate path_options
end


  








  

    #ip  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 164



def ip
  constraints[:ip] || //
end


  








  

    #match_verb(request)   (private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 181



def match_verb(request)
  @request_method_match.any? { |m| m.call request }
end


  








  

    #matches?(request)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 146



def matches?(request)
  match_verb(request) &&
  constraints.all? { |method, value|
    case value
    when Regexp, String
      value === request.send(method).to_s
    when Array
      value.include?(request.send(method))
    when TrueClass
      request.send(method).present?
    when FalseClass
      request.send(method).blank?
    else
      value === request.send(method)
    end
  }
end


  








  

    #parts  
    Also known as: #segment_keys
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 115



def parts
  @parts ||= segments.map(&:to_sym)
end


  








  

    #required_default?(key)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 128



def required_default?(key)
  @_required_defaults.include?(key)
end


  








  

    #required_defaults  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 132



def required_defaults
  @required_defaults ||= @defaults.dup.delete_if do |k, _|
    parts.include?(k) || !required_default?(k)
  end
end


  








  

    #required_keys  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 103



def required_keys
  required_parts + required_defaults.keys
end


  








  

    #required_parts  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 124



def required_parts
  @required_parts ||= path.required_names.map(&:to_sym)
end


  








  

    #requirements  
  



  

    

Needed for bin/rails routes. Picks up succinctly defined requirements for a route, for example route



get 'photo/:id', :controller => 'photos', :action => 'show',
  :id => /[A-Z]\d{5}/



will have :action=>“show”, :id=>/d{5/} as requirements.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 93



def requirements
  @defaults.merge(path.requirements).delete_if { |_, v|
    /.+?/m == v
  }
end


  








  

    #score(supplied_keys)  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 107



def score(supplied_keys)
  path.required_names.each do |k|
    return -1 unless supplied_keys.include?(k)
  end

  (required_defaults.length * 2) + path.names.count { |k| supplied_keys.include?(k) }
end


  








  

    #segment_keys  
  



  

    

Alias for #parts.


  



  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 118



alias :segment_keys :parts


  








  

    #segments  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 99



def segments
  path.names
end


  








  

    #verb  
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 172



def verb
  verbs.join("|")
end


  








  

    #verbs   (private)
  

  [ GitHub ]


  

  


# File 'actionpack/lib/action_dispatch/journey/route.rb', line 177



def verbs
  @request_method_match.map(&:verb)
end