mina-rsync 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDNmYTkyYWQyYzAxMjhjOWNjNTY1YWNiOWExZWEyODBlMGE5MTAxZQ==
+  data.tar.gz: !binary |-
+    YzEwNDEyZDZiNTAyYWEzYzY5MGEwMzg2NDY3MDJmZjNjYTc2MjJjMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YWVkNjFjZDAxOWI1ZWI2MjQyOTQ2ZGU2ZTY0MmMyOWNkODZlZDdmN2M2Yzc5
+    NjgxMGM3NDNmMmFlZWVkN2ZjNjA2OWYyZTc4ODYwNzE1OTUwNDM4YzI5MGIy
+    MzE4YjUzNzNhMWNlZjliOTE4OTZjM2EwNmQ3ZWZhMWI3YzdmNzI=
+  data.tar.gz: !binary |-
+    Mjg4ODcxMjBlNzAyOTFjZTRjY2VjMzUwYzEwOTkzZjg2ODE2ZmI5Zjk1N2Uy
+    NGViMjM4MmU1YTRkZmMzYjk1NjNiYTM4ZTI1YWVjMzQ2Mjc1OGNhNDgwOWE3
+    ZWRmM2E0YmJjMDMxNzAwMWU0NTExMzI5ZGZlMWRmZDE3ZTk0NmQ=

data/.gitignore

@@ -0,0 +1 @@
+/*.gem

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 (Sep 2, 2013)
+- First release. Let's get syncing!

data/LICENSE

@@ -0,0 +1,20 @@
+Mina::Rsync
+Copyright (C) 2013 Andri Möll
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or any later version.
+
+Additional permission under the GNU Affero GPL version 3 section 7:
+If you modify this Program, or any covered work, by linking or
+combining it with other code, such other code is not for that reason
+alone subject to any of the requirements of the GNU Affero GPL version 3.
+
+In summary:
+- You can use this program for no cost.
+- You can use this program for both personal and commercial reasons.
+- You do not have to share your own program's code which uses this program.
+- You have to share modifications (e.g bug-fixes) you've made to this program.
+
+For the full copy of the GNU Affero General Public License see:
+http://www.gnu.org/licenses.

data/Makefile

@@ -0,0 +1,12 @@
+NAME = mina-rsync
+
+love:
+	@echo "Feel like makin' love."
+
+pack:
+	gem build $(NAME).gemspec
+
+publish:
+	gem push $(NAME)-*.gem
+	
+.PHONY: love pack publish

data/README.md

@@ -0,0 +1,111 @@
+Mina::Rsync for Mina
+====================
+[![Gem version](https://badge.fury.io/rb/mina-rsync.png)](http://badge.fury.io/rb/mina-rsync)
+
+**Deploy with Rsync** to your server from any local (or remote) repository when using [**Mina**](http://nadarei.co/mina).  
+Saves you from having to install Git on your production machine and allows you to customize which files you want to deploy. Also allows you to easily precompile things on your local machine before deploying.
+
+### Tour
+- Suitable for deploying any apps, be it Ruby, Rails, Node.js or others.  
+- Exclude files from being deployed with Rsync's `--exclude` options.
+- Precompile files or assets easily before deploying, like JavaScript or CSS.
+- Caches your previously deployed code to speed up deployments ~1337%.
+- Currently works only with Git, so please shout out your interest in other SCMs.
+
+
+Using
+-----
+Install with:
+```
+gem install mina-rsync
+```
+
+Require it at the top of your `Minafile` (or `config/deploy.rb`):
+```ruby
+require "mina/rsync"
+```
+
+Set some `rsync_options` to your liking:
+```ruby
+set :rsync_options, %w[--recursive --delete --delete-excluded --exclude .git*]
+```
+
+Then invoke Mina::Rsync's tasks from your `deploy` task:
+```ruby
+task :deploy do
+  deploy do
+    invoke "rsync:deploy"
+  end
+end
+```
+
+And after setting regular Mina options, deploy as usual!
+```
+mina deploy
+```
+
+### Implementation
+1. Clones and updates your repository to `rsync_stage` (defaults to `tmp/deploy`) on your local machine.
+2. Checks out the branch set in the `branch` variable (defaults to `master`).
+3. Rsyncs to `rsync_cache` (defaults to `shared/deploy`) on the server.
+4. Copies the content of the cache directory to the build directory.
+
+After that, Mina takes over and runs its usual tasks and symlinking.
+
+### Excluding files from being deployed
+If you don't want to deploy everything you've committed to your repository, pass some `--exclude` options to Rsync:
+```ruby
+set :rsync_options, %w[
+  --recursive --delete --delete-excluded
+  --exclude .git*
+  --exclude /config/database.yml
+  --exclude /test/***
+]
+```
+
+### Precompile assets before deploy
+Mina::Rsync runs `rsync:stage` before rsyncing. Hook to that like this:
+```ruby
+task :precompile do
+  Dir.chdir settings.rsync_stage do
+    system "rake", "assets:precompile"
+  end
+end
+
+task "rsync:stage" do
+  invoke "precompile"
+end
+```
+
+
+Configuration
+-------------
+Set Mina variables with `set name, value`.
+
+Name          | Default | Description
+--------------|---------|------------
+repository    | `.` | The path or URL to a Git repository to clone from.  
+branch        | `master` | The Git branch to checkout.  
+rsync_stage   | `tmp/deploy` | Path where to clone your repository for staging, checkouting and rsyncing. Can be both relative or absolute.
+rsync_cache   | `shared/deploy` | Path where to cache your repository on the server to avoid rsyncing from scratch each time. Can be both relative or absolute.
+rsync_options | `[]` | Array of options to pass to `rsync`.  
+
+
+License
+-------
+Mina::Rsync is released under a *Lesser GNU Affero General Public License*, which in summary means:
+
+- You **can** use this program for **no cost**.
+- You **can** use this program for **both personal and commercial reasons**.
+- You **do not have to share your own program's code** which uses this program.
+- You **have to share modifications** (e.g bug-fixes) you've made to this program.
+
+For more convoluted language, see the `LICENSE` file.
+
+
+About
+-----
+**[Andri Möll](http://themoll.com)** made this happen.  
+[Monday Calendar](https://mondayapp.com) was the reason I needed this.
+
+If you find Mina::Rsync needs improving, please don't hesitate to type to me now at [andri@dot.ee](mailto:andri@dot.ee) or [create an issue online](https://github.com/moll/mina-rsync/issues).

data/lib/mina/rsync.rb

@@ -0,0 +1,79 @@
+require File.expand_path("../rsync/version", __FILE__)
+
+# NOTE: Please don't depend on tasks without a description (`desc`) remaining
+# as they are between minor or patch version releases. They make up the private
+# API and internalas of Mina::Rsync. If you think something should be public
+# for extending, please let me know!
+
+set_default :repository, "."
+set_default :branch, "master"
+set_default :rsync_options, []
+set_default :rsync_copy, "rsync --archive --acls --xattrs"
+
+# Stage is used on your local machine for rsyncing from.
+set_default :rsync_stage, "tmp/deploy"
+
+# Cache is used on the server to copy files to from to the release directory.
+# Saves you rsyncing your whole app folder each time.
+set_default :rsync_cache, "shared/deploy"
+
+run = lambda do |*cmd|
+  if simulate_mode?
+    puts "$ #{cmd.join(" ")}"
+  else
+    Kernel.system *cmd
+  end
+end
+
+rsync_cache = lambda do
+  cache = settings.rsync_cache
+  raise TypeError, "Please set rsync_cache." unless cache
+  cache = settings.deploy_to + "/" + cache if cache && cache !~ /^\//
+  cache
+end
+
+desc "Stage and rsync to the server (or its cache)."
+task :rsync => %w[rsync:stage] do
+  puts "Rsyncing to #{rsync_cache.call}..."
+
+  rsync = %w[rsync]
+  rsync.concat settings.rsync_options
+  rsync << settings.rsync_stage + "/"
+
+  user = settings.user + "@" if settings.user
+  host = settings.domain
+  rsync << "#{user}#{host}:#{rsync_cache.call}"
+
+  run.call *rsync
+end
+
+namespace :rsync do
+  task :create_stage do
+    next if File.directory?(settings.rsync_stage)
+    puts "Cloning repository for the first time..."
+
+    clone = %W[git clone]
+    clone << settings.repository
+    clone << settings.rsync_stage
+    run.call *clone
+  end
+
+  desc "Stage the repository in a local directory."
+  task :stage => %w[create_stage] do
+    puts "Staging..."
+
+    puts "$ cd #{settings.rsync_stage}" if simulate_mode?
+    Dir.chdir settings.rsync_stage do
+      run.call *%W[git fetch --quiet --all --prune]
+      print "Git checkout: "
+      run.call *%W[git reset --hard origin/#{settings.branch}]
+    end
+  end
+
+  task :build do
+    queue %(#{settings.rsync_copy} "#{rsync_cache.call}/" ".")
+  end
+
+  desc "Stage, rsync and copy to the build path."
+  task :deploy => %w[rsync build]
+end

data/lib/mina/rsync/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Rsync
+    VERSION = "1.0.0"
+  end
+end

data/mina-rsync.gemspec

@@ -0,0 +1,30 @@
+require File.expand_path("../lib/mina/rsync/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "mina-rsync"
+  gem.version = Mina::Rsync::VERSION
+  gem.homepage = "https://github.com/moll/mina-rsync"
+  gem.summary = <<-end.strip.gsub(/\s*\n\s*/, " ")
+    Deploy with Rsync from any local (or remote) repository.
+  end
+
+  gem.description = <<-end.strip.gsub(/\s*?\n(\n?)\s*/, " \\1\\1")
+    Deploy with Rsync to your server from any local (or remote) repository.
+
+    Saves you the need to install Git on your production machine and deploy all
+    of your development files each time!
+
+    Suitable for deploying any apps, be it Ruby or Node.js.
+  end
+
+  gem.author = "Andri Möll"
+  gem.email = "andri@dot.ee"
+  gem.license = "LAGPL"
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(/^bin\//).map(&File.method(:basename))
+  gem.test_files = gem.files.grep(/^spec\//)
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mina", ">= 0.3.0", "< 2"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: mina-rsync
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andri Möll
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+description: ! "Deploy with Rsync to your server from any local (or remote) repository.
+  \n\nSaves you the need to install Git on your production machine and deploy all
+  of your development files each time! \n\nSuitable for deploying any apps, be it
+  Ruby or Node.js."
+email: andri@dot.ee
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- LICENSE
+- Makefile
+- README.md
+- lib/mina/rsync.rb
+- lib/mina/rsync/version.rb
+- mina-rsync.gemspec
+homepage: https://github.com/moll/mina-rsync
+licenses:
+- LAGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Deploy with Rsync from any local (or remote) repository.
+test_files: []
+has_rdoc: