silo 0.1.0

data/.yardopts

@@ -0,0 +1 @@
+--files Changelog.md,LICENSE

data/Changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## Version 0.1.0
+
+ **January 30<sup>th</sup>, 2011**
+
+ * First release
+ * Simple saving and restoring
+ * Mirroring using Git's built-in remotes
+ * Getting simple information from the repository
+
+ See the [Git history](https://github.com/koraktor/silo/commits/0.1.0) for
+ version 0.1.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2010-2011, Sebastian Staudt
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of the author nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,153 @@
+Silo
+====
+
+Silo is command-line utility and Ruby API for Git-based backups. With Silo you
+can backup arbitrary files into one or more Git repositories and take advantage
+of Git's compression, speed and other features. No Git knowledge needed.
+
+## Concept
+
+To backup files into a repository Silo uses the well-known and established
+version control system (VCS) Git. Instead of using Git's frontend commands for
+the end-user, so called *"porcelain"* commands, Silo makes use of the more
+low-level *"plumbing"* commands. These can be used to write directly to the Git
+repository, bypassing the automatisms tailored for source code histories.
+
+## Requirements
+
+* Grit – a Ruby API for Git
+* Rubikon – a Ruby framework for console applications
+* Git >= 1.6
+
+## Installation
+
+You can install Silo using RubyGems. This is the easiest way of installing
+and recommended for most users.
+
+    $ gem install silo
+
+If you want to use the development code you should clone the Git repository:
+
+    $ git clone git://github.com/koraktor/silo.git
+    $ cd silo
+    $ rake install
+
+## Basic usage
+
+### Configuration files
+
+Silo searches for configuration files (`.silo`) in the current working
+directory, your home directory and your systems global configuration directory
+(i.e. /etc on Unix).
+
+They can be used to set Silo-specific options globally or for single
+directories. That way you may have one general Silo repository for common
+backups and another Silo repository for e.g. work-related files.
+
+Configuration files are expected in a Git-like format and
+may contain the following sections and variables:
+
+* repository
+
+  * path – The path of the default repository to use
+  * prefix – The path inside the repository to store files to per default
+
+#### Sample
+
+    [repository]
+      path   = /Users/jondoe/backup.git
+      prefix = work
+
+This would usually save and restore files to and from
+`/Users/jondoe/backup.git` and save files into the directory `work` inside the
+repository.
+
+### Initialize a repository
+
+    $ silo init [repository path]
+
+### Add files or directories to the repository
+
+    $ silo add file [file ...] [--prefix <prefix>]
+
+The prefix allows to organize the files inside the repository.
+
+### Restore files or directories from the repository
+
+    $ silo restore file [file ...] [--prefix <prefix>]
+
+The prefix is the directory inside your file system where the restored files
+will be saved.
+
+### Remove files or directories from the repository
+
+    $ silo remove file [file ...]
+    $ silo rm file [file ...]
+
+### Completely purge files or directories from the repository
+
+    $ silo purge file [file ...] [--no-clean]
+
+This will completely remove the specified files from the repository and thus
+reduce the required disk space.
+
+**WARNING**: There's no method built-in to Silo or Git to recover files after
+purging.
+
+The `--no-clean` flag will cause Git commits to persist even after their
+contents have been purged.
+
+### Manage remote repositories for mirrored backups
+
+    $ silo remote [-v]
+    $ silo remote add name url
+    $ silo remote rm name
+
+Add or remove a remote repository with the specified name. When adding a remote
+repository the specified location may be given as any location Git understands
+– including file system paths.
+
+### Distribute the state of your repository to all mirror repositories
+
+    $ silo distribute
+
+### List repository contents
+
+    $ silo list [file ...] [-l] [-r]
+
+The `-l` flag will list each directory and file in a separate line, `-r` will
+reverse the listing.
+
+### Display info about repository contents
+
+    $ silo info [file ...] [-v]
+
+## Using the Ruby API
+
+The documentation of the Ruby API can be seen at [RubyDoc.info][1]. The API
+documentation of the current development version is also available [there][5].
+
+## License
+
+This code is free software; you can redistribute it and/or modify it under the
+terms of the new BSD License. A copy of this license can be found in the
+LICENSE file.
+
+## Credits
+
+* Sebastian Staudt – koraktor(at)gmail.com
+
+## See Also
+
+* [API documentation][1]
+* [Silo's homepage][2]
+* [GitHub project page][3]
+* [GitHub issue tracker][4]
+
+Follow Silo on Twitter [@silorb](http://twitter.com/silorb).
+
+ [1]: http://rubydoc.info/gems/silo/frames
+ [2]: http://koraktor.github.com/silo
+ [3]: http://github.com/koraktor/silo
+ [4]: http://github.com/koraktor/silo/issues
+ [5]: http://rubydoc.info/github/koraktor/silo/master/frames

data/Rakefile

@@ -0,0 +1,45 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+require 'rake/testtask'
+
+task :default => :test
+
+# Test task
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+begin
+  require 'ore/tasks'
+  Ore::Tasks.new
+rescue LoadError
+  $stderr.puts 'You need ore-tasks to build the gem. Install it using `gem install ore-tasks`.'
+end
+
+begin
+  require 'yard'
+
+  # Create a rake task +:doc+ to build the documentation using YARD
+  YARD::Rake::YardocTask.new do |yardoc|
+    yardoc.name    = 'doc'
+    yardoc.files   = ['lib/**/*.rb', 'LICENSE', 'README.md']
+    yardoc.options = ['--private', '--title', 'Silo &mdash; API Documentation']
+  end
+rescue LoadError
+  desc 'Generate YARD Documentation (not available)'
+  task :doc do
+    $stderr.puts 'You need YARD to build the documentation. Install it using `gem install yard`.'
+  end
+end
+
+# Task for cleaning documentation and package directories
+desc 'Clean documentation and package directories'
+task :clean do
+  FileUtils.rm_rf 'doc'
+  FileUtils.rm_rf 'pkg'
+end

data/bin/silo

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'silo.rb')
+require 'silo/cli.rb'

data/gemspec.yml

@@ -0,0 +1,29 @@
+name:        silo
+summary:     A command-line utility and API for Git-based backups
+description: With Silo you can backup arbitrary files into one or more Git
+             repositories and take advantage of Git's compression, speed and
+             other features. No Git knowledge needed.
+
+license:  BSD
+authors:  Sebastian Staudt
+email:    koraktor@gmail.com
+homepage: http://koraktor.de/silo
+has_yard: true
+
+extra_doc_files:
+ - Changelog.md
+ - LICENSE
+require_paths: lib
+test_files:    test/**/test_*.rb
+
+dependencies:
+  grit:    ~> 2.4.1
+  rubikon: ~> 0.6.0
+
+development_dependencies:
+  ore-tasks: ~> 0.3.0
+  shoulda:   ~> 2.11.3
+  yard:      ~> 0.6.4
+
+requirements:
+  - git >= 1.6

data/lib/core_ext/pathname.rb

@@ -0,0 +1,20 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'pathname'
+
+# Provides extensions to the Pathname class provided by Ruby's standard
+# Library
+class Pathname
+
+  # Appends a path to this path and expands it
+  #
+  # @param [#to_s] path The path to append
+  # @return [Pathname] The generated path
+  def /(path)
+    (self + path).expand_path
+  end
+
+end

data/lib/silo.rb

@@ -0,0 +1,20 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010, Sebastian Staudt
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'silo/errors'
+require 'silo/repository'
+require 'silo/remote/git'
+require 'silo/version'
+
+# A command-line utility and API for Git-based backups
+#
+# With Silo you can backup arbitrary files into one or more Git repositories
+# and take advantage of Git's compression, speed and other features. No Git
+# knowledge needed.
+module Silo
+end

data/lib/silo/cli.rb

@@ -0,0 +1,167 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2010-2011, Sebastian Staudt
+
+require 'rubygems'
+require 'rubikon'
+
+module Silo
+
+  # This class is a Rubikon application that implements the command-line
+  # interface for Silo
+  #
+  # @author Sebastian Staudt
+  # @since 0.1.0
+  class CLI < Rubikon::Application::Base
+
+    # Changes the current repository
+    #
+    # @see #repo
+    attr_writer :repo
+
+    set :config_file, '.silo'
+    set :config_format, :ini
+    set :help_banner, 'Usage: silo'
+
+    global_option :repository, :repo_path do
+      self.repo = Repository.new repo_path
+    end
+
+    pre_execute do
+      if config.empty?
+        puts "y{Warning:} Configuration file(s) could not be loaded.\n\n"
+      else
+        @prefix = config['repository']['prefix']
+        self.repo = Repository.new config['repository']['path']
+      end
+    end
+
+    default '<hidden>' do
+      puts "This is Silo. A Git-based backup utility.\n\n"
+      call :help
+    end
+
+    option :prefix, 'The prefix path inside the repository to store the files to', :path
+    command :add, 'Store one or more files in the repository', :files => :remainder do
+      files.uniq.each do |file|
+        repo.add file, prefix.path || @prefix
+      end
+    end
+
+    command :distribute, 'Push repository contents to remote repositories' do
+      repo.distribute
+    end
+
+    command :info, 'Get information about repository contents', :files => :remainder do
+      files.uniq.each do |path|
+        info = repo.info path
+        puts '' unless path == args.first
+        puts "#{info[:type] == :blob ? 'File' : 'Directory'}: #{info[:path]}"
+        if info[:type] == :blob
+          puts "  Size:             #{info[:size].to_s.
+            gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")} bytes"
+          puts "  MIME-Type:        #{info[:mime]}"
+        end
+        puts "  Created at:       #{info[:created]}"
+        puts "  Last modified at: #{info[:modified]}"
+
+        if $VERBOSE
+          puts "  Initial commit:   #{info[:history].last.id}"
+          puts "  Last commit:      #{info[:history].first.id}"
+          puts "  Mode:             #{info[:mode]}"
+          puts "  #{info[:type].to_s.capitalize}-ID:          #{info[:sha]}"
+        end
+      end
+    end
+
+    command :init, 'Initialize a Silo repository', :path => :optional do
+      path = File.expand_path(path || '.')
+      puts "Initializing Silo repository in #{path}..."
+      Repository.new path
+    end
+
+    flag :l, 'List each object in a separate line'
+    flag :r, 'Reverse list order'
+    command :list, 'List the contents of a repository', :paths => [ :remainder, :optional ] do
+      paths = self.paths || [nil]
+      contents = []
+      paths.each do |path|
+        new_contents = repo.contents path
+        puts "y{Warning:} File '#{path}' does not exist in the repository." if new_contents.empty?
+        contents |= new_contents
+      end
+
+      contents.reverse! if r.given?
+
+      unless l.given?
+        col_size = contents.max_by { |path| path.size }.size + 1
+        contents.each { |path| put path.ljust(col_size) }
+        puts ''
+      else
+        contents.each { |path| puts path }
+      end
+    end
+
+    command :remote, 'Add or remove remote repositories', { :action => ['add', 'rm', :optional], :name => :optional, :url => :optional } do
+      usage = lambda do
+        puts 'usage: silo remote add <name> <url>'
+        puts '   or: silo remote rm <name>'
+      end
+      case action
+        when nil
+          repo.remotes.each_value do |remote|
+            info = remote.name
+            info += "  #{remote.url}" if $VERBOSE
+            puts info
+          end
+        when 'add'
+          if url.nil?
+            repo.add_remote name, url
+          else
+            usage.call
+          end
+        when 'rm'
+          unless url.nil?
+            repo.remove_remote name
+          else
+            usage.call
+          end
+        else
+          usage.call
+      end
+    end
+
+    option :prefix, 'The prefix path to store the files to', :path
+    command :restore, 'Restore one or more files or directories from the repository', :files => :remainder do
+      files.uniq.each do |file|
+        repo.restore file, prefix.path || '.'
+      end
+    end
+
+    flag :'no-clean', "Don't remove empty commits from the Git history"
+    command :purge, 'Permanently remove one or more files or directories from the repository', :files => :remainder do
+      files.uniq.each do |file|
+        repo.purge file, !given?(:'no-clean')
+      end
+    end
+
+    command :rm => :remove
+    command :remove, 'Remove one or more files or directories from the repository', :files => :remainder do
+      files.uniq.each do |file|
+        repo.remove file
+      end
+    end
+
+    # Returns the current repository
+    #
+    # @return [Repository] The currently configured Silo repository
+    # @raise [RuntimeError] if no repository is configured
+    def repo
+      raise 'No repository configured.' if @repo.nil?
+      @repo
+    end
+
+  end
+
+end