Class: ActionView::DependencyTracker::ERBTracker

Relationships & Source Files
Inherits:	Object
Defined in:	actionview/lib/action_view/dependency_tracker/erb_tracker.rb

Overview

Action View ERB Dependency Tracker

Finds the dependencies of an ::ERB template by scanning its source with regular expressions for render calls and # {ActionView::Template} Dependency: comments.

Because it matches against the source, it also handles template languages whose render calls look like Ruby.

Constant Summary

EXPLICIT_DEPENDENCY =
# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 15
```
/# Template Dependency: (\S+)/
```
IDENTIFIER =

A valid ruby identifier - suitable for class, method and specially variable names

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 18
```
/
  [[:alpha:]_] # at least one uppercase letter, lowercase letter or underscore
  [[:word:]]*  # followed by optional letters, numbers or underscores
/x
```

LAYOUT_DEPENDENCY =
# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 67

/\A
  (?:\s*\(?\s*)                                  # optional opening paren surrounded by spaces
  (?:.*?#{LAYOUT_HASH_KEY})                      # check if the line has layout key declaration
  (?:#{STRING}|#{VARIABLE_OR_METHOD_CHAIN})      # finally, the dependency name of interest
/xm

LAYOUT_HASH_KEY =

Part of any hash containing the :layout key

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 45

/
  (?:\blayout:|:layout\s*=>)   # layout key in either old or new style hash syntax
  \s*                          # followed by optional spaces
/x

PARTIAL_HASH_KEY =

Part of any hash containing the :partial key

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 39

/
  (?:\bpartial:|:partial\s*=>) # partial key in either old or new style hash syntax
  \s*                          # followed by optional spaces
/x

RENDER_ARGUMENTS =

Matches:

partial: "comments/comment", collection: @all_comments => "comments/comment"
(object: @single_comment, partial: "comments/comment") => "comments/comment"

"comments/comments"
'comments/comments'
('comments/comments')

(@topic)         => "topics/topic"
topics          => "topics/topic"
(message.topics) => "topics/topic"

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 61

/\A
  (?:\s*\(?\s*)                                  # optional opening paren surrounded by spaces
  (?:.*?#{PARTIAL_HASH_KEY}|#{LAYOUT_HASH_KEY})? # optional hash, up to the partial or layout key declaration
  (?:#{STRING}|#{VARIABLE_OR_METHOD_CHAIN})      # finally, the dependency name of interest
/xm

STRING =

A simple string literal. e.g. "School's out!"

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 32

/
  (?<quote>['"]) # an opening quote
  (?<static>.*?) # with anything inside, captured as STATIC
  \k<quote>      # and a matching closing quote
/x

VARIABLE_OR_METHOD_CHAIN =

Any kind of variable name. e.g. @instance, @@class, $global or local. Possibly following a method call chain

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 25

/
  (?:\$|@{1,2})?            # optional global, instance or class variable indicator
  (?:#{IDENTIFIER}\.)*      # followed by an optional chain of zero-argument method calls
  (?<dynamic>#{IDENTIFIER}) # and a final valid identifier, captured as DYNAMIC
/x

Class Attribute Summary

.supports_view_paths? ⇒ Boolean readonly Internal use only

Class Method Summary

.call(name, template, view_paths = nil)
.new(name, template, view_paths = nil) ⇒ ERBTracker constructor

Instance Attribute Summary

#name readonly private
#template readonly private

Instance Method Summary

#dependencies
#add_dependencies(render_dependencies, arguments, pattern) private
#add_dynamic_dependency(dependencies, dependency) private
#add_static_dependency(dependencies, dependency, quote_type) private
#directory private
#explicit_dependencies private
#render_dependencies private
#source private

Constructor Details

.new(name, template, view_paths = nil) ⇒ `ERBTracker`

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 81


def initialize(name, template, view_paths = nil)
  @name, @template, @view_paths = name, template, view_paths
end

Class Attribute Details

.supports_view_paths? ⇒ `Boolean` (readonly)

This method is for internal use only.

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 73


def self.supports_view_paths? # :nodoc:
  true
end

Class Method Details

.call(name, template, view_paths = nil)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 77


def self.call(name, template, view_paths = nil)
  new(name, template, view_paths).dependencies
end

Instance Attribute Details

#name (readonly, private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 89


attr_reader :name, :template

#template (readonly, private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 89


attr_reader :name, :template

Instance Method Details

#add_dependencies(render_dependencies, arguments, pattern) (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 113


def add_dependencies(render_dependencies, arguments, pattern)
  arguments.scan(pattern) do
    match = Regexp.last_match
    add_dynamic_dependency(render_dependencies, match[:dynamic])
    add_static_dependency(render_dependencies, match[:static], match[:quote])
  end
end

#add_dynamic_dependency(dependencies, dependency) (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 121


def add_dynamic_dependency(dependencies, dependency)
  if dependency
    dependencies << "#{dependency.pluralize}/#{dependency.singularize}"
  end
end

#add_static_dependency(dependencies, dependency, quote_type) (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 127


def add_static_dependency(dependencies, dependency, quote_type)
  if quote_type == '"' && dependency.include?('#{')
    scanner = StringScanner.new(dependency)

    wildcard_dependency = +""

    while !scanner.eos?
      if scanner.scan_until(/\#{/)
        unmatched_brackets = 1
        wildcard_dependency << scanner.pre_match

        while unmatched_brackets > 0 && !scanner.eos?
          found = scanner.scan_until(/[{}]/)
          return unless found

          case scanner.matched
          when "{"
            unmatched_brackets += 1
          when "}"
            unmatched_brackets -= 1
          end
        end

        wildcard_dependency << "*"
      else
        wildcard_dependency << scanner.rest
        scanner.terminate
      end
    end

    dependencies << wildcard_dependency
  elsif dependency
    if dependency.include?("/")
      dependencies << dependency
    else
      dependencies << "#{directory}/#{dependency}"
    end
  end
end

#dependencies

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 85


def dependencies
  WildcardResolver.new(@view_paths, render_dependencies + explicit_dependencies).resolve
end

#directory (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 97


def directory
  name.split("/")[0..-2].join("/")
end

#explicit_dependencies (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 167


def explicit_dependencies
  source.scan(EXPLICIT_DEPENDENCY).flatten.uniq
end

#render_dependencies (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 101


def render_dependencies
  dependencies = []
  render_calls = source.scan(/<%(?:(?:(?!<%).)*?\brender\b((?:(?!%>).)*?))%>/m).flatten

  render_calls.each do |arguments|
    add_dependencies(dependencies, arguments, LAYOUT_DEPENDENCY)
    add_dependencies(dependencies, arguments, RENDER_ARGUMENTS)
  end

  dependencies
end

#source (private)

[ GitHub ]

# File 'actionview/lib/action_view/dependency_tracker/erb_tracker.rb', line 93


def source
  template.source
end

Class: ActionView::DependencyTracker::ERBTracker

Overview

Action View ERB Dependency Tracker

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, template, view_paths = nil) ⇒ ERBTracker

Class Attribute Details

.supports_view_paths? ⇒ Boolean (readonly)

Class Method Details

.call(name, template, view_paths = nil)

Instance Attribute Details

#name (readonly, private)

#template (readonly, private)

Instance Method Details

#add_dependencies(render_dependencies, arguments, pattern) (private)

#add_dynamic_dependency(dependencies, dependency) (private)

#add_static_dependency(dependencies, dependency, quote_type) (private)

#dependencies

#directory (private)

#explicit_dependencies (private)

#render_dependencies (private)

#source (private)

.new(name, template, view_paths = nil) ⇒ `ERBTracker`

.supports_view_paths? ⇒ `Boolean` (readonly)