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



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
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/linguist/language.rb', line 259

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] + (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]
  @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, 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



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



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

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



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

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



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

def codemirror_mode
  @codemirror_mode
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

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



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

def language_id
  @language_id
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



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

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

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.



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

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



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

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



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

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.



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

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



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

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.



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

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.



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

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.



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

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



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

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



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

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.



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

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.



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

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.



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

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

Instance Method Details

#==(other) ⇒ Object 



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

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

#default_alias ⇒ Object Also known as: default_alias_name

Public: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



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

def hash
  name.hash
end

#inspect ⇒ Object 



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

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

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) 


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

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



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

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


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

def unpopular?
  !popular?
end