load_glob 1.0.0

data/CHANGES

@@ -0,0 +1,3 @@
+1.0.0:
+
+* Initial release

data/LICENSE

@@ -0,0 +1,58 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README.textile

@@ -0,0 +1,56 @@
+h1. load_glob
+
+Tired of futzing around with require statements everywhere, littering your code
+with <code>require File.dirname(__FILE__)</code> crap?  What if you could just 
+point something at a big directory full of code and have everything just 
+automagically load regardless of the dependency structure?  
+
+Wouldn't that be nice?  Well, now you can!
+
+ <code>require 'load_glob'</code>
+
+This gem defines a single method on main:
+
+ <code>load_glob(glob)</code>
+
+which will enumerate the files in the given glob, determining the proper
+order to load them in.  So, to load all the Ruby files under the 'lib'
+directory, just do:
+
+ <code>load_glob 'lib/**/*.rb'</code>
+
+If the dependencies are unresolvable, it will throw the first unresolvable
+NameError.
+
+That's it!
+
+h2. Methodology
+
+I didn't invent the approach this gem uses.  It was shamelessly stolen from
+Merb.  Once upon a time at MountainWest RubyConf we were discussing how 
+horrible ActiveSupport's dependencies.rb hijacking of const_missing and
+someone described the approach Merb used to me.  It was so simple and clean!
+Here's how it works:
+
+# Enumerate the files in the glob
+# Try to load all of the files.  If we encounter a NameError loading a 
+  particular file, store that file in a "try to load it later" list.
+# If all the files loaded, great, we're done!  If not, go through the
+  "try to load it later" list again rescuing NameErrors the same way.
+# If we walk the whole "try to load it later" list and it doesn't shrink
+  at all, we've encountered an unresolvable dependency.  In this case,
+  load_glob will rethrow the first NameError it encountered.
+
+h2. Questions? Concerns?
+
+You can reach the author on github or freenode: "tarcieri"
+
+Or by email: tony@medioh.com
+
+The Github issue tracker is here:
+
+http://github.com/tarcieri/load_glob/issues
+
+h2. License
+
+MIT (see the LICENSE file for details)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/clean'
+
+Dir['tasks/**/*.rake'].each { |task| load task }
+
+task :default => :spec
+
+task :clean do
+  %w[pkg coverage].each do |dir|
+    rm_rf dir
+  end
+end

data/lib/load_glob.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright (C)2009 Tony Arcieri
+# You can redistribute this under the terms of the MIT license
+# See file LICENSE for details
+#++
+
+module LoadGlob
+  # Load all files matching the given glob, handling dependencies between
+  # the files gracefully
+  def load_glob(glob)
+    files = Dir[glob].map { |file| File.expand_path file }
+            
+    begin
+      failed = []
+      first_name_error = nil
+      
+      # Attempt to load each file, rescuing which ones raise NameError for
+      # undefined constants.  Keep trying to successively reload files that 
+      # previously caused NameErrors until they've all been loaded or no new
+      # files can be loaded, indicating unresolvable dependencies.
+      files.each do |file|
+        begin
+          require file
+        rescue NameError => ex
+          failed << file
+          first_name_error ||= ex
+        rescue ArgumentError => ex
+          # Work around ActiveSuport freaking out... *sigh*
+          #
+          # ActiveSupport sometimes throws these exceptions and I really
+          # have no idea why.  Code loading will work successfully if these
+          # exceptions are swallowed, although I've run into strange 
+          # nondeterministic behaviors with constants mysteriously vanishing.
+          # I've gone spelunking through dependencies.rb looking for what 
+          # exactly is going on, but all I ended up doing was making my eyes 
+          # bleed.
+          #
+          # FIXME: If you can understand ActiveSupport's dependencies.rb 
+          # better than I do I would *love* to find a better solution
+          raise ex unless ex["is not missing constant"]
+          STDERR.puts "Warning: load_glob swallowed ActiveSupport 'is not missing constant' error"
+          STDERR.puts ex.backtrace[0..9]
+        end
+      end
+      
+      # If this pass didn't resolve any NameErrors, we've hit an unresolvable
+      # dependency, so raise one of the exceptions we encountered.
+      if failed.size == files.size
+        raise first_name_error
+      else
+        files = failed
+      end
+    end until failed.empty?
+    
+    true
+  end
+end
+
+include LoadGlob

data/load_glob.gemspec

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = "load_glob"
+  s.version = "1.0.0"
+  s.authors = "Tony Arcieri"
+  s.email = "tony@medioh.com"
+  s.date = "2009-06-08"
+  s.summary = "Load all files matching a given glob, resolving dependencies automagically"
+  s.platform = Gem::Platform::RUBY
+
+  # Gem contents
+  s.files = Dir.glob("{lib,spec}/**/*") + ['Rakefile', 'load_glob.gemspec']
+
+  # RubyForge info
+  s.homepage = "http://github.com/tarcieri/load_glob"
+  s.rubyforge_project = "codeforpeople"
+
+  # RDoc settings
+  s.has_rdoc = true
+  s.rdoc_options = %w(--title load_glob --main README.textile --line-numbers)
+  s.extra_rdoc_files = ["LICENSE", "README.textile", "CHANGES"]
+
+  # Extensions
+  s.extensions = FileList["ext/**/extconf.rb"].to_a
+end

data/spec/fixtures/resolvable/a.rb

@@ -0,0 +1 @@
+class A < C; end

data/spec/fixtures/resolvable/b.rb

@@ -0,0 +1 @@
+class B < A; end

data/spec/fixtures/resolvable/c.rb

@@ -0,0 +1 @@
+class C; end

data/spec/fixtures/resolvable/d.rb

@@ -0,0 +1 @@
+class D < C; end

data/spec/fixtures/unresolvable/a.rb

@@ -0,0 +1 @@
+class A < C; end

data/spec/fixtures/unresolvable/b.rb

@@ -0,0 +1 @@
+class B < A; end

data/spec/fixtures/unresolvable/c.rb

@@ -0,0 +1 @@
+class C < Nonexistent; end

data/spec/fixtures/unresolvable/d.rb

@@ -0,0 +1 @@
+class D < C; end

data/spec/load_glob_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../lib/load_glob.rb'
+
+describe "load_glob" do    
+  it "handles load ordering when dependencies are resolvable" do
+    load_glob File.dirname(__FILE__) + '/fixtures/resolvable/*.rb'
+    
+    defined?(A).should == "constant"
+    defined?(B).should == "constant"
+    defined?(C).should == "constant"
+    defined?(D).should == "constant"
+  end
+  
+  it "raises NameError if dependencies can't be resolved" do
+    proc do 
+      load_glob File.dirname(__FILE__) + '/fixtures/unresolvable/*.rb'
+    end.should raise_error(NameError)
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: load_glob
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tony Arcieri
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tony@medioh.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+- CHANGES
+files: 
+- lib/load_glob.rb
+- spec/fixtures/resolvable/a.rb
+- spec/fixtures/resolvable/b.rb
+- spec/fixtures/resolvable/c.rb
+- spec/fixtures/resolvable/d.rb
+- spec/fixtures/unresolvable/a.rb
+- spec/fixtures/unresolvable/b.rb
+- spec/fixtures/unresolvable/c.rb
+- spec/fixtures/unresolvable/d.rb
+- spec/load_glob_spec.rb
+- Rakefile
+- load_glob.gemspec
+- LICENSE
+- README.textile
+- CHANGES
+has_rdoc: true
+homepage: http://github.com/tarcieri/load_glob
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- load_glob
+- --main
+- README.textile
+- --line-numbers
+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: codeforpeople
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Load all files matching a given glob, resolving dependencies automagically
+test_files: []
+