Class: Languages::Language

Inherits:
Object
  • Object
show all
Defined in:
lib/languages.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/languages.yml`.

Constant Summary collapse

TYPES =

Valid Languages types

[:data, :markup, :programming, :prose]

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/languages.rb', line 159

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



267
268
269
 
# File 'lib/languages.rb', line 267

def ace_mode
  @ace_mode
end

#aliases ⇒ Object (readonly)

Public: Get aliases

Examples

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

Returns an Array of String names



240
241
242
 
# File 'lib/languages.rb', line 240

def aliases
  @aliases
end

#color ⇒ Object (readonly)

Public: Get color.

Returns a hex color String.



230
231
232
 
# File 'lib/languages.rb', line 230

def color
  @color
end

#extensions ⇒ Object (readonly)

Public: Get extensions

Examples

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

Returns the extensions Array



281
282
283
 
# File 'lib/languages.rb', line 281

def extensions
  @extensions
end

#filenames ⇒ Object (readonly)

Public: Get filenames

Examples

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

Returns the extensions Array



299
300
301
 
# File 'lib/languages.rb', line 299

def filenames
  @filenames
end

#interpreters ⇒ Object (readonly)

Public: Get interpreters

Examples

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

Returns the interpreters Array



290
291
292
 
# File 'lib/languages.rb', line 290

def interpreters
  @interpreters
end

#name ⇒ Object (readonly)

Public: Get proper name

Examples

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

Returns the name String



220
221
222
 
# File 'lib/languages.rb', line 220

def name
  @name
end

#search_term ⇒ Object (readonly)

Deprecated: Get code search term

Examples

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

Returns the name String



251
252
253
 
# File 'lib/languages.rb', line 251

def search_term
  @search_term
end

#tm_scope ⇒ Object (readonly)

Public: Get the name of a TextMate-compatible scope

Returns the scope



256
257
258
 
# File 'lib/languages.rb', line 256

def tm_scope
  @tm_scope
end

#type ⇒ Object (readonly)

Public: Get type.

Returns a type Symbol or nil.



225
226
227
 
# File 'lib/languages.rb', line 225

def type
  @type
end

#wrap ⇒ Object (readonly)

Public: Should language lines be wrapped

Returns true or false



272
273
274
 
# File 'lib/languages.rb', line 272

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.



121
122
123
 
# File 'lib/languages.rb', line 121

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

.all ⇒ Object

Public: Get all Languages

Returns an Array of Languages



76
77
78
 
# File 'lib/languages.rb', line 76

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



23
24
25
 
# File 'lib/languages.rb', line 23

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.



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

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



32
33
34
35
36
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
 
# File 'lib/languages.rb', line 32

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] << language
  end

  language.interpreters.each do |interpreter|
    @interpreter_index[interpreter] << language
  end

  language.filenames.each do |filename|
    @filename_index[filename] << language
  end

  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.



104
105
106
 
# File 'lib/languages.rb', line 104

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



90
91
92
 
# File 'lib/languages.rb', line 90

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



133
134
135
 
# File 'lib/languages.rb', line 133

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.



145
146
147
 
# File 'lib/languages.rb', line 145

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

Instance Method Details

#==(other) ⇒ Object 



373
374
375
 
# File 'lib/languages.rb', line 373

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

#default_alias_name ⇒ Object

Internal: Get default alias name

Returns the alias name String



333
334
335
 
# File 'lib/languages.rb', line 333

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
 
# File 'lib/languages.rb', line 377

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.



326
327
328
 
# File 'lib/languages.rb', line 326

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

#group ⇒ Object

Public: Get Language group

Returns a Language



340
341
342
 
# File 'lib/languages.rb', line 340

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

#hash ⇒ Object 



381
382
383
 
# File 'lib/languages.rb', line 381

def hash
  name.hash
end

#inspect ⇒ Object 



385
386
387
 
# File 'lib/languages.rb', line 385

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

#popular? ⇒ Boolean

Public: Is it popular?

Returns true or false

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/languages.rb', line 347

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.



313
314
315
 
# File 'lib/languages.rb', line 313

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) 


364
365
366
 
# File 'lib/languages.rb', line 364

def searchable?
  @searchable
end

#to_s ⇒ Object

Public: Return name as String representation



369
370
371
 
# File 'lib/languages.rb', line 369

def to_s
  name
end

#unpopular? ⇒ Boolean

Public: Is it not popular?

Returns true or false

Returns:

  • (Boolean) 


354
355
356
 
# File 'lib/languages.rb', line 354

def unpopular?
  !popular?
end