Module: ActiveSupport::Dependencies

Extended by:
Dependencies
Included in:
Dependencies
Defined in:
activesupport/lib/active_support/dependencies.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Blamable, Loadable, ModuleConstMissing Classes: ClassCache, WatchStack

Constant Summary

Reference =
ClassCache.new

Instance Method Summary (collapse)

Instance Method Details

- (Object) autoload_module!(into, const_name, qualified_name, path_suffix)

Attempt to autoload the provided module name by searching for a directory matching the expected path suffix. If found, the module is created and assigned to into's constants with the name const_name. Provided that the directory was loaded from a reloadable base path, it is added to the set of constants that are to be unloaded.



420
421
422
423
424
425
426
# File 'activesupport/lib/active_support/dependencies.rb', line 420

def autoload_module!(into, const_name, qualified_name, path_suffix)
  return nil unless base_path = autoloadable_module?(path_suffix)
  mod = Module.new
  into.const_set const_name, mod
  autoloaded_constants << qualified_name unless autoload_once_paths.include?(base_path)
  mod
end

- (Boolean) autoloadable_module?(path_suffix)

Does the provided path_suffix correspond to an autoloadable module? Instead of returning a boolean, the autoload base for this module is returned.



402
403
404
405
406
407
# File 'activesupport/lib/active_support/dependencies.rb', line 402

def autoloadable_module?(path_suffix)
  autoload_paths.each do |load_path|
    return load_path if File.directory? File.join(load_path, path_suffix)
  end
  nil
end

- (Boolean) autoloaded?(desc)

Determine if the given constant has been automatically loaded.



593
594
595
596
597
598
# File 'activesupport/lib/active_support/dependencies.rb', line 593

def autoloaded?(desc)
  return false if desc.is_a?(Module) && desc.anonymous?
  name = to_constant_name desc
  return false unless qualified_const_defined? name
  return autoloaded_constants.include?(name)
end

- (Object) clear



316
317
318
319
320
# File 'activesupport/lib/active_support/dependencies.rb', line 316

def clear
  log_call
  loaded.clear
  remove_unloadable_constants!
end

- (Object) constantize(name)

Get the reference for class named name. Raises an exception if referenced class does not exist.



582
583
584
# File 'activesupport/lib/active_support/dependencies.rb', line 582

def constantize(name)
  Reference.get(name)
end

- (Object) depend_on(file_name, message = "No such file to load -- %s.rb")



305
306
307
308
309
310
311
312
313
314
# File 'activesupport/lib/active_support/dependencies.rb', line 305

def depend_on(file_name, message = "No such file to load -- %s.rb")
  path = search_for_file(file_name)
  require_or_load(path || file_name)
rescue LoadError => load_error
  if file_name = load_error.message[/ -- (.*?)(\.rb)?$/, 1]
    load_error.message.replace(message % file_name)
    load_error.copy_blame!(load_error)
  end
  raise
end

- (Object) hook!



290
291
292
293
294
# File 'activesupport/lib/active_support/dependencies.rb', line 290

def hook!
  Object.class_eval { include Loadable }
  Module.class_eval { include ModuleConstMissing }
  Exception.class_eval { include Blamable }
end

- (Boolean) load?



301
302
303
# File 'activesupport/lib/active_support/dependencies.rb', line 301

def load?
  mechanism == :load
end

- (Object) load_file(path, const_paths = loadable_constants_for_path(path))

Load the file at the provided path. const_paths is a set of qualified constant names. When loading the file, Dependencies will watch for the addition of these constants. Each that is defined will be marked as autoloaded, and will be removed when Dependencies.clear is next called.

If the second parameter is left off, then Dependencies will construct a set of names that the file at path may define. See loadable_constants_for_path for more details.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# File 'activesupport/lib/active_support/dependencies.rb', line 436

def load_file(path, const_paths = loadable_constants_for_path(path))
  log_call path, const_paths
  const_paths = [const_paths].compact unless const_paths.is_a? Array
  parent_paths = const_paths.collect { |const_path| const_path[/.*(?=::)/] || ::Object }

  result = nil
  newly_defined_paths = new_constants_in(*parent_paths) do
    result = Kernel.load path
  end

  autoloaded_constants.concat newly_defined_paths unless load_once_path?(path)
  autoloaded_constants.uniq!
  log "loading #{path} defined #{newly_defined_paths * ', '}" unless newly_defined_paths.empty?
  result
end

- (Object) load_missing_constant(from_mod, const_name)

Load the constant named const_name which is missing from from_mod. If it is not possible to load the constant into from_mod, try its parent module using const_missing.

Raises:



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
# File 'activesupport/lib/active_support/dependencies.rb', line 461

def load_missing_constant(from_mod, const_name)
  log_call from_mod, const_name

  unless qualified_const_defined?(from_mod.name) && Inflector.constantize(from_mod.name).equal?(from_mod)
    raise ArgumentError, "A copy of #{from_mod} has been removed from the module tree but is still active!"
  end

  qualified_name = qualified_name_for from_mod, const_name
  path_suffix = qualified_name.underscore

  file_path = search_for_file(path_suffix)

  if file_path
    expanded = File.expand_path(file_path)
    expanded.sub!(/\.rb\z/, '')

    if loaded.include?(expanded)
      raise "Circular dependency detected while autoloading constant #{qualified_name}"
    else
      require_or_load(expanded, qualified_name)
      raise LoadError, "Unable to autoload constant #{qualified_name}, expected #{file_path} to define it" unless from_mod.const_defined?(const_name, false)
      return from_mod.const_get(const_name)
    end
  elsif mod = autoload_module!(from_mod, const_name, qualified_name, path_suffix)
    return mod
  elsif (parent = from_mod.parent) && parent != from_mod &&
        ! from_mod.parents.any? { |p| p.const_defined?(const_name, false) }
    # If our parents do not have a constant named +const_name+ then we are free
    # to attempt to load upwards. If they do have such a constant, then this
    # const_missing must be due to from_mod::const_name, which should not
    # return constants from from_mod's parents.
    begin
      # Since Ruby does not pass the nesting at the point the unknown
      # constant triggered the callback we cannot fully emulate constant
      # name lookup and need to make a trade-off: we are going to assume
      # that the nesting in the body of Foo::Bar is [Foo::Bar, Foo] even
      # though it might not be. Counterexamples are
      #
      #   class Foo::Bar
      #     Module.nesting # => [Foo::Bar]
      #   end
      #
      # or
      #
      #   module M::N
      #     module S::T
      #       Module.nesting # => [S::T, M::N]
      #     end
      #   end
      #
      # for example.
      return parent.const_missing(const_name)
    rescue NameError => e
      raise unless e.missing_name? qualified_name_for(parent, const_name)
    end
  end

  raise NameError,
        "uninitialized constant #{qualified_name}",
        caller.reject { |l| l.starts_with? __FILE__ }
end

- (Boolean) load_once_path?(path)



409
410
411
412
413
# File 'activesupport/lib/active_support/dependencies.rb', line 409

def load_once_path?(path)
  # to_s works around a ruby1.9 issue where String#starts_with?(Pathname)
  # will raise a TypeError: no implicit conversion of Pathname into String
  autoload_once_paths.any? { |base| path.starts_with? base.to_s }
end

- (Object) loadable_constants_for_path(path, bases = autoload_paths)

Given path, a filesystem path to a ruby file, return an array of constant paths which would cause Dependencies to attempt to load this file.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'activesupport/lib/active_support/dependencies.rb', line 368

def loadable_constants_for_path(path, bases = autoload_paths)
  path = $` if path =~ /\.rb\z/
  expanded_path = File.expand_path(path)
  paths = []

  bases.each do |root|
    expanded_root = File.expand_path(root)
    next unless %r{\A#{Regexp.escape(expanded_root)}(/|\\)} =~ expanded_path

    nesting = expanded_path[(expanded_root.size)..-1]
    nesting = nesting[1..-1] if nesting && nesting[0] == ?/
    next if nesting.blank?

    paths << nesting.camelize
  end

  paths.uniq!
  paths
end

- (Object) mark_for_unload(const_desc)

Mark the provided constant name for unloading. This constant will be unloaded on each request, not just the next one.



608
609
610
611
612
613
614
615
616
# File 'activesupport/lib/active_support/dependencies.rb', line 608

def mark_for_unload(const_desc)
  name = to_constant_name const_desc
  if explicitly_unloadable_constants.include? name
    false
  else
    explicitly_unloadable_constants << name
    true
  end
end

- (Object) new_constants_in(*descs)

Run the provided block and detect the new constants that were loaded during its execution. Constants may only be regarded as 'new' once – so if the block calls new_constants_in again, then the constants defined within the inner call will not be reported in this one.

If the provided block does not run to completion, and instead raises an exception, any new constants are regarded as being only partially defined and will be removed immediately.



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'activesupport/lib/active_support/dependencies.rb', line 626

def new_constants_in(*descs)
  log_call(*descs)

  constant_watch_stack.watch_namespaces(descs)
  aborting = true

  begin
    yield # Now yield to the code that is to define new constants.
    aborting = false
  ensure
    new_constants = constant_watch_stack.new_constants

    log "New constants: #{new_constants * ', '}"
    return new_constants unless aborting

    log "Error during loading, removing partially loaded constants "
    new_constants.each { |c| remove_constant(c) }.clear
  end

  []
end

- (Boolean) qualified_const_defined?(path)

Is the provided constant path defined?



361
362
363
# File 'activesupport/lib/active_support/dependencies.rb', line 361

def qualified_const_defined?(path)
  Object.qualified_const_defined?(path.sub(/^::/, ''), false)
end

- (Object) qualified_name_for(mod, name)

Returns the constant path for the provided parent and constant name.



453
454
455
456
# File 'activesupport/lib/active_support/dependencies.rb', line 453

def qualified_name_for(mod, name)
  mod_name = to_constant_name mod
  mod_name == "Object" ? name.to_s : "#{mod_name}::#{name}"
end

- (Object) reference(klass)

Store a reference to a class klass.



576
577
578
# File 'activesupport/lib/active_support/dependencies.rb', line 576

def reference(klass)
  Reference.store klass
end

- (Object) remove_constant(const)

:nodoc:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
# File 'activesupport/lib/active_support/dependencies.rb', line 661

def remove_constant(const) #:nodoc:
  # Normalize ::Foo, ::Object::Foo, Object::Foo, Object::Object::Foo, etc. as Foo.
  normalized = const.to_s.sub(/\A::/, '')
  normalized.sub!(/\A(Object::)+/, '')

  constants = normalized.split('::')
  to_remove = constants.pop

  # Remove the file path from the loaded list.
  file_path = search_for_file(const.underscore)
  if file_path
    expanded = File.expand_path(file_path)
    expanded.sub!(/\.rb\z/, '')
    self.loaded.delete(expanded)
  end

  if constants.empty?
    parent = Object
  else
    # This method is robust to non-reachable constants.
    #
    # Non-reachable constants may be passed if some of the parents were
    # autoloaded and already removed. It is easier to do a sanity check
    # here than require the caller to be clever. We check the parent
    # rather than the very const argument because we do not want to
    # trigger Kernel#autoloads, see the comment below.
    parent_name = constants.join('::')
    return unless qualified_const_defined?(parent_name)
    parent = constantize(parent_name)
  end

  log "removing constant #{const}"

  # In an autoloaded user.rb like this
  #
  #   autoload :Foo, 'foo'
  #
  #   class User < ActiveRecord::Base
  #   end
  #
  # we correctly register "Foo" as being autoloaded. But if the app does
  # not use the "Foo" constant we need to be careful not to trigger
  # loading "foo.rb" ourselves. While #const_defined? and #const_get? do
  # require the file, #autoload? and #remove_const don't.
  #
  # We are going to remove the constant nonetheless ---which exists as
  # far as Ruby is concerned--- because if the user removes the macro
  # call from a class or module that were not autoloaded, as in the
  # example above with Object, accessing to that constant must err.
  unless parent.autoload?(to_remove)
    begin
      constantized = parent.const_get(to_remove, false)
    rescue NameError
      log "the constant #{const} is not reachable anymore, skipping"
      return
    else
      constantized.before_remove_const if constantized.respond_to?(:before_remove_const)
    end
  end

  begin
    parent.instance_eval { remove_const to_remove }
  rescue NameError
    log "the constant #{const} is not reachable anymore, skipping"
  end
end

- (Object) remove_unloadable_constants!

Remove the constants that have been autoloaded, and those that have been marked for unloading. Before each constant is removed a callback is sent to its class/module if it implements before_remove_const.

The callback implementation should be restricted to cleaning up caches, etc. as the environment will be in an inconsistent state, e.g. other constants may have already been unloaded and not accessible.



530
531
532
533
534
535
# File 'activesupport/lib/active_support/dependencies.rb', line 530

def remove_unloadable_constants!
  autoloaded_constants.each { |const| remove_constant const }
  autoloaded_constants.clear
  Reference.clear!
  explicitly_unloadable_constants.each { |const| remove_constant const }
end

- (Object) require_or_load(file_name, const_path = nil)



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'activesupport/lib/active_support/dependencies.rb', line 322

def require_or_load(file_name, const_path = nil)
  log_call file_name, const_path
  file_name = $` if file_name =~ /\.rb\z/
  expanded = File.expand_path(file_name)
  return if loaded.include?(expanded)

  # Record that we've seen this file *before* loading it to avoid an
  # infinite loop with mutual dependencies.
  loaded << expanded

  begin
    if load?
      log "loading #{file_name}"

      # Enable warnings if this file has not been loaded before and
      # warnings_on_first_load is set.
      load_args = ["#{file_name}.rb"]
      load_args << const_path unless const_path.nil?

      if !warnings_on_first_load or history.include?(expanded)
        result = load_file(*load_args)
      else
        enable_warnings { result = load_file(*load_args) }
      end
    else
      log "requiring #{file_name}"
      result = require file_name
    end
  rescue Exception
    loaded.delete expanded
    raise
  end

  # Record history *after* loading so first load gets warnings.
  history << expanded
  result
end

- (Object) safe_constantize(name)

Get the reference for class named name if one exists. Otherwise returns nil.



588
589
590
# File 'activesupport/lib/active_support/dependencies.rb', line 588

def safe_constantize(name)
  Reference.safe_get(name)
end

- (Object) search_for_file(path_suffix)

Search for a file in autoload_paths matching the provided suffix.



389
390
391
392
393
394
395
396
397
# File 'activesupport/lib/active_support/dependencies.rb', line 389

def search_for_file(path_suffix)
  path_suffix = path_suffix.sub(/(\.rb)?$/, ".rb")

  autoload_paths.each do |root|
    path = File.join(root, path_suffix)
    return path if File.file? path
  end
  nil # Gee, I sure wish we had first_match ;-)
end

- (Object) to_constant_name(desc)

Convert the provided const desc to a qualified constant name (as a string). A module, class, symbol, or string may be provided.



650
651
652
653
654
655
656
657
658
659
# File 'activesupport/lib/active_support/dependencies.rb', line 650

def to_constant_name(desc) #:nodoc:
  case desc
    when String then desc.sub(/^::/, '')
    when Symbol then desc.to_s
    when Module
      desc.name ||
        raise(ArgumentError, "Anonymous modules have no name to be referenced by")
    else raise TypeError, "Not a valid constant descriptor: #{desc.inspect}"
  end
end

- (Object) unhook!



296
297
298
299
# File 'activesupport/lib/active_support/dependencies.rb', line 296

def unhook!
  ModuleConstMissing.exclude_from(Module)
  Loadable.exclude_from(Object)
end

- (Boolean) will_unload?(const_desc)

Will the provided constant descriptor be unloaded?



601
602
603
604
# File 'activesupport/lib/active_support/dependencies.rb', line 601

def will_unload?(const_desc)
  autoloaded?(const_desc) ||
    explicitly_unloadable_constants.include?(to_constant_name(const_desc))
end