blavosync 0.2.2 → 0.2.3

data/Blavosync.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{blavosync}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jayronc"]
-  s.date = %q{2009-12-29}
+  s.date = %q{2009-12-30}
   s.description = %q{Sync a remote db and rsync content to your development environment.  Useful for small teams and developers who are not able to do this manually.}
   s.email = %q{jerrodblavos@mac.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.markdown"
+     "README.rdoc"
   ]
   s.files = [
     "Blavosync.gemspec",
      "History.txt",
      "LICENSE",
      "Manifest.txt",
-     "README.markdown",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/blavosync.rb",

data/README.rdoc

@@ -0,0 +1,70 @@
+= BlavoSync
+
+== DEPENDENCIES
+
+* Capistrano2 (http://github.com/jamis/capistrano)
+
+== Requirements
+
+* A reason to have your production stuff on your development machine.
+* A production server running mysql and sshd.
+* A valid $RAILS_ROOT/config/database.yml file with entries for both production and development.
+* The latest capistrano2 and a valid $RAILS_ROOT/config/deploy.rb file with either a :domain or :rsync domain entry.
+* The blavosync rubygem, available at http://gemcutter.org (sudo gem install blavosync).
+* Hopefully you already have a nice little app running somewhere that has some decent data and assets. In your $RAILS_ROOT/config/deploy.rb file add this line to the top:
+
+    require "blavosync/recipes"
+
+In addition, ensure that you have an entry either for :domain or :rsync_domain like so:
+
+    set :domain, "my.awesomedomain.com"
+
+or if you are using some custom deployment location:
+
+    set :rsync_domain, "my.awesomedomain.com"
+
+This covers the basic requirements, on to usage.  As long as your $RAILS_ROOT/config/deploy.rb file is working, the only action you need to take is to run the following on your local machine.
+
+    cap local:sync
+
+This will dump the production database and load it into your local mysql database, defined in your $RAILS_ROOT/config/database.yml, and then rsync anything in your $RAILS_ROOT/shared/system directory on production into your $RAILS_ROOT/tmp directory in a new system directory. Once this is done, the $RAILS_ROOT/tmp/system directory will be symlinked into $RAILS_ROOT/public/system.
+
+There are some considerations you should take before using this tool, such as do you have enough disk space or bandwidth to pull down all the assets. You may already have a $RAILS_ROOT/public/system directory full of assets, in which case if you want to keep those you should back them up somewhere and delete the system directory, otherwise the symlink may not work.
+
+If you are on OSX you may need to enable FollowSymLinks in your virtualhost entry for these assets to be served by apache.
+
+== USAGE
+
+adds the following tasks to projects using capistrano
+
+=== cap local:sync
+
+Wrapper for local:sync_db and local:sync\_content
+$> cap local:sync
+
+=== cap local:rsync
+
+Wrapper for local:rsync_content and local:rsync\_restore\_content
+$> cap local:sync_content
+
+=== cap local:sync_db
+
+Wrapper for local:backup_db and local:restore\_db.
+$> cap local:sync_db
+
+
+For subcommands try cap -T local
+
+==== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+===== Copyright
+
+Copyright (c) 2009 jayronc. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blavosync
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - jayronc
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-29 00:00:00 -05:00
+date: 2009-12-30 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -21,13 +21,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.rdoc
 files: 
 - Blavosync.gemspec
 - History.txt
 - LICENSE
 - Manifest.txt
-- README.markdown
+- README.rdoc
 - Rakefile
 - VERSION
 - lib/blavosync.rb

data/README.markdown

@@ -1,97 +0,0 @@
-== blavosync
-
-REQUIREMENTS:
-
-  a valid database.yml file with access to both production and development data
-  rsync binaries locally and on server, or gzip and tar
-  a config/deploy.rb script and ssh access to your production box
-
-INSTALLATION:
-Add this line to your config/deploy.rb file
-
-  require 'blavosync/recipes'
-
-USAGE:
-adds the following tasks to projects using capistrano
-
-------------------------------------------------------------
-cap local:backup_content
-------------------------------------------------------------
-Downloads a tarball of shared content (identified by the :shared_content and
-:content _ directories properties) from a deployable environment (RAILS_ENV) to
-the local filesystem.
-
-------------------------------------------------------------
-cap local:backup _ db
-------------------------------------------------------------
-Backs up deployable environment's database and copies it to
-the local machine.
-
-------------------------------------------------------------
-cap local:force _ backup _ content
-------------------------------------------------------------
-Regenerate files.
-
-------------------------------------------------------------
-cap local:force _ backup _ db
-------------------------------------------------------------
-Regenerate files.
-
-------------------------------------------------------------
-cap local:restore _ content
-------------------------------------------------------------
-Restores the backed up content (env var FROM specifies which environment
-was backed up, defaults to RAILS_ENV) to the local development environment app
-
-------------------------------------------------------------
-cap local:restore _ db
-------------------------------------------------------------
-Untars the backup file downloaded from local:backup_db and imports 
-(via mysql command line tool) it back into the development database.
-
-------------------------------------------------------------
-cap local:resync _ db
-------------------------------------------------------------
-Ensure that a fresh remote data dump is retrieved before syncing to the local
-environment
-
-------------------------------------------------------------
-cap local:sync
-------------------------------------------------------------
-Wrapper for local:sync _ db and local:sync _ content
-$> cap local:sync
-
-------------------------------------------------------------
-cap local:sync_content
-------------------------------------------------------------
-Wrapper for local:backup _ content and local:restore _ content
-$> cap local:sync_content
-
-------------------------------------------------------------
-cap local:sync_db
-------------------------------------------------------------
-Wrapper for local:backup _ db and local:restore _ db.
-$> cap local:sync _ db
-
-------------------------------------------------------------
-cap local:sync_init
-------------------------------------------------------------
-Wrapper for local:force _ backup _ db, local:force _ backup _ content, and the
-local:sync to get
-a completely fresh set of data from the server
-$> cap local:sync
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 jayronc. See LICENSE for details.