Do not truncate source file path

[sustmi]

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT

Description

Remove truncating of source file path to only two levels. I think the only added value of truncation is that filepaths in UI are shorter. Anyway, if this is really a problem, it should be done in the UI/presentation part, not FileSource class.

[sustmi]

The problem with truncating the path is that sometimes you end-up with ambiguous truncated path.
For example both Administration/User/Xml/base.html.twig and Api/User/Xml/base.html.twig will be truncated to User/Xml/base.html.twig.

[Nyholm]

I like this, we should not truncate the sources. However, how will this look in the WebUI? I think we have to truncate the string there and make sure the full path is shown on hover. (Use HTML's title attribute)

[sustmi]

I updated the PR to truncate the path from left in UI. It uses JavaScript as it cannot be done right in CSS.

[Nyholm]

I like this change. I've sent you a PR with suggestions. At the moment the source line will render on two rows. Let me know what you think. sustmi#1

[Nyholm]

This will fix #87

[Nyholm]

Do you have any updates on this PR?

[sustmi]

Hi @Nyholm . You want the file path to be always only one line. The best solution for good UX I can think of is the left-side ellipsis (because the left side of the path is usually the same).
But left-side ellipsis cannot be done in CSS (without ugly hacks) and the JS plugin I used does not play well with Chrome.
I would rather let the file path to be over more lines than use classic ellipsis (on the right side) that is useless in my opinion (you would always see only the common part of the file path).
What do you suggest?

[sustmi]

I found a different truncating JS plugin - trunk8.js . It looks like it works in Chrome too.
Is it all-right now, @Nyholm ?

[Nyholm]

You want the file path to be always only one line.

I thought that was your idea when you truncated it.

I found a different truncating JS plugin - trunk8.js . It looks like it works in Chrome too.

Okey, cool. I'll make sure to have a look later today.

[sustmi]

I thought that was your idea when you truncated it.

No, I reacted to your comment:

However, how will this look in the WebUI? I think we have to truncate the string there and make sure the full path is shown on hover

Actually, I do not use the UI at all. I use only the parser and export parts of bundle. :)

[Nyholm]

Sorry for being back and forth with this. Im not sure what the best solution might be...

What I think is great:

• We have an absolute reference to the source file.

What we must fix:

• Make sure the WebUI not look horrible because of long source paths.

Possible solutions:

• Truncate the path in the UI
• Create a "$absolutePath" in the FileSource class and deprecate the current $path.
• Introduce/Use a twig filter that shortens the path to x chars
• Something else?

What do you think is the best and most simple solution?

---

I tested the current PR with the new truncate library in Chrome (OSX). It does not work as expected.

[sustmi]

What version of Chrome do you use and what is the resolution?

[Nyholm]

I use:

• Chrome 49.0.2623.110
• OS X 10.11.0
• 19200x1200

[sustmi]

How it comes that your table columns widths are not 20:40:40?
Here is how it looks in Chrome 48 on Mac OSX 10.8:

Do you use the branch without any changes?

[Nyholm]

I do not know. I get the same result in Safari but not Firefox. Firefox is behaving as expected...
Yes, Im using your branch with no additional changes. I do not have the same issue with master. It has noting to do with the javascript..

Im going to try to revert your changes one by one...

[Nyholm]

I do not have the same issue with master

No, sorry. That is not correct. I have the same issue with master when the content of the third column is too big.

This issue is resolved by adding some CSS. Example:

li {
    word-break: break-all;
}

After that it all looks good. Thank you!

[sustmi]

Thank you. I added the word-break CSS attribute. Is it all right now?

[Nyholm]

I think so. I've flagged this PR for a 2nd review. I like it and if any of my collaborators agrees with me they will merge it.

[gnat42]

So I'm quite confused by this PR actually. I understood what it was meant to do. But when I apply it to my project using this bundle I'm wondering why it is even needed. My translation files don't have a full path? The HTML for example looks like this for me:

The message translations are already truncated there with or without the trunk8.js.

Which leaves me to wonder why are yours not?

[Nyholm]

See the changes in FileSource.php

The purpose of this PR is to make sure that the FileSource has the full path. In master we only got the 2 directories. That is great because we should have as much info about the source as possible.

But when we have the complete path in the WebUI it looks weird. That is why @sustmi made all this extra changes in the WebUI.

After merge of this PR:

• WebUI will look the same
• FileSource will have the full path.

[gnat42]

This looks good. Thanks

[sustmi]

Thank you.