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



264
265
266
267
268
269
270
271
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
 
# File 'lib/linguist/language.rb', line 264

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

  # 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



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



338
339
340
 
# File 'lib/linguist/language.rb', line 338

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



328
329
330
 
# File 'lib/linguist/language.rb', line 328

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



379
380
381
 
# File 'lib/linguist/language.rb', line 379

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#lexer ⇒ Object (readonly)

Public: Get Lexer

Returns the Lexer



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

def lexer
  @lexer
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



318
319
320
 
# File 'lib/linguist/language.rb', line 318

def name
  @name
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



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

def search_term
  @search_term
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

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.



219
220
221
 
# File 'lib/linguist/language.rb', line 219

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

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

Returns an Array of Languages.



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

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



143
144
145
 
# File 'lib/linguist/language.rb', line 143

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



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

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.



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

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



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
90
91
 
# File 'lib/linguist/language.rb', line 52

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

  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.



102
103
104
105
106
107
108
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
 
# File 'lib/linguist/language.rb', line 102

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



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

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.



171
172
173
 
# File 'lib/linguist/language.rb', line 171

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.



185
186
187
188
189
190
 
# File 'lib/linguist/language.rb', line 185

def self.find_by_filename(filename)
  basename, extname = File.basename(filename), File.extname(filename)
  langs = @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.



157
158
159
 
# File 'lib/linguist/language.rb', line 157

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



202
203
204
 
# File 'lib/linguist/language.rb', line 202

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.



231
232
233
 
# File 'lib/linguist/language.rb', line 231

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.



243
244
245
 
# File 'lib/linguist/language.rb', line 243

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

Instance Method Details

#==(other) ⇒ Object 



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

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

#all_extensions ⇒ Object

Public: Return all possible extensions for language



400
401
402
 
# File 'lib/linguist/language.rb', line 400

def all_extensions
  (extensions + [primary_extension]).uniq
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



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

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean 



490
491
492
 
# File 'lib/linguist/language.rb', line 490

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



443
444
445
 
# File 'lib/linguist/language.rb', line 443

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

#hash ⇒ Object 



494
495
496
 
# File 'lib/linguist/language.rb', line 494

def hash
  name.hash
end

#inspect ⇒ Object 



498
499
500
 
# File 'lib/linguist/language.rb', line 498

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false



450
451
452
 
# File 'lib/linguist/language.rb', line 450

def popular?
  @popular
end

#primary_extension ⇒ Object

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.



416
417
418
 
# File 'lib/linguist/language.rb', line 416

def primary_extension
  extensions.first
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



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

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



482
483
484
 
# File 'lib/linguist/language.rb', line 482

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false



457
458
459
 
# File 'lib/linguist/language.rb', line 457

def unpopular?
  !popular?
end