dir_sync 0.1.0 → 0.1.1

data/HISTORY.rdoc

@@ -1,4 +1,10 @@
-= 0.1.0
+= 0.1.1 Sun 29 Jan 2012 14:40:03 EST
 
-Fri 27 Jan 2012 20:57:18 EST
-Initial release
+* moved everything into a DirSync module to prevent any namespace collisions.
+* explicitly stated support for ruby 1.9 only in gem specification
+* changed drain script to accept any number of parameters
+
+= 0.1.0 Fri 27 Jan 2012 20:57:18 EST
+
+* initial release
+* performs multidirectional synchronisation for any number of local directories

data/README.rdoc

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/markryall/dir_sync.png)](http://travis-ci.org/markryall/dir_sync)
+
 = dir_sync
 
 Produce a script to synchronise two directories.  Kind of like unison but a bit simpler.
@@ -12,10 +14,13 @@ in subsequent synchronisations to detect deletions.  You can then review the com
 before executing them (in case they seem likely to do something undesirable). Note that
 files that differ only in modification time will be overwritten with the most recent one.
 
-    drain script
+    drain script1 script2
 
-This simply runs each line in the specified script.  As each line is executed, a new script is
-produced.  The purpose of this is to allow the script to be interrupted and able to resume.
+This simply runs each line in the specified scripts rewriting the script as each
+command is succesfully executed. This is just so if the script is interrupted or
+killed, you can resume.  Note that the new file will be written to a temp file first
+(in case the rewriting is interrupted), each command must appear on a single line
+and it is likely that the command interrupted will be rexecuted.
 
 Together, these scripts can be used as follows:
 

data/Rakefile

@@ -1,12 +1,20 @@
 require 'bundler/gem_tasks'
 
-task :default => :test
-task :test => [:spec, :features]
+task :default => [:spec, :cucumber]
 
-task :spec do
-  sh 'rspec spec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'cucumber/rake/task'
+namespace :cucumber do
+  Cucumber::Rake::Task.new :strict do |task|
+    task.cucumber_opts = '-p strict'
+  end
+
+  Cucumber::Rake::Task.new :wip do |task|
+    task.cucumber_opts = '-p wip'
+  end
 end
 
-task :features do
-  sh 'cucumber'
-end
+desc 'Run all Cucumber features'
+task :cucumber => ['cucumber:wip', 'cucumber:strict']

data/bin/dir_sync

@@ -1,13 +1,4 @@
 #!/usr/bin/env ruby
-
 $: << File.dirname(__FILE__)+'/../lib'
-
-require 'synchroniser'
-
-if ARGV.size < 3
-  puts "usage: #{__FILE__} name directory1 directory2 ..."
-  puts " set DEBUG for verbose output"
-  exit 1
-end
-
-Synchroniser.iterate *ARGV
+require 'dir_sync'
+DirSync.sync *ARGV

data/bin/drain

@@ -1,18 +1,4 @@
 #!/usr/bin/env ruby
-
-if ARGV.empty?
-  puts "Runs a set of single line commands one by one (so that you can interrupt and the script will resume)"
-  puts "usage: #{__FILE__} script"
-  exit 1
-end
-
-file = ARGV.shift
-lines = File.readlines(file).map {|s| s.chomp.strip }.select {|s| !s.empty? and !s.start_with?('#')}
-
-loop do
-  break if lines.empty?
-  lines.shift.tap {|s| puts "> #{s}" }.tap {|s| puts `#{s}` }
-  File.open("#{file}.tmp", 'w') {|f| f.puts lines.join "\n" }
-  `mv #{file}.tmp #{file}`
-end
-`rm #{file}`
+$: << File.dirname(__FILE__)+'/../lib'
+require 'dir_sync'
+DirSync.drain *ARGV

data/features/backup.feature

@@ -0,0 +1,76 @@
+Feature: Synchonising folders
+  As a practical, intelligent and charismatic person
+  I want to synchronise folders
+  So that I can keep multiple backup copies of my work
+
+Scenario: Syncing two empty directories
+  Given a directory named "a"
+  And a directory named "b"
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+
+  """
+
+Scenario: Syncing two non existant directories
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+
+  """
+  And a directory named "a" should exist
+  And a directory named "b" should exist
+
+Scenario: Syncing a single file from left to right
+  Given a directory named "a"
+  And I write to "a/readme.txt" with:
+  """
+  The content
+  """
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+  cp -p "a/readme.txt" "b/readme.txt"
+
+  """
+
+Scenario: Syncing a single file from right to left
+  Given a directory named "b"
+  And I write to "b/readme.txt" with:
+  """
+  The content
+  """
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+  cp -p "b/readme.txt" "a/readme.txt"
+
+  """
+
+Scenario: Do nothing when files are already in sync with history
+  Given the file system:
+  | path         | time |
+  | a/readme.txt | 1000 |
+  | b/readme.txt | 1000 |
+  And past synchronisation history:
+  | path         | time |
+  | readme.txt   | 1000 |
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+
+  """
+
+Scenario: Detecting a deletion from past history
+  Given the file system:
+  | path         | time |
+  | b/readme.txt | 1000 |
+  And past synchronisation history:
+  | path         | time |
+  | readme.txt   | 1000 |
+  When I successfully run `dir_sync test a b`
+  Then the stdout should contain exactly:
+  """
+  rm "b/readme.txt"
+
+  """

data/features/step_definitions/dir_sync_steps.rb

@@ -0,0 +1,22 @@
+Given /^the file system:$/ do |table|
+  `mkdir -p tmp/aruba`
+  Dir.chdir 'tmp/aruba' do
+    table.hashes.each do |row|
+      path, time =  row['path'], row['time'].to_i
+      formatted_time = Time.at(time).strftime '%Y%m%d%H%M.%S'
+      `mkdir -p #{File.dirname path}`
+      `touch -t #{formatted_time} #{path}`
+    end
+  end
+end
+
+Given /^past synchronisation history:$/ do |table|
+  home = File.expand_path '~'
+  `mkdir #{home}/.dir_sync`
+  File.open("#{home}/.dir_sync/test", 'w') do |f|
+    table.hashes.each do |row|
+      path, time =  row['path'], row['time'].to_i
+      f.puts "#{path}:#{time}"
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+Before do
+  `rm ~/.dir_sync/test`
+end

data/lib/{change_log_file_system.rb → dir_sync/change_log_file_system.rb}

@@ -1,4 +1,7 @@
-class ChangeLogFileSystem
+module DirSync
+end
+
+class DirSync::ChangeLogFileSystem
   def initialize io
     @io = io
   end
@@ -12,4 +15,4 @@ class ChangeLogFileSystem
   def rm path
     @io.puts "rm \"#{path}\""
   end
-end
+end

data/lib/{change_resolver.rb → dir_sync/change_resolver.rb}

@@ -1,4 +1,7 @@
-class ChangeResolver
+module DirSync
+end
+
+class DirSync::ChangeResolver
   def debug message
     puts "# #{message}" if ENV['DEBUG']
   end
@@ -71,4 +74,4 @@ private
     exps.each { |exp| return exp unless exp == 0 }
     0
   end
-end
+end

data/lib/{historical_traverser.rb → dir_sync/history_traverser.rb}

@@ -1,4 +1,7 @@
-class HistoricalTraverser
+module DirSync
+end
+
+class DirSync::HistoryTraverser
   attr_reader :name, :ts, :base, :description
   REGEXP = /:(\d+)$/
 
@@ -43,4 +46,4 @@ class HistoricalTraverser
   def empty?
     @description.nil?
   end
-end
+end

data/lib/{traverser.rb → dir_sync/traverser.rb}

@@ -1,6 +1,9 @@
 require 'pathname'
 
-class Traverser
+module DirSync
+end
+
+class DirSync::Traverser
   attr_reader :base
 
   TOLERANCE=5
@@ -57,4 +60,4 @@ class Traverser
   def equivalent? traverser
     name == traverser.name and (ts - traverser.ts).abs <= TOLERANCE
   end
-end
+end

data/lib/dir_sync.rb

@@ -0,0 +1,40 @@
+require 'dir_sync/change_log_file_system'
+require 'dir_sync/traverser'
+require 'dir_sync/history_traverser'
+require 'dir_sync/change_resolver'
+
+module DirSync
+  def self.sync name, *paths
+    if paths.count < 2
+      puts "usage: #{__FILE__} name directory1 directory2 ..."
+      puts " set DEBUG for verbose output"
+      exit 1
+    end
+    file_system = DirSync::ChangeLogFileSystem.new $stdout
+    traversers = paths.map {|path| DirSync::Traverser.new path, file_system }
+    history = DirSync::HistoryTraverser.new name
+    resolver = DirSync::ChangeResolver.new history, *traversers
+    loop { break unless resolver.iterate }
+    history.close
+  end
+
+  def self.drain *paths
+    if paths.empty?
+      puts "usage: #{__FILE__} *scripts"
+      puts "  Runs a set of single line commands one by one (so that you can interrupt and the script will resume)"
+      exit 1
+    end
+
+    paths.each do |path|
+      lines = File.readlines(path).map {|s| s.chomp.strip }.select {|s| !s.empty? and !s.start_with?('#')}
+
+      loop do
+        break if lines.empty?
+        lines.shift.tap {|s| puts "> #{s}" }.tap {|s| puts `#{s}` }
+        File.open("#{path}.tmp", 'w') {|f| f.puts lines.join "\n" }
+        `mv #{path}.tmp #{path}`
+      end
+      `rm #{path}`
+    end
+  end
+end

data/spec/dir_sync/change_log_file_system_spec.rb

@@ -0,0 +1,24 @@
+$: << File.dirname(__FILE__)+'/../lib'
+
+require 'dir_sync/change_log_file_system'
+
+describe DirSync::ChangeLogFileSystem do
+  let(:io) { stub 'io' }
+  let(:file_system) { DirSync::ChangeLogFileSystem.new io }
+
+  it 'should cp a file' do
+    io.should_receive(:puts).with 'cp -p "from" "to"'
+    file_system.cp 'from', 'to'
+  end
+
+  it 'should mkdir for cp when parent does not exist' do
+    io.should_receive(:puts).with 'mkdir -p "a/b/c"'
+    io.should_receive(:puts).with 'cp -p "from" "a/b/c/to"'
+    file_system.cp 'from', 'a/b/c/to'
+  end
+
+  it 'should rm a file' do
+    io.should_receive(:puts).with 'rm "file"'
+    file_system.rm 'file'
+  end
+end

data/spec/{change_resolver_spec.rb → dir_sync/change_resolver_spec.rb}

@@ -1,11 +1,11 @@
 $: << File.dirname(__FILE__)+'/../lib'
 
-require 'change_resolver'
+require 'dir_sync/change_resolver'
 
-describe ChangeResolver do
+describe DirSync::ChangeResolver do
   let(:history) { stub 'history', name: nil, base: nil, description: nil, report: nil, advance: nil }
   let(:traversers) { [] }
-  let(:resolver) { ChangeResolver.new history, *traversers }
+  let(:resolver) { DirSync::ChangeResolver.new history, *traversers }
 
   def stub_history hash
     hash.each do |meth,ret|

data/spec/dir_sync/history_traverser_spec.rb

@@ -0,0 +1,25 @@
+$: << File.dirname(__FILE__)+'/../lib'
+
+require 'dir_sync/history_traverser'
+
+describe DirSync::HistoryTraverser do
+  let(:dir_sync_path) { stub 'dir_sync_path', mkpath: nil }
+  let(:new_path) { stub 'new_path' }
+  let(:traverser) { DirSync::HistoryTraverser.new 'test' }
+
+  before do
+    File.stub!(:expand_path).with('~').and_return '/home/user'
+    Pathname.stub!(:new).with('/home/user/.dir_sync').and_return dir_sync_path
+    File.stub!(:open).with('/home/user/.dir_sync/test.new', 'w').and_return new_path
+  end
+
+  it 'should create the ~/.dir_sync directory' do
+    dir_sync_path.should_receive :mkpath
+    traverser
+  end
+
+  it 'should open the new file for capturing new state' do
+    File.should_receive(:open).with '/home/user/.dir_sync/test.new', 'w'
+    traverser
+  end
+end

data/spec/{traverser_spec.rb → dir_sync/traverser_spec.rb}

@@ -1,11 +1,11 @@
 $: << File.dirname(__FILE__)+'/../lib'
 
-require 'traverser'
+require 'dir_sync/traverser'
 
-describe Traverser do
+describe DirSync::Traverser do
   let(:pathname) { stub 'pathname', mkpath: nil, find: nil}
   let(:file_system) { stub 'file_system'}
-  let(:traverser) { Traverser.new 'a', file_system }
+  let(:traverser) { DirSync::Traverser.new 'a', file_system }
 
   before do
     Pathname.should_receive(:new).with('a').and_return pathname
@@ -55,4 +55,4 @@ describe Traverser do
     file_system.should_receive(:cp).with 'a/1.txt', 'b/1.txt'
     traverser.cp other_traverser
   end
-end
+end

data/spec/{synchroniser_spec.rb → dir_sync_spec.rb}

@@ -1,8 +1,8 @@
 $: << File.dirname(__FILE__)+'/../lib'
 
-require 'synchroniser'
+require 'dir_sync'
 
-describe Synchroniser do
+describe DirSync do
   let(:file_system) { stub 'file_system' }
   let(:resolver) { stub 'resolver'}
   let(:history) { stub 'history', close: nil }
@@ -10,22 +10,22 @@ describe Synchroniser do
   let(:traverser_b) { stub 'traverser_b' }
 
   before do
-    ChangeLogFileSystem.should_receive(:new).with($stdout).and_return file_system
-    HistoricalTraverser.should_receive(:new).with('test').and_return history
-    Traverser.should_receive(:new).with('a', file_system).and_return traverser_a
-    Traverser.should_receive(:new).with('b', file_system).and_return traverser_b
-    ChangeResolver.should_receive(:new).with(history, traverser_a, traverser_b).and_return resolver
+    DirSync::ChangeLogFileSystem.should_receive(:new).with($stdout).and_return file_system
+    DirSync::HistoryTraverser.should_receive(:new).with('test').and_return history
+    DirSync::Traverser.should_receive(:new).with('a', file_system).and_return traverser_a
+    DirSync::Traverser.should_receive(:new).with('b', file_system).and_return traverser_b
+    DirSync::ChangeResolver.should_receive(:new).with(history, traverser_a, traverser_b).and_return resolver
   end
 
   it 'should call iterate once resolved if it returns false' do
     resolver.should_receive(:iterate).and_return false
-    Synchroniser.iterate 'test', 'a', 'b'
+    DirSync.sync 'test', 'a', 'b'
   end
 
   it 'should repeatedly call iterate on resolved until it returns false' do
     resolver.should_receive(:iterate).and_return true
     resolver.should_receive(:iterate).and_return true
     resolver.should_receive(:iterate).and_return false
-    Synchroniser.iterate 'test', 'a', 'b'
+    DirSync.sync 'test', 'a', 'b'
   end
-end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: dir_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
 - Mark Ryall
+- James Ottaway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000Z
+date: 2012-01-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70177781836300 !ruby/object:Gem::Requirement
+  requirement: &70170387871540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177781836300
+  version_requirements: *70170387871540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70177781835000 !ruby/object:Gem::Requirement
+  requirement: &70170387870300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +33,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70177781835000
+  version_requirements: *70170387870300
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70177781834120 !ruby/object:Gem::Requirement
+  requirement: &70170387869340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177781834120
+  version_requirements: *70170387869340
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70177781832600 !ruby/object:Gem::Requirement
+  requirement: &70170387868340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177781832600
+  version_requirements: *70170387868340
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70170387867260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70170387867260
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70177781831880 !ruby/object:Gem::Requirement
+  requirement: &70170387866340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,8 +77,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177781831880
-description: ! 'Bidirectional directory synchronisation for any number of directories
+  version_requirements: *70170387866340
+description: ! 'Multidirectional directory synchronisation for any number of directories
 
 '
 email: mark@ryall.name
@@ -76,21 +88,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/change_log_file_system.rb
-- lib/change_resolver.rb
-- lib/historical_traverser.rb
-- lib/synchroniser.rb
-- lib/traverser.rb
-- spec/change_resolver_spec.rb
-- spec/synchroniser_spec.rb
-- spec/traverser_spec.rb
 - bin/dir_sync
 - bin/drain
-- README.rdoc
-- MIT-LICENSE
+- features/backup.feature
+- features/step_definitions/dir_sync_steps.rb
+- features/support/env.rb
+- lib/dir_sync/change_log_file_system.rb
+- lib/dir_sync/change_resolver.rb
+- lib/dir_sync/history_traverser.rb
+- lib/dir_sync/traverser.rb
+- lib/dir_sync.rb
+- spec/dir_sync/change_log_file_system_spec.rb
+- spec/dir_sync/change_resolver_spec.rb
+- spec/dir_sync/history_traverser_spec.rb
+- spec/dir_sync/traverser_spec.rb
+- spec/dir_sync_spec.rb
+- .gemtest
 - HISTORY.rdoc
+- MIT-LICENSE
 - Rakefile
-- .gemtest
+- README.rdoc
 homepage: http://github.com/markryall/dir_sync
 licenses: []
 post_install_message: 
@@ -102,10 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -2227443201844382087
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2227443201844382087
+      hash: -3613376495215102755
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10

data/lib/synchroniser.rb

@@ -1,15 +0,0 @@
-require 'traverser'
-require 'historical_traverser'
-require 'change_resolver'
-require 'change_log_file_system'
-
-module Synchroniser
-  def self.iterate name, *paths
-    file_system = ChangeLogFileSystem.new $stdout
-    traversers = paths.map {|path| Traverser.new path, file_system }
-    history = HistoricalTraverser.new name
-    resolver = ChangeResolver.new history, *traversers
-    loop { break unless resolver.iterate }
-    history.close
-  end
-end