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



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

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



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



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

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



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

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



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

def codemirror_mode
  @codemirror_mode
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#fs_name ⇒ Object (readonly)

Public:



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

def fs_name
  @fs_name
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

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



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

def language_id
  @language_id
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



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

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

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.



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

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



99
100
101
 
# File 'lib/linguist/language.rb', line 99

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



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

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.



254
255
256
 
# File 'lib/linguist/language.rb', line 254

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



45
46
47
48
49
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
92
93
94
 
# File 'lib/linguist/language.rb', line 45

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

  # Index filesystem name if defined
  if language.fs_name
    if @name_index.key?(language.fs_name)
      raise ArgumentError "Duplicate language name: #{language.fs_name}"
    end
    @index[language.fs_name.downcase] = @name_index[language.fs_name.downcase] = language
  end

  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.



128
129
130
131
 
# File 'lib/linguist/language.rb', line 128

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.



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

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.



148
149
150
151
 
# File 'lib/linguist/language.rb', line 148

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



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

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



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

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.



113
114
115
116
 
# File 'lib/linguist/language.rb', line 113

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.



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

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.



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

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

Instance Method Details

#==(other) ⇒ Object 



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

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

#default_alias ⇒ Object Also known as: default_alias_name

Public: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



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

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

#get_types ⇒ Object 



305
306
307
308
 
# File 'lib/linguist/language.rb', line 305

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



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

def hash
  name.hash
end

#inspect ⇒ Object 



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

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

def popular?
  @popular
end

#to_s ⇒ Object

Public: Return name as String representation



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

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


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

def unpopular?
  !popular?
end