synqa 0.2.0 → 0.3.0

data/.document

@@ -1,5 +1,5 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -1,16 +1,16 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-gem "net-ssh", ">= 2.0"
-gem "net-scp", ">= 1.0"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "net-ssh", ">= 2.0"
+gem "net-scp", ">= 1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -2,8 +2,8 @@ GEM
   remote: http://rubygems.org/
   specs:
     git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     net-scp (1.0.4)
@@ -14,11 +14,12 @@ GEM
     shoulda (2.11.3)
 
 PLATFORMS
+  ruby
   x86-mingw32
 
 DEPENDENCIES
   bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  jeweler (~> 1.6.2)
   net-scp (>= 1.0)
   net-ssh (>= 2.0)
   rcov

data/README.rdoc

@@ -1,43 +1,43 @@
-= synqa
-
-*Synqa* is a simple file syncing tool that works over SSH, and is designed
-primarily for maintaining static websites. It uses a secure hash function to
-determine which files don't need to be copied because the destination copy
-is already identical to the source copy.
-
-It is available as a Ruby gem.
-
-I wrote *synqa* for two main reasons:
-
-* I couldn't get *rsync* to work on the combination of Cygwin and my
-  hosting provider, and the rsync error messages were not very informative.
-* It was an opportunity to learn about SSH and how to use SSH and SCP with Ruby.
-
-== Installation
-
-<code>gem install synqa</code>
-
-== Dependencies of *synqa* are: 
-
-* Ruby 1.9.2
-* Ruby gems *net-ssh* and *net-scp*
-
-Optionally:
-* An external SSH client. I use *plink*.
-* An external SCP client. I use *pscp*.
-
-For some sample code, see <b>examples/synga-useage.rb</b> and <b>examples/sample-rakefile</b>.
-
-== Licence
-
-Synqa is licensed under the GNU General Public License version 3.
-
-== Notes and Issues
-
-* *Synqa* has not been tested (or even designed to work) with file names
-  containing whitespace or non-ASCII characters. Typically this doesn't matter for
-  many static websites, but it will reduce the tool's usefulness as a general purpose
-  backup tool.
-
-* Currently *Synqa* does not provide authentication options, on the assumption that you
-  will use Pageant (which automagically provides "presented" keys for specified user/host combinations).
+= synqa
+
+*Synqa* is a simple file syncing tool that works over SSH, and is designed
+primarily for maintaining static websites. It uses a secure hash function to
+determine which files don't need to be copied because the destination copy
+is already identical to the source copy.
+
+It is available as a Ruby gem.
+
+I wrote *synqa* for two main reasons:
+
+* I couldn't get *rsync* to work on the combination of Cygwin and my
+  hosting provider, and the rsync error messages were not very informative.
+* It was an opportunity to learn about SSH and how to use SSH and SCP with Ruby.
+
+== Installation
+
+<code>gem install synqa</code>
+
+== Dependencies of *synqa* are: 
+
+* Ruby 1.9.2
+* Ruby gems *net-ssh* and *net-scp*
+
+Optionally:
+* An external SSH client. I use *plink*.
+* An external SCP client. I use *pscp*.
+
+For some sample code, see <b>examples/synga-useage.rb</b> and <b>examples/sample-rakefile</b>.
+
+== Licence
+
+Synqa is licensed under the GNU General Public License version 3.
+
+== Notes and Issues
+
+* *Synqa* has not been tested (or even designed to work) with file names
+  containing whitespace or non-ASCII characters. Typically this doesn't matter for
+  many static websites, but it will reduce the tool's usefulness as a general purpose
+  backup tool.
+
+* Currently *Synqa* does not provide authentication options, on the assumption that you
+  will use Pageant (which automagically provides "presented" keys for specified user/host combinations).

data/Rakefile

@@ -1,53 +1,53 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "synqa"
-  gem.homepage = "http://www.1729.com/software/synqa/"
-  gem.license = "GPLv3"
-  gem.summary = %Q{Sync files from a local directory to a remote directory via SSH/SCP}
-  gem.description = %Q{Sync files from a local directory to a remote directory via SSH/SCP}
-  gem.email = "http://www.1729.com/email.html"
-  gem.authors = ["Philip Dorrell"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "synqa #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "synqa"
+  gem.homepage = "http://www.1729.com/software/synqa/"
+  gem.license = "GPLv3"
+  gem.summary = %Q{Sync files from a local directory to a remote directory via SSH/SCP}
+  gem.description = %Q{Synqa syncs files from a local directory to a remote directory using an SSH connection. It is designed for uploading a static website. It determines if existing files need to be updated by calculating cryptographic hashes on the remote server.}
+  gem.email = "http://www.1729.com/email.html"
+  gem.authors = ["Philip Dorrell"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "synqa #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/_project.el

@@ -1,9 +1,9 @@
-
-(load-this-project
- `( (:ruby-executable ,*ruby-1.9-executable*)
-    (:run-project-command (ruby-run-file ,(concat (project-base-directory) "RunMain.rb")))
-    (:build-function project-compile-with-command)
-    (:compile-command "rake")
-    (:ruby-args ("-I."))
-    ) )
-
+
+(load-this-project
+ `( (:ruby-executable ,*ruby-1.9-executable*)
+    (:run-project-command (ruby-run-file ,(concat (project-base-directory) "RunMain.rb")))
+    (:build-function project-compile-with-command)
+    (:compile-command "rake")
+    (:ruby-args (,(concat "-I" (project-base-directory) "lib")))
+    ) )
+

data/examples/synqa-useage.rb

@@ -1,37 +1,37 @@
-# Sample code for synqa useage -- you will need to fill in your own details
-
-require 'synqa.rb'
-require 'based'
-require 'digest/sha2'
-
-STDOUT.sync = true
-
-include Synqa
-sha256Sum = Sha256SumCommand.new()    # sha256sum (with 2 characters between hash and file name)
-sha256 = Sha256Command.new()          # sha256 -r (with 1 space between hash and file name)
-
-# Default is use Ruby net-ssh & net-scp gems, the following line defines external SSH/SCP applications
-# plinkAndPscp = ExternalSshScp.new("plink", "pscp")
-
-localContentLocation = LocalContentLocation.new(Based::BaseDirectory.new("c:/dev/src/project"), 
-                                                Digest::SHA256, 
-                                                "c:/temp/synqa/local.project.content.cache.txt")
-# Default uses Ruby net-ssh & net-scp gems
-remoteHost = SshContentHost.new("username@host.example.com", sha256)
-
-# Alternative uses plink & pscp
-#remoteHost = SshContentHost.new("username@host.example.com", sha256, ExternalSshScp)
-
-
-# Note: the specification of plink & pscp assumes that keys are managed with Pageant, and therefore
-# do not need to be specified on the command line.
-                                
-remoteContentLocation = RemoteContentLocation.new(remoteHost, 
-                                                  "/home/username/public", 
-                                                  "c:/temp/synqa/remote.project.content.cache.txt")
-
-# Note: the cache files are currently written, but not yet used to speed up the sync 
-
-syncOperation = SyncOperation.new(localContentLocation, remoteContentLocation)
-
-syncOperation.doSync(:dryRun => true)  # set to false to make it actually happen
+# Sample code for synqa useage -- you will need to fill in your own details
+
+require 'synqa.rb'
+require 'based'
+require 'digest/sha2'
+
+STDOUT.sync = true
+
+include Synqa
+sha256Sum = Sha256SumCommand.new()    # sha256sum (with 2 characters between hash and file name)
+sha256 = Sha256Command.new()          # sha256 -r (with 1 space between hash and file name)
+
+# Default is use Ruby net-ssh & net-scp gems, the following line defines external SSH/SCP applications
+# plinkAndPscp = ExternalSshScp.new("plink", "pscp")
+
+localContentLocation = LocalContentLocation.new(Based::BaseDirectory.new("c:/dev/src/project"), 
+                                                Digest::SHA256, 
+                                                "c:/temp/synqa/local.project.content.cache.txt")
+# Default uses Ruby net-ssh & net-scp gems
+remoteHost = SshContentHost.new("username@host.example.com", sha256)
+
+# Alternative uses plink & pscp
+#remoteHost = SshContentHost.new("username@host.example.com", sha256, ExternalSshScp)
+
+
+# Note: the specification of plink & pscp assumes that keys are managed with Pageant, and therefore
+# do not need to be specified on the command line.
+                                
+remoteContentLocation = RemoteContentLocation.new(remoteHost, 
+                                                  "/home/username/public", 
+                                                  "c:/temp/synqa/remote.project.content.cache.txt")
+
+# Note: the cache files are currently written, but not yet used to speed up the sync 
+
+syncOperation = SyncOperation.new(localContentLocation, remoteContentLocation)
+
+syncOperation.doSync(:dryRun => true)  # set to false to make it actually happen

data/lib/based.rb

@@ -1,177 +1,177 @@
-# The Based module supports the concept of a "based" directory. Typically in modern software development, 
-# a project is represented by a set of sub-directories and files within a base directory. The exact location
-# of the base directory is not so important (i.e. it's wherever you checked it out of source control). For a given
-# file or sub-directory, one is often more interested in the path relative to the base directory, rather than 
-# the absolute path. (But you still need the full path when performing an actual file operation on the file
-# or directory.)
-# Also, there might be files and directories that you wish to ignore. Based supports simple functional includes and
-# excludes. (A bit less succint than include/exclude globs, but probably more flexible.)
-
-module Based
-  
-  # A base class for directories: i.e. either the base directory itself, or a sub-directory
-  class Directory
-    # The base directory (object)
-    attr_reader :base
-    
-    # The path of this directory relative to the base directory (includes a following "/" if non-empty)
-    attr_reader :relativePath
-    
-    # The elements of the relative path as an array
-    attr_reader :pathElements
-    
-    # The immediate name of the directory (nil for the base directory)
-    attr_reader :name
-    
-    # The parent directory (nil for the base directory)
-    attr_reader :parent
-    
-    # The full path of the file
-    attr_reader :fullPath
-    
-    # initialise with un-initialised entries
-    def initialize
-      @entries = nil
-    end
-    
-    # get the "entries", i.e. list of files and directories immediately contained in this directory, and cache them.
-    # Note that dirExclude, fileInclude and fileExclude functions in the base directory object
-    # may be applied to filter out some entries.
-    def getEntries
-      if @entries == nil
-        @entries = Dir.entries(fullPath)
-        @dirs = []
-        @files = []
-        for entry in @entries
-          if entry != "." and entry != ".." 
-            fullEntryPath = fullPath + entry
-            if ::File.directory?(fullEntryPath)
-              subDirectory = SubDirectory.new(entry, self)
-              if @base.dirExclude == nil or not @base.dirExclude.call(subDirectory)
-                @dirs << subDirectory
-              end
-            elsif ::File.file?(fullEntryPath)
-              file = File.new(entry, self)
-              if @base.fileInclude == nil or @base.fileInclude.call(file)
-                if @base.fileExclude == nil or not @base.fileExclude.call(file)
-                  @files << file
-                end
-              end
-            end
-          end
-        end
-        @dirs.sort_by! {|dir| dir.name}
-        @files.sort_by! {|file| file.name}
-      end
-    end
-    
-    # Get list of files immediately contained in this directory
-    def files
-      getEntries()
-      return @files
-    end
-    
-    # Get list of directories immediately contained in this directory
-    def dirs
-      getEntries()
-      return @dirs
-    end
-    
-    # Get a list of all the sub-directories of this directory (with parents preceding children)
-    def subDirs
-      result = []
-      for dir in dirs
-        result << dir
-        result += dir.subDirs
-      end
-      return result
-    end
-    
-    # Get a list of all files contained within this directory
-    def allFiles
-      result = files
-      for subDir in subDirs
-        result += subDir.files
-      end
-      return result
-    end
-  end
-  
-  # An object representing a sub-directory (i.e. not the base directory itself)
-  class SubDirectory<Directory
-    
-    # Construct directory object from parent directory object and this directory's name
-    def initialize(name, parent)
-      super()
-      @name = name
-      @parent = parent
-      @base = @parent.base
-      @relativePath = @parent.relativePath + @name + "/"
-      @pathElements = @parent.pathElements + [name]
-      @fullPath = @parent.fullPath + @name + "/"
-    end
-  end
-  
-  # An object representing the base directory
-  class BaseDirectory<Directory
-    
-    # Function to decide if files should be included (if nil, assume all included). Subject
-    # to exclusion by fileExclude
-    attr_reader :fileInclude
-    
-    # Function to decide if files should be excluded
-    attr_reader :fileExclude
-    
-    # Function to decide if sub-directories should be excluded (if a directory is excluded, so 
-    # are all it's sub-directories and files contained within)
-    attr_reader :dirExclude
-    
-    # Initialise from absolute file path. Options include :dirExclude, :fileInclude and :fileExclude
-    def initialize(path, options = {})
-      super()
-      @name = nil
-      @parent = nil
-      @base = self
-      @relativePath = ""
-      @pathElements = []
-      @fullPath = path.end_with?("/") ? path : path + "/"
-      @dirExclude = options.fetch(:dirExclude, nil)
-      @fileInclude = options.fetch(:fileInclude, nil)
-      @fileExclude = options.fetch(:fileExclude, nil)
-    end
-  end
-  
-  # An object representing a file within the base directory
-  class File
-    # immediate name of file
-    attr_reader :name
-    
-    # parent, i.e. containing directory
-    attr_reader :parent
-    
-    # the base directory
-    attr_reader :base
-    
-    # path of this file relative to base directory
-    attr_reader :relativePath
-    
-    # elements of file path (including the name) as an array
-    attr_reader :pathElements
-    
-    # full absolute path name of file
-    attr_reader :fullPath
-    
-    # initialise from name and containing directory
-    def initialize(name, parent)
-      super()
-      @name = name
-      @parent = parent
-      @base = @parent.base
-      @relativePath = @parent.relativePath + @name
-      @pathElements = @parent.pathElements + [name]
-      @fullPath = @parent.fullPath + @name
-    end
-    
-  end
-  
-end
+# The Based module supports the concept of a "based" directory. Typically in modern software development, 
+# a project is represented by a set of sub-directories and files within a base directory. The exact location
+# of the base directory is not so important (i.e. it's wherever you checked it out of source control). For a given
+# file or sub-directory, one is often more interested in the path relative to the base directory, rather than 
+# the absolute path. (But you still need the full path when performing an actual file operation on the file
+# or directory.)
+# Also, there might be files and directories that you wish to ignore. Based supports simple functional includes and
+# excludes. (A bit less succint than include/exclude globs, but probably more flexible.)
+
+module Based
+  
+  # A base class for directories: i.e. either the base directory itself, or a sub-directory
+  class Directory
+    # The base directory (object)
+    attr_reader :base
+    
+    # The path of this directory relative to the base directory (includes a following "/" if non-empty)
+    attr_reader :relativePath
+    
+    # The elements of the relative path as an array
+    attr_reader :pathElements
+    
+    # The immediate name of the directory (nil for the base directory)
+    attr_reader :name
+    
+    # The parent directory (nil for the base directory)
+    attr_reader :parent
+    
+    # The full path of the file
+    attr_reader :fullPath
+    
+    # initialise with un-initialised entries
+    def initialize
+      @entries = nil
+    end
+    
+    # get the "entries", i.e. list of files and directories immediately contained in this directory, and cache them.
+    # Note that dirExclude, fileInclude and fileExclude functions in the base directory object
+    # may be applied to filter out some entries.
+    def getEntries
+      if @entries == nil
+        @entries = Dir.entries(fullPath)
+        @dirs = []
+        @files = []
+        for entry in @entries
+          if entry != "." and entry != ".." 
+            fullEntryPath = fullPath + entry
+            if ::File.directory?(fullEntryPath)
+              subDirectory = SubDirectory.new(entry, self)
+              if @base.dirExclude == nil or not @base.dirExclude.call(subDirectory)
+                @dirs << subDirectory
+              end
+            elsif ::File.file?(fullEntryPath)
+              file = File.new(entry, self)
+              if @base.fileInclude == nil or @base.fileInclude.call(file)
+                if @base.fileExclude == nil or not @base.fileExclude.call(file)
+                  @files << file
+                end
+              end
+            end
+          end
+        end
+        @dirs.sort_by! {|dir| dir.name}
+        @files.sort_by! {|file| file.name}
+      end
+    end
+    
+    # Get list of files immediately contained in this directory
+    def files
+      getEntries()
+      return @files
+    end
+    
+    # Get list of directories immediately contained in this directory
+    def dirs
+      getEntries()
+      return @dirs
+    end
+    
+    # Get a list of all the sub-directories of this directory (with parents preceding children)
+    def subDirs
+      result = []
+      for dir in dirs
+        result << dir
+        result += dir.subDirs
+      end
+      return result
+    end
+    
+    # Get a list of all files contained within this directory
+    def allFiles
+      result = files
+      for subDir in subDirs
+        result += subDir.files
+      end
+      return result
+    end
+  end
+  
+  # An object representing a sub-directory (i.e. not the base directory itself)
+  class SubDirectory<Directory
+    
+    # Construct directory object from parent directory object and this directory's name
+    def initialize(name, parent)
+      super()
+      @name = name
+      @parent = parent
+      @base = @parent.base
+      @relativePath = @parent.relativePath + @name + "/"
+      @pathElements = @parent.pathElements + [name]
+      @fullPath = @parent.fullPath + @name + "/"
+    end
+  end
+  
+  # An object representing the base directory
+  class BaseDirectory<Directory
+    
+    # Function to decide if files should be included (if nil, assume all included). Subject
+    # to exclusion by fileExclude
+    attr_reader :fileInclude
+    
+    # Function to decide if files should be excluded
+    attr_reader :fileExclude
+    
+    # Function to decide if sub-directories should be excluded (if a directory is excluded, so 
+    # are all it's sub-directories and files contained within)
+    attr_reader :dirExclude
+    
+    # Initialise from absolute file path. Options include :dirExclude, :fileInclude and :fileExclude
+    def initialize(path, options = {})
+      super()
+      @name = nil
+      @parent = nil
+      @base = self
+      @relativePath = ""
+      @pathElements = []
+      @fullPath = path.end_with?("/") ? path : path + "/"
+      @dirExclude = options.fetch(:dirExclude, nil)
+      @fileInclude = options.fetch(:fileInclude, nil)
+      @fileExclude = options.fetch(:fileExclude, nil)
+    end
+  end
+  
+  # An object representing a file within the base directory
+  class File
+    # immediate name of file
+    attr_reader :name
+    
+    # parent, i.e. containing directory
+    attr_reader :parent
+    
+    # the base directory
+    attr_reader :base
+    
+    # path of this file relative to base directory
+    attr_reader :relativePath
+    
+    # elements of file path (including the name) as an array
+    attr_reader :pathElements
+    
+    # full absolute path name of file
+    attr_reader :fullPath
+    
+    # initialise from name and containing directory
+    def initialize(name, parent)
+      super()
+      @name = name
+      @parent = parent
+      @base = @parent.base
+      @relativePath = @parent.relativePath + @name
+      @pathElements = @parent.pathElements + [name]
+      @fullPath = @parent.fullPath + @name
+    end
+    
+  end
+  
+end