Added support to limit synching to specified directories

[jimmynotjim]

See #63

• Adds rsync_limited var
• Adds :limited task to both :up and :down

NOTE: Rather than change the functionality of the current :files task I thought it better to add an :limited task to synch the directories specified (with /uploads as the default). This is really useful when converting really old sites with lots of cruft over to Genesis.

To test on a Genesis project run

bower install git@github.com:genesis/wordpress.git#63-rsync-uploads-dir

and select the branch when prompted.

[ericclemmons]

Man, you're right on. I usually don't care about anything but those. I do think that perhaps we should pivot off of shared.

[jimmynotjim]

I tried making this work as a one line rsync like this:

        desc "Downloads shared children files to Vagrant"
        task :shared, :roles => :web do
            set :excludes, "--exclude '#{rsync_exclude.join('\' --exclude \'')}'"
            set :remote_children, "\'#{remote_web}/#{shared_children.join(' '"#{remote_web}"'/')}\'"

            ssh = "-e \"ssh -i #{ssh_options[:keys][0]}\"" unless ssh_options.keys.empty?

            find_servers_for_task(current_task).each do |current_server|
                system "chmod 600 #{ssh_options[:keys][0]}" unless ssh_options.keys.empty?
                system "rsync #{ssh} -avvru --delete --copy-links #{excludes} --progress #{'--dry-run' if dry_run} #{user}@#{current_server}:#{remote_children} #{local_web}/wp-content/"
            end
        end

but the only issue is rsync removes the parent directories of the source, so without appending /wp-content on the destination the bottom source directory (in this case /uploads) are copied directly to /web.

The other option would be to loop through each key in shared_children like this:

        desc "Downloads shared children files to Vagrant"
        task :shared, :roles => :web do
            set :excludes, "--exclude '#{rsync_exclude.join('\' --exclude \'')}'"

            ssh = "-e \"ssh -i #{ssh_options[:keys][0]}\"" unless ssh_options.keys.empty?

            find_servers_for_task(current_task).each do |current_server|
                system "chmod 600 #{ssh_options[:keys][0]}" unless ssh_options.keys.empty?
                shared_children.each do |key|
                    system "rsync #{ssh} -avvru --delete --copy-links #{excludes} --progress #{'--dry-run' if dry_run} #{user}@#{current_server}:#{remote_web}/#{key}/ #{local_web}/#{key}/"
                end
            end
        end

What do you think?

[jimmynotjim]

Went ahead w/ the second option. I've tested it on a few projects and it seems to be working just fine.

[jimmynotjim]

Bah! Just realized this doesn't work with staging/production as the :remote_web path and /uploads path in :shared_children both contain the /web directory. How is :shared_children processed by Cap? Can we assume they're in the /web dir or should we go with a new variable for this task?

[jimmynotjim]

Temporarily closing so this isn't merged by accident.

[ericclemmons]

You can leave it open, and just put [RFC] or [WIP] in the title for clarity...

[jimmynotjim]

Cool. I changed to a dedicated "rsync_limited" var to avoid the issue w/ duplicate dirs in "shared_children" and "remote/local_web". Thoughts?

[jimmynotjim]

I've thoroughly tested this on both existing Genesis setups and site conversions and it's been running like a champ. Let me know if you figure out some way to test these types of tasks and I'll make an attempt at writing some.

[AntJanus]

@ericclemmons @jimmynotjim should we merge this down and start using it? It looks like it's been lurking here for months.

[jimmynotjim]

I've just been waiting for someone to give the 👍 I've tested it on multiple projects and it works great.

[ericclemmons]

I think we can merge this down safely for now. For v0.3.0, I think this should be the default behavior and introduce that BC break.

[jimmynotjim]

[jimmynotjim]

Sooo....this going to get merged down?

[jimmynotjim]

Monthly reminder...

[jimmynotjim]

Whoohooo. Now to update projects to use it.