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

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



258
259
260
261
262
263
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
 
# File 'lib/linguist/language.rb', line 258

def initialize(attributes = {})
  # @name is required
  @name = attributes[:name] || raise(ArgumentError, "missing name")

  @fs_name = attributes[:fs_name]

  # Set type
  @type = attributes[:type] ? attributes[:type].to_sym : nil
  if @type && !get_types.include?(@type)
    raise ArgumentError, "invalid type: #{@type}"
  end

  @color = attributes[:color]

  # Set aliases
  @aliases = [default_alias] + (attributes[:aliases] || [])

  @tm_scope = attributes[:tm_scope] || 'none'
  @ace_mode = attributes[:ace_mode]
  @codemirror_mode = attributes[:codemirror_mode]
  @codemirror_mime_type = attributes[:codemirror_mime_type]
  @wrap = attributes[:wrap] || false

  # Set the language_id
  @language_id = attributes[:language_id]

  # Set extensions or default to [].
  @extensions   = attributes[:extensions]   || []
  @interpreters = attributes[:interpreters] || []
  @filenames    = attributes[:filenames]    || []

  # Set popular flag
  @popular    = attributes.key?(:popular)    ? attributes[:popular]    : false

  # If group name is set, save the name so we can lazy load it later
  if attributes[:group_name]
    @group_name = attributes[:group_name]

  # Otherwise we can set it to self now
  else
    @group_name = self.name
  end
end

Instance Attribute Details

#ace_mode ⇒ Object (readonly)

Public: Get Ace mode

Examples

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

Returns a String name or nil



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



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

def aliases
  @aliases
end

#codemirror_mime_type ⇒ Object (readonly)

Public: Get CodeMirror MIME type mode

Examples

# => "nil"
# => "text/x-javascript"
# => "text/x-csrc"

Returns a String name or nil



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

def codemirror_mime_type
  @codemirror_mime_type
end

#codemirror_mode ⇒ Object (readonly)

Public: Get CodeMirror mode

Maps to a directory in the ‘mode/` source code.

https://github.com/codemirror/CodeMirror/tree/master/mode

Examples

# => "nil"
# => "javascript"
# => "clike"

Returns a String name or nil



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

def codemirror_mode
  @codemirror_mode
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#fs_name ⇒ Object (readonly)

Public:



320
321
322
 
# File 'lib/linguist/language.rb', line 320

def fs_name
  @fs_name
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#language_id ⇒ Object (readonly)

Public: Get language_id (used in GitHub search)

Examples

# => "1"
# => "2"
# => "3"

Returns the integer language_id



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

def language_id
  @language_id
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



316
317
318
 
# File 'lib/linguist/language.rb', line 316

def name
  @name
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



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

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



325
326
327
 
# File 'lib/linguist/language.rb', line 325

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

def wrap
  @wrap
end

Class Method Details

.[](name) ⇒ Object

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.



215
216
217
218
219
220
221
222
 
# File 'lib/linguist/language.rb', line 215

def self.[](name)
  return nil if !name.is_a?(String) || name.to_s.empty?

  lang = @index[name.downcase]
  return lang if lang

  @index[name.split(',', 2).first.downcase]
end

.all ⇒ Object

Public: Get all Languages

Returns an Array of Languages



96
97
98
 
# File 'lib/linguist/language.rb', line 96

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



41
42
43
 
# File 'lib/linguist/language.rb', line 41

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.



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

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



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

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_id_index[language.language_id] = language

  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 Language or nil if none was found.



125
126
127
128
 
# File 'lib/linguist/language.rb', line 125

def self.find_by_alias(name)
  return nil if !name.is_a?(String) || name.to_s.empty?
  name && (@alias_index[name.downcase] || @alias_index[name.split(',', 2).first.downcase])
end

.find_by_extension(filename) ⇒ Object

Public: Look up Languages by file extension.

The behaviour of this method recently changed. See the second example below.

filename - The path String.

Examples

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

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



165
166
167
168
169
170
171
172
 
# File 'lib/linguist/language.rb', line 165

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

  @extension_index[extname]
end

.find_by_filename(filename) ⇒ Object

Public: Look up Languages by filename.

The behaviour of this method recently changed. See the second example below.

filename - The path String.

Examples

Language.find_by_filename('Cakefile')
# => [#<Language name="CoffeeScript">]
Language.find_by_filename('foo.rb')
# => []

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



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

def self.find_by_filename(filename)
  basename = File.basename(filename)
  @filename_index[basename]
end

.find_by_id(language_id) ⇒ Object

Public: Look up Languages by its language_id.

language_id - Integer of language_id

Examples

Language.find_by_id(100)
# => [#<Language name="Elixir">]

Returns the matching Language



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

def self.find_by_id(language_id)
  @language_id_index[language_id.to_i]
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



184
185
186
 
# File 'lib/linguist/language.rb', line 184

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.



110
111
112
113
 
# File 'lib/linguist/language.rb', line 110

def self.find_by_name(name)
  return nil if !name.is_a?(String) || name.to_s.empty?
  name && (@name_index[name.downcase] || @name_index[name.split(',', 2).first.downcase])
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 Languages.



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

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



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

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

Instance Method Details

#==(other) ⇒ Object 



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

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

#default_alias ⇒ Object Also known as: default_alias_name

Public: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



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

def escaped_name
  CGI.escape(name).gsub('+', '%20')
end

#get_types ⇒ Object 



302
303
304
305
 
# File 'lib/linguist/language.rb', line 302

def get_types
  # Valid Languages types
  @types = [:data, :markup, :programming, :prose]
end

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



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

def hash
  name.hash
end

#inspect ⇒ Object 



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

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

def popular?
  @popular
end

#to_s ⇒ Object

Public: Return name as String representation



469
470
471
 
# File 'lib/linguist/language.rb', line 469

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


464
465
466
 
# File 'lib/linguist/language.rb', line 464

def unpopular?
  !popular?
end