dotbox 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    backbox (1.0.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.0)
+    childprocess (0.3.8)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.2.1)
+    ffi (1.4.0)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    json (1.7.7)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    thor (0.17.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  backbox!
+  rspec

data/README.md

@@ -0,0 +1,41 @@
+# Dotbox
+
+Backup your dotfiles to dropbox and restore them easily.
+
+## Installation
+
+```
+gem i dotbox
+```
+
+## Usage
+
+```
+$ dotbox -h
+Tasks:
+  dotbox add          # Backup the file
+  dotbox help [TASK]  # Describe available tasks or one specific task
+  dotbox remove       # Remove the backuped file
+  dotbox restore      # Restore all backuped files
+  dotbox setup        # Setup bakbox
+```
+
+## How does it works?
+
+Assume that we have a file named `/home/meck/.zshrc`.
+
+When you run `dotbox add .zshrc`, it equals running following commands:
+```
+$ mv /home/meck/.zshrc /home/meck/Dropbox/Apps/Dotbox/.zshrc
+$ ln -s /home/meck/Dropbox/Apps/Dotbox/.zshrc /home/meck/.zshrc
+```
+
+When you run `dotbox remove .zshrc`, it equals running following commands:
+```
+$ rm /home/meck/.zshrc
+$ mv /home/meck/Dropbox/Apps/Dotbox/.zshrc /home/meck.zshrc
+```
+
+When you run `dotbox restore` it will link all files in dropbox to  their original postions.
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/dotbox

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'dotbox/cli'
+
+Dotbox::CLI.start

data/dotbox.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path("../lib/dotbox/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "dotbox"
+  s.description = "Backup your dotfiles to dropbox and restore them easily."
+  s.summary = s.description
+  s.authors = ["Wei Zhu"]
+  s.email = ["yesmeck@gmail.com"]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = "https://github.com/yesmeck/dotbox"
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Dotbox::VERSION::STRING
+
+  s.add_dependency 'thor'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rspec'
+end

data/features/add.feature

@@ -0,0 +1,29 @@
+Feature: add file to dropbox
+
+  In order backup the file
+  As a user
+  I want to add the file to dropbox and link it back
+
+  @announce
+  Scenario: add a not exist file
+    When I run `dotbox add not_exist_file`
+    Then the stdout should contain "not exist"
+
+  @announce
+  Scenario: add a exists file
+    Given an empty file named "foo/bar"
+    When I run `dotbox add foo/bar`
+    Then a file named "dropbox/Apps/Dotbox/foo/bar" should exist
+    And the link named "foo/bar" should be a link of "dropbox/Apps/Dotbox/foo/bar"
+    And the record file should contain "foo/bar" => "file"
+
+  @announce
+  Scenario: add a directory
+    Given a directory named "foo/bar"
+    Given an empty file named "foo/bar/example"
+    When I run `dotbox add foo/bar`
+    Then a directory named "dropbox/Apps/Dotbox/foo/bar"
+    And a directory named "dropbox/Apps/Dotbox/foo/bar" should exist
+    And the link named "foo/bar" should be a link of "dropbox/Apps/Dotbox/foo/bar"
+    And the record file should contain "foo/bar" => "directory"
+

data/features/remove.feature

@@ -0,0 +1,48 @@
+Feature: remove a file from dotbox
+
+  As a user
+  I want to remove a file from dotbox
+
+  @announce
+  Scenario: remove a not exist file
+    When I run `dotbox remove not_exist_file`
+    Then the stdout should contain "not exist"
+
+  @announce
+  Scenario: remove a not backuped file
+    Given an empty file named "foo/bar"
+    When I run `dotbox remove foo/bar`
+    Then the stdout should contain "not backuped"
+
+  @announce
+  Scenario: remove a backuped file
+    Given a backuped file named "foo/bar"
+    When I run `dotbox remove foo/bar`
+    Then a file named "dropbox/Apps/Dotbox/foo/bar" should not exist
+    And a file named "dropbox/Apps/Dotbox/foo" should not exist
+    And a file named "foo/bar" should exist
+    And the file named "foo/bar" should not be a link
+    And the record file should not contain "foo/bar"
+
+  @announce
+  Scenario: remove a backuped directory
+    Given a backuped directory named "foo/bar"
+    When I run `dotbox remove foo/bar`
+    Then a directory named "dropbox/Apps/Dotbox/foo/bar" should not exist
+    And a directory named "dropbox/Apps/Dotbox/foo" should not exist
+    And a directory named "foo/bar" should exist
+    And the directory named "foo/bar" should not be a link
+    And the record file should not contain "foo/bar"
+
+  @announce
+  Scenario: remove a backuped file in which directory has two files
+    Given a backuped file named "foo/bar"
+    And a backuped file named "foo/baz"
+    When I run `dotbox remove foo/bar`
+    Then a file named "dropbox/Apps/Dotbox/foo/bar" should not exist
+    And a file named "dropbox/Apps/Dotbox/foo/baz" should exist
+    And a file named "foo/bar" should exist
+    And the file named "foo/bar" should not be a link
+    And the record file should not contain "foo/bar"
+    And the record file should contain "foo/baz" => "file"
+

data/features/restore.feature

@@ -0,0 +1,16 @@
+Feature: restore backuped files
+
+  I got a fresh system
+  In order to restore all my backuped files
+  I can use `dotbox restore`
+
+  @announce
+  Scenario: restore all backuped files
+    Given a backup file named "foo/bar"
+    Given a backup directory named "baz/bar"
+    When I run `dotbox restore`
+    Then a link named "foo/bar" should exist
+    And the link named "foo/bar" should be a link of "dropbox/Apps/Dotbox/foo/bar"
+    And a link named "baz/bar" should exist
+    And the link named "baz/bar" should be a link of "dropbox/Apps/Dotbox/baz/bar"
+

data/features/setup.feature

@@ -0,0 +1,15 @@
+Feature: setup dotbox
+
+  This is my first time to use dotbox
+  So I want to setup it
+
+  @announce
+  Scenario: setup dotbox
+    Given a directory named "dropbox"
+    When I run `dotbox setup` interactively
+    And I type "dropbox"
+    Then a file named ".dotbox" should exist
+    And the file ".dotbox" should contain exactly:
+    """
+    dropbox
+    """

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,65 @@
+require 'dotbox'
+require 'dotbox/config'
+require 'dotbox/record'
+require 'dotbox/api'
+
+World(Aruba::Api)
+World(Dotbox::Api)
+
+Given /^a backuped file named "(.*?)"$/ do |path|
+  write_file(path, "")
+  in_current_dir do
+    create_backup(path)
+  end
+end
+
+Given /^a backuped directory named "(.*?)"$/ do |path|
+  in_current_dir do
+    _mkdir(path)
+    create_backup(path)
+  end
+end
+
+Given /^a backup file named "(.*?)"$/ do |path|
+  in_current_dir do
+    create_backup_file path
+  end
+end
+
+Given /^a backup directory named "(.*?)"$/ do |path|
+  in_current_dir do
+    create_backup_directory path
+  end
+end
+
+
+Then /^the link named "(.*?)" should be a link of "(.*?)"$/ do |link, file|
+  in_current_dir do
+    link_file = File.readlink(link) rescue nil
+    link_file.should == File.expand_path(file)
+  end
+end
+
+Then /^the (?:file|directory) named "(.*?)" should not be a link$/ do |path|
+  in_current_dir do
+    File.should_not be_symlink(path)
+  end
+end
+
+Then /^a link named "(.*?)" should exist$/ do |link|
+  in_current_dir do
+    File.should be_symlink(link)
+  end
+end
+
+Then /^the record file should contain "(.*?)" => "(.*?)"$/ do |path, type|
+  record  = Dotbox::Record.new
+  record[path].should == type
+end
+
+
+Then /^the record file should not contain "(.*?)"$/ do |path|
+  record  = Dotbox::Record.new
+  record[path].should be nil
+end
+

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require 'aruba/cucumber'
+require 'cucumber/rspec/doubles'
+require File.expand_path('../../../lib/dotbox/config.rb', __FILE__)
+
+ENV['PATH'] = "#{File.expand_path('../../bin/dotbox', __FILE__)}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+ENV['HOME'] = File.expand_path('../../../tmp/aruba', __FILE__)
+ENV['DROPBOX_PATH'] = "#{ENV['HOME']}/dropbox"

data/lib/dotbox.rb

@@ -0,0 +1,5 @@
+require 'thor'
+
+module Dotbox
+  CONFIG_FILE = "#{Thor::Util.user_home}/.dotbox"
+end

data/lib/dotbox/actions.rb

@@ -0,0 +1,13 @@
+module Dotbox
+  module Actions
+
+    def rm_empty_dir(path)
+      return nil if !::File.directory?(path)
+      if (Dir.entries(path) - %w{. ..}).empty?
+        FileUtils.rm_r path
+        rm_empty_dir ::File.dirname(path)
+      end
+    end
+
+  end
+end

data/lib/dotbox/api.rb

@@ -0,0 +1,29 @@
+require 'dotbox'
+require 'dotbox/config'
+require 'dotbox/record'
+require 'dotbox/file'
+
+module Dotbox
+  module Api
+
+    def create_backup(path)
+      file = Dotbox::File.new(path)
+      file.backup
+      Dotbox::Record.new.add file
+    end
+
+    def create_backup_file(path)
+      FileUtils.mkdir ::File.dirname(path)
+      FileUtils.touch path
+      create_backup path
+      FileUtils.rm path
+    end
+
+    def create_backup_directory(path)
+      FileUtils.mkdir_p path
+      create_backup path
+      FileUtils.rm_r path
+    end
+
+  end
+end

data/lib/dotbox/cli.rb

@@ -0,0 +1,75 @@
+require 'dotbox'
+require 'dotbox/config'
+require 'dotbox/file'
+require 'dotbox/record'
+
+module Dotbox
+  class CLI < Thor
+
+    desc :setup, 'Setup bakbox'
+    def setup
+      dropbox_path = ask('Enter dropbox folder location:').strip
+      Dotbox::Config.new(Dotbox::CONFIG_FILE, dropbox_path)
+    end
+
+    desc :add, 'Backup the file'
+    def add(*pathes)
+      check_setup
+      @record = Record.new
+      pathes.each do |path|
+        path = ::File.expand_path(path)
+        if ::File.exists?(path)
+          file = File.new(path)
+          file.backup
+          @record.add file
+        else
+          say "#{path} not exists."
+        end
+      end
+    end
+
+    desc :remove, 'Remove the backuped file'
+    def remove(*pathes)
+      check_setup
+      @record = Record.new
+      pathes.each do |path|
+        path = ::File.expand_path(path)
+        file = File.new(path)
+        if !::File.exists?(path)
+          die "#{path} not exists."
+        elsif !file.backuped?
+          die "#{path} is not backuped."
+        end
+        file.remove
+        @record.remove file
+      end
+    end
+
+    desc :restore, 'Restore all backuped files'
+    def restore
+      check_setup
+      @record = Record.new
+      @record.each do |path|
+        file = File.new(path)
+        file.restore
+      end
+    end
+
+    def self.source_root
+      ::File.dirname(::File.expand_path('../../../bin/dotbox', __FILE__))
+    end
+
+    private
+    def check_setup
+      if !Config.new(Dotbox::CONFIG_FILE).setted?
+        die 'Use `bakbox setup` to setup dotbox first.'
+      end
+    end
+
+    def die(msg)
+      say msg
+      exit;
+    end
+
+  end
+end

data/lib/dotbox/config.rb

@@ -0,0 +1,31 @@
+module Dotbox
+  class Config
+
+    def initialize(file, value = nil)
+      @file = file
+      if !value.nil?
+        save(value)
+      end
+    end
+
+    def value
+      if ENV['DROPBOX_PATH'].nil?
+        ::File.new(@file).read.strip.chomp('/')
+      else
+        ENV['DROPBOX_PATH']
+      end
+    end
+
+    def setted?
+      ::File.exists?(@file) || !ENV['DROPBOX_PATH'].nil?
+    end
+
+    private
+    def save(value)
+      f = ::File.new(@file, 'w+')
+      f.write(value)
+      f.close
+    end
+
+  end
+end

data/lib/dotbox/file.rb

@@ -0,0 +1,63 @@
+require 'dotbox/actions'
+
+module Dotbox
+  class File
+
+    attr_reader :abs_path, :rel_path
+
+    include Dotbox::Actions
+
+    def initialize(path)
+      @abs_path = ::File.expand_path(path)
+      @rel_path = @abs_path.sub(/^#{Thor::Util.user_home}\//, '')
+    end
+
+    def directory?
+      ::File.directory?(@abs_path)
+    end
+
+    def backup_path
+      if @backup_path.nil?
+        backup_path = "#{Config.new(Dotbox::CONFIG_FILE).value}/Apps/Dotbox"
+        @backup_path = ::File.expand_path("#{backup_path}/#{@rel_path}")
+      end
+      @backup_path
+    end
+
+    def backup
+      FileUtils.mkdir_p ::File.dirname(backup_path)
+      FileUtils.mv @abs_path, backup_path
+      FileUtils.ln_s backup_path, @abs_path
+    end
+
+    def remove
+      # must get the backup path first
+      backup_path
+      FileUtils.rm @abs_path
+      FileUtils.mv backup_path, @abs_path
+      rm_empty_dir ::File.dirname(backup_path)
+    end
+
+    def restore
+      FileUtils.mkdir_p ::File.dirname(@abs_path)
+      FileUtils.ln_s backup_path, @abs_path
+    end
+
+    def backuped?
+      link? && link_of?(backup_path)
+    end
+
+    def link?
+      ::File.symlink? @abs_path
+    end
+
+    def link_of?(src)
+      ::File.readlink(@abs_path) == src
+    end
+
+    def type
+      @type = directory? ? 'directory' : 'file'
+    end
+
+  end
+end

data/lib/dotbox/record.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'dotbox/file'
+
+module Dotbox
+  class Record
+
+    def initialize
+      @record_file_path = "#{Config.new(Dotbox::CONFIG_FILE).value}/Apps/Dotbox/.dotbox"
+      if !::File.exists?(@record_file_path)
+        FileUtils.mkdir_p(::File.dirname(@record_file_path))
+        FileUtils.touch(@record_file_path)
+      end
+      @records = YAML.load_file(@record_file_path) || {}
+    end
+
+    def add(file)
+      @records[file.rel_path] = file.type
+      save
+    end
+
+    def remove(file)
+      @records.delete file.rel_path
+      save
+    end
+
+    def save
+      record_file = ::File.new(@record_file_path, 'w+')
+      record_file.puts(YAML.dump(@records))
+      record_file.close
+    end
+
+    def [](path)
+      @records[path]
+    end
+
+    def each
+      @records.each do |path, type|
+        yield path
+      end
+    end
+
+  end
+end

data/lib/dotbox/version.rb

@@ -0,0 +1,10 @@
+module Dotbox
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: dotbox
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Wei Zhu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Backup your dotfiles to dropbox and restore them easily.
+email:
+- yesmeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/dotbox
+- dotbox.gemspec
+- features/add.feature
+- features/remove.feature
+- features/restore.feature
+- features/setup.feature
+- features/step_definitions/file_steps.rb
+- features/support/env.rb
+- lib/dotbox.rb
+- lib/dotbox/actions.rb
+- lib/dotbox/api.rb
+- lib/dotbox/cli.rb
+- lib/dotbox/config.rb
+- lib/dotbox/file.rb
+- lib/dotbox/record.rb
+- lib/dotbox/version.rb
+homepage: https://github.com/yesmeck/dotbox
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Backup your dotfiles to dropbox and restore them easily.
+test_files:
+- features/add.feature
+- features/remove.feature
+- features/restore.feature
+- features/setup.feature
+- features/step_definitions/file_steps.rb
+- features/support/env.rb
+has_rdoc: