Class: Linguist::Language

Inherits:
Object
  • Object
show all
Defined in:
lib/linguist/language.rb

Overview

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

Constant Summary collapse

TYPES =

Valid Languages types

[:data, :markup, :programming]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Language

Internal: Initialize a new Language

attributes - A hash of attributes



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/linguist/language.rb', line 213

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] || [])

  # Lookup Lexer object
  @lexer = Pygments::Lexer.find_by_name(attributes[:lexer] || name) ||
    raise(ArgumentError, "#{@name} is missing lexer")

  @ace_mode = attributes[:ace_mode]

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

  # Set extensions or default to [].
  @extensions = attributes[:extensions] || []
  @overrides  = attributes[:overrides]  || []
  @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

Instance Attribute Details

#ace_mode ⇒ Object (readonly)

Public: Get Ace mode

Examples

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

Returns a String name or nil



322
323
324
 
# File 'lib/linguist/language.rb', line 322

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



295
296
297
 
# File 'lib/linguist/language.rb', line 295

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



285
286
287
 
# File 'lib/linguist/language.rb', line 285

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



331
332
333
 
# File 'lib/linguist/language.rb', line 331

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



359
360
361
 
# File 'lib/linguist/language.rb', line 359

def filenames
  @filenames
end

#lexer ⇒ Object (readonly)

Public: Get Lexer

Returns the Lexer



311
312
313
 
# File 'lib/linguist/language.rb', line 311

def lexer
  @lexer
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



275
276
277
 
# File 'lib/linguist/language.rb', line 275

def name
  @name
end

#overrides ⇒ Object (readonly)

Internal: Get overridden extensions.

Returns the extensions Array.



350
351
352
 
# File 'lib/linguist/language.rb', line 350

def overrides
  @overrides
end

#primary_extension ⇒ Object (readonly)

Deprecated: Get primary extension

Defaults to the first extension but can be overriden 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.



345
346
347
 
# File 'lib/linguist/language.rb', line 345

def primary_extension
  @primary_extension
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



306
307
308
 
# File 'lib/linguist/language.rb', line 306

def search_term
  @search_term
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



280
281
282
 
# File 'lib/linguist/language.rb', line 280

def type
  @type
end

Class Method Details

.[](name) ⇒ Object

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.



168
169
170
 
# File 'lib/linguist/language.rb', line 168

def self.[](name)
  @index[name]
end

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

Returns an Array of Languages.



206
207
208
 
# File 'lib/linguist/language.rb', line 206

def self.ace_modes
  @ace_modes ||= all.select(&:ace_mode).sort_by { |lang| lang.name.downcase }
end

.all ⇒ Object

Public: Get all Languages

Returns an Array of Languages



94
95
96
 
# File 'lib/linguist/language.rb', line 94

def self.all
  @languages
end

.ambiguous?(extension) ⇒ Boolean

Internal: Test if extension maps to multiple Languages.

Returns true or false.

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/linguist/language.rb', line 27

def self.ambiguous?(extension)
  @overrides.include?(extension)
end

.colors ⇒ Object

Public: A List of languages with assigned colors.

Returns an Array of Languages.



199
200
201
 
# File 'lib/linguist/language.rb', line 199

def self.colors
  @colors ||= all.select(&:color).sort_by { |lang| lang.name.downcase }
end

.create(attributes = {}) ⇒ Object

Internal: Create a new Language object

attributes - A hash of attributes

Returns a Language object



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/linguist/language.rb', line 36

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

    unless ambiguous?(extension)
      # Index the extension with a leading ".": ".rb"
      @extension_index[extension] = language

      # Index the extension without a leading ".": "rb"
      @extension_index[extension.sub(/^\./, '')] = language
    end
  end

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

    if l = @overrides[extension]
      raise ArgumentError, "#{extension} is already overridden by #{l.name}"
    end

    @overrides[extension] = language
  end

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

  language
end

.find_by_alias(name) ⇒ Object

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.



122
123
124
 
# File 'lib/linguist/language.rb', line 122

def self.find_by_alias(name)
  @alias_index[name]
end

.find_by_extension(extension) ⇒ Object

Public: Look up Language by extension.

extension - The extension String. May include leading “.”

Examples

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

Returns the Language or nil if none was found.



136
137
138
 
# File 'lib/linguist/language.rb', line 136

def self.find_by_extension(extension)
  @extension_index[extension]
end

.find_by_filename(filename) ⇒ Object

Public: Look up Language by filename.

filename - The path String.

Examples

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

Returns the Language or nil if none was found.



150
151
152
153
 
# File 'lib/linguist/language.rb', line 150

def self.find_by_filename(filename)
  basename, extname = File.basename(filename), File.extname(filename)
  @filename_index[basename] || @extension_index[extname]
end

.find_by_name(name) ⇒ Object

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.



108
109
110
 
# File 'lib/linguist/language.rb', line 108

def self.find_by_name(name)
  @name_index[name]
end

.popular ⇒ Object

Public: A List of popular languages

Popular languages are sorted to the top of language chooser dropdowns.

This list is configured in “popular.yml”.

Returns an Array of Lexers.



180
181
182
 
# File 'lib/linguist/language.rb', line 180

def self.popular
  @popular ||= all.select(&:popular?).sort_by { |lang| lang.name.downcase }
end

.unpopular ⇒ Object

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.



192
193
194
 
# File 'lib/linguist/language.rb', line 192

def self.unpopular
  @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase }
end

Instance Method Details

#==(other) ⇒ Object 



427
428
429
 
# File 'lib/linguist/language.rb', line 427

def ==(other)
  eql?(other)
end

#colorize(text, options = {}) ⇒ Object

Public: Highlight syntax of text

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

Returns html String



418
419
420
 
# File 'lib/linguist/language.rb', line 418

def colorize(text, options = {})
  lexer.highlight(text, options = {})
end

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



377
378
379
 
# File 'lib/linguist/language.rb', line 377

def default_alias_name
  name.downcase.gsub(/\s/, '-')
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


431
432
433
 
# File 'lib/linguist/language.rb', line 431

def eql?(other)
  equal?(other)
end

#escaped_name ⇒ Object

Public: Get URL escaped name.

Examples

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

Returns the escaped String.



370
371
372
 
# File 'lib/linguist/language.rb', line 370

def escaped_name
  EscapeUtils.escape_url(name).gsub('+', '%20')
end

#group ⇒ Object

Public: Get Language group

Returns a Language



384
385
386
 
# File 'lib/linguist/language.rb', line 384

def group
  @group ||= Language.find_by_name(@group_name)
end

#hash ⇒ Object 



435
436
437
 
# File 'lib/linguist/language.rb', line 435

def hash
  name.hash
end

#inspect ⇒ Object 



439
440
441
 
# File 'lib/linguist/language.rb', line 439

def inspect
  "#<#{self.class} name=#{name}>"
end

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/linguist/language.rb', line 391

def popular?
  @popular
end

#searchable? ⇒ Boolean

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

Returns:

  • (Boolean) 


408
409
410
 
# File 'lib/linguist/language.rb', line 408

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



423
424
425
 
# File 'lib/linguist/language.rb', line 423

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/linguist/language.rb', line 398

def unpopular?
  !popular?
end