class Linguist::Language

Language names that are recognizable by GitHub. Defined languages can be highlighted, searched and listed under the Top Languages page.

Languages are defined in ‘lib/linguist/languages.yml`.

Constants

TYPES

Valid Languages types

Attributes

ace_mode[R]

Public: Get Ace mode

Examples

# => "text"
# => "javascript"
# => "c_cpp"

Returns a String name or nil

aliases[R]

Public: Get aliases

Examples

Language['C++'].aliases
# => ["cpp"]

Returns an Array of String names

color[R]

Public: Get color.

Returns a hex color String.

extensions[R]

Public: Get extensions

Examples

# => ['.rb', '.rake', ...]

Returns the extensions Array

filenames[R]

Public: Get filenames

Examples

# => ['Rakefile', ...]

Returns the extensions Array

lexer[R]

Public: Get Lexer

Returns the Lexer

name[R]

Public: Get proper name

Examples

# => "Ruby"
# => "Python"
# => "Perl"

Returns the name String

primary_extension[R]

Deprecated: Get primary extension

Defaults to the first extension but can be overridden in the languages.yml.

The primary extension can not be nil. Tests should verify this.

This attribute is only used by app/helpers/gists_helper.rb for creating the language dropdown. It really should be using ‘name` instead. Would like to drop primary extension.

Returns the extension String.

search_term[R]

Deprecated: Get code search term

Examples

# => "ruby"
# => "python"
# => "perl"

Returns the name String

type[R]

Public: Get type.

Returns a type Symbol or nil.

wrap[R]

Public: Should language lines be wrapped

Returns true or false

Public Class Methods

[](name) click to toggle source

Public: Look up Language by its name or lexer.

name - The String name of the Language

Examples

Language['Ruby']
# => #<Language name="Ruby">

Language['ruby']
# => #<Language name="Ruby">

Returns the Language or nil if none was found.

# File lib/linguist/language.rb, line 177
def self.[](name)
  @index[name]
end
ace_modes() click to toggle source

Public: A List of languages compatible with Ace.

Returns an Array of Languages.

# File lib/linguist/language.rb, line 215
def self.ace_modes
  @ace_modes ||= all.select(&:ace_mode).sort_by { |lang| lang.name.downcase }
end
all() click to toggle source

Public: Get all Languages

Returns an Array of Languages

# File lib/linguist/language.rb, line 114
def self.all
  @languages
end
colors() click to toggle source

Public: A List of languages with assigned colors.

Returns an Array of Languages.

# File lib/linguist/language.rb, line 208
def self.colors
  @colors ||= all.select(&:color).sort_by { |lang| lang.name.downcase }
end
create(attributes = {}) click to toggle source

Internal: Create a new Language object

attributes - A hash of attributes

Returns a Language object

# File lib/linguist/language.rb, line 37
def self.create(attributes = {})
  language = new(attributes)

  @languages << language

  # All Language names should be unique. Raise if there is a duplicate.
  if @name_index.key?(language.name)
    raise ArgumentError, "Duplicate language name: #{language.name}"
  end

  # Language name index
  @index[language.name] = @name_index[language.name] = language

  language.aliases.each do |name|
    # All Language aliases should be unique. Raise if there is a duplicate.
    if @alias_index.key?(name)
      raise ArgumentError, "Duplicate alias: #{name}"
    end

    @index[name] = @alias_index[name] = language
  end

  language.extensions.each do |extension|
    if extension !~ /^\./
      raise ArgumentError, "Extension is missing a '.': #{extension.inspect}"
    end

    @extension_index[extension] << language
  end

  if @primary_extension_index.key?(language.primary_extension)
    raise ArgumentError, "Duplicate primary extension: #{language.primary_extension}"
  end

  @primary_extension_index[language.primary_extension] = language

  language.filenames.each do |filename|
    @filename_index[filename] << language
  end

  language
end
detect(name, data, mode = nil) click to toggle source

Public: Detects the Language of the blob.

name - String filename data - String blob data. A block also maybe passed in for lazy

loading. This behavior is deprecated and you should always
pass in a String.

mode - Optional String mode (defaults to nil)

Returns Language or nil.

# File lib/linguist/language.rb, line 89
def self.detect(name, data, mode = nil)
  # A bit of an elegant hack. If the file is executable but extensionless,
  # append a "magic" extension so it can be classified with other
  # languages that have shebang scripts.
  if File.extname(name).empty? && mode && (mode.to_i(8) & 05) == 05
    name += ".script!"
  end

  possible_languages = find_by_filename(name)

  if possible_languages.length > 1
    data = data.call() if data.respond_to?(:call)
    if data.nil? || data == ""
      nil
    elsif result = Classifier.classify(Samples::DATA, data, possible_languages.map(&:name)).first
      Language[result[0]]
    end
  else
    possible_languages.first
  end
end
detectable_markup() click to toggle source

Names of non-programming languages that we will still detect

Returns an array

# File lib/linguist/language.rb, line 28
def self.detectable_markup
  ["AsciiDoc", "CSS", "Creole", "Less", "Markdown", "MediaWiki", "Org", "RDoc", "Sass", "Textile", "reStructuredText"]
end
find_by_alias(name) click to toggle source

Public: Look up Language by one of its aliases.

name - A String alias of the Language

Examples

Language.find_by_alias('cpp')
# => #<Language name="C++">

Returns the Lexer or nil if none was found.

# File lib/linguist/language.rb, line 142
def self.find_by_alias(name)
  @alias_index[name]
end
find_by_filename(filename) click to toggle source

Public: Look up Languages by filename.

filename - The path String.

Examples

Language.find_by_filename('foo.rb')
# => [#<Language name="Ruby">]

Returns all matching Languages or [] if none were found.

# File lib/linguist/language.rb, line 156
def self.find_by_filename(filename)
  basename, extname = File.basename(filename), File.extname(filename)
  langs = [@primary_extension_index[extname]] +
          @filename_index[basename] +
          @extension_index[extname]
  langs.compact.uniq
end
find_by_name(name) click to toggle source

Public: Look up Language by its proper name.

name - The String name of the Language

Examples

Language.find_by_name('Ruby')
# => #<Language name="Ruby">

Returns the Language or nil if none was found.

# File lib/linguist/language.rb, line 128
def self.find_by_name(name)
  @name_index[name]
end
new(attributes = {}) click to toggle source

Internal: Initialize a new Language

attributes - A hash of attributes

# File lib/linguist/language.rb, line 222
def initialize(attributes = {})
  # @name is required
  @name = attributes[:name] || raise(ArgumentError, "missing name")

  # Set type
  @type = attributes[:type] ? attributes[:type].to_sym : nil
  if @type && !TYPES.include?(@type)
    raise ArgumentError, "invalid type: #{@type}"
  end

  @color = attributes[:color]

  # Set aliases
  @aliases = [default_alias_name] + (attributes[:aliases] || [])

  @ace_mode = attributes[:ace_mode]
  @wrap = attributes[:wrap] || false

  # Set legacy search term
  @search_term = attributes[:search_term] || default_alias_name

  # Set extensions or default to [].
  @extensions = attributes[:extensions] || []
  @filenames  = attributes[:filenames]  || []

  unless @primary_extension = attributes[:primary_extension]
    raise ArgumentError, "#{@name} is missing primary extension"
  end

  # Prepend primary extension unless its already included
  if primary_extension && !extensions.include?(primary_extension)
    @extensions = [primary_extension] + extensions
  end

  # Set popular, and searchable flags
  @popular    = attributes.key?(:popular)    ? attributes[:popular]    : false
  @searchable = attributes.key?(:searchable) ? attributes[:searchable] : true

  # If group name is set, save the name so we can lazy load it later
  if attributes[:group_name]
    @group = nil
    @group_name = attributes[:group_name]

  # Otherwise we can set it to self now
  else
    @group = self
  end
end
unpopular() click to toggle source

Public: A List of non-popular languages

Unpopular languages appear below popular ones in language chooser dropdowns.

This list is created from all the languages not listed in “popular.yml”.

Returns an Array of Lexers.

# File lib/linguist/language.rb, line 201
def self.unpopular
  @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase }
end

Public Instance Methods

==(other) click to toggle source
# File lib/linguist/language.rb, line 432
def ==(other)
  eql?(other)
end
colorize(text, options = {}) click to toggle source

Public: Highlight syntax of text

text - String of code to be highlighted options - A Hash of options (defaults to {})

Returns html String

# File lib/linguist/language.rb, line 423
def colorize(text, options = {})
  text
end
default_alias_name() click to toggle source

Internal: Get default alias name

Returns the alias name String

# File lib/linguist/language.rb, line 382
def default_alias_name
  name.downcase.gsub(/\s/, '-')
end
eql?(other) click to toggle source
# File lib/linguist/language.rb, line 436
def eql?(other)
  equal?(other)
end
escaped_name() click to toggle source

Public: Get URL escaped name.

Examples

"C%23"
"C%2B%2B"
"Common%20Lisp"

Returns the escaped String.

# File lib/linguist/language.rb, line 375
def escaped_name
  EscapeUtils.escape_url(name).gsub('+', '%20')
end
group() click to toggle source

Public: Get Language group

Returns a Language

# File lib/linguist/language.rb, line 389
def group
  @group ||= Language.find_by_name(@group_name)
end
hash() click to toggle source
# File lib/linguist/language.rb, line 440
def hash
  name.hash
end
inspect() click to toggle source
# File lib/linguist/language.rb, line 444
def inspect
  "#<#{self.class} name=#{name}>"
end
searchable?() click to toggle source

Public: Is it searchable?

Unsearchable languages won’t by indexed by solr and won’t show up in the code search dropdown.

Returns true or false

# File lib/linguist/language.rb, line 413
def searchable?
  @searchable
end
to_s() click to toggle source

Public: Return name as String representation

# File lib/linguist/language.rb, line 428
def to_s
  name
end
unpopular?() click to toggle source

Public: Is it not popular?

Returns true or false

# File lib/linguist/language.rb, line 403
def unpopular?
  !popular?
end