ruby_diff 0.1 → 0.1.5

data/.gitignore

@@ -2,5 +2,7 @@
 *~
 # Ignore rubygems pkg dir
 /pkg
+# Ignore rubygems docs dir
+/doc
 # Ignore MacOSX .DS_Store
-.DS_Store
+.DS_Store

data/History.txt

@@ -1,2 +1,9 @@
-=== 0.0.1 / 2008-06-03
- Initial verison of RubyDiff
+=== 0.1.5 / --
+Making everything a little better:
+- Merged changes from kballard to fix the git feeder
+- Added support for git working directory (use --git-wd)
+- Added support for multiple inputs
+- Metamethods such as 'attr_reader' are now processed
+
+=== 0.1 / 2008-06-03
+Initial verison of RubyDiff

data/Manifest.txt

@@ -8,12 +8,16 @@ lib/ruby_diff.rb
 lib/ruby_diff/code_comparison.rb
 lib/ruby_diff/file_feeder.rb
 lib/ruby_diff/git_feeder.rb
+lib/ruby_diff/git_support.rb
+lib/ruby_diff/git_working_dir_feeder.rb
 lib/ruby_diff/patterns.rb
 lib/ruby_diff/structure_processor.rb
 ruby_diff.gemspec
+test/code_comparison_test.rb
 test/file_feeder_test.rb
 test/git_feeder_test.rb
 test/git_sample/README
 test/git_sample/book.rb
 test/git_sample/lib/chapter.rb
+test/git_working_dir_feeder_test.rb
 test/structure_processor_test.rb

data/README.txt

@@ -27,9 +27,13 @@ changes to instance methods.  The API is likely to change drastically.
 == Usage
 This is likely to change a bunch, but for the moment:
   ruby_diff old_file new_file
+  
 Or for git repositories, etc.
-  ruby_diff --git HEAD --file ./
-
+  ruby_diff --git HEAD --git-wd
+  
+Compare three different release tags.
+  ruby_diff --git v0.1 --git v0.2 --git v0.3
+  
 See help for more information.
 
 == Contact

data/Rakefile

@@ -24,7 +24,7 @@ namespace :git do
   task :changed do |t|
     _divider
     puts "Changes since last commit:"
-    puts `./bin/ruby_diff --git HEAD --file ./`
+    puts `./bin/ruby_diff --git HEAD --git-wd ./`
     _divider
   end
    

data/bin/ruby_diff

@@ -1,13 +1,26 @@
 #!/usr/bin/env ruby
 require 'rubygems'
-require 'ruby_diff'
-require 'optparse' 
+require 'optparse'
+require 'enumerator'
+
+# If we're loading ruby_diff directly for development,
+# don't require it through rubygems.  Is there a better
+# way to do this?
+
+if $0 == __FILE__
+  # loaded directly (dev)
+  require File.dirname(__FILE__)+"/../lib/ruby_diff"
+else
+  # loaded via ruby_gems
+  require 'ruby_diff'
+end
 
 @options = {}
 
 feeder_mapping = {
   :file =>  FileFeeder,
-  :git  =>  GitFeeder
+  :git  =>  GitFeeder,
+  :git_wd  =>  GitWorkingDirFeeder,
 }
 
 feeders = []
@@ -21,25 +34,35 @@ opts.separator "Specific options:"
 opts.define_head <<-HEAD
 
 Examples:
-Changes between git HEAD and current file system:
-ruby_diff --git HEAD --file ./
+Changes between git HEAD and current working directory:
+ruby_diff --git HEAD --git-wd ./
+
+Changes between two sets of files:
+ruby_diff --file old_dir --file new_dir
 
-Changes between HEAD and previous revision:
-ruby_diff --git HEAD~1 --git HEAD
 HEAD
 
-opts.on('--sexp', "Show the s expressions for each input"){ 
+opts.on('--sexp', "Show the s expressions for each input (mostly for debugging)"){ 
   @options[:sexp] = true 
 }
 
+opts.on('--verbose', "Shows more information while processing files"){ 
+  @options[:verbose] = true 
+}
+
 opts.on('--git PATH', "Use a git repository as a code source"){|path| 
   feeders << feeder_mapping[:git].new(path) 
 }
+
+opts.on('--git-wd PATH', "Use the git working directory as a code source"){|path| 
+  feeders << feeder_mapping[:git_wd].new(path) 
+}
+
 opts.on('--file PATH', "Use a file system path as a code source"){|path| 
   feeders << feeder_mapping[:file].new(path) 
 }
 
-opts.on_tail('-v', '--version')    { puts "ruby_diff v:0" ; exit }
+opts.on_tail('-v', '--version')    { puts "ruby_diff #{RubyDiff::VERSION}" ; exit }
 opts.on_tail('-h', '--help')       { puts opts; exit }
 
 opts.parse!(ARGV)
@@ -49,36 +72,42 @@ ARGV.each do |path|
   feeders << feeder_mapping[:file].new(path)
 end
 
-if feeders.length > 2
+if feeders.length < 2
   puts opts
-  puts "Too many code sources (#{feeders.length})"
-  exit 1
-elsif feeders.length < 2
-  puts opts
-  puts "Must supply least 2 code sources (#{feeders.length})"
+  puts "Must supply at least 2 code sources (found #{feeders.length})"
   exit 1
 end
 
 processors = feeders.map do |feeder|
   puts "#{feeder.class}: #{feeder.path}" if @options[:sexp]
-  processor = StructureProcessor.new
-  feeder.each do |code|
-    sexp = ParseTree.new.parse_tree_for_string(code)
-    if @options[:sexp]
-      pp sexp
-      puts "--"
-    end
+  processor = StructureProcessor.new(feeder.path)
+  puts "\n#{feeder.path}" if @options[:verbose]
+  
+  feeder.each do |code, path|
+    puts path if @options[:verbose]
+    begin
+      sexp = ParseTree.new.parse_tree_for_string(code,path)
+      if @options[:sexp]
+        pp sexp
+        puts "--"
+      end
     
-    processor.process(*sexp)
+      processor.process(*sexp) unless sexp.empty?
+    rescue Exception => ex
+      STDERR << "Could not parse input (#{path}):\n#{ex}"
+    end
   end
   
   processor
 end
 
- 
-old_processor, new_processor = *processors
 
-changes = old_processor.diff(new_processor).sort_by{|c| c.signature}
-changes.each do |change|
-  puts change.to_s
+processors.each_cons(2) do |old_processor, new_processor|
+  if processors.length > 2 or @options[:verbose]
+    puts "# #{old_processor.name} to #{new_processor.name}"
+  end
+  changes = old_processor.diff(new_processor).sort_by{|c| c.signature}
+  changes.each do |change|
+    puts change.to_s
+  end
 end

data/lib/ruby_diff.rb

@@ -11,10 +11,10 @@ require 'set'
 require 'pp'
 
 module RubyDiff
-  VERSION = "0.1"
+  VERSION = "0.1.5"
 end
 
 # RubyDiff
-%w(code_comparison structure_processor file_feeder git_feeder).each do |name|
+%w(code_comparison structure_processor file_feeder git_support git_feeder git_working_dir_feeder).each do |name|
   require File.expand_path(File.dirname(__FILE__) + "/ruby_diff/#{name}")
 end

data/lib/ruby_diff/code_comparison.rb

@@ -1,3 +1,5 @@
+# A CodeChange represents a difference between two sets of ruby
+# code.  It may contain child changes.
 class CodeChange
   attr_reader :signature
   attr_reader :operation
@@ -23,12 +25,15 @@ class CodeChange
   end
 end
 
+# Compares two sets of parsed CodeObjects.  A CodeComparison
+# Expects sets of CodeObjects hashed by their signature.
 class CodeComparison
   def initialize(old_signatures, new_signatures)
     @old = old_signatures
     @new = new_signatures
   end
   
+  # Returns the set of changes.
   def changes
     changes = []
     seen = Set.new

data/lib/ruby_diff/file_feeder.rb

@@ -1,3 +1,9 @@
+# A Feeder reads in files for RubyDiff's processor to
+# run over.  FileFeeder reads them from the file system.
+#
+# Example Usage:
+#  ruby_diff --file old_version.rb --file new_version.rb
+#  ruby_diff --file old_dir/ --file new_dir
 class FileFeeder
   attr_accessor :files
   attr_accessor :path
@@ -21,7 +27,7 @@ class FileFeeder
     
   def each
     @files.each do |file|
-      yield(open(file, 'r'){|io| io.read})      
+      yield(open(file, 'r'){|io| io.read}, file)      
     end
   end
 

data/lib/ruby_diff/git_feeder.rb

@@ -1,9 +1,17 @@
-GitFile = Struct.new :access, :type, :hash, :name
+# A Feeder reads in files for RubyDiff's processor to
+# run over.  GitFeeder reads them from a git repository.
+#
+# Example Usage:
+#  ruby_diff --git v0.1:lib --git v0.1:lib
+#  ruby_diff --git HEAD^2 --git HEAD^1 --git HEAD
 class GitFeeder
+  GitFile = Struct.new :access, :type, :hash, :name
+  
   attr_accessor :files
   attr_accessor :path
   
   include Enumerable
+  include GitSupport
   
   # Expects something in the form of REV:PATH
   #   --git REV:[PATH]
@@ -27,7 +35,7 @@ class GitFeeder
     @files = []
           
     FileUtils.cd(@working_dir) do
-      git_list = git "git-ls-tree -r #{rev}"
+      git_list = git "ls-tree -r #{rev}"
       git_list.each_line do |line|
         file = GitFile.new(*line.chomp.split(/\s+/,4))
         
@@ -42,36 +50,10 @@ class GitFeeder
   def each
     FileUtils.cd(@working_dir) do
       @files.each do |file|
-        code = git "git-show #{file.hash}"
-        yield(code)      
+        code = git "show #{file.hash}"
+        yield(code, file.name)      
       end
     end
   end
-    
-  def init_git(path, search_path='')
-    if File.exist?(File.join(path, ".git"))
-      # If this is the git repository
-      @working_dir = path
-      @search_path = search_path
-      
-    else
-      next_search = File.join( File.split(path).last, search_path )
-      next_path = File.dirname(path)
-      
-      if next_path == path # We have reached the root, and can go no further
-        raise "Could not find a git working directory"
-      else
-        init_git(next_path, next_search)
-      end
-    end
-  end
-  
-  def git command
-    output = `#{command} 2>&1`.chomp
-    unless $?.success?
-      raise RuntimeError, output
-    end
-    output
-  end
   
 end

data/lib/ruby_diff/git_support.rb

@@ -0,0 +1,33 @@
+# Common feeder support for working with git repositories.
+module GitSupport
+
+  # Finds root of a git repository.  If the repository is the parent of the
+  # supplied path, then the remainder is made into the search path.
+  def init_git(path, search_path='')
+    path = File.expand_path(path)
+    if File.exist?(File.join(path, ".git"))
+      # If this is the git repository
+      @working_dir = path
+      @search_path = search_path
+      
+    else
+      next_search = File.join( File.basename(path), search_path )
+      next_path = File.dirname(path)
+      
+      if next_path == path # We have reached the root, and can go no further
+        raise "Could not find a git working directory"
+      else
+        init_git(next_path, next_search)
+      end
+    end
+  end
+  
+  # issues a command to git
+  def git command
+    output = `git #{command} 2>&1`.chomp
+    unless $?.success?
+      raise RuntimeError, output
+    end
+    output
+  end
+end

data/lib/ruby_diff/git_working_dir_feeder.rb

@@ -0,0 +1,53 @@
+# A Feeder reads in files for RubyDiff's processor to
+# run over.  GitWorkingDirFeeder reads them from a git repository.  Usually 
+# used in conjunction with the GitFeeder.
+#
+# Example Usage:
+#  ruby_diff --git v0.1:lib --git-wd lib
+class GitWorkingDirFeeder
+  attr_accessor :files
+  attr_accessor :path
+  
+  include Enumerable
+  include GitSupport
+  
+  # Expects something in the form of PATH
+  #   --file [PATH]
+  def initialize(path)
+    @path = path
+    
+    path = File.expand_path(path) if path
+    init_git(path || '.')
+    @file_pattern = if @search_path == ''
+      "**.rb"
+    elsif @search_path =~ /\.rb#{File::SEPARATOR}$/
+      # So appending each piece into the search path during init_git
+      # causes the search path to always end with a /
+      @search_path[0...-1]
+    else
+      File.join(@search_path,"**.rb")
+    end
+    
+    @files = []
+          
+    FileUtils.cd(@working_dir) do
+      git_list = git "ls-files"
+      git_list.each_line do |line|
+        file = line.chomp
+        if File.fnmatch(@file_pattern, file)
+          @files << file        
+        end
+      end
+    end
+    
+  end
+    
+  def each
+    FileUtils.cd(@working_dir) do
+      @files.each do |file|
+        yield(open(file, 'r'){|io| io.read}, file)      
+      end
+    end
+  end
+
+end

data/lib/ruby_diff/structure_processor.rb

@@ -4,7 +4,7 @@ class CodeObject
   attr_reader :children
   attr_reader :sexp
   
-  def initialize(name, parent, sexp)
+  def initialize(name, parent=nil, sexp=Sexp.new)
     @name = name
     @parent = parent
     @sexp = sexp.deep_clone
@@ -56,14 +56,58 @@ class MethodCode < CodeObject
   end
 end
 
+# Meta method support
+class MetaCode < CodeObject
+  def initialize(name, parent, label, sexp=s() )
+    super(name, parent, sexp)
+    @label = label
+  end
+  
+  def signature
+    parent_signature = self.parent ? self.parent.signature : ""
+    "#{parent_signature} {#{@label} #{self.name}}"
+  end
+end
+
+class AccessorHandler  
+  def initialize(label)
+    @label = label
+  end
+  
+  def meta_codes(args_sexp, scope)
+    meta_codes = []
+    args_sexp.sexp_body.each do |arg| 
+      if name = name_for_arg(arg)
+        meta_codes << MetaCode.new(name, scope, @label)
+      end
+    end
+    meta_codes
+  end
+  
+  def name_for_arg(name_sexp)
+    identifier = name_sexp.to_a
+    case identifier.first
+      when :lit then identifier.last
+      when :str then identifier.last.to_sym
+      else nil
+    end
+  end
+end
+
+# StructureProcessor is a SexpProcessor which will generate a logical
+# model of the ruby code.  It can be fooled by metaprogramming and method
+# redefinition, but in most cases should be fairly accurate.
 class StructureProcessor < SexpProcessor
+  attr_reader   :name
   attr_accessor :code_objects
   attr_accessor :root_objects
   
   attr_accessor :scope_stack
+  attr_reader   :meta_methods
   
-  def initialize
-    super
+  def initialize(name='')
+    super()
+    @name = name
     self.strict = false
     self.auto_shift_type = true
     
@@ -71,6 +115,11 @@ class StructureProcessor < SexpProcessor
     @code_objects = {}
     @root_objects = {}
     @scope_stack = []
+    @meta_methods = {
+      :attr_accessor => AccessorHandler.new("accessor"),
+      :attr_writer   => AccessorHandler.new("writer"),
+      :attr_reader   => AccessorHandler.new("reader")
+    }
   end
   
   def process_class(exp)
@@ -120,6 +169,18 @@ class StructureProcessor < SexpProcessor
     s(:sclass, exp_scope, body)
   end
   
+  def process_fcall(exp)
+    name = exp.shift
+    args = process exp.shift
+
+    if meta_handler = @meta_methods[name]
+      meta_codes = meta_handler.meta_codes(args, self.scope)
+      meta_codes.each{|m| record(m)}
+    end
+    
+    return s(:fcall, name, args)
+  end
+  
   def diff(other_processor)
     method_diff = CodeComparison.new(self.root_objects, other_processor.root_objects).changes
   end
@@ -141,4 +202,5 @@ class StructureProcessor < SexpProcessor
   def scope
     self.scope_stack.last
   end
+  
 end

data/test/code_comparison_test.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require 'test/unit/testcase'
+require "ruby_diff"
+
+class CodeComparisonTestCase < Test::Unit::TestCase  
+  def setup
+    @old_objects = []
+    @new_objects = []
+    @changes = nil
+  end
+  
+  def test_empty_set
+    assert_changes
+  end
+  
+  def test_removed
+    @old_objects << DummyCodeObject.new('m')
+    assert_changes 'm' => :removed
+  end
+  
+  def test_added
+    @new_objects << DummyCodeObject.new('m')
+    assert_changes 'm' => :added
+  end
+  
+  def test_changed
+    @old_objects << DummyCodeObject.new('m',nil,s(:a))
+    @new_objects << DummyCodeObject.new('m',nil,s(:b))
+    assert_changes 'm' => :changed
+  end
+  
+  def test_no_change
+    @old_objects << DummyCodeObject.new('m',nil,s(:a))
+    @new_objects << DummyCodeObject.new('m',nil,s(:a))
+    assert_changes
+    assert @changes.empty?
+  end
+  
+private
+  class DummyCodeObject < CodeObject    
+    def signature
+      name
+    end
+  end
+  
+  def assert_changes(sig_hash={})
+    c = CodeComparison.new(
+      code_objects_by_sig(@old_objects),
+      code_objects_by_sig(@new_objects)
+    )
+    
+    change_hash = {}
+    @changes = c.changes
+    @changes.each{|change| change_hash[change.signature] = change.operation}
+    sig_hash.each do |sig, operation|
+      assert_equal operation, change_hash[sig], "#{sig} should have been #{operation}"
+    end
+  end
+    
+  def code_objects_by_sig(code_objects)
+    h = {}
+    code_objects.each{|o| h[o.signature] = o}
+    h
+  end
+end

data/test/file_feeder_test.rb

@@ -2,9 +2,8 @@ require 'test/unit'
 require 'test/unit/testcase'
 require "ruby_diff"
 
-DIR = File.join(File.dirname(__FILE__), "git_sample")
-
 class FileFeederTestCase < Test::Unit::TestCase  
+  DIR = File.join(File.dirname(__FILE__), "git_sample")
   
   def test_find_all_files
     assert File.exist?(DIR)
@@ -26,7 +25,7 @@ class FileFeederTestCase < Test::Unit::TestCase
   def test_files_are_suitable_for_processing
     feeder = FileFeeder.new DIR
     assert_nothing_raised do
-      sexps = feeder.map{|code| ParseTree.new.parse_tree_for_string(code)}
+      sexps = feeder.map{|code,name| ParseTree.new.parse_tree_for_string(code)}
 
       sexps.each do |sexp|
         assert sexp.length > 0, "Parsed code should not be empty"

data/test/git_feeder_test.rb

@@ -2,9 +2,8 @@ require 'test/unit'
 require 'test/unit/testcase'
 require "ruby_diff"
 
-GIT_REPO = File.join(File.dirname(__FILE__), "git_sample")
-
 class GitFeederTestCase < Test::Unit::TestCase  
+  GIT_REPO = File.join(File.dirname(__FILE__), "git_sample")
   
   def test_find_all_files
     assert File.exist?(GIT_REPO)
@@ -26,7 +25,7 @@ class GitFeederTestCase < Test::Unit::TestCase
   def test_files_are_suitable_for_processing
     feeder = GitFeeder.new "HEAD:#{GIT_REPO}"
     assert_nothing_raised do
-      sexps = feeder.map{|code| ParseTree.new.parse_tree_for_string(code)}
+      sexps = feeder.map{|code,name| ParseTree.new.parse_tree_for_string(code)}
 
       sexps.each do |sexp|
         assert sexp.length > 0, "Parsed code should not be empty"

data/test/git_working_dir_feeder_test.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+require 'test/unit/testcase'
+require "ruby_diff"
+
+class GitWorkingDirFeederTestCase < Test::Unit::TestCase  
+  DIR = File.join(File.dirname(__FILE__), "git_sample")
+  
+  def test_find_all_files
+    assert File.exist?(DIR)
+    feeder = GitWorkingDirFeeder.new DIR
+    assert_equal 2, feeder.files.length
+  end
+  
+  def test_find_single_file
+    assert File.exist?(DIR)
+    feeder = GitWorkingDirFeeder.new(File.join(DIR,'lib','chapter.rb'))
+    assert_equal 1, feeder.files.length
+  end
+  
+  def test_find_files_in_sub_dir
+    feeder = GitWorkingDirFeeder.new(File.join(DIR,'lib'))
+    assert_equal 1, feeder.files.length
+  end
+  
+  def test_files_are_suitable_for_processing
+    feeder = GitWorkingDirFeeder.new DIR
+    assert_nothing_raised do
+      sexps = feeder.map{|code,name| ParseTree.new.parse_tree_for_string(code)}
+
+      sexps.each do |sexp|
+        assert sexp.length > 0, "Parsed code should not be empty"
+      end
+    end
+  end
+  
+end

data/test/structure_processor_test.rb

@@ -63,6 +63,22 @@ class StructureProcessorTestCase < Test::Unit::TestCase
     CODE
   end
   
+  def test_reader_attribute
+    assert_signatures <<-CODE, ["A {reader b}"], [MetaCode]
+      class A
+        attr_reader :b
+      end
+    CODE
+  end
+  
+  def test_multiple_writer_attributes
+    assert_signatures <<-CODE, ["A {writer b}", "A {writer c}"], [MetaCode]
+      class A
+        attr_writer :b, 'c'
+      end
+    CODE
+  end
+  
   def assert_signatures(code, signatures, types=[MethodCode])
     sexp = ParseTree.new.parse_tree_for_string(code)
     processor = StructureProcessor.new()

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: ruby_diff
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2008-06-04 00:00:00 -07:00
+  version: 0.1.5
+date: 2008-06-09 00:00:00 -07:00
 summary: a higher level diff application for analyzing changes to ruby code
 require_paths: 
 - lib
@@ -40,19 +40,25 @@ files:
 - lib/ruby_diff/code_comparison.rb
 - lib/ruby_diff/file_feeder.rb
 - lib/ruby_diff/git_feeder.rb
+- lib/ruby_diff/git_support.rb
+- lib/ruby_diff/git_working_dir_feeder.rb
 - lib/ruby_diff/patterns.rb
 - lib/ruby_diff/structure_processor.rb
 - ruby_diff.gemspec
+- test/code_comparison_test.rb
 - test/file_feeder_test.rb
 - test/git_feeder_test.rb
 - test/git_sample/README
 - test/git_sample/book.rb
 - test/git_sample/lib/chapter.rb
+- test/git_working_dir_feeder_test.rb
 - test/structure_processor_test.rb
 test_files: 
 - test/git_feeder_test.rb
 - test/file_feeder_test.rb
+- test/code_comparison_test.rb
 - test/structure_processor_test.rb
+- test/git_working_dir_feeder_test.rb
 rdoc_options: 
 - --main
 - README.txt