Added custom name for favorites item #601

IgorGalarraga · 2016-09-16T00:55:18Z

Refs: Assing new name and rename items in Favorites list #599
Custom name for favorites item.
Recent item name is now full path.
Very initial implementation. My first contact with Python.
TODO:
Old settings file (~/.config/git-cola/settings) compatible.
Unify 2 prompt windows when add favorite on one window.
Traductions for new strings.
Add rename line on contextual menu.
Extend renaming to recent repo list.
Pass Travis C

Recent item name is now full path.

davvid · 2016-09-17T01:01:59Z

Thanks for this first version. It looks like we're on the right track. The backwards-compatibility thing is probably essential to iron out before rolling this in. I'll see if I can lend a hand in the coming weeks.

Please run the test suite via make test. You may have noticed that the Travis CI build failed because the tests were broken by these changes, so we'll have to get that in order too.

Let me know if you have any questions. I'll do a thorough review of this first version over the weekend.

brlin-tw · 2016-09-17T01:29:28Z

I haven't tried the patch, but I wonder if it's sane to rather use the ~~<repo>/.git/name~~ <repo>/.git/description conventional(?) file for repo description instead.

what should be in the git description file? - Stack Overflow

IgorGalarraga · 2016-09-17T17:58:27Z

@Lin-Buo-Ren Is the first time that I ear about .git/description file for GitWeb application. Thanks!.
After evaluate this a bit, I think that the best way to add this file usage could be:

Mantain repo path and name on git-cola settings. Like now.
On Favorite add action, check this file: if it has a name, propouse this name. If it is default (as they are in all my repos! ;) ) propouse repo base name like now.
On settings create a new check box to select or not this file sincronization with git-cola renaming system.

IgorGalarraga · 2016-09-17T18:13:55Z

@davvid I know that the backwards-compatibility is very important, but it seem difficult for me and for now with my limited knowledge on Python, anyway, I will try to do it.
After pull-request I check Travis CI errors, I will try to pass them: some functions has changed their number of parameters.

Now automatically "import" old format favorites list saved on settings.

davvid

Getting really close. After we address these last notes this looks just about ready to go. Thanks again.

davvid · 2016-09-18T04:52:42Z

cola/settings.py

+                if not self.verify(bookmark):
+                    missing_bookmarks.append(bookmark)
+                else:
+                    update_bookmarks.append(new_bookmark)


It looks like we're dealing with the old bookmarks format in self.remove_missing() which is probably a bit too late to upgrade the data.

Instead of doing a try/except we can check if isinstance(bookmark, dict): and detect the new format, since the old format will be a string.

A better place to fix this would be to add a separate upgrade() method and call it from load() before self.remove_missing() is called. Try something like this... (if I'm understanding the new format correctly)

def upgrade(self): """Upgrade the settings format from v1 to v2""" if self.bookmarks and not isinstance(self.bookmarks[0], dict): self.bookmarks = [{'name': os.path.basename(i), 'path': i} for i in self.bookmarks]

this'll allow remove_bookmarks() to only deal with the new format.

Two bookmarks version are a list (of different components). self.remove_missing() works well on both settings file versions (on my tests), because it deals with whole unit on list not with content, after this parse, the bookmark will be updated.
Yes, try/except not is more elegant, the use of if isinstance(bookmark, dict): is the correct choice for this code.
In my first try, I wanted do a first upgrade parse, but I did not know to find the solution in Phyton... thanks for your example.

My comment:

Two bookmarks version are a list (of different components). self.remove_missing() works well on both settings file versions (on my tests), because it deals with whole unit on list not with content, after this parse, the bookmark will be updated.

was an explanation of behavior of self.bookmarks.remove(bookmark) into def remove_missing(self), not for self.remove_missing()...

davvid · 2016-09-18T04:54:59Z

cola/settings.py


        for bookmark in missing_bookmarks:
            try:
                self.bookmarks.remove(bookmark)
            except:
                pass

+        """In case of old settings version, clear old bookmars list and fill with new list"""


A python idiom is that we really only ever use """ for docstrings. For in-line comments just use # .... I guess that probably wasn't clear because the codebase is probably a little terse/under-commented ;-)

Thanks for the clarification.

IgorGalarraga · 2016-09-18T23:23:22Z

When add def upgrade(self): I have 2 problems:

I can't directly update self.bookmarks like your example. I must use other list and use self.bookmarks.remove and self.bookmarks.append. BUT:
It seems that changes are overwritten (with file contents in old version) again in remove_missing

For better explanation, I attach a patch with working (with problems above) method.
0001-Update-bookmarks-method-but-has-problems.patch.txt

Therefore I have changed try/except using isinstance.

Also code style has been updated.

I am not able to make a prompt window with two text boxes... any help (url, reference, example)?

Thanks!

Simplify the code by upgrading bookmarks immediately instead of making the remove_missing() function deal with the format differences. Related-to: git-cola#599 Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

Make the code more closely match the original version by homogenizing the data rather than having two code paths. Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

* rename-favorites: doc: update v2.9 release notes draft bookmarks: use settings.rename_bookmark() settings: add rename_bookmark() method bookmarks: wrap long line startup: remove repeated code settings: small style tweaks settings: upgrade bookmarks immediately after loading Added favorites list item renaming functionality Bugfix: default repo now working again on favorites. Bugfix: startup problem on launching git-cola in no git repo path Code style Using isinstance(bookmark,dict) instead of use try/except Backwards-compatibility with old settings file Automatically updates old settins to new bookmarks make test passed for last modification. Added custom name for favorites item Closes git-cola#599 Closes git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

Added custom name for favorites item

7f77859

Recent item name is now full path.

Igor-Galarraga added 3 commits September 18, 2016 00:21

make test passed for last modification.

9e88319

Automatically updates old settins to new bookmarks

62341aa

Backwards-compatibility with old settings file

ff15de3

Now automatically "import" old format favorites list saved on settings.

davvid requested changes Sep 18, 2016

View reviewed changes

Igor-Galarraga added 2 commits September 19, 2016 01:00

Using isinstance(bookmark,dict) instead of use try/except

06033f8

Code style

05e1b01

Igor-Galarraga added 4 commits September 21, 2016 23:42

Bugfix: startup problem on launching git-cola in no git repo path

f49e574

Merge remote-tracking branch 'origin/master'

e3d9064

Bugfix: default repo now working again on favorites.

ba5613c

Added favorites list item renaming functionality

ed45534

davvid added a commit to davvid/git-cola that referenced this pull request Sep 22, 2016

settings: small style tweaks

57a5e39

Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

davvid added a commit to davvid/git-cola that referenced this pull request Sep 22, 2016

bookmarks: wrap long line

2fab91e

Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

davvid added a commit to davvid/git-cola that referenced this pull request Sep 22, 2016

bookmarks: use settings.rename_bookmark()

482d618

Related-to: git-cola#601 Signed-off-by: David Aguilar <davvid@gmail.com>

davvid merged commit ed45534 into git-cola:master Sep 22, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added custom name for favorites item #601

Added custom name for favorites item #601

IgorGalarraga commented Sep 16, 2016 •

edited

Loading

davvid commented Sep 17, 2016

brlin-tw commented Sep 17, 2016 •

edited

Loading

IgorGalarraga commented Sep 17, 2016

IgorGalarraga commented Sep 17, 2016

davvid left a comment

davvid Sep 18, 2016 •

edited

Loading

IgorGalarraga Sep 18, 2016

IgorGalarraga Sep 18, 2016

davvid Sep 18, 2016 •

edited

Loading

IgorGalarraga Sep 18, 2016

IgorGalarraga commented Sep 18, 2016 •

edited

Loading

Added custom name for favorites item #601

Added custom name for favorites item #601

Conversation

IgorGalarraga commented Sep 16, 2016 • edited Loading

davvid commented Sep 17, 2016

brlin-tw commented Sep 17, 2016 • edited Loading

IgorGalarraga commented Sep 17, 2016

IgorGalarraga commented Sep 17, 2016

davvid left a comment

Choose a reason for hiding this comment

davvid Sep 18, 2016 • edited Loading

Choose a reason for hiding this comment

IgorGalarraga Sep 18, 2016

Choose a reason for hiding this comment

IgorGalarraga Sep 18, 2016

Choose a reason for hiding this comment

davvid Sep 18, 2016 • edited Loading

Choose a reason for hiding this comment

IgorGalarraga Sep 18, 2016

Choose a reason for hiding this comment

IgorGalarraga commented Sep 18, 2016 • edited Loading

IgorGalarraga commented Sep 16, 2016 •

edited

Loading

brlin-tw commented Sep 17, 2016 •

edited

Loading

davvid Sep 18, 2016 •

edited

Loading

davvid Sep 18, 2016 •

edited

Loading

IgorGalarraga commented Sep 18, 2016 •

edited

Loading