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]
Instance Attribute Summary collapse
-
#ace_mode ⇒ Object
readonly
Public: Get Ace mode.
-
#aliases ⇒ Object
readonly
Public: Get aliases.
-
#color ⇒ Object
readonly
Public: Get color.
-
#extensions ⇒ Object
readonly
Public: Get extensions.
-
#filenames ⇒ Object
readonly
Public: Get filenames.
-
#lexer ⇒ Object
readonly
Public: Get Lexer.
-
#name ⇒ Object
readonly
Public: Get proper name.
-
#primary_extension ⇒ Object
readonly
Deprecated: Get primary extension.
-
#search_term ⇒ Object
readonly
Deprecated: Get code search term.
-
#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 or lexer.
-
.ace_modes ⇒ Object
Public: A List of languages compatible with Ace.
-
.all ⇒ Object
Public: Get all Languages.
-
.colors ⇒ Object
Public: A List of languages with assigned colors.
-
.create(attributes = {}) ⇒ Object
Internal: Create a new Language object.
-
.detect(name, data, mode = nil) ⇒ Object
Public: Detects the Language of the blob.
-
.detectable_markup ⇒ Object
Names of non-programming languages that we will still detect.
-
.find_by_alias(name) ⇒ Object
Public: Look up Language by one of its aliases.
-
.find_by_filename(filename) ⇒ Object
Public: Look up Languages by filename.
-
.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
-
#colorize(text, options = {}) ⇒ Object
Public: Highlight syntax of text.
-
#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?.
-
#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
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 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/linguist/language.rb', line 222 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] || []) @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
327 328 329 |
# File 'lib/linguist/language.rb', line 327 def ace_mode @ace_mode end |
#aliases ⇒ Object (readonly)
300 301 302 |
# File 'lib/linguist/language.rb', line 300 def aliases @aliases end |
#color ⇒ Object (readonly)
Public: Get color.
Returns a hex color String.
290 291 292 |
# File 'lib/linguist/language.rb', line 290 def color @color end |
#extensions ⇒ Object (readonly)
Public: Get extensions
Examples
# => ['.rb', '.rake', ...]
Returns the extensions Array
341 342 343 |
# File 'lib/linguist/language.rb', line 341 def extensions @extensions end |
#filenames ⇒ Object (readonly)
Public: Get filenames
Examples
# => ['Rakefile', ...]
Returns the extensions Array
364 365 366 |
# File 'lib/linguist/language.rb', line 364 def filenames @filenames end |
#lexer ⇒ Object (readonly)
Public: Get Lexer
Returns the Lexer
316 317 318 |
# File 'lib/linguist/language.rb', line 316 def lexer @lexer end |
#name ⇒ Object (readonly)
Public: Get proper name
Examples
# => "Ruby"
# => "Python"
# => "Perl"
Returns the name String
280 281 282 |
# File 'lib/linguist/language.rb', line 280 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.
355 356 357 |
# File 'lib/linguist/language.rb', line 355 def primary_extension @primary_extension end |
#search_term ⇒ Object (readonly)
Deprecated: Get code search term
Examples
# => "ruby"
# => "python"
# => "perl"
Returns the name String
311 312 313 |
# File 'lib/linguist/language.rb', line 311 def search_term @search_term end |
#type ⇒ Object (readonly)
Public: Get type.
Returns a type Symbol or nil.
285 286 287 |
# File 'lib/linguist/language.rb', line 285 def type @type end |
#wrap ⇒ Object (readonly)
Public: Should language lines be wrapped
Returns true or false
332 333 334 |
# File 'lib/linguist/language.rb', line 332 def wrap @wrap end |
Class Method Details
.[](name) ⇒ Object
177 178 179 |
# File 'lib/linguist/language.rb', line 177 def self.[](name) @index[name] end |
.ace_modes ⇒ Object
Public: A List of languages compatible with Ace.
Returns an Array of Languages.
215 216 217 |
# File 'lib/linguist/language.rb', line 215 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
114 115 116 |
# File 'lib/linguist/language.rb', line 114 def self.all @languages end |
.colors ⇒ Object
Public: A List of languages with assigned colors.
Returns an Array of Languages.
208 209 210 |
# File 'lib/linguist/language.rb', line 208 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
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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/linguist/language.rb', line 37 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 if @primary_extension_index.key?(language.primary_extension) raise ArgumentError, "Duplicate primary extension: #{language.primary_extension}" end @primary_extension_index[language.primary_extension] = language 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.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/linguist/language.rb', line 89 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 |
.detectable_markup ⇒ Object
Names of non-programming languages that we will still detect
Returns an array
28 29 30 |
# File 'lib/linguist/language.rb', line 28 def self.detectable_markup ["AsciiDoc", "CSS", "Creole", "Less", "Markdown", "MediaWiki", "Org", "RDoc", "Sass", "Textile", "reStructuredText"] 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.
142 143 144 |
# File 'lib/linguist/language.rb', line 142 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.
156 157 158 159 160 161 162 |
# File 'lib/linguist/language.rb', line 156 def self.find_by_filename(filename) basename, extname = File.basename(filename), File.extname(filename) langs = [@primary_extension_index[extname]] + @filename_index[basename] + @extension_index[extname] langs.compact.uniq 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.
128 129 130 |
# File 'lib/linguist/language.rb', line 128 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.
189 190 191 |
# File 'lib/linguist/language.rb', line 189 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.
201 202 203 |
# File 'lib/linguist/language.rb', line 201 def self.unpopular @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase } end |
Instance Method Details
#==(other) ⇒ Object
432 433 434 |
# File 'lib/linguist/language.rb', line 432 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
423 424 425 |
# File 'lib/linguist/language.rb', line 423 def colorize(text, = {}) text end |
#default_alias_name ⇒ Object
Internal: Get default alias name
Returns the alias name String
382 383 384 |
# File 'lib/linguist/language.rb', line 382 def default_alias_name name.downcase.gsub(/\s/, '-') end |
#eql?(other) ⇒ Boolean
436 437 438 |
# File 'lib/linguist/language.rb', line 436 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.
375 376 377 |
# File 'lib/linguist/language.rb', line 375 def escaped_name EscapeUtils.escape_url(name).gsub('+', '%20') end |
#group ⇒ Object
Public: Get Language group
Returns a Language
389 390 391 |
# File 'lib/linguist/language.rb', line 389 def group @group ||= Language.find_by_name(@group_name) end |
#hash ⇒ Object
440 441 442 |
# File 'lib/linguist/language.rb', line 440 def hash name.hash end |
#inspect ⇒ Object
444 445 446 |
# File 'lib/linguist/language.rb', line 444 def inspect "#<#{self.class} name=#{name}>" end |
#popular? ⇒ Boolean
Public: Is it popular?
Returns true or false
396 397 398 |
# File 'lib/linguist/language.rb', line 396 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
413 414 415 |
# File 'lib/linguist/language.rb', line 413 def searchable? @searchable end |
#to_s ⇒ Object
Public: Return name as String representation
428 429 430 |
# File 'lib/linguist/language.rb', line 428 def to_s name end |
#unpopular? ⇒ Boolean
Public: Is it not popular?
Returns true or false
403 404 405 |
# File 'lib/linguist/language.rb', line 403 def unpopular? !popular? end |