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

interpreters[R]

Public: Get interpreters

Examples

# => ['awk', 'gawk', 'mawk' ...]

Returns the interpreters Array

name[R]

Public: Get proper name

Examples

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

Returns the name String

search_term[R]

Deprecated: Get code search term

Examples

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

Returns the name String

tm_scope[R]

Public: Get the name of a TextMate-compatible scope

Returns the scope

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.

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 210
def self.[](name)
  return nil if name.to_s.empty?
  name && (@index[name.downcase] || @index[name.split(',').first.downcase])
end
ace_modes() click to toggle source

Public: A List of languages compatible with Ace.

TODO: Remove this method in a 5.x release. Every language now needs an #ace_mode key, so this function isn't doing anything unique anymore.

Returns an Array of Languages.

# File lib/linguist/language.rb, line 252
def self.ace_modes
  warn "This method will be deprecated in a future 5.x release. Every language now has an `ace_mode` set."
  @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 104
def self.all
  @languages
end
by_type(type) click to toggle source

Detect languages by a specific type

type - A symbol that exists within TYPES

Returns an array

# File lib/linguist/language.rb, line 40
def self.by_type(type)
  all.select { |h| h.type == type }
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 242
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 49
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.downcase] = @name_index[language.name.downcase] = 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.downcase] = @alias_index[name.downcase] = language
  end

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

    @extension_index[extension.downcase] << language
  end

  language.interpreters.each do |interpreter|
    @interpreter_index[interpreter] << language
  end

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

  language
end
detect(blob) click to toggle source

Public: Detects the Language of the blob.

blob - an object that includes the Linguist `BlobHelper` interface;

see Linguist::LazyBlob and Linguist::FileBlob for examples

Returns Language or nil.

# File lib/linguist/language.rb, line 96
def self.detect(blob)
  warn "[DEPRECATED] `Linguist::Language.detect` is deprecated. Use `Linguist.detect`. #{caller[0]}"
  Linguist.detect(blob)
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 Language or nil if none was found.

# File lib/linguist/language.rb, line 133
def self.find_by_alias(name)
  return nil if name.to_s.empty?
  name && (@alias_index[name.downcase] || @alias_index[name.split(',').first.downcase])
end
find_by_extension(extname) click to toggle source

Public: Look up Languages by file extension.

extname - The extension String.

Examples

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

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

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

# File lib/linguist/language.rb, line 172
def self.find_by_extension(extname)
  extname = ".#{extname}" unless extname.start_with?(".")
  @extension_index[extname.downcase]
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 148
def self.find_by_filename(filename)
  basename = File.basename(filename)

  # find the first extension with language definitions
  extname = FileBlob.new(filename).extensions.detect do |e|
    !@extension_index[e].empty?
  end

  (@filename_index[basename] + @extension_index[extname]).compact.uniq
end
find_by_interpreter(interpreter) click to toggle source

Public: Look up Languages by interpreter.

interpreter - String of interpreter name

Examples

Language.find_by_interpreter("bash")
# => [#<Language name="Bash">]

Returns the matching Language

# File lib/linguist/language.rb, line 192
def self.find_by_interpreter(interpreter)
  @interpreter_index[interpreter]
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 118
def self.find_by_name(name)
  return nil if name.to_s.empty?
  name && (@name_index[name.downcase] || @name_index[name.split(',').first.downcase])
end
find_by_shebang(data) click to toggle source

DEPRECATED

# File lib/linguist/language.rb, line 178
def self.find_by_shebang(data)
  @interpreter_index[Shebang.interpreter(data)]
end
new(attributes = {}) click to toggle source

Internal: Initialize a new Language

attributes - A hash of attributes

# File lib/linguist/language.rb, line 260
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] || [])

  # Load the TextMate scope name or try to guess one
  @tm_scope = attributes[:tm_scope] || begin
    context = case @type
              when :data, :markup, :prose
                'text'
              when :programming, nil
                'source'
              end
    "#{context}.#{@name.downcase}"
  end

  @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] || []
  @interpreters = attributes[:interpreters]   || []
  @filenames  = attributes[:filenames]  || []

  # 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 Languages.

# File lib/linguist/language.rb, line 235
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 474
def ==(other)
  eql?(other)
end
default_alias_name() click to toggle source

Internal: Get default alias name

Returns the alias name String

# File lib/linguist/language.rb, line 434
def default_alias_name
  name.downcase.gsub(/\s/, '-')
end
eql?(other) click to toggle source
# File lib/linguist/language.rb, line 478
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 427
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 441
def group
  @group ||= Language.find_by_name(@group_name)
end
hash() click to toggle source
# File lib/linguist/language.rb, line 482
def hash
  name.hash
end
inspect() click to toggle source
# File lib/linguist/language.rb, line 486
def inspect
  "#<#{self.class} name=#{name}>"
end
primary_extension() click to toggle source

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 method 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.

# File lib/linguist/language.rb, line 414
def primary_extension
  extensions.first
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 465
def searchable?
  @searchable
end
to_s() click to toggle source

Public: Return name as String representation

# File lib/linguist/language.rb, line 470
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 455
def unpopular?
  !popular?
end