Module: RequireAll

Defined in:
lib/chingu/require_all.rb

Overview

– Copyright ©2009 Tony Arcieri You can redistribute this under the terms of the MIT license See file LICENSE for details ++

Instance Method Summary collapse

Instance Method Details

#require_all(*args) ⇒ Object

A wonderfully simple way to load your code.

The easiest way to use require_all is to just point it at a directory containing a bunch of .rb files. These files can be nested under subdirectories as well:

require_all 'lib'

This will find all the .rb files under the lib directory and load them. The proper order to load them in will be determined automatically.

If the dependencies between the matched files are unresolvable, it will throw the first unresolvable NameError.

You can also give it a glob, which will enumerate all the matching files: 

require_all 'lib/**/*.rb'

It will also accept an array of files:

require_all Dir.glob("blah/**/*.rb").reject { |f| stupid_file(f) }

Or if you want, just list the files directly as arguments:

require_all 'lib/a.rb', 'lib/b.rb', 'lib/c.rb', 'lib/d.rb'

Raises:

  • (LoadError) 


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/chingu/require_all.rb', line 34

def require_all(*args)
  # Handle passing an array as an argument
  args.flatten!
  
  if args.size > 1
    # Expand files below directories
    files = args.map do |path|
      if File.directory? path
        Dir[File.join(path, '**', '*.rb')]
      else
        path
      end
    end.flatten
  else
    arg = args.first
    begin
      # Try assuming we're doing plain ol' require compat
      stat = File.stat(arg)
      
      if stat.file?
        files = [arg]
      elsif stat.directory?
        files = Dir.glob File.join(arg, '**', '*.rb')
      else
        raise ArgumentError, "#{arg} isn't a file or directory"
      end
    rescue Errno::ENOENT
      # If the stat failed, maybe we have a glob!
      files = Dir.glob arg
      
      # Maybe it's an .rb file and the .rb was omitted
      if File.file?(arg + '.rb')
        require(arg + '.rb')
        return true
      end
      
      # If we ain't got no files, the glob failed
      raise LoadError, "no such file to load -- #{arg}" if files.empty?
    end
  end

  # If there's nothing to load, you're doing it wrong!
  raise LoadError, "no files to load" if files.empty?
  
  files.map! { |file| File.expand_path file }
  files.sort!
          
  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 unless ex.message["is not missing constant"]
        
        STDERR.puts "Warning: require_all 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

#require_rel(*paths) ⇒ Object

Works like require_all, but paths are relative to the caller rather than the current working directory



129
130
131
132
133
134
135
136
137
 
# File 'lib/chingu/require_all.rb', line 129

def require_rel(*paths)
  # Handle passing an array as an argument
  paths.flatten!
  
  source_directory = File.dirname caller.first.sub(/:\d+$/, '')
  paths.each do |path|
    require_all File.join(source_directory, path)
  end
end