bak-shell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82a8960ce4c29af20821e579fd7b8c1f5acb3ea4
+  data.tar.gz: 60407ebba0cde615e224fa2949c1a10850052734
+SHA512:
+  metadata.gz: 5f3a4b5759f252dbc457f5ccfd8be6704e618d309d241ee88438951c1fc6017752f100e91aea026aac37f3c1dd4cc0875be019999db82ae54563db28371fa01a
+  data.tar.gz: 0d444113b60224ad3b8e044f79c7da429fe1e80ed981235937588f3de5a989e659ed6bb8286ae6552e55d1151ac30743149bd24a006ff2267fc259f81ff2cf90

data/.gitignore

@@ -0,0 +1,20 @@
+*.a
+*.bundle
+*.gem
+*.o
+*.rbc
+*.so
+.bundle
+.config
+/.bundle/
+/.config
+/InstalledFiles
+/lib/bundler/man/
+/pkg/
+/tmp/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+mkmf.log
+pkg
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert Audi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+bak-shell
+=========
+
+A backup utility for the shell.
+
+Installation
+------------
+
+```
+> gem install bak-shell
+```
+
+Usage
+-----
+
+```
+> bak help
+```
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/RobertAudi/bak-shell/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+License
+-------
+
+Copyright (c) 2014 Robert Audi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+
+spec = eval(File.read('bak-shell.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+task :default => :package

data/bak-shell.gemspec

@@ -0,0 +1,23 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),"lib","bak-shell","version.rb"])
+Gem::Specification.new do |s|
+  s.name        = "bak-shell"
+  s.version     = BakShell::VERSION
+  s.author      = "Robert Audi"
+  s.email       = "robert@audii.me"
+  s.homepage    = "https://github.com/RobertAudi/bak-shell"
+  s.summary     = "Backup utility for the shell"
+  s.description = "Backup utility that lets you back up files or directories, and manage those backups from the command line"
+  s.license     = "MIT"
+  s.files       = `git ls-files -z`.split("\x0")
+
+  s.bindir        = "bin"
+  s.require_paths << "lib"
+  s.executables   << "bak"
+
+  s.add_development_dependency "rake", "10.3.2"
+  s.add_development_dependency "bundler", "~> 1.6"
+
+  s.add_runtime_dependency "gli", "2.11.0"
+  s.add_runtime_dependency "rainbow", "2.0.0"
+end

data/bin/bak

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/bak-shell"
+
+Signal.trap("SIGINT") do
+  puts "\nTerminating"
+  exit 1
+end
+
+bak = BakShell::CLI
+
+exit bak.run(ARGV)

data/lib/bak-shell/cli.rb

@@ -0,0 +1,20 @@
+module BakShell
+  class CLI
+    extend GLI::App
+
+    program_desc  "Backup utility for the shell"
+    version       BakShell::VERSION
+
+    commands_from File.expand_path(File.join(File.dirname(File.realpath(__FILE__)), "commands"))
+
+    on_error do |exception|
+      case exception
+      when BakShell::BaseError
+        $stderr.puts exception.message.color(:red)
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/bak-shell/commands/backup.rb

@@ -0,0 +1,54 @@
+module BakShell
+  class CLI
+    desc "Backup a file or directory"
+    arg_name "TARGET"
+    command :backup do |c|
+      c.desc "Replace latest version of backup (if present). Default: false"
+      c.switch :R, :replace, default_value: false, negatable: false
+
+      c.action do |global_options, options, args|
+        raise TargetMissingError.new("Target missing") if args.empty?
+        raise TooManyTargetsError.new("Only one target can be specified") if args.count > 1
+
+        target = File.expand_path(args.first)
+        raise InvalidTargetError.new("No such file or directory: #{target}") unless File.exists?(target)
+
+        puts "Backing up...".color(:green)
+
+        indexer = Indexer.instance
+        backup = indexer.backup_with_target(target) || indexer.add(target)
+        backup_dir = File.join(BakShell::BACKUP_DIR, backup.id)
+
+        unless backup.persistent
+          FileUtils.mkdir_p(backup_dir)
+
+          puts "Created new backup directory".color(:green)
+        end
+
+        base_target = File.basename(target)
+        destination = File.join(BakShell::BACKUP_DIR, backup.id, "#{base_target}.bak-latest-#{Time.now.to_f}")
+        previous_latest = Dir.glob(File.join(backup_dir, "*.bak-latest-*"))
+
+        if previous_latest.count == 1
+          previous_latest = previous_latest.first
+
+          if options[:replace]
+            FileUtils.rm_r(previous_latest, force: true)
+
+            puts "Removed old backup".color(:green)
+          else
+            FileUtils.mv(previous_latest, previous_latest.sub(/-latest/, ""))
+
+            puts "Versionned old backup".color(:green)
+          end
+        elsif previous_latest.count > 1
+          raise "Found more than one backup marked as latest"
+        end
+
+        FileUtils.cp_r(target, destination)
+
+        puts "Backup complete!".color(:green)
+      end
+    end
+  end
+end

data/lib/bak-shell/commands/info.rb

@@ -0,0 +1,101 @@
+module BakShell
+  class CLI
+    desc "Show backup info"
+    arg_name "TARGET"
+    command :info do |c|
+      c.desc "Show all backups for a target (Doesn't work if no target is specified!!)"
+      c.switch :a, :all, default_value: false, negatable: false
+
+      c.desc "Show the path to the backup of a target (takes the index of the backup as argument)"
+      c.arg_name "index"
+      c.flag :p, :path, must_match: /\A[1-9][0-9]*\Z/
+
+      c.desc "Show the path to the latest backup of a target (equivalent to `-p 1`)"
+      c.switch :P, :"latest-path", default_value: false, negatable: false
+
+      c.action do |global_options, options, args|
+        raise TooManyTargetsError.new("Only one target can be specified") if args.count > 1
+
+        indexer = Indexer.instance
+
+        if args.empty?
+          illegal_options = {
+            a: false,
+            p: nil,
+            P: false
+          }
+
+          command_switches = c.switches.map { |k, s| { s.name => [s.name, s.aliases].flatten } }.inject({}) { |s, cs| s.merge(cs) }
+          command_flags = c.flags.map { |k, s| { s.name => [s.name, s.aliases].flatten } }.inject({}) { |s, cs| s.merge(cs) }
+          command_options = command_switches.merge(command_flags)
+
+          illegal_error_message = ""
+          options.each do |o, v|
+            if illegal_options.has_key?(o) && illegal_options[o] != v
+              illegal_error_message << "The #{command_options[o].map { |k| "`#{k.length > 1 ? "--" : "-"}#{k}`" }.join("/")} option cannot be used if no target is specified\n".color(:red)
+            end
+          end
+
+          puts "#{illegal_error_message}\n" unless illegal_error_message.empty?
+
+          backups = Hash.new
+          indexer.backups.each { |b| backups[b[:id]] = Dir.glob(File.join(BakShell::BACKUP_DIR, b[:id], "*")).reverse }
+
+          puts "#{backups.values.inject(0) { |count, b| count + b.count }} backups found".color(:green)
+
+          backups.each do |id, b|
+            puts indexer.backup_with_id(id).target
+            puts "\t#{b.count} backups"
+
+            latest = Time.at(b.find { |v| v =~ /\.bak-latest-.*\Z/ }.sub(/\A.*\.bak-latest-/, "").to_f)
+            puts "\tLatest backup time: #{latest}"
+          end
+        else
+          if options[:P] && !options[:p].nil?
+            raise BakShell::InvalidOptionError.new("Conflicting options: `-p`/`--path` and `-P`/`--latest-path`")
+          end
+
+          target = File.expand_path(args.first)
+          backup = indexer.backup_with_target(target)
+
+          raise InvalidBackupError.new("No backup found for file or directory: #{target}") if backup.nil?
+
+          backup_dir = File.join(BakShell::BACKUP_DIR, backup.id)
+
+          if options[:P]
+            puts Dir.glob(File.join(backup_dir, "*.bak-latest-*")).first
+          else
+            backups = Dir.glob(File.join(backup_dir, "*")).reverse
+            backup_count = backups.count
+
+            if !options[:p].nil?
+              if options[:p].to_i > backup_count
+                raise BakShell::InvalidBackupError.new("Invalid backup index: #{options[:p]}")
+              end
+
+              puts backups[options[:p].to_i - 1]
+            else
+              backup_times = backups.map do |b|
+                Time.at(File.basename(b).sub(/\A.*\.bak-(latest-)?/, "").to_f).to_s
+              end
+
+              puts "#{backup_count} found"
+
+              if !options[:a] && backup_count > 5
+                last_five = backup_times[0..4]
+                remaining_backups = backup_times.drop(5).count
+
+                puts "Showing five latest backup times:".color(:green)
+                last_five.each_with_index { |b, i| puts "[#{i + 1}] #{b}" }
+                puts "#{remaining_backups} more..."
+              else
+                puts "Showing all backup times:".color(:green)
+                backup_times.each_with_index { |b, i| puts "[#{i + 1}] #{b}" }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bak-shell/commands/purge.rb

@@ -0,0 +1,60 @@
+module BakShell
+  class CLI
+    desc "Remove (specific) backups"
+    arg_name "TARGET"
+    command :purge do |c|
+      c.desc "Number of backups to keep"
+      c.arg_name "count"
+      c.flag :k, :keep, default_value: 0, must_match: /\A[1-9][0-9]*\Z/
+
+      c.action do |global_options, options, args|
+        puts "Purging...".color(:green)
+
+        indexer = Indexer.instance
+        targets = Array.new
+        ids = Array.new
+
+        if args.empty?
+          raise InvalidBackupError.new("Nothing to purge") if indexer.backups.count == 0
+
+          targets = Dir.glob(File.join(BakShell::BACKUP_DIR, "*"))
+          targets.delete(indexer.index_file)
+
+
+          ids = indexer.ids
+        else
+          args.each do |arg|
+            target = File.expand_path(arg)
+            raise InvalidTargetError.new("No such file or directory: #{target}") unless File.exists?(target)
+
+            backup = indexer.backup_with_target(target)
+
+            if backup.nil?
+              puts"No backup found for file or directory: #{target}".color(:yellow)
+              next
+            end
+
+            targets << File.join(BakShell::BACKUP_DIR, backup.id)
+            ids << backup.id
+          end
+        end
+
+        keep_count = options[:k].to_i
+
+        if keep_count > 0
+          targets = targets.map { |t| Dir.glob(File.join(t, "*")).reverse.drop(keep_count) }.flatten
+          backup_count = targets.count
+        else
+          backup_count = targets.map { |t| Dir.glob(File.join(t, "*")).count }.inject(:+)
+          indexer.remove(ids)
+        end
+
+        if backup_count > 0
+          targets.each { |t| FileUtils.rm_r(t, force: true) }
+        end
+
+        puts "Purging complete! (#{backup_count} backups removed)".color(:green)
+      end
+    end
+  end
+end

data/lib/bak-shell/commands/restore.rb

@@ -0,0 +1,48 @@
+module BakShell
+  class CLI
+    desc "Restore a file or directory"
+    arg_name "TARGET"
+    command :restore do |c|
+      c.desc "Index of backup to restore"
+      c.arg_name "index"
+      c.flag :i, :index, default_value: 1, must_match: /\A[1-9][0-9]*\Z/
+
+      c.action do |global_options, options, args|
+        raise TargetMissingError.new("Target missing") if args.empty?
+        raise TooManyTargetsError.new("Only one target can be specified") if args.count > 1
+
+        target = File.expand_path(args.first)
+
+        raise InvalidTargetError.new("No such file or directory: #{target}") unless File.exists?(target)
+
+        puts "Restoring backup...".color(:green)
+
+        indexer = Indexer.instance
+        backup = indexer.backup_with_target(target)
+
+        raise InvalidBackupError.new("No backup found for file or directory: #{target}") if backup.nil?
+
+        backup_dir = File.join(BakShell::BACKUP_DIR, backup.id)
+        index = options[:i].to_i
+
+        if index == 1
+          backup_to_restore = Dir.glob(File.join(backup_dir, "*.bak-latest-*")).first
+        else
+          backups = Dir.glob(File.join(backup_dir, "*")).reverse
+
+          raise BakShell::InvalidBackupError.new("Invalid backup index: #{index}") if index > backups.count
+
+          backup_to_restore = backups[index - 1]
+        end
+
+        temp_bak = "#{target}.bak-#{Time.now.to_f}"
+
+        FileUtils.mv(target, temp_bak)
+        FileUtils.cp_r(backup_to_restore, target)
+        FileUtils.rm_r(temp_bak, force: true)
+
+        puts "Backup restored!".color(:green)
+      end
+    end
+  end
+end

data/lib/bak-shell/exceptions.rb

@@ -0,0 +1,8 @@
+module BakShell
+  class BaseError < ArgumentError; end
+  class TargetMissingError  < BaseError; end
+  class TooManyTargetsError < BaseError; end
+  class InvalidTargetError  < BaseError; end
+  class InvalidBackupError  < BaseError; end
+  class InvalidOptionError  < BaseError; end
+end

data/lib/bak-shell/indexer.rb

@@ -0,0 +1,115 @@
+require "singleton"
+require "ostruct"
+require "csv"
+require "securerandom"
+
+module BakShell
+  class Indexer
+    include Singleton
+
+    def backup_with_id(id)
+      return @backup if !@backup.nil? && id == @backup.id
+
+      backup = self.find_by_id(id)
+
+      if backup.nil?
+        @backup = nil
+      else
+        @backup = OpenStruct.new(backup)
+      end
+
+      @backup
+    end
+
+    def backup_with_target(target)
+      return @backup if !@backup.nil? && target == @backup[:target]
+
+      backup = self.find_by_target(target)
+
+      if backup.nil?
+        @backup = nil
+      else
+        @backup = OpenStruct.new(backup)
+      end
+
+      @backup
+    end
+
+    def add(target)
+      if self.targets.include?(target)
+        raise "Attempt to add an existing backup to the index"
+      end
+
+      begin
+        id = SecureRandom.hex
+      end while self.ids.include?(id)
+
+      CSV.open(self.index_file, "ab") { |f| f << [id, target] }
+
+      self.ids << id
+      self.targets << target
+      self.backups << { id: id, target: target, persistent: false }
+
+      @backup = OpenStruct.new(self.backups.last)
+    end
+
+    def remove(ids)
+      new_index = self.backups.select { |b| !ids.include?(b[:id]) }
+      new_index.map { |b| b.delete(:persistent) }
+      CSV.open(self.index_file, "wb") do |f|
+        new_index.each { |b| f << b.values }
+      end
+    end
+
+    def index_file
+      if @index_file.nil?
+        @index_file = File.join(BakShell::BACKUP_DIR, "baklist.index")
+        FileUtils.touch(@index_file)
+      end
+
+      @index_file
+    end
+
+    def index_file_exists?
+      File.file?(self.index_file)
+    end
+
+    def ids
+      self.load! if @ids.nil?
+
+      @ids
+    end
+
+    def targets
+      self.load! if @targets.nil?
+
+      @targets
+    end
+
+    def backups
+      self.load! if @backups.nil?
+
+      @backups
+    end
+
+    def load!
+      @ids = Array.new
+      @targets = Array.new
+      @backups = Array.new
+      CSV.foreach(self.index_file) do |row|
+        @ids << row.first
+        @targets << row.last
+        @backups << { id: row.first, target: row.last, persistent: true }
+      end
+    end
+    alias_method :reload!, :load!
+
+    def find_by_id(id)
+      self.backups.find { |b| id == b[:id] }
+    end
+
+    def find_by_target(target)
+      self.backups.find { |b| target == b[:target] }
+    end
+  end
+end

data/lib/bak-shell/version.rb

@@ -0,0 +1,3 @@
+module BakShell
+  VERSION = "0.0.1"
+end

data/lib/bak-shell.rb

@@ -0,0 +1,21 @@
+# Dev shit
+if ENV["BAK_SHELL_DEV_SHIT"] == "devshit"
+  require "awesome_print" rescue nil
+end
+
+# Standard lib shit
+require "fileutils"
+
+# Require gems shit
+require "gli"
+require "rainbow/ext/string"
+
+module BakShell
+  # BACKUP_DIR = File.expand_path(File.join(ENV["HOME"], "bak"))
+  BACKUP_DIR = File.expand_path(File.join(ENV["HOME"], "tmp", "bak"))
+end
+
+require_relative "./bak-shell/version"
+require_relative "./bak-shell/exceptions"
+require_relative "./bak-shell/indexer"
+require_relative "./bak-shell/cli"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: bak-shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Audi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Backup utility that lets you back up files or directories, and manage
+  those backups from the command line
+email: robert@audii.me
+executables:
+- bak
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bak-shell.gemspec
+- bin/bak
+- lib/bak-shell.rb
+- lib/bak-shell/cli.rb
+- lib/bak-shell/commands/backup.rb
+- lib/bak-shell/commands/info.rb
+- lib/bak-shell/commands/purge.rb
+- lib/bak-shell/commands/restore.rb
+- lib/bak-shell/exceptions.rb
+- lib/bak-shell/indexer.rb
+- lib/bak-shell/version.rb
+homepage: https://github.com/RobertAudi/bak-shell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- 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.2.2
+signing_key: 
+specification_version: 4
+summary: Backup utility for the shell
+test_files: []