Add truncate as a BibTex key modifier by k3KAW8Pnf7mkmdSMPHz27 · Pull Request #6427 · JabRef/jabref

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-05T20:35:08Z

Fixes #3915. Adds a truncate modifier to the available BibTex key modifiers. For "A Title" the bracketed pattern [title:truncate3] produces the result "A T".

The syntax is truncateN ([title:truncate5]) to mimic the pattern of authN etc.

Remaining

See if layered expressions are reasonable to implement, e.g., [[auth][title]:truncate10]
Update changelog
Documentation

Things I am not sure about

Should truncate be a formatter(org.jabref/logic/formatter)? Currently, formatters does not accept arguments
The interaction between BibTex key generation and truncate might lead to unexpected results as whitespaces are removed after truncation. Unless this is considered obvious, it should perhaps be mentioned in the documentation of truncate. E.g., for "A Title", [title:truncate3] will lead to the bibtexkey "AT"
Should this be included in the changelog?
There were a BracketedPatternTest in org.jabref/logic/util/. Is there a correct location for the BracketedPatternTest?

Others

Change in CHANGELOG.md described (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

This reverts commit 19fbbb3 The tests were placed in the wrong file.

…tern modifier

Siedlerchr · 2020-05-06T06:36:58Z

Changelog, yes please
Ideally it would be a formatter, maybe we need to adapt the interface to allow arguments.
Whitespace: At least it should be documented
BrackedPatternTest, yes would be nice if you could integrate your tests there, as they test with a bibtex entry and multiple formatters

Otherwise looks already good as starting point

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-07T14:50:50Z

2. Ideally it would be a formatter, maybe we need to adapt the interface to allow arguments.

I missed how RegexFormatter is implemented, I'll just mimic that and it shouldn't be a problem.

…atter.java Co-authored-by: Christoph <cschwentker@gmail.com>

…dSMPHz27/jabref into fix-for-issue-3915 � Conflicts: � src/main/java/org/jabref/logic/formatter/minifier/TruncateFormatter.java

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-08T21:17:46Z

Updates to documentation.

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-08T21:48:56Z

In a nutshell.

truncateN has been added as a Formatter.
Directory names are truncated to a length of 255 characters using a utility function for filenames.

I don't think I should change the parser, there is a large risk I will create more issues than I solve
It might be possible to shorten the code in java/org/jabref/logic/bibtexkeypattern/BracketedPattern.java quite a bit if larger parts of the code is turned into Formatters and Formatters can accept arguments (either in the constructor or in the format method, both are currently being used).

…-issue-3915

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-11T13:37:57Z

When I try to import a file from an URL using a pattern that creates a java.nio.file.FileSystemException. The directory cannot be created but the file is still downloaded. Should I try to fix that as part of this pull request as well?

If a file cannot be downloaded to the location specified by a file pattern it makes more sense (to me) that the file isn't downloaded at all.

Change to use a precompiled pattern for matching 'truncateN'

…dSMPHz27/jabref into fix-for-issue-3915

Siedlerchr · 2020-05-12T09:21:33Z

your changes look so far, is this ready then?

# Conflicts: # src/test/java/org/jabref/logic/bibtexkeypattern/BracketedPatternTest.java

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-12T13:49:35Z

Yes. The last conflicts should be resolved now.

k3KAW8Pnf7mkmdSMPHz27 · 2020-05-12T13:56:52Z

The last change (change of test names) can be removed but it seems more consistent with the guidelines?

Siedlerchr · 2020-05-12T14:05:57Z

For me it's fine. For external contributors we have the rule that at least two developers should review a PR. So when a second dev gives his okay, it's ready for merge!

tobiasdiez

The code looks good to me, so I'll merge now. Thanks for your contribution - we look forward to your next PR!

* upstream/master: (50 commits) Keep group pane size when resizing window (#6180) (#6423) Changelog: Fix missing citation for biblatex-mla Update AUTHORS Check duplicate DOI (#6333) Fix missing citation for biblatex-mla Change EasyBind dependency (#6480) Add testing of latest dev version as mandatory Squashed 'src/main/resources/csl-styles/' changes from 5dad23d..586e0b8 Fix libre office connection and other progress dialogs (#6478) Fix clear year and month field when converting to biblatex (#6434) Add truncate as a BibTex key modifier (#6427) Add new authors (not all - they need more work) Remove empty line Add simple Unit Tests for #6207 (#6240) Enforce LeftCurly rule (#6452) Implement task progress indicator (and dialog) in the toolbar (#6443) Consider empty brackets Changelog update Added a test Fixed brackets in regular expressions ...

e9fd2027de Add Medicine Publishing Styles (#6434) cae128f35f Create Bristol University Press (#6356) 74b4af3b82 Create internet-archaeology.csl (#6357) ee7ece480b Add Bio-Protocol style (#6429) 9a455efcee Create archives-of-medical-research.csl (#6415) e91aba46fc Remove some bursa-uludag styles (#6423) 03f3962657 Update offa.csl (#6428) 95dc9b9f5a Update journal-of-neolithic-archaeology.csl (#6427) a4e6c7f477 Update the-university-of-winchester-harvard.csl (#6374) c0bf10647a add manuscript formatting to ASA (#6387) 3a673a564a Update universite-de-sherbrooke-histoire.csl (#6392) 0c48c7289e Update chemistry-education-research-and-practice.csl (#6397) 51f718a7b9 Update journal-of-endodontics.csl (#6409) 51e419051f Update presses-universitaires-de-rennes.csl (#6413) git-subtree-dir: buildres/csl/csl-styles git-subtree-split: e9fd2027de4e2355f3244ac662960467e225774d

k3KAW8Pnf7mkmdSMPHz27 added 5 commits May 5, 2020 13:50

Add modifier to truncate a BibTex key

6ae850a

Add tests for the truncate BibTex key modifier

19fbbb3

Revert "Add tests for the truncate BibTex key modifier"

efb5e72

This reverts commit 19fbbb3 The tests were placed in the wrong file.

Add tests for the truncate bracketed pattern modifier

87b4bad

Remove unnecessary imports in the test for the truncate bracketed pat…

8fb49e3

…tern modifier

Siedlerchr requested changes May 6, 2020

View reviewed changes

Comment thread src/main/java/org/jabref/logic/bibtexkeypattern/BracketedPattern.java Outdated

k3KAW8Pnf7mkmdSMPHz27 added 4 commits May 6, 2020 13:27

Fix code style of local variable

b39ec98

Refactor BracketedPatternTest to maintain a parallel directory structure

572f724

Refactor test for the truncate BibTex key modifier

7e52aff

Drop unused and unnecessary imports from BracketedPatternTest.java

f23e888

k3KAW8Pnf7mkmdSMPHz27 added 2 commits May 7, 2020 15:39

Refactor truncate modifier to be compatible with Formatters

895f302

Fix type in truncate modifier test

4e54476

k3KAW8Pnf7mkmdSMPHz27 commented May 7, 2020

View reviewed changes

Comment thread src/main/java/org/jabref/logic/formatter/minifier/TruncateFormatter.java Outdated

k3KAW8Pnf7mkmdSMPHz27 commented May 7, 2020

View reviewed changes

Comment thread src/main/java/org/jabref/logic/formatter/Formatters.java Outdated

k3KAW8Pnf7mkmdSMPHz27 added 4 commits May 7, 2020 16:58

Add check for Null in format

9ace66b

Refactor tests for truncate modifier

cceb55d

Add truncation for long directory names

e35e79d

Fix name and documentation of createDirNameFromPattern

b48bc46

Siedlerchr reviewed May 8, 2020

View reviewed changes

Comment thread src/main/java/org/jabref/logic/formatter/minifier/TruncateFormatter.java Outdated

k3KAW8Pnf7mkmdSMPHz27 and others added 5 commits May 8, 2020 14:48

Update src/main/java/org/jabref/logic/formatter/minifier/TruncateForm…

d6f2bf9

…atter.java Co-authored-by: Christoph <cschwentker@gmail.com>

Fix matching the modifier String to a TruncateFormatter

2a04bf2

Fix encapsulation and naming in TruncateFormatter

5f8cc56

Fix JavaDoc in TruncateFormatter

544a05d

Merge branch 'fix-for-issue-3915' of https://github.com/k3KAW8Pnf7mkm…

30a8688

…dSMPHz27/jabref into fix-for-issue-3915 � Conflicts: � src/main/java/org/jabref/logic/formatter/minifier/TruncateFormatter.java

Add changes to CHANGELOG.md

deeaf2b

k3KAW8Pnf7mkmdSMPHz27 changed the title ~~[WIP] Add truncate as a BibTex key modifier~~ Add truncate as a BibTex key modifier May 8, 2020

k3KAW8Pnf7mkmdSMPHz27 added 5 commits May 9, 2020 17:32

Add tests for long directory names

7d1c54b

Fix truncate with negative integer

d667856

Add test with negative index

93470e2

Add test with invalid data

5d97d35

Refactor names of truncate tests

47be136

k3KAW8Pnf7mkmdSMPHz27 marked this pull request as draft May 11, 2020 13:01

k3KAW8Pnf7mkmdSMPHz27 added 3 commits May 11, 2020 09:23

Add TruncateFormatter to general Formatter tests

b1af777

Fix truncate with negative index

20487a5

Merge remote-tracking branch 'origin/fix-for-issue-3915' into fix-for…

d501d5d

…-issue-3915

k3KAW8Pnf7mkmdSMPHz27 commented May 11, 2020

View reviewed changes

Comment thread src/main/java/org/jabref/logic/util/io/FileUtil.java Outdated

k3KAW8Pnf7mkmdSMPHz27 added 4 commits May 11, 2020 10:24

Drop truncation of long directory names

1f7f2ee

Fix mating truncate in Formatters.java

59c2465

Change to use a precompiled pattern for matching 'truncateN'

Fix matching truncateN in Formatters.java

452ad96

Change to use a precompiled pattern for matching 'truncateN'

Merge branch 'fix-for-issue-3915' of https://github.com/k3KAW8Pnf7mkm…

9d9caa4

…dSMPHz27/jabref into fix-for-issue-3915

k3KAW8Pnf7mkmdSMPHz27 marked this pull request as ready for review May 12, 2020 13:25

k3KAW8Pnf7mkmdSMPHz27 changed the title ~~[WIP] Add truncate as a BibTex key modifier~~ Add truncate as a BibTex key modifier May 12, 2020

k3KAW8Pnf7mkmdSMPHz27 added 2 commits May 12, 2020 09:36

Merge branch 'master' into fix-for-issue-3915

7d96513

# Conflicts: # src/test/java/org/jabref/logic/bibtexkeypattern/BracketedPatternTest.java

Resolve conflicts

6a7a211

Siedlerchr approved these changes May 12, 2020

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label May 12, 2020

Refactor truncate tests in BracketedPatternTest

859493c

tobiasdiez approved these changes May 13, 2020

View reviewed changes

tobiasdiez merged commit 16d4938 into JabRef:master May 13, 2020

Uh oh!

Conversation

k3KAW8Pnf7mkmdSMPHz27 commented May 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Siedlerchr commented May 6, 2020

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 7, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 8, 2020

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 8, 2020

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Siedlerchr commented May 12, 2020

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 12, 2020

Uh oh!

k3KAW8Pnf7mkmdSMPHz27 commented May 12, 2020

Uh oh!

Siedlerchr commented May 12, 2020

Uh oh!

tobiasdiez left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

k3KAW8Pnf7mkmdSMPHz27 commented May 5, 2020 •

edited

Loading

k3KAW8Pnf7mkmdSMPHz27 commented May 11, 2020 •

edited

Loading