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, :prose]

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/linguist/language.rb', line 272

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

  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



382
383
384
 
# File 'lib/linguist/language.rb', line 382

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



355
356
357
 
# File 'lib/linguist/language.rb', line 355

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



396
397
398
 
# File 'lib/linguist/language.rb', line 396

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#lexer ⇒ Object (readonly)

Public: Get Lexer

Returns the Lexer



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

def lexer
  @lexer
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



335
336
337
 
# File 'lib/linguist/language.rb', line 335

def name
  @name
end

#primary_extension ⇒ Object (readonly)

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.



410
411
412
 
# File 'lib/linguist/language.rb', line 410

def primary_extension
  @primary_extension
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



366
367
368
 
# File 'lib/linguist/language.rb', line 366

def search_term
  @search_term
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



340
341
342
 
# File 'lib/linguist/language.rb', line 340

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



387
388
389
 
# File 'lib/linguist/language.rb', line 387

def wrap
  @wrap
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.



227
228
229
 
# File 'lib/linguist/language.rb', line 227

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

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

Returns an Array of Languages.



265
266
267
 
# File 'lib/linguist/language.rb', line 265

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



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

def self.all
  @languages
end

.by_type(type) ⇒ Object

Detect languages by a specific type

type - A symbol that exists within TYPES

Returns an array



44
45
46
 
# File 'lib/linguist/language.rb', line 44

def self.by_type(type)
  all.select { |h| h.type == type }
end

.colors ⇒ Object

Public: A List of languages with assigned colors.

Returns an Array of Languages.



258
259
260
 
# File 'lib/linguist/language.rb', line 258

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



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
90
91
92
93
94
95
96
97
98
 
# File 'lib/linguist/language.rb', line 53

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.interpreters.each do |interpreter|
    @interpreter_index[interpreter] << language
  end

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

  language
end

.detect(name, data, mode = nil) ⇒ Object

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.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/linguist/language.rb', line 109

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

  # First try to find languages that match based on filename.
  possible_languages = find_by_filename(name)

  # If there is more than one possible language with that extension (or no
  # extension at all, in the case of extensionless scripts), we need to continue
  # our detection work
  if possible_languages.length > 1
    data = data.call() if data.respond_to?(:call)
    possible_language_names = possible_languages.map(&:name)

    # Don't bother with emptiness
    if data.nil? || data == ""
      nil
    # Check if there's a shebang line and use that as authoritative
    elsif (result = find_by_shebang(data)) && !result.empty?
      result.first
    # No shebang. Still more work to do. Try to find it with our heuristics.
    elsif (determined = Heuristics.find_by_heuristics(data, possible_language_names)) && !determined.empty?
      determined.first
    # Lastly, fall back to the probablistic classifier.
    elsif classified = Classifier.classify(Samples::DATA, data, possible_language_names ).first
      # Return the actual Language object based of the string language name (i.e., first element of `#classify`)
      Language[classified[0]]
    end
  else
    # Simplest and most common case, we can just return the one match based on extension
    possible_languages.first
  end
end

.detectable_markup ⇒ Object

Names of non-programming languages that we will still detect

Returns an array



35
36
37
 
# File 'lib/linguist/language.rb', line 35

def self.detectable_markup
  ["CSS", "Less", "Sass", "SCSS", "Stylus", "TeX"]
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.



178
179
180
 
# File 'lib/linguist/language.rb', line 178

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

.find_by_filename(filename) ⇒ Object

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.



192
193
194
195
196
197
198
 
# File 'lib/linguist/language.rb', line 192

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) ⇒ 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.



164
165
166
 
# File 'lib/linguist/language.rb', line 164

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

.find_by_shebang(data) ⇒ Object

Public: Look up Languages by shebang line.

data - Array of tokens or String data to analyze.

Examples

Language.find_by_shebang("#!/bin/bash\ndate;")
# => [#<Language name="Bash">]

Returns the matching Language



210
211
212
 
# File 'lib/linguist/language.rb', line 210

def self.find_by_shebang(data)
  @interpreter_index[Linguist.interpreter_from_shebang(data)]
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.



239
240
241
 
# File 'lib/linguist/language.rb', line 239

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.



251
252
253
 
# File 'lib/linguist/language.rb', line 251

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

Instance Method Details

#==(other) ⇒ Object 



496
497
498
 
# File 'lib/linguist/language.rb', line 496

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



487
488
489
 
# File 'lib/linguist/language.rb', line 487

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



446
447
448
 
# File 'lib/linguist/language.rb', line 446

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


500
501
502
 
# File 'lib/linguist/language.rb', line 500

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



453
454
455
 
# File 'lib/linguist/language.rb', line 453

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

#hash ⇒ Object 



504
505
506
 
# File 'lib/linguist/language.rb', line 504

def hash
  name.hash
end

#inspect ⇒ Object 



508
509
510
 
# File 'lib/linguist/language.rb', line 508

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


460
461
462
 
# File 'lib/linguist/language.rb', line 460

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) 


477
478
479
 
# File 'lib/linguist/language.rb', line 477

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



492
493
494
 
# File 'lib/linguist/language.rb', line 492

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


467
468
469
 
# File 'lib/linguist/language.rb', line 467

def unpopular?
  !popular?
end