Constant Finding and Rails Autoloading

Rails Autoloading

從常數查詢開始

摘自Constant lookup in Ruby一文，Ruby class是常數，常數的搜尋是依下列步驟

Module.nesting
Module.nesting.first.ancestors
Object.ancestors 若Modeul.nesting.first為nil或module

用我的白話總結，找常數時先找當前程式區塊形成的Module.nesting，再找當前位置的祖先，但如果當前位置的Module.nesting是空的或是一個Module，就直接去Object.ancestors找。

Module.nesting

第一，Ruby在包住自己的語法中尋找

module A
  module B
  end

  module C
    module D
      B == A::B
      puts Module.nesting
    end
  end
end
#=> true
#=> A::C::D
#=> A::C
#=> A

這段程式中，碰到B時，它會先去A::C::D找，再去A::C，再找A::B，如Module.nesting顯示的那樣。

Namespace鏈可以在runtime用Module.nesting（內省introspectable機制）得到。

module A
  module B
    Module.nesting == [A::B, A]
  end
end
#=> true

因此如果嘗試直接下例，會找不到。因為在A::C的語法塊內，找不到A::B。

module A
  module B; end
end


module A::C
  puts Module.nesting
  B
end
#=> A::C (沒有A)
#=> NameError: uninitialized constant A::C::B

Module.nesting.first.ancestors

第二步，如果常數無法被在Module.nesting裡被找到，Ruby會在尋找當前的module或class的祖先。

class A
  module B; end
end


class C < A
  puts Module.nesting == [C]
  puts Module.nesting.first.ancestors == [C, A, Object, PP::ObjectMixin, Kernel, BasicObject]
  B == A::B
end
#=> true
#=> true
#=> true

Object.ancestors

如果Module.nesting == []表示在頂層物件Object。Ruby會在該物件和其祖先找常數。以下例而言，所有常數都出現在Object這一層。

class Object
  module C; end
end
C == Object::C

module B; end
B == Object::B

最後，雖然module的祖先沒有寫出來，但Ruby假設你會將module混入其他繼承於Object的類，所以會自動將Object.ancestors加到module的常數查詢鏈中。

module A; end
module B
  B.ancestors == [B]
  A == Object::A
end

About class_eval and singleton

如果是使用singleton，因為其繼承鏈不包含當前class，所以常數查詢也會找不到定義在該class的常數。

在class_eval時，會採用一樣的方式去找常數

class A
  module B; end
end
class C
  module B; end
  A.class_eval{ B } == C::B
  B == C::B
end

然而，如果參數不是block而是String，就會用當前的程式區塊去找。

class A
  module B; end
end
class C
  module B; end
  A.class_eval("B") == A::B
end

下例中，因為C::D的Module.nesting不為nil，所以找查詢的順序是先找C::D再找C(順序一），再找C::D.ancestors（順序二），又因為Module.nesting.first是Module，所以再去找到Object.ancestor（順序三），最後都沒找到，所以拋出例外。

class A
  module B; end
end

class C < A
  class D
    B
  end
end
#=> NameError: uninitialized constant C::D::B

這個例子在順序二找到。

class A
  module B; end
end

class C < A
  module B; end
  class D
    B
  end
end
#=> C::B

這個例子則是在順序三找到。

class F; end

class E
  class G
    F
  end
end
#=> F

Rails Autoloading

Ruby的autoload方法須要指定class name和檔案路徑，rails改寫了這個方法（實際上是改寫了const_missing方法），使得它可以自動從常數名去配對檔案路徑，因此可以不用require，只須指定autoload_path，rails即會在這些path內自動依慣例尋找。

預設情況下，rails會找專案中的app資料夾。但我們可以手動加入別的path。

# config/application.rb
module MyApp
  class Application < Rails::Application
    config.autoload_paths << Rails.root.join("lib")
  end
end
MyApp::Application.config.autoload_paths
#=> ["<project_folder>/lib"]

Rails autoloading — how it works, and when it doesn't

留下範例以供複習，以rails和ruby呼叫Foo::Bar.print_qux會有不同結果，以rails呼叫第二次會NameError，原因？

# qux.rb
Qux = "I'm at the root!"

# foo.rb
module Foo
end

# foo/qux.rb
module Foo
  Qux = "I'm in Foo!"
end

# foo/bar.rb
class Foo::Bar
  def self.print_qux
    puts Qux
  end
end

解決方法就是總是明確指定是在哪一層module。

Rails 常數查詢和 autoloading 機制