diff_dirs 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Carl Mercier
+ 
+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.rdoc

@@ -0,0 +1,19 @@
+= DiffDirs
+
+Helper to diff two directories
+
+= Example
+  require 'rubygems'
+  require 'diff_dirs'
+  diff_dirs "~/dir1", "~/dir2"
+
+== Dependencies (for tests only)
+
+  - jeremymcanally-context or shoulda
+  - giraffesoft-zebra
+  - mocha
+  - ruby-debug
+
+== COPYRIGHT
+
+Copyright (c) 2009 {Carl Mercier}[http://carlmercier.com]. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+ 
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "diff_dirs"
+    gemspec.summary = "Ruby helper to diff two directories"
+    gemspec.email = "carl@carlmercier.com"
+    gemspec.homepage = "http://github.com/cmer/diff_dirs"
+    gemspec.description = "Ruby helper to diff two directories"
+    gemspec.authors = ["Carl Mercier"]
+    gemspec.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
+    gemspec.rubyforge_project = 'diffdirs'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/cmercier/diff_dirs/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/diff_dirs.rb

@@ -0,0 +1,60 @@
+class DiffDirs
+  def self.diff_dirs(dir1, dir2)
+    raise(ArgumentError, "Directories must be strings.") unless dir1.is_a?(String) && dir2.is_a?(String)
+    
+    dir1 = expand_path(dir1)
+    dir2 = expand_path(dir2)
+    
+    cmd = "diff -qr #{dir1} #{dir2}"
+    diff_result = execute(cmd)
+    out = []
+    diff_result.each_line do |line|
+      line.chomp!
+      out << diff_result_line_parse(dir1, dir2, line)
+    end
+    out
+  end
+  
+  protected
+    def self.diff_result_line_parse(dir1, dir2, line)
+      # New/Deleted files
+      match = line.match(/^Only in ([^:]*): ([^$]*)$/)
+      if match
+        if match[1] == dir1
+          return [:deleted, match[2]] # deleted from second dir
+        elsif match[1] == dir2
+          return [:new, match[2]] # new in second dir
+        else
+          raise "#{dir1} or #{dir2} didn't match #{match[1]}"
+        end
+        
+      elsif line.match(/^Files\s/) && line.match(/\sdiffer$/) 
+        # Example: Files api/Rakefile and testing/Rakefile differ
+        # This should be done with a nice regexp but couldn't figure out how to match everything but the word "and"
+        files = line.sub(/^Files\s/, "").sub(/\sdiffer$/,"").split(" and ")
+        return [:modified] << remove_dir_from_path(files[0], dir1)
+      end
+      
+      raise RuntimeError, "Cannot parse: #{line}"
+    end
+    
+    def self.execute(cmd)
+      `#{cmd}`
+    end
+    
+    def self.remove_dir_from_path(path, dir)
+      dir += "/" unless dir[-1..-1] == "/"
+      path.sub(Regexp.new("^#{dir}"), "")
+    end
+    
+    def self.expand_path(dir)
+      if dir[0..0] == "~"
+        File.expand_path(dir) 
+      else
+        dir
+      end
+    end
+end
+
+public 
+def diff_dirs(dir1, dir2); DiffDirs::diff_dirs(dir1, dir2); end

data/test/diff_dirs_test.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../diff_dirs'
+
+class DiffDirsTest < Test::Unit::TestCase
+  context "diff executable" do
+    should "be found by which" do
+      assert_not_equal "", `which diff`
+    end
+  end
+  
+  context "diff_dirs method" do
+    should "correctly parse diff output and return proper array" do
+      diff_output = "Only in dir1: .git\nOnly in dir1: Capfile\nOnly in dir2: Capfile2\nFiles dir1/Rakefile and dir2/Rakefile differ\nFiles dir1/lib/format.rb and dir2/lib/format.rb differ\n"
+      DiffDirs.expects(:execute).with("diff -qr dir1 dir2").returns(diff_output)
+      assert_equal [[:deleted, ".git"],
+                    [:deleted, "Capfile"],
+                    [:new, "Capfile2"],
+                    [:modified, "Rakefile"],
+                    [:modified, "lib/format.rb"]], DiffDirs::diff_dirs("dir1", "dir2")
+    end
+    
+    should "fail if provided with non-string arguments" do
+      assert_raise(ArgumentError) { diff_dirs(nil, "") }
+      assert_raise(ArgumentError) { diff_dirs("", nil) }
+    end
+    
+    should "expand paths if starts with ~" do
+      
+    end
+  end
+  
+  context "diff_result_line_parse method" do
+    setup do
+      @d1 = "dir1"
+      @d2 = "dir2"
+      @diff_output = "Only in dir1: .git\nOnly in dir1: Capfile\nOnly in dir2: Capfile2\nFiles dir1/Rakefile and dir2/Rakefile differ\nFiles dir1/lib/format.rb and dir2/lib/format.rb differ\n".split("\n")
+    end
+    
+    should "correctly identify new files" do
+      assert_equal [:new, "Capfile2"], DiffDirs.send(:diff_result_line_parse, @d1, @d2, @diff_output[2])
+    end
+    
+    should "correctly identify deleted files" do
+      assert_equal [:deleted, ".git"],    DiffDirs.send(:diff_result_line_parse, @d1, @d2, @diff_output[0])
+      assert_equal [:deleted, "Capfile"], DiffDirs.send(:diff_result_line_parse, @d1, @d2, @diff_output[1])
+    end
+    
+    should "correctly identify modified files" do
+      assert_equal [:modified, "Rakefile"],      DiffDirs.send(:diff_result_line_parse, @d1, @d2, @diff_output[3])
+      assert_equal [:modified, "lib/format.rb"], DiffDirs.send(:diff_result_line_parse, @d1, @d2, @diff_output[4])
+    end
+  end
+  
+  context "remove_dir_from_path method" do
+    should "correctly remove dir not having a trailing slash" do
+      assert_equal "lib/format.rb", DiffDirs.send(:remove_dir_from_path, "dir1/lib/format.rb", "dir1")
+    end
+    
+    should "correctly remove dir having a trailing slash" do
+      assert_equal "lib/format.rb", DiffDirs.send(:remove_dir_from_path, "dir1/lib/format.rb", "dir1/")
+    end
+  end
+  
+  context "expand_path method" do
+    should "expand path when starting with ~" do
+      assert_equal "/tmp",   DiffDirs.send(:expand_path, "/tmp")
+      assert_not_equal "~/", DiffDirs.send(:expand_path, "~/")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'test/unit'
+require 'context'
+require 'zebra'
+require 'mocha'
+require 'ruby-debug'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: diff_dirs
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Carl Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-12 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Ruby helper to diff two directories
+email: carl@carlmercier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/diff_dirs.rb
+- test/diff_dirs_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cmer/diff_dirs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: diffdirs
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Ruby helper to diff two directories
+test_files: 
+- test/diff_dirs_test.rb
+- test/test_helper.rb