Special processing for dotfiles #17

jvkersch · 2016-07-31T21:37:49Z

This is a PR out of the patch that I submitted to stow-devel to allow for special processing for dotfiles. I use GNU stow to manage my dotfiles, but found it a bit hard to maintain an apparently empty Stow folder, which is full of hidden files.

To address this, the idea is to have a command-line option --dotfiles that would have Stow check if the files/folders to stow start with dot- (though I should make the prefix configurable...). In this case, Stow replaces the dot- prefix by an actual dot (.), turning the link target into a proper hidden file.

I am not a skilled Perl developer, so the code is probably rough around the edges. However, if this is a viable approach then I'm definitely up for polishing it and bringing it up to standards.

One corner case that I haven't explored yet is the interplay between this kind of processing and folding. I imagine that the dotfiles option would disable folding, but perhaps there is a way to have both.

coveralls · 2016-07-31T21:39:18Z

Coverage decreased (-0.2%) to 84.634% when pulling a672135 on jvkersch:enh/dot-files into c171ca8 on aspiers:master.

aspiers

This looks like a fantastic start - thanks a lot! Actually, there's really very little left to do, other than fix the small issues I've commented on here. But please do squash both commits into a single commit and then force push to amend this pull request, because code and corresponding tests should always belong together to keep the CI happy and the git history intuitive.

aspiers · 2016-09-24T19:32:44Z

lib/Stow/Util.pm.in

+
+    my @result = ();
+    for my $part (split m{/+}, $target) {
+        if ($part ne "dot-") {


I like the attention to detail here :-) I think you need to also defend against dot-. though, as that would currently be turned into ...

aspiers · 2016-09-24T19:33:34Z

lib/Stow/Util.pm.in

@@ -193,6 +193,20 @@ sub restore_cwd {
    chdir($prev) or error("Your current directory $prev seems to have vanished");
 }

+sub adjust_dotfile {
+    my $target = $_[0];


my ($target) = @_;

would be more consistent with the result of Stow's code style.

aspiers · 2016-09-24T19:34:58Z

lib/Stow.pm.in

@@ -377,6 +378,13 @@ sub stow_contents {
        next NODE if $node eq '..';
        my $node_target = join_paths($target, $node);
        next NODE if $self->ignore($stow_path, $package, $node_target);
+
+	if ($self->{dotfiles}) {


Please use spaces to indent, not tabs, to stay consistent with the rest of the code base.

aspiers · 2016-09-24T19:35:35Z

lib/Stow.pm.in

@@ -744,6 +753,13 @@ sub unstow_contents {
        next NODE if $node eq '..';
        my $node_target = join_paths($target, $node);
        next NODE if $self->ignore($stow_path, $package, $node_target);
+
+	if ($self->{dotfiles}) {


Use spaces not tabs here too.

aspiers · 2016-09-24T19:35:40Z

lib/Stow.pm.in

@@ -801,6 +817,12 @@ sub unstow_node {
        # Does the existing $target actually point to anything?
        if (-e $existing_path) {
            # Does link points to the right place?
+
+	    # Adjust for dotfile if necessary.


Use spaces not tabs here too.

aspiers · 2016-09-24T19:36:46Z

lib/Stow.pm.in

@@ -617,6 +625,7 @@ sub unstow_contents_orig {
        next NODE if $node eq '..';
        my $node_target = join_paths($target, $node);
        next NODE if $self->ignore($stow_path, $package, $node_target);
+        # $node_target = adjust_dotfile($node_target);


We don't want this line, but it will be cancelled out by the next commit when you squash the two commits into one anyway, so that's OK.

aspiers · 2016-09-24T19:38:03Z

t/dotfiles.t

@@ -0,0 +1,72 @@
+#!/usr/local/bin/perl


When adding a new file, you also need to update MANIFEST. That's the reason that the Travis CI builds are currently failing for this pull request.

coveralls · 2016-09-27T17:25:37Z

Coverage decreased (-0.2%) to 84.634% when pulling af8a4d6 on jvkersch:enh/dot-files into 928f893 on aspiers:master.

jvkersch · 2016-09-27T17:27:19Z

@aspiers Thanks for the insightful comments! I think I've addressed them all, but there might be other things still missing (for instance, I should write some docs, and do something about the decrease in test coverage).

aspiers

Apart from that indentation, it looks perfect now - thanks so much!

aspiers · 2016-10-02T22:53:00Z

lib/Stow.pm.in

@@ -744,6 +752,13 @@ sub unstow_contents {
        next NODE if $node eq '..';
        my $node_target = join_paths($target, $node);
        next NODE if $self->ignore($stow_path, $package, $node_target);
+
+    if ($self->{dotfiles}) {


Wrong indentation here. I'll see if GitHub lets me correct it myself though.

aspiers · 2016-10-02T23:03:14Z

Hmm no, it seems that you have to enable the Allow edits from maintainers option before GitHub will let me push to your fork. So please can you either fix that indentation issue, or enable that option? Thanks!

coveralls · 2016-10-03T16:53:42Z

Coverage decreased (-0.2%) to 84.634% when pulling bf6700d on jvkersch:enh/dot-files into 928f893 on aspiers:master.

coveralls · 2016-10-03T20:20:07Z

Coverage decreased (-0.2%) to 84.634% when pulling 5691124 on jvkersch:enh/dot-files into 928f893 on aspiers:master.

coveralls · 2016-10-03T20:47:32Z

Coverage decreased (-0.2%) to 84.634% when pulling ac17611 on jvkersch:enh/dot-files into 928f893 on aspiers:master.

jvkersch · 2016-10-03T20:52:12Z

@aspiers Thanks for the swift feedback and sorry for the oversight. I've fixed it (and enabled the option for future use, if necessary). I also added some more tests for some corner cases in the dot expansion, and I wrote a small summary of what the option does.

One remaining sore spot is the decrease in coverage. I need to figure out what lines aren't being hit, and then write a separate test for them. I'll do so as soon as possible.

coveralls · 2016-10-04T16:53:12Z

Coverage increased (+0.3%) to 85.106% when pulling 182acbb on jvkersch:enh/dot-files into 928f893 on aspiers:master.

jvkersch · 2016-10-04T16:54:07Z

@aspiers I added a simple unstow test. Please let me know if you want to see any further changes, and thanks again for all the reviewing.

lassik · 2018-03-17T14:02:33Z

This feature uses dot- as a prefix for dotfile directories. At least in BSD-land the usual prefix is dot. Examples:

I also found these files on my Mac: dot.mg and dot.gdbinit.

On the other hand, in one Emacs package I found dot-emacs.el.

On Alpine Linux or Ubuntu I didn't find any files with either prefix.

paride · 2018-05-31T08:50:02Z

FWIW, I would favor the dot. prefix.

shajra · 2018-09-14T22:06:11Z

It seems to be that there could be too-open debate on what the right prefix should be. Would it be better coming in as a configuration parameter optionally, with a reasonable default?

aspiers requested changes Sep 24, 2016

View reviewed changes

jvkersch force-pushed the enh/dot-files branch from a672135 to af8a4d6 Compare September 27, 2016 17:23

aspiers requested changes Oct 2, 2016

View reviewed changes

jvkersch force-pushed the enh/dot-files branch from af8a4d6 to bf6700d Compare October 3, 2016 16:51

jvkersch force-pushed the enh/dot-files branch from bf6700d to 5691124 Compare October 3, 2016 20:18

jvkersch force-pushed the enh/dot-files branch from 5691124 to ac17611 Compare October 3, 2016 20:45

Special processing for dotfiles

182acbb

jvkersch force-pushed the enh/dot-files branch from ac17611 to 182acbb Compare October 4, 2016 16:51

aspiers approved these changes Oct 5, 2016

View reviewed changes

aspiers merged commit 1b320b1 into aspiers:master Oct 5, 2016

jvkersch deleted the enh/dot-files branch October 10, 2016 16:39

rwa mentioned this pull request Jan 19, 2018

There is no release with this wonderful pull request that was merged over a year ago #26

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Special processing for dotfiles #17

Special processing for dotfiles #17

jvkersch commented Jul 31, 2016

coveralls commented Jul 31, 2016 •

edited

Loading

aspiers left a comment

aspiers Sep 24, 2016

aspiers Sep 24, 2016

aspiers Sep 24, 2016

aspiers Sep 24, 2016

aspiers Sep 24, 2016

aspiers Sep 24, 2016

aspiers Sep 24, 2016

coveralls commented Sep 27, 2016 •

edited

Loading

jvkersch commented Sep 27, 2016

aspiers left a comment

aspiers Oct 2, 2016

aspiers commented Oct 2, 2016

coveralls commented Oct 3, 2016 •

edited

Loading

coveralls commented Oct 3, 2016 •

edited

Loading

coveralls commented Oct 3, 2016 •

edited

Loading

jvkersch commented Oct 3, 2016

coveralls commented Oct 4, 2016 •

edited

Loading

jvkersch commented Oct 4, 2016

lassik commented Mar 17, 2018

paride commented May 31, 2018

shajra commented Sep 14, 2018

Special processing for dotfiles #17

Special processing for dotfiles #17

Conversation

jvkersch commented Jul 31, 2016

coveralls commented Jul 31, 2016 • edited Loading

aspiers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Sep 27, 2016 • edited Loading

jvkersch commented Sep 27, 2016

aspiers left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aspiers commented Oct 2, 2016

coveralls commented Oct 3, 2016 • edited Loading

coveralls commented Oct 3, 2016 • edited Loading

coveralls commented Oct 3, 2016 • edited Loading

jvkersch commented Oct 3, 2016

coveralls commented Oct 4, 2016 • edited Loading

jvkersch commented Oct 4, 2016

lassik commented Mar 17, 2018

paride commented May 31, 2018

shajra commented Sep 14, 2018

coveralls commented Jul 31, 2016 •

edited

Loading

coveralls commented Sep 27, 2016 •

edited

Loading

coveralls commented Oct 3, 2016 •

edited

Loading

coveralls commented Oct 3, 2016 •

edited

Loading

coveralls commented Oct 3, 2016 •

edited

Loading

coveralls commented Oct 4, 2016 •

edited

Loading