backto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ef31769f44a8b071bdc6ee8db36bfde374e288b
+  data.tar.gz: 2318eeb3c27a0fbac31671855efbbabb742ad8a9
+SHA512:
+  metadata.gz: 357f0c721f93387c089c0222df5da629ff405d45fb6e1040c6e09e614d3cb87926d8d37270bd3051f0f0fe2b28603a2bb3dda4ca2876f18fba246feb1c6ee49b
+  data.tar.gz: aaa26de0169f85437d9024376fe6bf4164d4ae3e3a6a11151d4594dffb6c5d71b01a16acab0f66978a62423e868283c751ac3207a0a3008dc2ec8d27446900ad

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backto.gemspec
+gemspec
+
+gem 'minitest', '~> 5.5.0'
+gem 'single_test'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 john1king
+
+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,39 @@
+# Backto
+
+A simple command line tool for backup files to one location.
+
+## Installation
+
+    $ gem install backto
+
+## Usage
+
+Example of backup Sublime Text 3 config to your Dropbox. You may have some files like below in `~/Dropbox/SublimeText3`
+
+```
+├── Installed\ Packages
+│   ├── 0_package_control_loader.sublime-package
+│   └── Package\ Control.sublime-package
+└── Packages
+    └── User
+        ├── Default\ (OSX).sublime-keymap
+        ├── Package\ Control.sublime-settings
+        └── Preferences.sublime-settings
+```
+
+Just wirte a json config file in `~/Dropbox/sublimetext3.json` like
+
+```json
+{
+    "form": "./SublimeText3",
+    "to": "~/Library/Application Support/Sublime Text 3"
+}
+
+```
+
+And then execute
+
+```
+$ backto ~/Dropbox/sublimetext3.json
+```
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'single_test/tasks'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/backto.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backto"
+  spec.version       = Backto::VERSION
+  spec.authors       = ["john1king"]
+  spec.email         = ["uifantasy@gmail.com"]
+  spec.summary       = %q{Link files easier}
+  spec.description   = %q{A simple command line tool for backup files to one location}
+  spec.homepage      = "https://github.com/john1king/backto"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/backto

@@ -0,0 +1,9 @@
+#! /usr/bin/env ruby
+
+require "backto"
+
+if ARGV[0]
+  Backto.run(ARGV[0])
+else
+  puts 'Usage: backto <CONFIG>'
+end

data/lib/backto.rb

@@ -0,0 +1,26 @@
+require "backto/version"
+require "backto/config"
+require "backto/scanner"
+require "backto/path"
+
+module Backto
+
+  module_function
+
+  def run(config)
+    config = Config.create(config)
+    link_options = {verbose: config[:verbose], force: config[:force]}
+    scanner = Scanner.new(config[:from], config[:exclude_patterns], config[:link_directory])
+    scanner.each do |path, is_recursive|
+      target = path.chdir(config[:to])
+      if path.directory? && is_recursive
+        path.mkdirs target, verbose: config[:verbose]
+      elsif config[:hardlink] && ! path.directory?
+        path.hardlink target, link_options
+      else
+        path.softlink target, link_options
+      end
+    end
+  end
+
+end

data/lib/backto/config.rb

@@ -0,0 +1,67 @@
+require "json"
+
+module Backto
+
+  class Config
+
+    EXCLUDE_PATTERNS = [
+      '.git',
+      '.svn',
+      '.DS_Store',
+      '*.swp',
+    ].freeze
+
+    DEFAULT = {
+      verbose: true,
+      force: false,
+      hardlink: false,
+      link_directory: false,
+      exclude_patterns: EXCLUDE_PATTERNS,
+      clean_link: false,
+    }.freeze
+
+    def self.create(config)
+      config.is_a?(self) ? config : new(config)
+    end
+
+    def initialize(config = {})
+      if config.is_a? String
+        @config = JSON.parse(File.read(config), symbolize_names: true)
+        @base_path = File.expand_path(File.dirname(config))
+      else
+        @config = config
+        @base_path = Dir.pwd
+      end
+    end
+
+    def from
+      @from ||= expand_path fetch(:from)
+    end
+
+    def to
+      @to ||= expand_path fetch(:to)
+    end
+
+    def [](name)
+      method = name.to_sym
+      if respond_to? method
+        send method
+      elsif @config.key? method
+        @config[method]
+      else
+        DEFAULT[method]
+      end
+    end
+
+    private
+
+    def expand_path(path)
+      File.expand_path path, @base_path
+    end
+
+    def fetch(name)
+      @config.fetch(name)
+    end
+  end
+
+end

data/lib/backto/path.rb

@@ -0,0 +1,63 @@
+require "fileutils"
+
+module Backto
+
+  class Path
+    attr_reader :relative
+
+    def initialize(path_name, relative = nil)
+      @path_name = path_name
+      @relative = relative
+    end
+
+    def absolute
+      @absolute ||= File.join(@path_name, relative || '')
+    end
+
+    alias :source :absolute
+
+    def join(file)
+      self.class.new(@path_name, relative ? File.join(relative, file) : file)
+    end
+
+    def chdir(path_name)
+      File.join(path_name, relative)
+    end
+
+    def mkdirs(target, options = {})
+      FileUtils.mkdir_p target, options unless File.exist? target
+    end
+
+    def hardlink(target, options)
+      FileUtils.ln source, target, options
+    rescue Errno::EEXIST
+      raise unless hardlink? target
+    end
+
+    def softlink(target, options = {})
+      return if softlink? target
+      if File.directory?(target) && directory?
+        FileUtils.rm_r target, options if options[:force]
+        FileUtils.ln_s source, File.dirname(target), options
+      else
+        FileUtils.ln_s source, target, options
+      end
+    end
+
+    def softlink?(target)
+      File.symlink?(target) && File.readlink(target) == source
+    end
+
+    def hardlink?(target)
+      File.stat(target).ino == File.stat(source).ino
+    rescue Errno::ENOENT
+      false
+    end
+
+    def directory?
+      @is_directory ||= File.directory?(absolute)
+    end
+
+  end
+
+end

data/lib/backto/scanner.rb

@@ -0,0 +1,61 @@
+require "backto/path"
+
+module Backto
+
+  class Scanner
+    attr_reader :exclude_patterns
+
+    def self.normalize_patterns(patterns)
+      patterns.map do |pattern|
+        normalized = pattern.dup
+        match_dir = normalized.chomp!('/') != nil
+        normalized = '/**/' + normalized unless normalized.start_with?('/')
+        [normalized, match_dir]
+      end
+    end
+
+    def initialize(entry, exclude_patterns = [], skip_recursive = false)
+      @entry = entry
+      @skip_recursive = skip_recursive
+      @exclude_patterns = self.class.normalize_patterns(exclude_patterns)
+    end
+
+    def each(&block)
+      scan Path.new(@entry), &block
+    end
+
+    private
+
+    def scan(parent, &block)
+      Dir.foreach(parent.absolute) do |name|
+        next if name == '.' || name == '..'
+        path = parent.join(name)
+        next if exclude? path
+        is_recursive = recursive?(path)
+        block.call(path, is_recursive)
+        scan(path, &block) if is_recursive
+      end
+    end
+
+    def exclude?(path)
+      test_path = File.join('/', path.relative)
+      exclude_patterns.any? do |pattern, match_dir|
+        fnmatch?(pattern, test_path) && (match_dir ? path.directory? : true)
+      end
+    end
+
+    def recursive?(path)
+      return false unless path.directory?
+      if @skip_recursive.is_a? Array
+        !@skip_recursive.include? path.relative
+      else
+        !@skip_recursive
+      end
+    end
+
+    def fnmatch?(pattern, path_name)
+       File.fnmatch? pattern, path_name, File::FNM_PATHNAME | File::FNM_DOTMATCH
+    end
+  end
+
+end

data/lib/backto/version.rb

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

data/test/backto_test.rb

@@ -0,0 +1,113 @@
+require 'backto'
+require 'minitest/autorun'
+require_relative './helper'
+
+
+class BacktoTest < Minitest::Test
+
+  def test_softlink
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+      t.mkdir 'a/d'
+    end
+
+    to = TempTree.new
+    Backto.run({from: from.dir, to: to.dir, verbose: false})
+
+    assert to.symlink? 'a/b/c'
+    assert to.directory? 'a/d'
+  end
+
+  def test_hardlink
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+      t.mkdir 'a/d'
+    end
+
+    to = TempTree.new
+    Backto.run({from: from.dir, to: to.dir, verbose: false, hardlink: true})
+
+    assert_equal from.inode('a/b/c'), to.inode('a/b/c')
+    assert to.directory? 'a/d'
+  end
+
+  def test_target_exist
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+    end
+
+    to = TempTree.new do |t|
+      t.file 'a/b/c'
+    end
+    assert_raises Errno::EEXIST do
+      Backto.run({from: from.dir, to: to.dir, verbose: false})
+    end
+    assert to.file? 'a/b/c'
+  end
+
+  def test_force
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+    end
+
+    to = TempTree.new do |t|
+      t.file 'a/b/c'
+    end
+
+    refute to.symlink? 'a/b/c'
+    Backto.run({from: from.dir, to: to.dir, verbose: false, force: true})
+    assert to.symlink? 'a/b/c'
+  end
+
+  def test_link_directory
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+    end
+    to = TempTree.new
+    Backto.run({from: from.dir, to: to.dir, verbose: false, link_directory: true})
+    assert to.symlink? 'a'
+    refute to.symlink? 'a/b/c'
+  end
+
+  def test_link_directory_when_target_exist
+    from = TempTree.new do |t|
+      t.mkdir 'a'
+    end
+
+    to = TempTree.new do |t|
+      t.mkdir 'a'
+    end
+    assert_raises Errno::EEXIST do
+      Backto.run({from: from.dir, to: to.dir, verbose: false, link_directory: true})
+    end
+    assert to.directory? 'a'
+    refute to.exist? 'a/a'
+  end
+
+  def test_force_link_directory_when_target_exist
+    from = TempTree.new do |t|
+      t.mkdir 'a'
+    end
+
+    to = TempTree.new do |t|
+      t.file 'a/b'
+    end
+    Backto.run({from: from.dir, to: to.dir, verbose: false, force: true, link_directory: true})
+    assert to.symlink? 'a'
+    refute to.exist? 'a/b'
+    Backto.run({from: from.dir, to: to.dir, verbose: false, force: true, link_directory: true})
+    refute to.exist? 'a/a'
+  end
+
+  def test_exclude_patterns
+    from = TempTree.new do |t|
+      t.file 'a/b/c'
+      t.file 'foo'
+    end
+    to = TempTree.new
+    Backto.run({from: from.dir, to: to.dir, verbose: false, exclude_patterns: ['f*']})
+    assert to.symlink? 'a/b/c'
+    refute to.exist? 'foo'
+  end
+
+end

data/test/config_test.rb

@@ -0,0 +1,47 @@
+require 'backto/config'
+require 'minitest/autorun'
+
+class ConfigTest < Minitest::Test
+
+  def test_default_config
+    config = Backto::Config.new({})
+    assert_equal config[:verbose], true
+  end
+
+  def test_necessary_config
+    config = Backto::Config.new({})
+    %i(from to).each do |key|
+      assert_raises KeyError do
+       config[key]
+      end
+    end
+  end
+
+  def test_absoute_path
+    config = Backto::Config.new({from: '/foo', to: '/bar'})
+    assert_equal config[:from], '/foo'
+    assert_equal config[:to], '/bar'
+  end
+
+  def test_expand_user_path
+    config = Backto::Config.new({from: '~/foo', to: '~root/foo'})
+    assert_equal config[:from], File.expand_path('~/foo')
+    assert_equal config[:to], File.expand_path('~root/foo')
+  end
+
+  def test_expand_relative_path
+    config = Backto::Config.new({from: './foo', to: 'bar'})
+    assert_equal config[:from], File.expand_path(File.join(Dir.pwd, 'foo'))
+    assert_equal config[:to], File.expand_path(File.join(Dir.pwd, 'bar'))
+  end
+
+  def test_file_config
+    fixtures_dir = File.expand_path('../fixtures', __FILE__)
+    file = File.join(fixtures_dir, 'test_file_config.json')
+    config = Backto::Config.new(file)
+    assert_equal config[:from], File.join(fixtures_dir, 'foo')
+    assert_equal config[:to], File.join(fixtures_dir, 'bar')
+    assert_equal config[:verbose], false
+  end
+
+end

data/test/fixtures/test_file_config.json

@@ -0,0 +1,5 @@
+{
+  "from": "./foo",
+  "to": "./bar",
+  "verbose": false
+}

data/test/helper.rb

@@ -0,0 +1,52 @@
+require "fileutils"
+
+class TempTree
+  attr_reader :dir
+
+  def initialize
+    @dir = Dir.mktmpdir
+    yield self if block_given?
+  end
+
+  def mkdir(path)
+    FileUtils.mkdir_p join(path)
+  end
+
+  def file(path, data='')
+    mkdir File.dirname(path)
+    File.write join(path), data
+  end
+
+  def remove(path)
+    FileUtils.rm_rf join(path)
+  end
+
+  def exist?(path)
+    File.exist? join(path)
+  end
+
+  def directory?(path)
+    File.directory? join(path)
+  end
+
+  def symlink?(path)
+    File.symlink? join(path)
+  end
+
+  def file?(path)
+    File.file? join(path)
+  end
+
+  def inode(path)
+    File.stat(join path).ino
+  end
+
+  def join(path)
+    File.join(@dir, path)
+  end
+
+  def destroy
+    FileUtils.rm_rf(@dir, noop: true, verbse: true)
+  end
+
+end

data/test/scanner_test.rb

@@ -0,0 +1,77 @@
+require 'backto/scanner'
+require 'minitest/autorun'
+require_relative './helper'
+
+class ScannerTest < Minitest::Test
+
+
+  def scan_result(*args)
+    Backto::Scanner.new(*args).to_enum.to_a.map(&:first).map(&:relative)
+  end
+
+  def assert_equal_set(expected, actual)
+    assert_equal expected.sort, actual.sort
+  end
+
+  def test_exclude_dir_patterns
+    tree = TempTree.new do |t|
+      t.mkdir 'foo'
+      t.mkdir 'foobar'
+      t.file 'bar'
+    end
+
+    assert_equal_set ['foobar', 'bar'], scan_result(tree.dir, ['foo/'])
+    assert_equal_set ['foo', 'foobar', 'bar'], scan_result(tree.dir, ['bar/'])
+  end
+
+  def test_exclude_recursive_patterns
+    tree = TempTree.new do |t|
+      t.file 'foo'
+      t.file '1/foo'
+      t.file '1/2/foo'
+    end
+
+    # test without exclude_pattern
+    assert_equal_set ['foo', '1', '1/foo', '1/2', '1/2/foo'], scan_result(tree.dir, [])
+    assert_equal_set ['1', '1/2'], scan_result(tree.dir, ['foo'])
+    assert_equal_set ['1', '1/foo', '1/2', '1/2/foo'], scan_result(tree.dir, ['/foo'])
+  end
+
+
+  def test_exclude_subdirectory_files
+    tree = TempTree.new do |t|
+      t.file 'foo/bar/a'
+    end
+
+    assert_equal_set ['foo'], scan_result(tree.dir, ['bar'])
+    assert_equal_set [], scan_result(tree.dir, ['foo'])
+  end
+
+  def test_exclude_match_patterns
+    tree = TempTree.new do |t|
+      t.file 'foo1'
+      t.file 'foo2'
+      t.file 'foo3/bar3'
+      t.file 'foo4/bar4/4'
+      t.file 'foo5/bar5/foobar5/5'
+    end
+
+    assert_equal_set [], scan_result(tree.dir, ['foo*'])
+    assert_equal_set ['foo1', 'foo2'], scan_result(tree.dir, ['foo*/'])
+    assert_equal_set ['foo1', 'foo2', 'foo3', 'foo3/bar3', 'foo4', 'foo5'], scan_result(tree.dir, ['foo*/*/'])
+    assert_equal_set ['foo1', 'foo2', 'foo3', 'foo3/bar3', 'foo4', "foo4/bar4", "foo5", "foo5/bar5", "foo5/bar5/foobar5"], scan_result(tree.dir, ['foo*/**/?'])
+  end
+
+
+  def test_skip_recursive_all
+    tree = TempTree.new do |t|
+      t.file 'foo1'
+      t.file 'foo2/bar2'
+      t.file 'foo3/bar3/3'
+    end
+
+    assert_equal_set ['foo1', 'foo2', 'foo3'], scan_result(tree.dir, [], true)
+    assert_equal_set ['foo1', 'foo2', 'foo2/bar2', 'foo3'], scan_result(tree.dir, [], ['foo3'])
+  end
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: backto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- john1king
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: A simple command line tool for backup files to one location
+email:
+- uifantasy@gmail.com
+executables:
+- backto
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backto.gemspec
+- bin/backto
+- lib/backto.rb
+- lib/backto/config.rb
+- lib/backto/path.rb
+- lib/backto/scanner.rb
+- lib/backto/version.rb
+- test/backto_test.rb
+- test/config_test.rb
+- test/fixtures/test_file_config.json
+- test/helper.rb
+- test/scanner_test.rb
+homepage: https://github.com/john1king/backto
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- 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: Link files easier
+test_files:
+- test/backto_test.rb
+- test/config_test.rb
+- test/fixtures/test_file_config.json
+- test/helper.rb
+- test/scanner_test.rb