Module: RequireAll

Defined in:
lib/arg_scanner/require_all.rb

Overview

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.

Instance Method Summary collapse

Instance Method Details

#autoload_all(*paths) ⇒ Object

Performs Kernel#autoload on all of the files rather than requiring immediately.

Note that all Ruby files inside of the specified directories should have same module name as the directory itself and file names should reflect the class/module names. For example if there is a my_file.rb in directories dir1/dir2/ then there should be a declaration like this in my_file.rb:

 module Dir1
   module Dir2
     class MyFile
       ...
     end
   end
end

If the filename and namespaces won’t match then my_file.rb will be loaded into wrong module! Better to fix these files.

Set $DEBUG=true to see how files will be autoloaded if experiencing any problems.

If trying to perform autoload on some individual file or some inner module, then you’d have to always specify :base_dir option to specify where top-level namespace resides. Otherwise it’s impossible to know the namespace of the loaded files.

For example loading only my_file.rb from dir1/dir2 with autoload_all:

autoload_all File.dirname(__FILE__) + '/dir1/dir2/my_file',
             :base_dir => File.dirname(__FILE__) + '/dir1'

WARNING: All modules will be created even if files themselves aren’t loaded yet, meaning that all the code which depends of the modules being loaded or not will not work, like usages of define? and it’s friends.

Also, normal caveats of using Kernel#autoload apply - you have to remember that before applying any monkey-patches to code using autoload, you’ll have to reference the full constant to load the code before applying your patch!



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/arg_scanner/require_all.rb', line 225

def autoload_all(*paths)
  paths.flatten!
  return false if paths.empty?
  require "pathname"

  options = {:method => :autoload}
  options.merge!(paths.pop) if paths.last.is_a?(Hash)

  paths.each do |path|
    require_all path, {:base_dir => path}.merge(options)
  end
end

#autoload_rel(*paths) ⇒ Object

Performs autoloading relatively from the caller instead of using current working directory



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/arg_scanner/require_all.rb', line 239

def autoload_rel(*paths)
  paths.flatten!
  return false if paths.empty?
  require "pathname"

  options = {:method => :autoload}
  options.merge!(paths.pop) if paths.last.is_a?(Hash)

  source_directory = File.dirname caller.first.sub(/:\d+$/, '')
  paths.each do |path|
    file_path = Pathname.new(source_directory).join(path).to_s
    require_all file_path, {:method => :autoload,
                            :base_dir => source_directory}.merge(options)
  end
end

#load_all(*paths) ⇒ Object

Loads all files like require_all instead of requiring



173
174
175
 
# File 'lib/arg_scanner/require_all.rb', line 173

def load_all(*paths)
  require_all paths, :method => :load
end

#load_rel(*paths) ⇒ Object

Loads all files by using relative paths of the caller rather than the current working directory



179
180
181
182
183
184
185
186
187
 
# File 'lib/arg_scanner/require_all.rb', line 179

def load_rel(*paths)
  paths.flatten!
  return false if paths.empty?

  source_directory = File.dirname caller.first.sub(/:\d+$/, '')
  paths.each do |path|
    require_all File.join(source_directory, path), :method => :load
  end
end

#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'



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/arg_scanner/require_all.rb', line 49

def require_all(*args)
  # Handle passing an array as an argument
  args.flatten!

  options = {:method => :require}
  options.merge!(args.pop) if args.last.is_a?(Hash)

  if args.empty?
    puts "no files were loaded due to an empty Array" if $DEBUG
    return false
  end

  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 SystemCallError
      # 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')
        file = arg + '.rb'
        options[:method] != :autoload ? Kernel.send(options[:method], file) : __autoload(file, file, options)
        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

  return if files.empty?

  if options[:method] == :autoload
    files.map! { |file_| [file_, File.expand_path(file_)] }
    files.each do |file_, full_path|
      __autoload(file_, full_path, options)
    end

    return true
  end

  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
        Kernel.send(options[:method], 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



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/arg_scanner/require_all.rb', line 161

def require_rel(*paths)
  # Handle passing an array as an argument
  paths.flatten!
  return false if paths.empty?

  source_directory = File.dirname caller.first.sub(/:\d+$/, '')
  paths.each do |path|
    require_all File.join(source_directory, path)
  end
end