lib/rouge/lexers/puppet.rb



# -*- coding: utf-8 -*- #
# frozen_string_literal: true

module Rouge
  module Lexers
    class Puppet < RegexLexer
      title "Puppet"
      desc 'The Puppet configuration management language (puppetlabs.org)'
      tag 'puppet'
      aliases 'pp'
      filenames '*.pp'

      def self.detect?(text)
        return true if text.shebang? 'puppet-apply'
        return true if text.shebang? 'puppet'
      end

      def self.keywords
        @keywords ||= Set.new %w(
          and case class default define else elsif if in import inherits
          node unless
        )
      end

      def self.constants
        @constants ||= Set.new %w(
          false true undef
        )
      end

      def self.metaparameters
        @metaparameters ||= Set.new %w(
          before require notify subscribe
        )
      end

      id = /[a-z]\w*/
      cap_id = /[A-Z]\w*/
      qualname = /(::)?(#{id}::)*\w+/

      state :whitespace do
        rule %r/\s+/m, Text
        rule %r/#.*?\n/, Comment
      end

      state :root do
        mixin :whitespace

        rule %r/[$]#{qualname}/, Name::Variable
        rule %r/(#{id})(?=\s*[=+]>)/m do |m|
          if self.class.metaparameters.include? m[0]
            token Keyword::Pseudo
          else
            token Name::Property
          end
        end

        rule %r/(#{qualname})(?=\s*[(])/m, Name::Function
        rule cap_id, Name::Class

        rule %r/[+=|~-]>|<[|~-]/, Punctuation
        rule %r/[|:}();\[\]]/, Punctuation

        # HACK for case statements and selectors
        rule %r/{/, Punctuation, :regex_allowed
        rule %r/,/, Punctuation, :regex_allowed

        rule %r/(in|and|or)\b/, Operator::Word
        rule %r/[=!<>]=/, Operator
        rule %r/[=!]~/, Operator, :regex_allowed
        rule %r([.=<>!+*/-]), Operator

        rule %r/(class|include)(\s*)(#{qualname})/ do
          groups Keyword, Text, Name::Class
        end

        rule %r/node\b/, Keyword, :regex_allowed

        rule %r/'(\\[\\']|[^'])*'/m, Str::Single
        rule %r/"/, Str::Double, :dquotes

        rule %r/\d+([.]\d+)?(e[+-]\d+)?/, Num

        # a valid regex.  TODO: regexes are only allowed
        # in certain places in puppet.
        rule qualname do |m|
          if self.class.keywords.include? m[0]
            token Keyword
          elsif self.class.constants.include? m[0]
            token Keyword::Constant
          else
            token Name
          end
        end
      end

      state :regex_allowed do
        mixin :whitespace
        rule %r(/), Str::Regex, :regex

        rule(//) { pop! }
      end

      state :regex do
        rule %r(/), Str::Regex, :pop!
        rule %r/\\./, Str::Escape
        rule %r/[(){}]/, Str::Interpol
        rule %r/\[/, Str::Interpol, :regex_class
        rule %r/./, Str::Regex
      end

      state :regex_class do
        rule %r/\]/, Str::Interpol, :pop!
        rule %r/(?<!\[)-(?=\])/, Str::Regex
        rule %r/-/, Str::Interpol
        rule %r/\\./, Str::Escape
        rule %r/[^\\\]-]+/, Str::Regex
      end

      state :dquotes do
        rule %r/"/, Str::Double, :pop!
        rule %r/[^$\\"]+/m, Str::Double
        rule %r/\\./m, Str::Escape
        rule %r/[$]#{qualname}/, Name::Variable
        rule %r/[$][{]#{qualname}[}]/, Name::Variable
      end
    end
  end
end