coral_backup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 166a85de67349ae7c3443bf59f11825895aa5808
+  data.tar.gz: 5fa3d934bc50506bcfc072a46a5ba05c2f820da0
+SHA512:
+  metadata.gz: b4f6f9c58a9e2cfa1eb8ab3af3f272921aabcefa995c55f7014b876adb186a4c84e54a195775f056c015731c680544d31e6509c7685cfbc8796fd72453218cf9
+  data.tar.gz: b026ff1ff97901effe349c782ac286ff3509580e8d132a43dd48c33fbdbb3341c09d78af11966cd3e4b60f3cd49249ecbc53b1560c914fdd7dace4efbc2648c2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coral_backup.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The zlib license (Zlib)
+
+Copyright (c) 2015 OTSUKA Tatsuya
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,38 @@
+# Coral Backup
+
+Coral Backup creates incremental backups of files that can be restored at a later date.
+
+## Installation
+
+```
+$ gem install coral_backup
+```
+
+## Usage
+### Commands
+
+* `coral add <ACTION>`: Add a new backup action
+* `coral delete <ACTION>`: Delete the backup action
+* `coral help [COMMAND]`: Describe available commands or one specific command
+* `coral list`: Show all backup actions
+* `coral run <ACTION>`: Run the backup action
+* `coral show <ACTION>`: Show information about the backup action
+* `coral version`: Print the version
+
+### Options
+
+* `-d`, `--dry-run`: Show what would have been backed up, but do not back them up
+
+## Dependencies
+
+* rsync 3.X.X binary
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec coral` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Tatzyr/coral_backup.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coral_backup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/coral_backup.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coral_backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coral_backup"
+  spec.version       = CoralBackup::VERSION
+  spec.authors       = ["OTSUKA Tatsuya"]
+  spec.email         = ["tatzyr@gmail.com"]
+
+  spec.summary       = %q{Coral Backup creates incremental backups of files that can be restored at a later date.}
+  spec.homepage      = "https://github.com/tatzyr/coral_backup"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.0"
+  spec.license       = "Zlib"
+
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "toml-rb", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/exe/coral

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "coral_backup"
+
+CoralBackup::CLI.start(ARGV)

data/lib/coral_backup.rb

@@ -0,0 +1,4 @@
+require "coral_backup/cli"
+require "coral_backup/file_selector"
+require "coral_backup/settings"
+require "coral_backup/version"

data/lib/coral_backup/cli.rb

@@ -0,0 +1,146 @@
+require "coral_backup/file_selector"
+require "coral_backup/settings"
+require "thor"
+
+module CoralBackup
+  class CLI < Thor
+    def initialize(*args)
+      super
+      @settings = Settings.new
+    end
+
+    desc "add <ACTION>", "Add a new backup action"
+    def add(action_name)
+      if @settings.exist_action?(action_name)
+        warn "ERROR: Backup action `#{action_name}' already exists."
+        exit 1
+      end
+
+      puts "Drag and drop or input source directory."
+      source = FileSelector.single_select
+      unless FileTest.directory?(source)
+        warn "ERROR: Not a directory: #{source}"
+        exit 1
+      end
+      source << "/" unless source.end_with?("/")
+
+      puts "Drag and drop or input destination directory."
+      destination = FileSelector.single_select
+      unless FileTest.directory?(destination)
+        warn "ERROR: Not a directory: #{destination}"
+        exit 1
+      end
+      destination << "/" unless destination.end_with?("/")
+
+      puts "Drag and drop or input exclusion files/directories."
+      puts "Press Ctrl + D to finish."
+      exclusions = FileSelector.select
+      exclusions.map! {|filename|
+        if FileTest.directory?(filename)
+          filename << "/" unless filename.end_with?("/")
+        end
+        filename
+      }
+      exclusions.uniq!
+
+      @settings.add(action_name, source, destination, exclusions)
+    end
+
+    desc "delete <ACTION>", "Delete the backup action"
+    def delete(action_name)
+      @settings.delete(action_name)
+    rescue ArgumentError => e
+      warn "ERROR: #{e}"
+      exit 1
+    end
+
+    desc "list", "Show all backup actions"
+    def list
+      puts @settings.action_names
+    end
+
+    map run: :__run
+    desc "run <ACTION>", "Run the backup action"
+    option :"dry-run", :type => :boolean, aliases: :d, desc: "Show what would have been backed up, but do not back them up"
+    def __run(action_name)
+      unless rsync_version.split(".").first.to_i >= 3
+        warn "ERROR: rsync version must be larger than 3.X.X"
+        exit 1
+      end
+
+      time = Time.now
+      data = @settings.action_data(action_name)
+
+      destination = data[:destination]
+      dryrun = options[:"dry-run"]
+      exclusions = data[:exclusions]
+      source = data[:source]
+
+      args = ["rsync", "-rlptgoxS", "--delete", "-X", "--progress", "--stats"]
+      args << "--dry-run" if dryrun
+
+      new_destination = File.expand_path("#{action_name} backup #{Time.now.strftime("%F-%H%M%S")}", destination)
+      old_destination =
+        Dir.chdir(destination) {
+          Dir["*"]
+        }.select{|dirname|
+          dirname.match(/#{Regexp.escape(action_name)} backup \d{4}-\d{2}-\d{2}-\d{6}/)
+        }.sort.last
+
+      if old_destination
+        args << "--link-dest"
+        args << Pathname.new(File.expand_path(old_destination, destination)).relative_path_from(Pathname.new(new_destination)).to_s
+      end
+
+      exclusions.each do |exclusion|
+        args << "--exclude"
+        args << Pathname.new(exclusion).relative_path_from(Pathname.new(source)).to_s
+      end
+
+      args << source
+      args << new_destination
+
+      system(args.flatten.shelljoin)
+
+      @settings.update_time(action_name, time) unless dryrun
+    end
+
+
+    desc "show <ACTION>", "Show information about the backup action"
+    def show(action_name)
+      data = @settings.action_data(action_name)
+
+      puts "Source: #{data[:source]}"
+      puts "Destination: #{data[:destination]}"
+      print "exclusions: "
+      if data[:exclusions].empty?
+        puts "(No exclusions)"
+      else
+        puts "#{data[:exclusions].size} exclusion(s)"
+        puts data[:exclusions]
+      end
+
+      print "Last backup run at: "
+      if data[:last_run_time].nil?
+        puts "No backup yet"
+      else
+        puts data[:last_run_time]
+      end
+    rescue  ArgumentError => e
+      warn "ERROR: #{e}"
+      exit 1
+    end
+
+    desc "version", "Print the version"
+    def version
+      puts VERSION
+    end
+
+    no_tasks do
+      def rsync_version
+        `rsync --version`.match(/^\s*rsync\s*version\s*(\d+\.\d+\.\d+)/)
+        $1
+      end
+    end
+  end
+end

data/lib/coral_backup/file_selector.rb

@@ -0,0 +1,68 @@
+require "shellwords"
+require "readline"
+
+module CoralBackup
+  class FileSelector
+    attr_reader :files
+
+    def initialize
+      @files = []
+    end
+
+    def add_file(filename)
+      if FileTest.exist?(filename)
+        @files << filename
+      else
+        raise Errno::ENOENT, filename
+      end
+    end
+
+    def self.select
+      file_selector = new
+      Readline.completion_proc = Readline::FILENAME_COMPLETION_PROC
+      while buf = Readline.readline("> ")
+        expanded = Shellwords.split(buf)
+        warn "WARNING: #{expanded.length} files are being added:" unless expanded.length == 1
+
+        expanded.each do |ex|
+          begin
+            file_selector.add_file(ex)
+          rescue Errno::ENOENT => e
+            warn e
+          else
+            warn ex
+          end
+        end
+      end
+
+      file_selector.files.uniq
+    end
+
+
+    def self.single_select
+      file_selector = new
+      Readline.completion_proc = Readline::FILENAME_COMPLETION_PROC
+      file_added = false
+      while !file_added && buf = Readline.readline("> ")
+        expanded = Shellwords.split(buf)
+        warn "WARNING: #{expanded.length} files are being added:" unless expanded.length == 1
+        begin
+          file_selector.add_file(expanded[0])
+        rescue Errno::ENOENT => e
+          warn e
+        else
+          file_added = true
+        end
+      end
+
+      unless file_selector.files.length == 1
+        warn "ERROR: Wrong number of directories (#{file_selector.files.length} for 1):"
+        file_selector.files.each do |e|
+          warn e
+        end
+        exit 1
+      end
+      file_selector.files[0]
+    end
+  end
+end

data/lib/coral_backup/settings.rb

@@ -0,0 +1,58 @@
+require "toml"
+
+module CoralBackup
+  class Settings
+    INITIAL_SETTINGS = {
+      actions: {}
+    }
+
+    def initialize(filename = "#{Dir.home}/.coral")
+      @filename = filename
+      @settings = file_load
+    end
+
+    def action_data(action_name)
+      raise ArgumentError, "Backup action `#{action_name}' does not exist." unless exist_action?(action_name)
+      @settings[:actions][action_name.to_sym]
+    end
+
+    def action_names
+      @settings[:actions].keys.map(&:to_s)
+    end
+
+    def exist_action?(action_name)
+      action_names.include?(action_name)
+    end
+
+    def add(action_name, source, destination, exclusions)
+      raise ArgumentError, "Backup action `#{action_name}' already exists." if exist_action?(action_name)
+      @settings[:actions][action_name.to_sym] = { source: source, destination: destination, exclusions: exclusions }
+      file_dump
+    end
+
+    def delete(action_name)
+      raise ArgumentError, "Backup action `#{action_name}' does not exist." unless exist_action?(action_name)
+      @settings[:actions].delete(action_name.to_sym)
+      file_dump
+    end
+
+    def update_time(action_name, time)
+      raise ArgumentError, "Backup action `#{action_name}' does not exist." unless exist_action?(action_name)
+      @settings[:actions][action_name.to_sym][:last_run_time] = time.to_s
+      file_dump
+    end
+
+    private
+    def file_load
+      return INITIAL_SETTINGS unless FileTest.exist?(@filename)
+
+      TOML.load_file(@filename, symbolize_keys: true)
+    end
+
+    def file_dump
+      open(@filename, "w") do |f|
+        f.puts TOML.dump(@settings)
+      end
+    end
+  end
+end

data/lib/coral_backup/version.rb

@@ -0,0 +1,3 @@
+module CoralBackup
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: coral_backup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OTSUKA Tatsuya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tatzyr@gmail.com
+executables:
+- coral
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coral_backup.gemspec
+- exe/coral
+- lib/coral_backup.rb
+- lib/coral_backup/cli.rb
+- lib/coral_backup/file_selector.rb
+- lib/coral_backup/settings.rb
+- lib/coral_backup/version.rb
+homepage: https://github.com/tatzyr/coral_backup
+licenses:
+- Zlib
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Coral Backup creates incremental backups of files that can be restored at
+  a later date.
+test_files: []