Contents

module Nanoc3

  # Nanoc3::RuleContext provides a context in which compilation and routing
  # rules can be executed. It provides access to the item representation that
  # is being compiled or routed.
  class RuleContext

    # Creates a new rule context for the given item representation.
    def initialize(rep)
      @rep = rep
    end

    # The representation that is currently being processed in this context.
    def rep
      @rep
    end

    # The item of the representation that is currently being processed in this
    # context.
    def item
      rep.item
    end

    # The site of the item representation that is currently being processed in
    # this context.
    def site
      item.site
    end

    # The configuration of the site of the item representation that is
    # currently being processed in this context.
    def config
      site.config
    end

    # The items in the site of the item representation that is currently being
    # processed in this context.
    def items
      site.items
    end

    # The layouts in the site of the item representation that is currently
    # being processed in this context.
    def layouts
      site.layouts
    end

    # Filters the current representation (calls #filter with the given
    # arguments on the rep).
    def filter(filter_name, filter_args={})
      rep.filter(filter_name, filter_args)
    end

    # Layouts the current representation (calls #layout with the given
    # arguments on the rep).
    def layout(layout_identifier)
      rep.layout(layout_identifier)
    end

    # Creates a snapshot of the current representation (calls #snapshot with
    # the given arguments on the rep).
    def snapshot(snapshot_name)
      rep.snapshot(snapshot_name)
    end

  end

end

Version data entries

10 entries across 10 versions & 1 rubygems

Version	Path
nanoc3-3.0.9	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.8	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.7	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.6	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.5	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.4	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.3	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.2	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.1	lib/nanoc3/base/rule_context.rb
nanoc3-3.0.0	lib/nanoc3/base/rule_context.rb