Class: Nanoc::IdentifiableCollectionView

Inherits:
View
  • Object
show all
Includes:
Enumerable
Defined in:
lib/nanoc/base/views/identifiable_collection_view.rb

Direct Known Subclasses

ItemCollectionWithRepsView, ItemCollectionWithoutRepsView, LayoutCollectionView, MutableIdentifiableCollectionView, PostCompileItemCollectionView

Instance Method Summary (collapse)

Methods inherited from View

#_context, #frozen?

Instance Method Details

- (nil, #identifier) [](string) - (nil, #identifier) [](regex)

Overloads:

  • - (nil, #identifier) [](string)

    Finds the object whose identifier matches the given string.

    If the glob syntax is enabled, the string can be a glob, in which case this method finds the first object that matches the given glob.

    Parameters:

    • string (String)

    Returns:

    • (nil) —

      if no object matches the string

    • (#identifier) —

      if an object was found

  • - (nil, #identifier) [](regex)

    Finds the object whose identifier matches the given regular expression.

    Parameters:

    • regex (Regex)

    Returns:

    • (nil) —

      if no object matches the regex

    • (#identifier) —

      if an object was found



72
73
74
75
 
# File 'lib/nanoc/base/views/identifiable_collection_view.rb', line 72

def [](arg)
  res = @objects[arg]
  res && view_class.new(res, @context)
end

- (self) each {|object| ... }

Calls the given block once for each object, passing that object as a parameter.

Yield Parameters:

  • object (#identifier)

Yield Returns:

  • (void)

Returns:

  • (self) 


30
31
32
33
 
# File 'lib/nanoc/base/views/identifiable_collection_view.rb', line 30

def each
  @objects.each { |i| yield view_class.new(i, @context) }
  self
end

- (Enumerable) find_all(arg)

Finds all objects whose identifier matches the given argument.

Parameters:

  • arg (String, Regex)

Returns:

  • (Enumerable) 


45
46
47
48
 
# File 'lib/nanoc/base/views/identifiable_collection_view.rb', line 45

def find_all(arg)
  pat = Nanoc::Int::Pattern.from(arg)
  select { |i| pat.match?(i.identifier) }
end

- (Integer) size

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/nanoc/base/views/identifiable_collection_view.rb', line 36

def size
  @objects.size
end