Skip to content

Commit

Permalink
Separate filename and extension configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
josh committed Jun 7, 2011
1 parent 0c45d67 commit c773911
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 27 deletions.
2 changes: 1 addition & 1 deletion lib/linguist/blob_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ def guess_language
language

# See if there is a Language for the extension
elsif language = Language.find_by_extension(extname)
elsif language = Language.find_by_filename(pathname.to_s)
language

# Try to detect Language from shebang line
Expand Down
39 changes: 37 additions & 2 deletions lib/linguist/language.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ class Language
@name_index = {}
@alias_index = {}
@extension_index = {}
@filename_index = {}

# Internal: Create a new Language object
#
Expand Down Expand Up @@ -37,6 +38,10 @@ def self.create(attributes = {})
end

language.extensions.each do |extension|
if extension !~ /^\./
warn "Extension is missing a '.': #{extension.inspect}"
end

# All Language extensions should be unique. Warn if there is a
# duplicate.
if @extension_index.key?(extension)
Expand All @@ -47,7 +52,11 @@ def self.create(attributes = {})
@extension_index[extension] = language

# Index the extension without a leading ".": "rb"
@extension_index[extension.sub(/^./, '')] = language
@extension_index[extension.sub(/^\./, '')] = language
end

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

language
Expand Down Expand Up @@ -102,6 +111,21 @@ def self.find_by_extension(extension)
@extension_index[extension]
end

# Public: Look up Language by filename.
#
# filename - The path String.
#
# Examples
#
# Language.find_by_filename('foo.rb')
# # => #<Language name="Ruby">
#
# Returns the Language or nil if none was found.
def self.find_by_filename(filename)
basename, extname = File.basename(filename), File.extname(filename)
@filename_index[basename] || @extension_index[extname]
end

# Public: Look up Language by its name or lexer.
#
# name - The case-insensitive String name of the Language
Expand Down Expand Up @@ -163,6 +187,7 @@ def initialize(attributes = {})
# Set extensions or default to [].
# Consider using `@lexer.extensions`
@extensions = attributes[:extensions] || []
@filenames = attributes[:filenames] || []

# Set popular, common, and searchable flags
@popular = attributes.key?(:popular) ? attributes[:popular] : false
Expand Down Expand Up @@ -211,11 +236,20 @@ def initialize(attributes = {})
#
# Examples
#
# # => ['.rb', '.rake', 'Rakefile', ...]
# # => ['.rb', '.rake', ...]
#
# Returns the extensions Array
attr_reader :extensions

# Public: Get filenames
#
# Examples
#
# # => ['Rakefile', ...]
#
# Returns the extensions Array
attr_reader :filenames

# Internal: Get default alias name
#
# Returns the alias name String
Expand Down Expand Up @@ -302,6 +336,7 @@ def hash
:searchable => options.key?(:searchable) ? options[:searchable] : true,
:search_term => options[:search_term],
:extensions => options[:ext],
:filenames => options[:filenames],
:popular => popular.include?(name),
:common => common.include?(name)
)
Expand Down
21 changes: 15 additions & 6 deletions lib/linguist/languages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Clojure:
CoffeeScript:
:ext:
- .coffee
:filenames:
- Cakefile
ColdFusion:
:lexer: ColdFusion HTML
Expand Down Expand Up @@ -249,9 +250,10 @@ Haskell:
INI:
:ext:
- .cfg
- .gitconfig
- .ini
- .properties
:filenames:
- .gitconfig
IRC log:
:lexer: IRC logs
:search_term: irc
Expand All @@ -277,11 +279,12 @@ JavaScript:
:ext:
- .js
- .sjs
- Jakefile
- .jss
- .ssjs
- .jsx
- .jake
:filenames:
- Jakefile
JSON:
:lexer: javascript
:search_term: javascript
Expand All @@ -303,6 +306,7 @@ Lua:
Makefile:
:ext:
- .mak
:filenames:
- Makefile
Mako:
:ext:
Expand Down Expand Up @@ -341,6 +345,7 @@ Nu:
- nush
:ext:
- .nu
:filenames:
- Nukefile
NumPy:
:ext:
Expand Down Expand Up @@ -451,16 +456,17 @@ Ruby:
- .rb
- .ru
- .builder
- Capfile
- .rbw
- .rbx
- .god
- .rake
- .gemspec
- Rakefile
- .irbrc
- Thorfile
- .thor
:filenames:
- Capfile
- Rakefile
- Thorfile
- Gemfile
SQL:
:searchable: false
Expand Down Expand Up @@ -491,10 +497,11 @@ Shell:
- zsh
:ext:
- .bash
- .sh
:filenames:
- .bash_profile
- .bashrc
- .profile
- .sh
- .zlogin
- .zsh
- .zshrc
Expand Down Expand Up @@ -548,6 +555,7 @@ VimL:
- vim
:ext:
- .vim
:filenames:
- .vimrc
- .gvimrc
Visual Basic:
Expand Down Expand Up @@ -583,6 +591,7 @@ YAML:
:ext:
- .yml
- .yaml
:filenames:
- .gemrc
Java Server Pages:
:lexer: Java Server Page
Expand Down
15 changes: 3 additions & 12 deletions lib/linguist/pathname.rb
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,9 @@ def basename
# Pathname.new('file.rb').extname
# # => '.rb'
#
# Pathname.new('Rakefile').extname
# # => 'Rakefile'
#
# Returns a String.
def extname
if basename[0] == ?.
basename
elsif basename.include?('.')
File.extname(basename)
else
basename
end
File.extname(@path)
end

# Public: Get the language of the path
Expand All @@ -65,7 +56,7 @@ def extname
#
# Returns a Langauge.
def language
Language.find_by_extension(extname) || Language['Text']
Language.find_by_filename(@path) || Language['Text']
end

# Internal: Has a language.
Expand All @@ -74,7 +65,7 @@ def language
#
# Returns true or false.
def language?
Language.find_by_extension(extname) ? true : false
Language.find_by_filename(@path) ? true : false
end

# Deprecated: Get the lexer of the path
Expand Down
4 changes: 4 additions & 0 deletions test/test_blob.rb
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,11 @@ def test_text
assert blob("README").text?
assert blob("file.json").text?
assert blob("file.txt").text?
assert blob("md").text?
assert blob("script.sh").text?
assert blob("tender.md").text?
assert blob("txt").text?
assert blob("zip").text?
end

def test_image
Expand Down
9 changes: 9 additions & 0 deletions test/test_language.rb
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,15 @@ def test_find_all_by_extension
end
end

def test_find_by_filename
assert_equal Language['Ruby'], Language.find_by_filename('foo.rb')
assert_equal Language['Ruby'], Language.find_by_filename('foo/bar.rb')
assert_equal Language['Ruby'], Language.find_by_filename('Rakefile')
assert_nil Language.find_by_filename('rb')
assert_nil Language.find_by_filename('.rb')
assert_nil Language.find_by_filename('.kt')
end

def test_find
assert_equal "Ruby", Language['Ruby'].name
assert_equal "Ruby", Language['ruby'].name
Expand Down
10 changes: 4 additions & 6 deletions test/test_pathname.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,19 @@ def test_basename
assert_equal 'file.rb', Pathname.new("file.rb").basename
assert_equal 'file.rb', Pathname.new("./file.rb").basename
assert_equal 'file.rb', Pathname.new("sub/dir/file.rb").basename
assert_equal '.profile', Pathname.new(".profile").basename
end

def test_extname
assert_equal '.rb', Pathname.new(".rb").extname
assert_equal '.rb', Pathname.new("file.rb").extname
assert_equal '.rb', Pathname.new("./file.rb").extname
assert_equal '.rb', Pathname.new("sub/dir/file.rb").extname

assert_equal 'Rakefile', Pathname.new("Rakefile").extname
assert_equal 'Rakefile', Pathname.new("./Rakefile").extname
assert_equal 'Rakefile', Pathname.new("vendor/Rakefile").extname
assert_equal '', Pathname.new(".profile").extname
end

def test_language
assert_equal Language['Ruby'], Pathname.new(".rb").language
assert_equal Language['Text'], Pathname.new(".rb").language

assert_equal Language['Ruby'], Pathname.new("file.rb").language
assert_equal Language['Ruby'], Pathname.new("./file.rb").language
assert_equal Language['Ruby'], Pathname.new("sub/dir/file.rb").language
Expand Down

0 comments on commit c773911

Please sign in to comment.