gem_file_conflict_checker 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 rdp
+
+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,68 @@
+= gem_conflict_plugin
+
+This is a rubygems plugin that warns warn you when you accidentally install gems that have filenames that collide and hence are unstable.
+
+Background:
+
+Currently with rubygems (1.3.5), if you install two gems that have same-named files, like
+
+gem1/lib/a.rb
+
+gem2/lib/a.rb
+
+Then do a
+
+require 'rubygems'
+require 'a'
+
+There is no guarantee of *which* a it is going to load.
+
+This can cause some really bizarre errors when, for example, in the middle of requiring gem1 gem, that gem does a
+
+require 'a'
+
+which ends up requiring a *from a totally different, unexpected, other gem*, like gem2.
+
+This can lead to unrelated looking errors, like
+
+'undefined method `sexp_type' for class `Sexp' (NameError)'
+
+or 'undefined constants Sane::OS'
+
+which really aren't helpful to deciphering the root cause (that you have conflicting gems installed).
+
+=============== What this gem does
+
+This gem creates a rubygems post_install hook that sanity checks your gems, looking for any files that could possibly conflict. If there is a conflict, it outputs a warning message to the screen about it.
+
+ex:
+
+E:\>gem install require_all
+warning: gem_conflict_plugin: conflicts detected! (they may be expected) your rubygems have one or more gems with conflicting lib/* filenames...
+ "require_all" was found redundantly in the libs of these gems: rdp-require_all (lib/require_all.rb), require_all (lib/require_all.rb)
+ 
+
+In this example two gems were installed with conflicting (competing) filenames--require_all.rb was found in rdp-require_all and require_all.
+
+The post install hook warned me of the problem, and I promptly uninstalled the one I didn't want so that there would be no confusion.
+
+================== Usage/Installation
+
+$ gem install gem_file_conflict_checker
+$ gem install gem_file_conflict_checker 
+# install it twice so that it will run its post install hooks and warn you of any conflicts.  Any gem install after this point will also warn you.
+
+
+This is especially useful for those of us who are using various versions of gems and forking them and installing our own versions, etc., to sanity check which gems are installed.  It is hoped that a future version of rubygems will alleviate this problem, and patches have been proposed [1].
+
+Enjoy.
+
+-r
+
+Feedback welcome:
+http://github.com/rdp/gem_file_conflict_checker
+
+refs:
+
+[1] http://rubyforge.org/tracker/index.php?func=detail&aid=27318&group_id=126&atid=578
+http://www.ruby-forum.com/topic/190217

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gem_file_conflict_checker"
+    gem.summary = %Q{A gem plugin to warn you when you accidentally install files with names that collide accidentally}
+    gem.email = "rogerpack2005@gmail.com"
+    gem.homepage = "http://github.com/rdp/gem_file_conflict_checker"
+    gem.authors = ["rdp"]
+  end
+  Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/conflict_checker.rb

@@ -0,0 +1,56 @@
+class ConflictChecker
+
+  # check some files
+  # expects input like
+  # :lib1 => 'lib/file1.rb',
+  # :lib2 => 'lib/file2.rb'
+  def check names_with_files
+    existing_list = {}
+    conflict_list = {}
+
+    for name, files in names_with_files
+      for file in files
+        orig_file = file.dup
+        file = file.split('/')[1..-1].join('/') # strip off lib/
+        
+        
+        if file =~ /_plugin.rb$/ # ignore lib/rubygems_plugin.rb, which *can* be redundant across gems
+          next
+        end
+        
+        if file =~ /(.rb|.so)$/
+          file = file.split('.')[0..-2].join('.') # strip off .rb .so
+        else
+         next # skip directories...
+        end
+        
+        if existing_list[file]
+          # add it to the bad list
+          if conflict_list[file]
+            conflict_list[file] << [name, orig_file] # add it to the list...
+          else
+           conflict_list[file] = [existing_list[file], [name, orig_file]]
+         end
+        end
+        existing_list[file] = [name, orig_file]
+      end
+    end
+    conflict_list
+  end
+
+  def self.do_all_gems
+    all = {}; Gem.source_index.latest_specs.map{|s| all[s.name] = s.lib_files}
+    collisions = ConflictChecker.new.check all
+    if collisions.length > 0
+      puts "warning: gem_conflict_plugin: conflicts detected! (they may be expected) your rubygems have one or more gems with conflicting lib/* filenames..."
+      for filename, gems in collisions
+        print " \"#{filename}\" was found redundantly in the libs of these gems: "
+        puts gems.map{|gem_name, file_name| "#{gem_name} (#{file_name})"}.join(', ')
+      end
+      puts
+    else
+      puts "all clean--your rubygems has no reported conflicting filenames"
+    end
+    collisions
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,4 @@
+Gem.post_install {
+  require 'conflict_checker'
+  ConflictChecker.do_all_gems
+}

data/spec/spec.gem_conflict_plugin.rb

@@ -0,0 +1,62 @@
+require 'spec/autorun'
+require 'sane'
+require __dir__ + '/../lib/conflict_checker'
+require 'rubygems'
+
+describe "conflict plugin" do
+
+  before do
+    @a = ConflictChecker.new
+    Gem.clear_paths 
+  end
+
+  it "should alert you of potential conflicts" do
+    conflict = {:lib1 => ['lib/go.rb'], :lib2 => ['lib/go.rb']}
+    @a.check(conflict).should == {"go"=>[[:lib1, "lib/go.rb"], [:lib2, "lib/go.rb"]]}
+  end
+
+=begin example  
+  # pp Gem.source_index.latest_specs[0].lib_files
+["lib/map_reduce",
+ "lib/map_reduce.rb",
+ "lib/starfish.rb",
+ "lib/map_reduce/active_record.rb",
+ "lib/map_reduce/array.rb",
+ "lib/map_reduce/file.rb"]
+=end
+  
+  it "should also do subdir clashes" do
+    conflict = {:lib1 => ['lib/y/go.rb'], :lib2 => ['lib/y/go.rb']}
+    @a.check(conflict).should == {"y/go"=>[[:lib1, "lib/y/go.rb"], [:lib2, "lib/y/go.rb"]]}
+  end
+
+  it "should work with non lib directories" do
+    pending "request"
+  end
+  
+  it "should pass back a hash" do
+    ConflictChecker.do_all_gems.should be_a(Hash)
+  end
+  
+  it "should detect collisions between .rb and .so" do
+    conflict = {:lib1 => ['lib/y/go.so'], :lib2 => ['lib/y/go.rb']}
+    @a.check(conflict).should ==  {"y/go"=>[[:lib1, "lib/y/go.so"], [:lib2, "lib/y/go.rb"]]}
+    
+  end
+  
+  it "should do triple collisions" do
+    conflict = {:lib1 => ['lib/go.rb'], :lib2 => ['lib/go.rb'], :lib3 => ['lib/go.rb']}
+    @a.check(conflict).should ==  {"go"=>[[:lib1, "lib/go.rb"], [:lib2, "lib/go.rb"], [:lib3, "lib/go.rb"]]}
+  end
+  
+  it "should ignore directory looking entires" do
+    conflict = {:lib1 => ['lib/y/go.so'], :lib2 => ['lib/y/go']}
+    @a.check(conflict).should == {}
+  end
+  
+  it "should ignore plugins which can be redundant" do
+    conflict = {:lib1 => ['lib/y/go_plugin.rb'], :lib2 => ['lib/y/go_plugin.rb']}
+    @a.check(conflict).should == {}
+  end
+  
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: gem_file_conflict_checker
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- rdp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rogerpack2005@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/conflict_checker.rb
+- lib/rubygems_plugin.rb
+- spec/spec.gem_conflict_plugin.rb
+has_rdoc: true
+homepage: http://github.com/rdp/gem_file_conflict_checker
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem plugin to warn you when you accidentally install files with names that collide accidentally
+test_files: 
+- spec/spec.gem_conflict_plugin.rb