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



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

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

  # 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]
  @wrap = attributes[:wrap] || false

  # Set legacy search term
  @search_term = attributes[:search_term] || default_alias_name

  # 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



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

#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



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



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

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



373
374
375
 
# File 'lib/linguist/language.rb', line 373

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.



210
211
212
213
 
# File 'lib/linguist/language.rb', line 210

def self.[](name)
  return nil if name.to_s.empty?
  name && (@index[name.downcase] || @index[name.split(',').first.downcase])
end

.ace_modes ⇒ Object

Public: A List of languages compatible with Ace.

TODO: Remove this method in a 5.x release. Every language now needs an ace_mode key, so this function isn’t doing anything unique anymore.

Returns an Array of Languages.



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

def self.ace_modes
  warn "This method will be deprecated in a future 5.x release. Every language now has an `ace_mode` set."
  @ace_modes ||= all.select(&:ace_mode).sort_by { |lang| lang.name.downcase }
end

.all ⇒ Object

Public: Get all Languages

Returns an Array of Languages



104
105
106
 
# File 'lib/linguist/language.rb', line 104

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



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

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.



242
243
244
 
# File 'lib/linguist/language.rb', line 242

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



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

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
end

.detect(blob) ⇒ Object

Public: Detects the Language of the blob.

blob - an object that includes the Linguist ‘BlobHelper` interface;

see Linguist::LazyBlob and Linguist::FileBlob for examples

Returns Language or nil.



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

def self.detect(blob)
  warn "[DEPRECATED] `Linguist::Language.detect` is deprecated. Use `Linguist.detect`. #{caller[0]}"
  Linguist.detect(blob)
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.



133
134
135
136
 
# File 'lib/linguist/language.rb', line 133

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

.find_by_extension(extname) ⇒ Object

Public: Look up Languages by file extension.

extname - The extension String.

Examples

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

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

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



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

def self.find_by_extension(extname)
  extname = ".#{extname}" unless extname.start_with?(".")
  @extension_index[extname.downcase]
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.



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/linguist/language.rb', line 148

def self.find_by_filename(filename)
  basename = File.basename(filename)

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

  (@filename_index[basename] + @extension_index[extname]).compact.uniq
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



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

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.



118
119
120
121
 
# File 'lib/linguist/language.rb', line 118

def self.find_by_name(name)
  return nil if name.to_s.empty?
  name && (@name_index[name.downcase] || @name_index[name.split(',').first.downcase])
end

.find_by_shebang(data) ⇒ Object

DEPRECATED



178
179
180
 
# File 'lib/linguist/language.rb', line 178

def self.find_by_shebang(data)
  @interpreter_index[Shebang.interpreter(data)]
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.



223
224
225
 
# File 'lib/linguist/language.rb', line 223

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.



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

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_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



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

def default_alias_name
  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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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) 


448
449
450
 
# File 'lib/linguist/language.rb', line 448

def popular?
  @popular
end

#primary_extension ⇒ Object

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



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

def primary_extension
  extensions.first
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) 


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

def searchable?
  @searchable
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) 


455
456
457
 
# File 'lib/linguist/language.rb', line 455

def unpopular?
  !popular?
end