Skip to content

Allow additional ignored classes when inferring tags in DebugTree #362

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.

Sign up for GitHub

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

Open
drewhamilton wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Allow additional ignored classes when inferring tags in DebugTree #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c61a7b6
Add and test `DebugTree#ignoreForTagging`
drewhamilton Mar 19, 2019
a3decdc
Convert custom ignore list to constructor parameter
drewhamilton Jul 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions timber/src/main/java/timber/log/Timber.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,13 +193,13 @@ class Timber private constructor() {
}

/** A [Tree] for debug builds. Automatically infers the tag from the calling class. */
open class DebugTree : Tree() {
private val fqcnIgnore = listOf(
open class DebugTree(vararg ignoredClasses: Class<*>) : Tree() {
private val fqcnIgnore = setOf(
Timber::class.java.name,
Timber.Forest::class.java.name,
Tree::class.java.name,
DebugTree::class.java.name
)
).plus(ignoredClasses.map { it.name })

override val tag: String?
get() = super.tag ?: Throwable().stackTrace
Expand Down
11 changes: 11 additions & 0 deletions timber/src/test/java/timber/log/TimberTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,17 @@ class TimberTest {
.hasNoMoreMessages()
}

@Test fun debugTreeDoesNotUseIgnoredClassForTag() {
val tree = Timber.DebugTree(ThisIsAReallyLongClassName::class.java)
Timber.plant(tree)

ThisIsAReallyLongClassName().run()

assertLog()
.hasDebugMessage("TimberTest", "Hello, world!")
.hasNoMoreMessages()
}

@Test fun debugTreeCustomTag() {
Timber.plant(Timber.DebugTree())
Timber.tag("Custom").d("Hello, world!")
Expand Down