dep_walker 1.0.0

data/.autotest

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+ at.add_mapping(/.*\.c/) do |f, _|
+    at.files_matching(/test_.*rb$/)
+  end
+end
+
+Autotest.add_hook :run_command do |at|
+  system "rake clean compile"
+end

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-04-13
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/dep_walker
+ext/dep_walker/dep_walker.c
+ext/dep_walker/extconf.rb
+ext/dep_walker/win.c
+ext/dep_walker/win.h
+lib/dep_walker.rb
+test/test_dep_walker.rb

data/README.rdoc

@@ -0,0 +1,88 @@
+= dep_walker
+
+* GitHub: http://github.com/bosko/dep_walker
+* Issues: http://github.com/bosko/dep_walker/issues
+* Blog:   http://pragdevnotes.com
+
+== DESCRIPTION:
+
+The dep_walker is small utility gem that checks dependencies for native extensions
+used by installed gems on Windows. If you are {RubyInstaller}[http://www.rubyinstaller.org]
+user and have seen message box:
+
+<em>"This application has failed to start because <name_of_dll>.dll was not found.
+Re-installing the application may fix this problem"</em>
+
+when you tried to use gem that has pre-built binariy extension, you've faced common
+problem on Windows systems - missing dependency dll. Same error might occur even if
+extension library was built during gem installation if all header files and libraries
+are available to the build tools, but runtime dependencies are not present.
+
+With dep_walker you can simply check all installed gems. Even more, if log is turned on,
+gem will print out information where dependency is found on the system, so you can check
+whether Ruby extension really uses correct version of required dll.
+
+== FEATURES/PROBLEMS:
+
+* None at the moment
+
+== SYNOPSIS:
+
+The dep_walker can check all installed gems:
+
+ >dep_walker -a
+
+or just specific gem
+
+ >dep_walker -c nokogiri-1.4.4
+
+For verbose output use -t switch
+
+ >dep_walker -c nokogiri-1.4.4 -t
+
+Finally if you want colored output use --color option. In this case you must
+have {ANSICON}[http://adoxa.110mb.com/ansicon/index.html] installed.
+
+For full list of options use
+
+ >dep_walker -h
+
+== REQUIREMENTS:
+
+* rake
+* rubygems
+* hoe (development)
+* rake-compiler (development)
+
+== INSTALL:
+
+ >gem install dep_walker
+
+== DEVELOPERS:
+
+* Boško Ivanišević (bosko ivanisevic at gmail com)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Boško Ivanišević
+
+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/Rakefile

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'rake/extensiontask'
+
+Hoe.spec 'dep_walker' do
+  developer('Boško Ivanišević', 'bosko.ivanisevic@gmail.com')
+  self.url = %q{http://github.com/bosko/dep_walker}
+  self.readme_file = 'README.rdoc'
+  self.history_file = 'History.rdoc'
+  self.extra_rdoc_files = FileList['*.rdoc']
+  self.extra_dev_deps << ['rake-compiler', '>= 0']
+  self.spec_extras = { :extensions => ["ext/dep_walker/extconf.rb"] }
+
+  Rake::ExtensionTask.new('dep_walker', spec) do |ext|
+    ext.lib_dir = File.join('lib', 'dep_walker')
+  end
+end
+
+Rake::Task[:test].prerequisites << :compile

data/bin/dep_walker

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require "ostruct"
+require "optparse"
+require "dep_walker"
+
+def print_result(deps)
+  if deps.empty?
+    print green("All dependencies found")
+  else
+    deps.each do |k,v|
+      print red("Missing dependencies:\n  #{k}: ")
+      missing = []
+      v.each do |ext,dll|
+        missing << dll unless missing.include? dll
+      end
+      puts red(missing.join(","))
+    end
+  end
+end
+
+$options = OpenStruct.new
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: dep_walker [options]"
+  opts.separator ""
+  opts.separator "Options are ..."
+
+  opts.on('-c', '--check [GEM_NAME]', 'Check single gem') do |name|
+    $options.gem_name = name
+  end
+
+  opts.on('-i', '--gem-version [VERSION]', 'Gem version to be checked (optional)') do |version|
+    $options.gem_version = version
+  end
+  
+  opts.on('-a', '--all', 'Check all installed gems (overrides -c)') do
+    $options.check_all = true
+  end
+
+  opts.on('-t', '--trace', 'Print messages while checkint is performed') do
+    $options.trace = true
+  end
+
+  opts.on('', '--color', 'Enable color in output') do
+    $options.color = true
+  end
+  
+  opts.on('-v', '--version', 'Display program version') do
+    puts "DepWalker version #{DepWalker::VERSION}"
+    exit
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::ParseError => pe
+  puts pe.message
+  puts ''
+  puts optparse
+  exit
+end
+
+if $options.check_all
+  print_result(DepWalker.check_all)
+elsif $options.gem_name
+  print_result(DepWalker.check $options.gem_name, $options.gem_version)
+else
+  puts optparse
+end

data/ext/dep_walker/dep_walker.c

@@ -0,0 +1,18 @@
+#include <ruby.h>
+#include "win.h"
+
+static VALUE raw_dependencies(VALUE self, VALUE path)
+{
+  VALUE mDeps = rb_ary_new();
+  if (RSTRING_LEN(path) > 0)
+  {
+    DumpDllFromPath(mDeps, StringValuePtr(path));
+  }
+  return mDeps;
+}
+
+void Init_dep_walker()
+{
+  VALUE mDepWalker = rb_define_module("DepWalker");
+  rb_define_singleton_method(mDepWalker, "raw_dependencies", raw_dependencies, 1);
+}

data/ext/dep_walker/extconf.rb

@@ -0,0 +1,11 @@
+require "mkmf"
+
+unless find_header('imagehlp.h')
+  abort "header imagehlp.h is missing"
+end
+
+unless find_library('imagehlp', 'LoadImage')
+  abort "library imagehlp is missing"
+end
+
+create_makefile('dep_walker/dep_walker')

data/ext/dep_walker/win.c

@@ -0,0 +1,64 @@
+#include <windows.h>
+#include <imagehlp.h>
+#include <ruby.h>
+
+IMAGE_SECTION_HEADER* GetEnclosingSectionHeader(unsigned long rva, IMAGE_NT_HEADERS32* pNTHeader)
+{
+  IMAGE_SECTION_HEADER* section = IMAGE_FIRST_SECTION(pNTHeader);
+  unsigned int i;
+
+  for (i=0; i < pNTHeader->FileHeader.NumberOfSections; i++, section++)
+  {
+    unsigned long size = section->Misc.VirtualSize;
+    if (0 == size)
+    {
+      size = section->SizeOfRawData;
+    }
+
+    // Is the RVA within this section?
+    if ((rva >= section->VirtualAddress) &&
+        (rva < (section->VirtualAddress + size)))
+    {
+      return section;
+    }
+  }
+
+  return 0;
+}
+
+void* GetPtrFromRVA(unsigned long rva, IMAGE_NT_HEADERS32* pNTHeader, unsigned char* imageBase)
+{
+  IMAGE_SECTION_HEADER* pSectionHdr;
+  int delta;
+
+  pSectionHdr = GetEnclosingSectionHeader(rva, pNTHeader);
+  if (!pSectionHdr)
+    return 0;
+
+  delta = (int)(pSectionHdr->VirtualAddress-pSectionHdr->PointerToRawData);
+  return (void*)(imageBase + rva - delta);
+}
+
+void DumpDllFromPath(VALUE mDeps, char* path)
+{
+  LOADED_IMAGE* image=ImageLoad(path,0);
+
+  if (NULL != image && image->FileHeader->OptionalHeader.NumberOfRvaAndSizes>=2) {
+    IMAGE_IMPORT_DESCRIPTOR* importDesc=
+      (IMAGE_IMPORT_DESCRIPTOR*)GetPtrFromRVA(
+                         image->FileHeader->OptionalHeader.DataDirectory[1].VirtualAddress,
+                         image->FileHeader, image->MappedAddress);
+    while (1)
+    {
+      // See if we've reached an empty IMAGE_IMPORT_DESCRIPTOR
+      if ((importDesc->TimeDateStamp==0) && (importDesc->Name==0))
+        break;
+
+      rb_ary_push(mDeps, rb_str_new2((const char*)GetPtrFromRVA(importDesc->Name,
+                                                          image->FileHeader,
+                                                          image->MappedAddress)));
+      importDesc++;
+    }
+  }
+  ImageUnload(image);
+}

data/ext/dep_walker/win.h

@@ -0,0 +1,8 @@
+#ifndef _WIN_H_
+#define _WIN_H_
+
+IMAGE_SECTION_HEADER* GetEnclosingSectionHeader(unsigned long rva, IMAGE_NT_HEADERS32* pNTHeader);
+void* GetPtrFromRVA(unsigned long rva, IMAGE_NT_HEADERS32* pNTHeader, unsigned char* imageBase);
+void DumpDllFromPath(VALUE mDeps, char* path);
+
+#endif /* _WIN_H_ */

data/lib/dep_walker.rb

@@ -0,0 +1,164 @@
+$LOAD_PATH.unshift File.expand_path('../', __FILE__)
+require 'rubygems'
+require "dep_walker/dep_walker"
+
+##
+# Set the terminal's foreground color to green if
+# colored output is set through options
+##
+def green(string)
+  if $options.color
+    "\e[1;32m#{string}\e[0m"
+  else
+    string
+  end
+end
+
+##
+# Set the terminal's foreground color to red if
+# colored output is set through options
+##
+def red(string)
+  if $options.color
+    "\e[1;31m#{string}\e[0m"
+  else
+    string
+  end
+end
+
+##
+# Output message colored according to the message
+# level (info - no color, success - green, error - red)
+##
+def trace(message, level=TRACE_INFO)
+  return unless $options.trace
+  
+  case level
+  when DepWalker::TRACE_INFO
+    puts message
+  when DepWalker::TRACE_SUCCESS
+    puts green(message)
+  when DepWalker::TRACE_ERROR
+    puts red(message)
+  end
+end
+
+module DepWalker
+  extend self
+  
+  VERSION = '1.0.0'
+
+  ##
+  # Informational messages
+  ##
+  TRACE_INFO = 0
+
+  ##
+  # Succes messages
+  ##
+  TRACE_SUCCESS = 1
+
+  ##
+  # Error messages
+  #
+  TRACE_ERROR = 2
+
+  ##
+  # Checks dependencies for all installed gems. Returns
+  # hash of all unresolved dependencies with the full Gem
+  # name in keys and hash of extension libraries and
+  # dependencies that are not found in the system.
+  ##
+  def check_all
+    all_deps = {}
+    Gem::Specification.find_all.each do |spec|
+      gem_deps = check(spec)
+      all_deps[spec.full_name] = gem_deps unless gem_deps.empty?
+    end
+    
+    all_deps
+  end
+
+  ##
+  # Checks dependencis for a single Gem. Returns hash of extension
+  # library used by Gem as a key and array of unresolved dependencies
+  # as a value.
+  ##
+  def check(name_or_spec, version=nil)
+    gem_deps = {}
+    spec = name_or_spec.is_a?(String) ? Gem::Specification.find_all_by_name(name_or_spec, version) : name_or_spec
+    spec.each do |s|
+      walk_deps(s).each do |k,v|
+        gem_deps[k] = v[:not_found] unless v[:not_found].empty?
+      end
+    end
+    gem_deps
+  end
+
+  ##
+  # Search dependency dlls for all extension libraries in the Gem.
+  # Search is performed across all directories in the system path
+  # and the extension library's directory. Returns hash with a
+  # full path to extension library as a key and hash with all
+  # dependencies found with the paths from which they will be loade
+  # and all dependencies that are not found.
+  ##
+  def walk_deps(gem_spec)
+    dep_tree = {}
+    if gem_spec.is_a? Gem::Specification
+      trace("Checking #{gem_spec.full_name}", TRACE_INFO)
+      dependencies(gem_spec).each do |k,v|
+        trace("  #{k}", TRACE_INFO)
+        found = {}
+        not_found = []
+        v.each do |shlib|
+          if found[shlib].nil? || not_found.include?(shlib)
+            shlib_dir = find_shlib_dir(File.dirname(k), shlib)
+            if shlib_dir
+              found[shlib] = shlib_dir
+              trace("    #{shlib} -> Found at #{shlib_dir}", TRACE_SUCCESS)
+            elsif !shlib.start_with?("msvcrt-ruby")
+              not_found << shlib
+              trace("    #{shlib} -> Not found", TRACE_ERROR)
+            end
+          end
+        end
+        dep_tree[k] = {:found => found, :not_found => not_found}
+      end
+      trace("="*40, TRACE_INFO)
+    end
+    dep_tree
+  end
+
+  ##
+  # Returns dependencies for all shared libraries found in the
+  # Gem's directories
+  ##
+  def dependencies(gem_spec)
+    deps = {}
+    Dir.glob(File.join(gem_spec.full_gem_path, "**/*")).select do |f|
+      f if [".so",".dll"].include? File.extname(f)
+    end.each do |ext|
+      deps[ext] = dll_dependencies(ext)
+    end
+    deps
+  end
+
+  ##
+  # Returns all dependencies for input shared library
+  ##
+  def dll_dependencies(dll_path = "")
+    return [] unless ['.dll', '.so'].include? File.extname dll_path
+    
+    raw_dependencies(dll_path).map {|dep| dep.downcase}.uniq
+  end
+
+  private
+
+  def find_shlib_dir(init_path, shlib)
+    ENV["PATH"].split(File::PATH_SEPARATOR).unshift(init_path).each do |path|
+      return path if File.file?(File.join(path, shlib))
+    end
+    nil
+  end
+end

data/test/test_dep_walker.rb

@@ -0,0 +1,22 @@
+require "test/unit"
+require "dep_walker"
+
+class TestDepWalker < Test::Unit::TestCase
+  def test_no_argument
+    deps = DepWalker.dll_dependencies
+    assert deps.is_a? Array
+    assert_equal 0, deps.length
+  end
+
+  def test_dep_walker
+    path = File.join(File.expand_path('../../lib/dep_walker', __FILE__), 'dep_walker.so')
+    deps = DepWalker.dll_dependencies path
+    assert_equal 4, deps.length
+    assert deps.include? 'msvcrt.dll'
+    assert deps.include? 'imagehlp.dll'
+  end
+
+  def test_wrong_extension
+    assert_equal 0, DepWalker.dll_dependencies("dummy.txt").length
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dep_walker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Boško Ivanišević
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &22551840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22551840
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &22548516 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *22548516
+description: ! 'The dep_walker is small utility gem that checks dependencies for native
+  extensions
+
+  used by installed gems on Windows. If you are {RubyInstaller}[http://www.rubyinstaller.org]
+
+  user and have seen message box:
+
+
+  <em>"This application has failed to start because <name_of_dll>.dll was not found.
+
+  Re-installing the application may fix this problem"</em>
+
+
+  when you tried to use gem that has pre-built binariy extension, you''ve faced common
+
+  problem on Windows systems - missing dependency dll. Same error might occur even
+  if
+
+  extension library was built during gem installation if all header files and libraries
+
+  are available to the build tools, but runtime dependencies are not present.
+
+
+  With dep_walker you can simply check all installed gems. Even more, if log is turned
+  on,
+
+  gem will print out information where dependency is found on the system, so you can
+  check
+
+  whether Ruby extension really uses correct version of required dll.'
+email:
+- bosko.ivanisevic@gmail.com
+executables:
+- dep_walker
+extensions:
+- ext/dep_walker/extconf.rb
+extra_rdoc_files:
+- Manifest.txt
+- History.rdoc
+- README.rdoc
+files:
+- .autotest
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/dep_walker
+- ext/dep_walker/dep_walker.c
+- ext/dep_walker/extconf.rb
+- ext/dep_walker/win.c
+- ext/dep_walker/win.h
+- lib/dep_walker.rb
+- test/test_dep_walker.rb
+- .gemtest
+homepage: http://github.com/bosko/dep_walker
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: dep_walker
+rubygems_version: 1.8.1
+signing_key: 
+specification_version: 3
+summary: The dep_walker is small utility gem that checks dependencies for native extensions
+  used by installed gems on Windows
+test_files:
+- test/test_dep_walker.rb