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]
STRATEGIES = 
[
  Linguist::Strategy::Filename,
  Linguist::Shebang,
  Linguist::Heuristics,
  Linguist::Classifier
]

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



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
325
326
327
328
329
330
 
# File 'lib/linguist/language.rb', line 280

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

Instance Attribute Details

#ace_mode ⇒ Object (readonly)

Public: Get Ace mode

Examples

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

Returns a String name or nil



393
394
395
 
# File 'lib/linguist/language.rb', line 393

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



361
362
363
 
# File 'lib/linguist/language.rb', line 361

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



425
426
427
 
# File 'lib/linguist/language.rb', line 425

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#lexer ⇒ Object (readonly)

Public: Get Lexer

Returns the Lexer



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

def lexer
  @lexer
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



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

def search_term
  @search_term
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



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

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

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.



235
236
237
 
# File 'lib/linguist/language.rb', line 235

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

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

Returns an Array of Languages.



273
274
275
 
# File 'lib/linguist/language.rb', line 273

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



131
132
133
 
# File 'lib/linguist/language.rb', line 131

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



46
47
48
 
# File 'lib/linguist/language.rb', line 46

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.



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

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



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

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] << 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) ⇒ Object

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.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/linguist/language.rb', line 109

def self.detect(blob)
  # Bail early if the blob is binary or empty.
  return nil if blob.likely_binary? || blob.binary? || blob.empty?

  # Call each strategy until one candidate is returned.
  STRATEGIES.reduce([]) do |languages, strategy|
    candidates = strategy.call(blob, languages)
    if candidates.size == 1
      return candidates.first
    elsif candidates.size > 1
      # More than one candidate was found, pass them to the next strategy.
      candidates
    else
      # No candiates were found, pass on languages from the previous strategy.
      languages
    end
  end.first
end

.detectable_markup ⇒ Object

Names of non-programming languages that we will still detect

Returns an array



37
38
39
 
# File 'lib/linguist/language.rb', line 37

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.



159
160
161
 
# File 'lib/linguist/language.rb', line 159

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

.find_by_extension(extname) ⇒ Object

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.



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

def self.find_by_extension(extname)
  extname = ".#{extname}" unless extname.start_with?(".")
  @extension_index[extname]
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.



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/linguist/language.rb', line 173

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

Public: Look up Languages by interpreter.

interpreter - String of interpreter name

Examples

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

Returns the matching Language



217
218
219
 
# File 'lib/linguist/language.rb', line 217

def self.find_by_interpreter(interpreter)
  @interpreter_index[interpreter]
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.



145
146
147
 
# File 'lib/linguist/language.rb', line 145

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

.find_by_shebang(data) ⇒ Object

DEPRECATED



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

def self.find_by_shebang(data)
  @interpreter_index[Shebang.interpreter(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.



247
248
249
 
# File 'lib/linguist/language.rb', line 247

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.



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

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

Instance Method Details

#==(other) ⇒ Object 



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

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



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

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean 



513
514
515
 
# File 'lib/linguist/language.rb', line 513

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



517
518
519
 
# File 'lib/linguist/language.rb', line 517

def hash
  name.hash
end

#inspect ⇒ Object 



521
522
523
 
# File 'lib/linguist/language.rb', line 521

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false



473
474
475
 
# File 'lib/linguist/language.rb', line 473

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.



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

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



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

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



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

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false



480
481
482
 
# File 'lib/linguist/language.rb', line 480

def unpopular?
  !popular?
end