# File lib/linguist/language.rb, line 444 def primary_extension extensions.first end
class Linguist::Language
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`.
Constants
- TYPES
Valid Languages types
Attributes
Public: Get Ace mode
Examples
# => "text" # => "javascript" # => "c_cpp"
Returns a String name or nil
Public: Get aliases
Examples
Language['C++'].aliases # => ["cpp"]
Returns an Array of String names
Public: Get color.
Returns a hex color String.
Public: Get extensions
Examples
# => ['.rb', '.rake', ...]
Returns the extensions Array
Public: Get filenames
Examples
# => ['Rakefile', ...]
Returns the extensions Array
Public: Get interpreters
Examples
# => ['awk', 'gawk', 'mawk' ...]
Returns the interpreters Array
Public: Get #language_id (used in GitHub search)
Examples
# => "1" # => "2" # => "3"
Returns the integer #language_id
Public: Get proper name
Examples
# => "Ruby" # => "Python" # => "Perl"
Returns the name String
Deprecated: Get code search term
Examples
# => "ruby" # => "python" # => "perl"
Returns the name String
Public: Get the name of a TextMate-compatible scope
Returns the scope
Public: Get type.
Returns a type Symbol or nil.
Public: Should language lines be wrapped
Returns true or false
Public Class Methods
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.
# 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
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.
# 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." @ace_modes ||= all.select(&:ace_mode).sort_by { |lang| lang.name.downcase } end
Public: Get all Languages
Returns an Array of Languages
# File lib/linguist/language.rb, line 107 def self.all @languages end
Detect languages by a specific type
type - A symbol that exists within TYPES
Returns an array
# File lib/linguist/language.rb, line 41 def self.by_type(type) all.select { |h| h.type == type } end
Public: A List of languages with assigned colors.
Returns an Array of Languages.
# File lib/linguist/language.rb, line 258 def self.colors @colors ||= all.select(&:color).sort_by { |lang| lang.name.downcase } end
Internal: Create a new Language object
attributes - A hash of attributes
Returns a Language object
# 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
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.
# 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
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.
# 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
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.
# File lib/linguist/language.rb, line 175 def self.find_by_extension(extname) extname = ".#{extname}" unless extname.start_with?(".") @extension_index[extname.downcase] end
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.
# 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
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
# File lib/linguist/language.rb, line 209 def self.find_by_id(language_id) @language_id_index[language_id.to_i] end
Public: Look up Languages by interpreter.
interpreter - String of interpreter name
Examples
Language.find_by_interpreter("bash") # => [#<Language name="Bash">]
Returns the matching Language
# File lib/linguist/language.rb, line 195 def self.find_by_interpreter(interpreter) @interpreter_index[interpreter] end
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.
# 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
DEPRECATED
# File lib/linguist/language.rb, line 181 def self.find_by_shebang(data) @interpreter_index[Shebang.interpreter(data)] end
Internal: Initialize a new Language
attributes - A hash of attributes
# File lib/linguist/language.rb, line 276 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 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
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.
# File lib/linguist/language.rb, line 239 def self.popular @popular ||= all.select(&:popular?).sort_by { |lang| lang.name.downcase } end
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.
# File lib/linguist/language.rb, line 251 def self.unpopular @unpopular ||= all.select(&:unpopular?).sort_by { |lang| lang.name.downcase } end
Public Instance Methods
# File lib/linguist/language.rb, line 504 def ==(other) eql?(other) end
Internal: Get default alias name
Returns the alias name String
# File lib/linguist/language.rb, line 464 def default_alias_name name.downcase.gsub(/\s/, '-') end
# File lib/linguist/language.rb, line 508 def eql?(other) equal?(other) end
Public: Get URL escaped name.
Examples
"C%23" "C%2B%2B" "Common%20Lisp"
Returns the escaped String.
# File lib/linguist/language.rb, line 457 def escaped_name EscapeUtils.escape_url(name).gsub('+', '%20') end
# File lib/linguist/language.rb, line 512 def hash name.hash end
# File lib/linguist/language.rb, line 516 def inspect "#<#{self.class} name=#{name}>" end
Public: Is it popular?
Returns true or false
# File lib/linguist/language.rb, line 478 def popular? @popular end
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.
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
# File lib/linguist/language.rb, line 495 def searchable? @searchable end
Public: Return name as String representation
# File lib/linguist/language.rb, line 500 def to_s name end
Public: Is it not popular?
Returns true or false
# File lib/linguist/language.rb, line 485 def unpopular? !popular? end