Contents

# encoding: utf-8

module Nanoc3

  # Contains the processing information for a item.
  class Rule

    # @return [Regexp] The regex that determines which items this rule can be
    # applied to. This rule can be applied to items with a identifier matching
    # this regex.
    attr_reader :identifier_regex

    # @return [Symbol] The name of the representation that will be compiled
    # using this rule
    attr_reader :rep_name

    # Creates a new item compilation rule with the given identifier regex,
    # compiler and block. The block will be called during compilation with the
    # item rep as its argument.
    #
    # @param [Regexp] identifier_regex A regular expression that will be used
    # to determine whether this rule is applicable to certain items.
    #
    # @param [String, Symbol] rep_name The name of the item representation
    # where this rule can be applied to
    #
    # @param [Proc] block A block that will be called when matching items are
    # compiled
    def initialize(identifier_regex, rep_name, block)
      @identifier_regex = identifier_regex
      @rep_name         = rep_name.to_sym

      @block = block
    end

    # @param [Nanoc3::Item] item The item to check
    #
    # @return [Boolean] true if this rule can be applied to the given item
    # rep, false otherwise
    def applicable_to?(item)
      item.identifier =~ @identifier_regex
    end

    # Applies this rule to the given item rep.
    #
    # @param [Nanoc3::ItemRep] rep The item representation where this rule
    # should be applied to
    #
    # @return [void]
    def apply_to(rep)
      Nanoc3::RuleContext.new(rep).instance_eval &@block
    end

  end

end

Version data entries

14 entries across 14 versions & 1 rubygems

Version	Path
nanoc3-3.1.9	lib/nanoc3/base/rule.rb
nanoc3-3.1.8	lib/nanoc3/base/rule.rb
nanoc3-3.1.7	lib/nanoc3/base/rule.rb
nanoc3-3.1.6	lib/nanoc3/base/rule.rb
nanoc3-3.1.5	lib/nanoc3/base/rule.rb
nanoc3-3.1.4	lib/nanoc3/base/rule.rb
nanoc3-3.1.3	lib/nanoc3/base/rule.rb
nanoc3-3.1.2	lib/nanoc3/base/rule.rb
nanoc3-3.1.1	lib/nanoc3/base/rule.rb
nanoc3-3.1.0	lib/nanoc3/base/rule.rb
nanoc3-3.1.0rc1	lib/nanoc3/base/rule.rb
nanoc3-3.1.0b2	lib/nanoc3/base/rule.rb
nanoc3-3.1.0b1	lib/nanoc3/base/rule.rb
nanoc3-3.1.0a3	lib/nanoc3/base/rule.rb