Class: ActionDispatch::Routing::Mapper::Scope

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
actionpack/lib/action_dispatch/routing/mapper.rb

Overview

:nodoc:

Constant Summary collapse

OPTIONS = 
[:path, :shallow_path, :as, :shallow_prefix, :module,
:controller, :action, :path_names, :constraints,
:shallow, :blocks, :defaults, :via, :format, :options, :to]
RESOURCE_SCOPES = 
[:resource, :resources]
RESOURCE_METHOD_SCOPES = 
[:collection, :member, :new]
NULL = 
Scope.new(nil, nil)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#as_json, #compact_blank, #exclude?, #excluding, #in_order_of, #including, #index_by, #index_with, #many?, #maximum, #minimum, #pick, #pluck, #sole

Constructor Details

#initialize(hash, parent = NULL, scope_level = nil) ⇒ Scope

Returns a new instance of Scope.



2270
2271
2272
2273
2274
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2270

def initialize(hash, parent = NULL, scope_level = nil)
  @hash = hash
  @parent = parent
  @scope_level = scope_level
end

Instance Attribute Details

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



2268
2269
2270
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2268

def parent
  @parent
end

#scope_level ⇒ Object (readonly)

Returns the value of attribute scope_level.



2268
2269
2270
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2268

def scope_level
  @scope_level
end

Instance Method Details

#[](key) ⇒ Object 



2329
2330
2331
2332
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2329

def [](key)
  scope = find { |node| node.frame.key? key }
  scope && scope.frame[key]
end

#action_name(name_prefix, prefix, collection_name, member_name) ⇒ Object 



2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2296

def action_name(name_prefix, prefix, collection_name, member_name)
  case scope_level
  when :nested
    [name_prefix, prefix]
  when :collection
    [prefix, name_prefix, collection_name]
  when :new
    [prefix, :new, name_prefix, member_name]
  when :member
    [prefix, name_prefix, member_name]
  when :root
    [name_prefix, collection_name, prefix]
  else
    [name_prefix, member_name, prefix]
  end
end

#each ⇒ Object 



2336
2337
2338
2339
2340
2341
2342
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2336

def each
  node = self
  until node.equal? NULL
    yield node
    node = node.parent
  end
end

#frame ⇒ Object 



2344
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2344

def frame; @hash; end

#nested? ⇒ Boolean

Returns:

  • (Boolean) 


2276
2277
2278
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2276

def nested?
  scope_level == :nested
end

#new(hash) ⇒ Object 



2321
2322
2323
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2321

def new(hash)
  self.class.new hash, self, scope_level
end

#new_level(level) ⇒ Object 



2325
2326
2327
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2325

def new_level(level)
  self.class.new(frame, self, level)
end

#null? ⇒ Boolean

Returns:

  • (Boolean) 


2280
2281
2282
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2280

def null?
  @hash.nil? && @parent.nil?
end

#options ⇒ Object 



2317
2318
2319
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2317

def options
  OPTIONS
end

#resource_method_scope? ⇒ Boolean

Returns:

  • (Boolean) 


2292
2293
2294
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2292

def resource_method_scope?
  RESOURCE_METHOD_SCOPES.include? scope_level
end

#resource_scope? ⇒ Boolean

Returns:

  • (Boolean) 


2313
2314
2315
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2313

def resource_scope?
  RESOURCE_SCOPES.include? scope_level
end

#resources? ⇒ Boolean

Returns:

  • (Boolean) 


2288
2289
2290
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2288

def resources?
  scope_level == :resources
end

#root? ⇒ Boolean

Returns:

  • (Boolean) 


2284
2285
2286
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 2284

def root?
  @parent.null?
end