Class: Linguist::Strategy::XML

Inherits:

Object

• Object
• Linguist::Strategy::XML

Defined in:

lib/linguist/strategy/xml.rb

Overview

Detects XML files based on root tag.

Constant Summary

SEARCH_SCOPE =

Scope of the search for the root tag Number of lines to check at the beginning of the file

2

Class Method Summary

• .call(blob, candidates = []) ⇒ Object

  Public: Use the root tag to detect the XML blobs, only if no other candidates were previously identified.

Class Method Details

.call(blob, candidates = []) ⇒ Object

Public: Use the root tag to detect the XML blobs, only if no other candidates were previously identified.

blob - An object that quacks like a blob. candidates - A list of candidate languages.

Examples

XML.call(FileBlob.new("path/to/file"))

Returns the list of candidates if it wasn’t empty, an array with the XML language as sole item if the root tag is detected, and an empty Array otherwise.

# File 'lib/linguist/strategy/xml.rb', line 22

def self.call(blob, candidates = [])
  return candidates if candidates.any?

  header = blob.first_lines(SEARCH_SCOPE).join("\n")
  /<?xml version=/.match(header) ? [Language["XML"]] : []
end