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]

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/linguist/language.rb', line 205

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] || [])

  # Lookup Lexer object
  @lexer = Pygments::Lexer.find_by_name(attributes[:lexer] || name) ||
    raise(ArgumentError, "#{@name} is missing lexer")

  @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] || []
  @filenames  = attributes[:filenames]  || []

  unless @primary_extension = attributes[:primary_extension]
    raise ArgumentError, "#{@name} is missing primary extension"
  end

  # Prepend primary extension unless its already included
  if primary_extension && !extensions.include?(primary_extension)
    @extensions = [primary_extension] + extensions
  end

  # 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



314
315
316
 
# File 'lib/linguist/language.rb', line 314

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



287
288
289
 
# File 'lib/linguist/language.rb', line 287

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



277
278
279
 
# File 'lib/linguist/language.rb', line 277

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#lexer ⇒ Object (readonly)

Public: Get Lexer

Returns the Lexer



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

def lexer
  @lexer
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#primary_extension ⇒ Object (readonly)

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



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

def primary_extension
  @primary_extension
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



298
299
300
 
# File 'lib/linguist/language.rb', line 298

def search_term
  @search_term
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



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

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.



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

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

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

Returns an Array of Languages.



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

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



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

def self.all
  @languages
end

.colors ⇒ Object

Public: A List of languages with assigned colors.

Returns an Array of Languages.



191
192
193
 
# File 'lib/linguist/language.rb', line 191

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/linguist/language.rb', line 29

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] = @name_index[language.name] = 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] = @alias_index[name] = language
  end

  language.extensions.each do |extension|
    if extension !~ /^\./
      raise ArgumentError, "Extension is missing a '.': #{extension.inspect}"
    end

    @extension_index[extension] << language
  end

  language.filenames.each do |filename|
    @filename_index[filename] << language
  end

  language
end

.detect(name, data, mode = nil) ⇒ Object

Public: Detects the Language of the blob.

name - String filename data - String blob data. A block also maybe passed in for lazy

loading. This behavior is deprecated and you should always
pass in a String.

mode - Optional String mode (defaults to nil)

Returns Language or nil.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/linguist/language.rb', line 75

def self.detect(name, data, mode = nil)
  # A bit of an elegant hack. If the file is executable but extensionless,
  # append a "magic" extension so it can be classified with other
  # languages that have shebang scripts.
  if File.extname(name).empty? && mode && (mode.to_i(8) & 05) == 05
    name += ".script!"
  end

  possible_languages = find_by_filename(name)

  if possible_languages.length > 1
    data = data.call() if data.respond_to?(:call)
    if data.nil? || data == ""
      nil
    elsif result = Classifier.classify(Samples::DATA, data, possible_languages.map(&:name)).first
      Language[result[0]]
    end
  else
    possible_languages.first
  end
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.



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

def self.find_by_alias(name)
  @alias_index[name]
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.



142
143
144
145
 
# File 'lib/linguist/language.rb', line 142

def self.find_by_filename(filename)
  basename, extname = File.basename(filename), File.extname(filename)
  @filename_index[basename] + @extension_index[extname]
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.



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

def self.find_by_name(name)
  @name_index[name]
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.



172
173
174
 
# File 'lib/linguist/language.rb', line 172

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.



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

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

Instance Method Details

#==(other) ⇒ Object 



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

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



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

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



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

def hash
  name.hash
end

#inspect ⇒ Object 



431
432
433
 
# File 'lib/linguist/language.rb', line 431

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

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) 


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

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



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

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


390
391
392
 
# File 'lib/linguist/language.rb', line 390

def unpopular?
  !popular?
end