123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Journey::Formatter

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

Overview

The Formatter class is used for formatting URLs. For example, parameters passed to url_for in ::Rails will eventually call #generate.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(routes) ⇒ Formatter

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 15

def initialize(routes)
  @routes = routes
  @cache  = nil
end

Instance Attribute Details

#routes (readonly)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 13

attr_reader :routes

Instance Method Details

#build_cache (private)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 209

def build_cache
  root = { ___routes: [] }
  routes.routes.each_with_index do |route, i|
    leaf = route.required_defaults.inject(root) do |h, tuple|
      h[tuple] ||= {}
    end
    (leaf[:___routes] ||= []) << [i, route]
  end
  root
end

#cache (private)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 220

def cache
  @cache ||= build_cache
end

#clear

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 105

def clear
  @cache = nil
end

#eager_load!

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 109

def eager_load!
  cache
  nil
end

#extract_parameterized_parts(route, options, recall) (private)

[ GitHub ]

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

def extract_parameterized_parts(route, options, recall)
  parameterized_parts = recall.merge(options)

  keys_to_keep = route.parts.reverse_each.drop_while { |part|
    !(options.key?(part) || route.scope_options.key?(part)) || (options[part].nil? && recall[part].nil?)
  } | route.required_parts

  parameterized_parts.delete_if do |bad_key, _|
    !keys_to_keep.include?(bad_key)
  end

  parameterized_parts.each do |k, v|
    if k == :controller
      parameterized_parts[k] = v
    else
      parameterized_parts[k] = v.to_param
    end
  end

  parameterized_parts.compact!
  parameterized_parts
end

#generate(name, options, path_parameters)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 61

def generate(name, options, path_parameters)
  original_options = options.dup
  path_params = options.delete(:path_params) || {}
  options = path_params.merge(options)
  constraints = path_parameters.merge(options)
  missing_keys = nil

  match_route(name, constraints) do |route|
    parameterized_parts = extract_parameterized_parts(route, options, path_parameters)

    # Skip this route unless a name has been provided or it is a standard Rails
    # route since we can't determine whether an options hash passed to url_for
    # matches a Rack application or a redirect.
    next unless name || route.dispatcher?

    missing_keys = missing_keys(route, parameterized_parts)
    next if missing_keys && !missing_keys.empty?
    params = options.delete_if do |key, _|
      # top-level params' normal behavior of generating query_params should be
      # preserved even if the same key is also a bind_param
      parameterized_parts.key?(key) || route.defaults.key?(key) ||
        (path_params.key?(key) && !original_options.key?(key))
    end

    defaults       = route.defaults
    required_parts = route.required_parts

    route.parts.reverse_each do |key|
      break if defaults[key].nil? && parameterized_parts[key].present?
      next if parameterized_parts[key].to_s != defaults[key].to_s
      break if required_parts.include?(key)

      parameterized_parts.delete(key)
    end

    return RouteWithParams.new(route, parameterized_parts, params)
  end

  unmatched_keys = (missing_keys || []) & constraints.keys
  missing_keys = (missing_keys || []) - unmatched_keys

  MissingRoute.new(constraints, missing_keys, unmatched_keys, routes, name)
end

#match_route(name, options) (private)

[ GitHub ]

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

def match_route(name, options)
  if named_routes.key?(name)
    yield named_routes[name]
  else
    routes = non_recursive(cache, options)

    supplied_keys = options.each_with_object({}) do |(k, v), h|
      h[k.to_s] = true if v
    end

    hash = routes.group_by { |_, r| r.score(supplied_keys) }

    hash.keys.sort.reverse_each do |score|
      break if score < 0

      hash[score].sort_by { |i, _| i }.each do |_, route|
        yield route
      end
    end
  end
end

#missing_keys(route, parts) (private)

Returns an array populated with missing keys if any are present.

[ GitHub ]

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

def missing_keys(route, parts)
  missing_keys = nil
  tests = route.path.requirements_for_missing_keys_check
  route.required_parts.each { |key|
    case tests[key]
    when nil
      unless parts[key]
        missing_keys ||= []
        missing_keys << key
      end
    else
      unless tests[key].match?(parts[key])
        missing_keys ||= []
        missing_keys << key
      end
    end
  }
  missing_keys
end

#named_routes (private)

[ GitHub ]

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

def named_routes
  routes.named_routes
end

#non_recursive(cache, options) (private)

[ GitHub ]

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

def non_recursive(cache, options)
  routes = []
  queue  = [cache]

  while queue.any?
    c = queue.shift
    routes.concat(c[:___routes]) if c.key?(:___routes)

    options.each do |pair|
      queue << c[pair] if c.key?(pair)
    end
  end

  routes
end

#possibles(cache, options, depth = 0) (private)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/journey/formatter.rb', line 201

def possibles(cache, options, depth = 0)
  cache.fetch(:___routes) { [] } + options.find_all { |pair|
    cache.key?(pair)
  }.flat_map { |pair|
    possibles(cache[pair], options, depth + 1)
  }
end