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]
STRATEGIES = 
[
  Linguist::Strategy::Modeline,
  Linguist::Shebang,
  Linguist::Strategy::Filename,
  Linguist::Heuristics,
  Linguist::Classifier
]

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/linguist/language.rb', line 291

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



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

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



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

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



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

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



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

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



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

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



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

def interpreters
  @interpreters
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



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

def name
  @name
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



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

def search_term
  @search_term
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



388
389
390
 
# File 'lib/linguist/language.rb', line 388

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



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

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



404
405
406
 
# File 'lib/linguist/language.rb', line 404

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.



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

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



283
284
285
286
 
# File 'lib/linguist/language.rb', line 283

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



138
139
140
 
# File 'lib/linguist/language.rb', line 138

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.



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

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.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/linguist/language.rb', line 104

def self.detect(blob)
  # Bail early if the blob is binary or empty.
  return nil if blob.likely_binary? || blob.binary? || blob.empty?

  Linguist.instrument("linguist.detection", :blob => blob) do
    # Call each strategy until one candidate is returned.
    languages = []
    returning_strategy = nil

    STRATEGIES.each do |strategy|
      returning_strategy = strategy
      candidates = Linguist.instrument("linguist.strategy", :blob => blob, :strategy => strategy, :candidates => languages) do
        strategy.call(blob, languages)
      end
      if candidates.size == 1
        languages = candidates
        break
      elsif candidates.size > 1
        # More than one candidate was found, pass them to the next strategy.
        languages = candidates
      else
        # No candidates, try the next strategy
      end
    end

    Linguist.instrument("linguist.detected", :blob => blob, :strategy => returning_strategy, :language => languages.first)

    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 Language or nil if none was found.



166
167
168
 
# File 'lib/linguist/language.rb', line 166

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



204
205
206
207
 
# File 'lib/linguist/language.rb', line 204

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.



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/linguist/language.rb', line 180

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



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

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.



152
153
154
 
# File 'lib/linguist/language.rb', line 152

def self.find_by_name(name)
  name && @name_index[name.downcase]
end

.find_by_shebang(data) ⇒ Object

DEPRECATED



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

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.



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

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.



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

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

Instance Method Details

#==(other) ⇒ Object 



505
506
507
 
# File 'lib/linguist/language.rb', line 505

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



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

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


509
510
511
 
# File 'lib/linguist/language.rb', line 509

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.



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

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

#group ⇒ Object

Public: Get Language group

Returns a Language



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

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

#hash ⇒ Object 



513
514
515
 
# File 'lib/linguist/language.rb', line 513

def hash
  name.hash
end

#inspect ⇒ Object 



517
518
519
 
# File 'lib/linguist/language.rb', line 517

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


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

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.



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

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) 


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

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



501
502
503
 
# File 'lib/linguist/language.rb', line 501

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


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

def unpopular?
  !popular?
end