Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an explicit method to retrieve supported languages. #210

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions lib/coderay.rb
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,20 @@ def get_scanner_options options
options.fetch :scanner_options, {}
end

# Provide a list of supported code languages.
#
# Returns a hash of symbols.
def supported_languages(include_aliases=true, include_internals=false)
languages = CodeRay::Scanners.list
if include_aliases == true
languages += CodeRay::Scanners.plugin_hash.keys.map(&:to_sym)
end
if include_internals == false
languages -= %w(debug default raydebug scanner).map(&:to_sym)
end
return languages
end

end

end
34 changes: 34 additions & 0 deletions test/functional/basic.rb
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,40 @@ def test_list_of_scanners
assert CodeRay::Scanners.list.include?(:text)
end

def test_supported_languages_should_return_array_of_symbols
assert_kind_of(Array, CodeRay.supported_languages)
assert_kind_of(Symbol, CodeRay.supported_languages.first)
end

def test_supported_languages_should_include_languages
assert CodeRay.supported_languages.include?(:ruby)
end

def test_supported_languages_without_arguments_should_include_aliases_and_exclude_internals
assert CodeRay.supported_languages.include?(:javascript)
assert !CodeRay.supported_languages.include?(:debug)
end

def test_supported_languages_with_arguments_should_include_aliases_and_exclude_internals
assert CodeRay.supported_languages(true, false).include?(:javascript)
assert !CodeRay.supported_languages(true, false).include?(:debug)
end

def test_supported_languages_with_arguments_should_exclude_aliases_and_include_internals
assert !CodeRay.supported_languages(false, true).include?(:javascript)
assert CodeRay.supported_languages(false, true).include?(:debug)
end

def test_supported_languages_with_arguments_should_include_aliases_and_internals
assert CodeRay.supported_languages(true, true).include?(:javascript)
assert CodeRay.supported_languages(true, true).include?(:debug)
end

def test_supported_languages_with_arguments_should_exclude_aliases_and_internals
assert !CodeRay.supported_languages(false, false).include?(:javascript)
assert !CodeRay.supported_languages(false, false).include?(:debug)
end

def test_token_kinds
assert_kind_of Hash, CodeRay::TokenKinds
for kind, css_class in CodeRay::TokenKinds
Expand Down