Class: Linguist::Language
- Inherits:
-
Object
- Object
- Linguist::Language
- 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
-
#ace_mode ⇒ Object
readonly
Public: Get Ace mode.
-
#aliases ⇒ Object
readonly
Public: Get aliases.
-
#codemirror_mime_type ⇒ Object
readonly
Public: Get CodeMirror MIME type mode.
-
#codemirror_mode ⇒ Object
readonly
Public: Get CodeMirror mode.
-
#color ⇒ Object
readonly
Public: Get color.
-
#extensions ⇒ Object
readonly
Public: Get extensions.
-
#filenames ⇒ Object
readonly
Public: Get filenames.
-
#interpreters ⇒ Object
readonly
Public: Get interpreters.
-
#language_id ⇒ Object
readonly
Public: Get language_id (used in GitHub search).
-
#name ⇒ Object
readonly
Public: Get proper name.
-
#search_term ⇒ Object
readonly
Deprecated: Get code search term.
-
#tm_scope ⇒ Object
readonly
Public: Get the name of a TextMate-compatible scope.
-
#type ⇒ Object
readonly
Public: Get type.
-
#wrap ⇒ Object
readonly
Public: Should language lines be wrapped.
Class Method Summary collapse
-
.[](name) ⇒ Object
Public: Look up Language by its name.
-
.ace_modes ⇒ Object
Public: A List of languages compatible with Ace.
-
.all ⇒ Object
Public: Get all Languages.
-
.by_type(type) ⇒ Object
Detect languages by a specific type.
-
.colors ⇒ Object
Public: A List of languages with assigned colors.
-
.create(attributes = {}) ⇒ Object
Internal: Create a new Language object.
-
.detect(blob) ⇒ Object
Public: Detects the Language of the blob.
-
.find_by_alias(name) ⇒ Object
Public: Look up Language by one of its aliases.
-
.find_by_extension(extname) ⇒ Object
Public: Look up Languages by file extension.
-
.find_by_filename(filename) ⇒ Object
Public: Look up Languages by filename.
-
.find_by_id(language_id) ⇒ Object
Public: Look up Languages by its language_id.
-
.find_by_interpreter(interpreter) ⇒ Object
Public: Look up Languages by interpreter.
-
.find_by_name(name) ⇒ Object
Public: Look up Language by its proper name.
-
.find_by_shebang(data) ⇒ Object
DEPRECATED.
-
.popular ⇒ Object
Public: A List of popular languages.
-
.unpopular ⇒ Object
Public: A List of non-popular languages.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#default_alias_name ⇒ Object
Internal: Get default alias name.
- #eql?(other) ⇒ Boolean
-
#escaped_name ⇒ Object
Public: Get URL escaped name.
-
#group ⇒ Object
Public: Get Language group.
- #hash ⇒ Object
-
#initialize(attributes = {}) ⇒ Language
constructor
Internal: Initialize a new Language.
- #inspect ⇒ Object
-
#popular? ⇒ Boolean
Public: Is it popular?.
-
#primary_extension ⇒ Object
Deprecated: Get primary extension.
-
#searchable? ⇒ Boolean
Public: Is it searchable?.
-
#to_s ⇒ Object
Public: Return name as String representation.
-
#unpopular? ⇒ Boolean
Public: Is it not popular?.
Constructor Details
#initialize(attributes = {}) ⇒ Language
Internal: Initialize a new Language
attributes - A hash of attributes
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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/linguist/language.rb', line 277 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] @codemirror_mode = attributes[:codemirror_mode] @codemirror_mime_type = attributes[:codemirror_mime_type] @wrap = attributes[:wrap] || false # Set legacy search term @search_term = attributes[:search_term] || default_alias_name # 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
401 402 403 |
# File 'lib/linguist/language.rb', line 401 def ace_mode @ace_mode end |
#aliases ⇒ Object (readonly)
363 364 365 |
# File 'lib/linguist/language.rb', line 363 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
426 427 428 |
# File 'lib/linguist/language.rb', line 426 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
415 416 417 |
# File 'lib/linguist/language.rb', line 415 def codemirror_mode @codemirror_mode end |
#color ⇒ Object (readonly)
Public: Get color.
Returns a hex color String.
353 354 355 |
# File 'lib/linguist/language.rb', line 353 def color @color end |
#extensions ⇒ Object (readonly)
Public: Get extensions
Examples
# => ['.rb', '.rake', ...]
Returns the extensions Array
440 441 442 |
# File 'lib/linguist/language.rb', line 440 def extensions @extensions end |
#filenames ⇒ Object (readonly)
Public: Get filenames
Examples
# => ['Rakefile', ...]
Returns the extensions Array
458 459 460 |
# File 'lib/linguist/language.rb', line 458 def filenames @filenames end |
#interpreters ⇒ Object (readonly)
Public: Get interpreters
Examples
# => ['awk', 'gawk', 'mawk' ...]
Returns the interpreters Array
449 450 451 |
# File 'lib/linguist/language.rb', line 449 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
385 386 387 |
# File 'lib/linguist/language.rb', line 385 def language_id @language_id end |
#name ⇒ Object (readonly)
Public: Get proper name
Examples
# => "Ruby"
# => "Python"
# => "Perl"
Returns the name String
343 344 345 |
# File 'lib/linguist/language.rb', line 343 def name @name end |
#search_term ⇒ Object (readonly)
Deprecated: Get code search term
Examples
# => "ruby"
# => "python"
# => "perl"
Returns the name String
374 375 376 |
# File 'lib/linguist/language.rb', line 374 def search_term @search_term end |
#tm_scope ⇒ Object (readonly)
Public: Get the name of a TextMate-compatible scope
Returns the scope
390 391 392 |
# File 'lib/linguist/language.rb', line 390 def tm_scope @tm_scope end |
#type ⇒ Object (readonly)
Public: Get type.
Returns a type Symbol or nil.
348 349 350 |
# File 'lib/linguist/language.rb', line 348 def type @type end |
#wrap ⇒ Object (readonly)
Public: Should language lines be wrapped
Returns true or false
431 432 433 |
# File 'lib/linguist/language.rb', line 431 def wrap @wrap end |
Class Method Details
.[](name) ⇒ Object
226 227 228 229 |
# File 'lib/linguist/language.rb', line 226 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.
268 269 270 271 272 |
# File 'lib/linguist/language.rb', line 268 def self.ace_modes warn "This method will be deprecated in a future 5.x release. Every language now has an `ace_mode` set." warn caller @ace_modes ||= all.select(&:ace_mode).sort_by { |lang| lang.name.downcase } end |
.all ⇒ Object
Public: Get all Languages
Returns an Array of Languages
107 108 109 |
# File 'lib/linguist/language.rb', line 107 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
41 42 43 |
# File 'lib/linguist/language.rb', line 41 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.
258 259 260 |
# File 'lib/linguist/language.rb', line 258 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
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 |
# File 'lib/linguist/language.rb', line 50 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 |
.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.
99 100 101 102 |
# File 'lib/linguist/language.rb', line 99 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.
136 137 138 139 |
# File 'lib/linguist/language.rb', line 136 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
175 176 177 178 |
# File 'lib/linguist/language.rb', line 175 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.
151 152 153 154 155 156 157 158 159 160 |
# File 'lib/linguist/language.rb', line 151 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_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
209 210 211 |
# File 'lib/linguist/language.rb', line 209 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
195 196 197 |
# File 'lib/linguist/language.rb', line 195 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.
121 122 123 124 |
# File 'lib/linguist/language.rb', line 121 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
181 182 183 |
# File 'lib/linguist/language.rb', line 181 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.
239 240 241 |
# File 'lib/linguist/language.rb', line 239 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.
251 252 253 |
# File 'lib/linguist/language.rb', line 251 def self.unpopular @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase } end |
Instance Method Details
#==(other) ⇒ Object
532 533 534 |
# File 'lib/linguist/language.rb', line 532 def ==(other) eql?(other) end |
#default_alias_name ⇒ Object
Internal: Get default alias name
Returns the alias name String
492 493 494 |
# File 'lib/linguist/language.rb', line 492 def default_alias_name name.downcase.gsub(/\s/, '-') end |
#eql?(other) ⇒ Boolean
536 537 538 |
# File 'lib/linguist/language.rb', line 536 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.
485 486 487 |
# File 'lib/linguist/language.rb', line 485 def escaped_name EscapeUtils.escape_url(name).gsub('+', '%20') end |
#group ⇒ Object
Public: Get Language group
Returns a Language
499 500 501 |
# File 'lib/linguist/language.rb', line 499 def group @group ||= Language.find_by_name(@group_name) end |
#hash ⇒ Object
540 541 542 |
# File 'lib/linguist/language.rb', line 540 def hash name.hash end |
#inspect ⇒ Object
544 545 546 |
# File 'lib/linguist/language.rb', line 544 def inspect "#<#{self.class} name=#{name}>" end |
#popular? ⇒ Boolean
Public: Is it popular?
Returns true or false
506 507 508 |
# File 'lib/linguist/language.rb', line 506 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.
472 473 474 |
# File 'lib/linguist/language.rb', line 472 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
523 524 525 |
# File 'lib/linguist/language.rb', line 523 def searchable? @searchable end |
#to_s ⇒ Object
Public: Return name as String representation
528 529 530 |
# File 'lib/linguist/language.rb', line 528 def to_s name end |
#unpopular? ⇒ Boolean
Public: Is it not popular?
Returns true or false
513 514 515 |
# File 'lib/linguist/language.rb', line 513 def unpopular? !popular? end |