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
301
 
# 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 = 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



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



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

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



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

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



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

def codemirror_mode
  @codemirror_mode
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

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

#fs_name ⇒ Object (readonly)

Public:



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

def fs_name
  @fs_name
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

#language_id ⇒ Object (readonly)

Public: Get language_id (used in GitHub search)

Examples

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

Returns the integer language_id



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

def language_id
  @language_id
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



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

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

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.

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 



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

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

#default_alias ⇒ Object Also known as: default_alias_name

Public: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



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

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

#get_types ⇒ Object 



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



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

def hash
  name.hash
end

#inspect ⇒ Object 



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

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

def popular?
  @popular
end

#to_s ⇒ Object

Public: Return name as String representation



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

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


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

def unpopular?
  !popular?
end