What does ruby include when it encounters the "include module" statement?

Question

If I have the following project structure

project/   
  lib/
    subproject/
      a.rb
      b.rb
      lib.rb

where lib.rb looks like this :-

module Subproject
  def foo
    do_some_stuff
  end
end

and a.rb and b.rb both need to mixin some methods within lib.rb and are both namespaced within a module like so :-

require 'subproject/lib'

module Subproject
  class A
    include Subproject

    def initialize()
      foo()
    end
  end
end

What does ruby do when it encounters the include statement? How does it know that I want to only include the mixin from lib.rb rather than the whole module which includes both class A and class B, is this based purely on the require of subproject/lib or am I getting it wrong and it is including the whole of the module, including the definitions of Class A and B within themselves?

Mladen Jablanović · Accepted Answer · 2010-03-18 10:51:09Z

1

It is including the whole of the module. There is only one Subproject module, you've just reopened it in a.rb and b.rb and added classes A and B to it. I don't think require is related anyhow there.

BTW, you can always try it out in irb:

>> Subproject::A
=> Subproject::A
>> Subproject::A::A
=> Subproject::A

answered Mar 18, 2010 at 10:51

Mladen Jablanović

44.2k13 gold badges92 silver badges113 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Steve Weet Over a year ago

So if I just want to include lib.rb functions then I have to define it in a module called SubprojectLib or similar and just include that?

Collectives™ on Stack Overflow

What does ruby include when it encounters the "include module" statement?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related