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.
-
#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.
-
.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.
-
.find_by_alias(name) ⇒ Object
Public: Look up Language by one of its aliases.
-
.find_by_extension(filename) ⇒ 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.
-
.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 ⇒ Object
(also: #default_alias_name)
Public: 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?.
-
#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
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 311 312 313 314 |
# File 'lib/linguist/language.rb', line 262 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] + (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 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
372 373 374 |
# File 'lib/linguist/language.rb', line 372 def ace_mode @ace_mode end |
#aliases ⇒ Object (readonly)
345 346 347 |
# File 'lib/linguist/language.rb', line 345 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
397 398 399 |
# File 'lib/linguist/language.rb', line 397 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
386 387 388 |
# File 'lib/linguist/language.rb', line 386 def codemirror_mode @codemirror_mode end |
#color ⇒ Object (readonly)
Public: Get color.
Returns a hex color String.
335 336 337 |
# File 'lib/linguist/language.rb', line 335 def color @color end |
#extensions ⇒ Object (readonly)
Public: Get extensions
Examples
# => ['.rb', '.rake', ...]
Returns the extensions Array
411 412 413 |
# File 'lib/linguist/language.rb', line 411 def extensions @extensions end |
#filenames ⇒ Object (readonly)
Public: Get filenames
Examples
# => ['Rakefile', ...]
Returns the extensions Array
429 430 431 |
# File 'lib/linguist/language.rb', line 429 def filenames @filenames end |
#interpreters ⇒ Object (readonly)
Public: Get interpreters
Examples
# => ['awk', 'gawk', 'mawk' ...]
Returns the interpreters Array
420 421 422 |
# File 'lib/linguist/language.rb', line 420 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
356 357 358 |
# File 'lib/linguist/language.rb', line 356 def language_id @language_id end |
#name ⇒ Object (readonly)
Public: Get proper name
Examples
# => "Ruby"
# => "Python"
# => "Perl"
Returns the name String
325 326 327 |
# File 'lib/linguist/language.rb', line 325 def name @name end |
#tm_scope ⇒ Object (readonly)
Public: Get the name of a TextMate-compatible scope
Returns the scope
361 362 363 |
# File 'lib/linguist/language.rb', line 361 def tm_scope @tm_scope end |
#type ⇒ Object (readonly)
Public: Get type.
Returns a type Symbol or nil.
330 331 332 |
# File 'lib/linguist/language.rb', line 330 def type @type end |
#wrap ⇒ Object (readonly)
Public: Should language lines be wrapped
Returns true or false
402 403 404 |
# File 'lib/linguist/language.rb', line 402 def wrap @wrap end |
Class Method Details
.[](name) ⇒ Object
216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/linguist/language.rb', line 216 def self.[](name) return nil if name.to_s.empty? lang = @index[name.downcase] return lang if lang name = name.split(',').first return nil if name.to_s.empty? @index[name.downcase] end |
.all ⇒ Object
Public: Get all Languages
Returns an Array of Languages
97 98 99 |
# File 'lib/linguist/language.rb', line 97 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
42 43 44 |
# File 'lib/linguist/language.rb', line 42 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.
255 256 257 |
# File 'lib/linguist/language.rb', line 255 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
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 |
# File 'lib/linguist/language.rb', line 51 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 |
.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.
126 127 128 129 |
# File 'lib/linguist/language.rb', line 126 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(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.
166 167 168 169 170 171 172 173 |
# File 'lib/linguist/language.rb', line 166 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.
146 147 148 149 |
# File 'lib/linguist/language.rb', line 146 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
199 200 201 |
# File 'lib/linguist/language.rb', line 199 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
185 186 187 |
# File 'lib/linguist/language.rb', line 185 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.
111 112 113 114 |
# File 'lib/linguist/language.rb', line 111 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 |
.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.
236 237 238 |
# File 'lib/linguist/language.rb', line 236 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.
248 249 250 |
# File 'lib/linguist/language.rb', line 248 def self.unpopular @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase } end |
Instance Method Details
#==(other) ⇒ Object
488 489 490 |
# File 'lib/linguist/language.rb', line 488 def ==(other) eql?(other) end |
#default_alias ⇒ Object Also known as: default_alias_name
Public: Get default alias name
Returns the alias name String
447 448 449 |
# File 'lib/linguist/language.rb', line 447 def default_alias name.downcase.gsub(/\s/, '-') end |
#eql?(other) ⇒ Boolean
492 493 494 |
# File 'lib/linguist/language.rb', line 492 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.
440 441 442 |
# File 'lib/linguist/language.rb', line 440 def escaped_name EscapeUtils.escape_url(name).gsub('+', '%20') end |
#group ⇒ Object
Public: Get Language group
Returns a Language
455 456 457 |
# File 'lib/linguist/language.rb', line 455 def group @group ||= Language.find_by_name(@group_name) end |
#hash ⇒ Object
496 497 498 |
# File 'lib/linguist/language.rb', line 496 def hash name.hash end |
#inspect ⇒ Object
500 501 502 |
# File 'lib/linguist/language.rb', line 500 def inspect "#<#{self.class} name=#{name}>" end |
#popular? ⇒ Boolean
Public: Is it popular?
Returns true or false
462 463 464 |
# File 'lib/linguist/language.rb', line 462 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
479 480 481 |
# File 'lib/linguist/language.rb', line 479 def searchable? @searchable end |
#to_s ⇒ Object
Public: Return name as String representation
484 485 486 |
# File 'lib/linguist/language.rb', line 484 def to_s name end |
#unpopular? ⇒ Boolean
Public: Is it not popular?
Returns true or false
469 470 471 |
# File 'lib/linguist/language.rb', line 469 def unpopular? !popular? end |