dependency_tracker.rb 2.6 KB
Newer Older
D
Daniel Schierbeck 已提交
1 2
require 'thread_safe'

3 4
module ActionView
  class DependencyTracker
D
Daniel Schierbeck 已提交
5
    @trackers = ThreadSafe::Cache.new
6

7
    def self.find_dependencies(name, template)
8 9 10 11 12 13 14
      tracker = @trackers[template.handler]

      if tracker.present?
        tracker.call(name, template)
      else
        []
      end
15 16
    end

17 18
    def self.register_tracker(extension, tracker)
      handler = Template.handler_for_extension(extension)
19 20 21 22 23
      @trackers[handler] = tracker
    end

    def self.remove_tracker(handler)
      @trackers.delete(handler)
24 25
    end

26
    class ERBTracker
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
      EXPLICIT_DEPENDENCY = /# Template Dependency: (\S+)/

      # Matches:
      #   render partial: "comments/comment", collection: commentable.comments
      #   render "comments/comments"
      #   render 'comments/comments'
      #   render('comments/comments')
      #
      #   render(@topic)         => render("topics/topic")
      #   render(topics)         => render("topics/topic")
      #   render(message.topics) => render("topics/topic")
      RENDER_DEPENDENCY = /
        render\s*                     # render, followed by optional whitespace
        \(?                           # start an optional parenthesis for the render call
        (partial:|:partial\s+=>)?\s*  # naming the partial, used with collection -- 1st capture
42
        ([@a-z"'][@\w\/\."']+)        # the template name itself -- 2nd capture
43 44 45
      /x

      def self.call(name, template)
46
        new(name, template).dependencies
47 48 49 50 51 52
      end

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

53
      def dependencies
54 55 56
        render_dependencies + explicit_dependencies
      end

57 58 59
      attr_reader :name, :template
      private :name, :template

60 61
      private

62 63 64 65
        def source
          template.source
        end

66 67 68 69 70
        def directory
          name.split("/")[0..-2].join("/")
        end

        def render_dependencies
71
          source.scan(RENDER_DEPENDENCY).
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
            collect(&:second).uniq.

            # render(@topic)         => render("topics/topic")
            # render(topics)         => render("topics/topic")
            # render(message.topics) => render("topics/topic")
            collect { |name| name.sub(/\A@?([a-z]+\.)*([a-z_]+)\z/) { "#{$2.pluralize}/#{$2.singularize}" } }.

            # render("headline") => render("message/headline")
            collect { |name| name.include?("/") ? name : "#{directory}/#{name}" }.

            # replace quotes from string renders
            collect { |name| name.gsub(/["']/, "") }
        end

        def explicit_dependencies
87
          source.scan(EXPLICIT_DEPENDENCY).flatten.uniq
88 89
        end
    end
90

91
    register_tracker :erb, ERBTracker
92 93
  end
end