How do I create a "getter" for my modules (How do you instantiate a Module Object using a Navigator?)

I am trying to make it so that all of my page and module references can autocomplete in intellij.

Due to some sort of bug I am unable to do this like one normally would. (see here for more details: How to have geb static content recognized form test script )

In order to work around the above mentioned bug. I opted to create "getters" for all of my static content.

for example:

The Page:

class MyPage extends Page{
    static content = { 
        tab {$(By.xpath("somexpath")}
    }

    Navigator tab(){
        return tab
    }
}

The Script:

//imagine we are in the middle of a feature method here
def test = at MyPage
test.tab().click()

So all of the above code works as I expect it to, and I want to redo my pages like this so that I can have autocomplete from the script side. Problems occur when I try to use this same technique for modules.

For example:

class MyPage extends Page{
    static content = { 
        mod {module(new MyModule())}
    }

    MyModule mod(){
        return mod
    }
}

If I try and access mod from the script like so

//imagine we are in the middle of a feature method here
def test = at MyPage
test.mod().someModContentMaybe().click()

I get the following error:

org.codehaus.groovy.runtime.typehandling.GroovyCastException: Cannot cast object 'MyPage' -> mod: 'MyModule' with class 'geb.content.TemplateDerivedPageContent' to class 'MyModule'

If I try to do the following in the page object:

class MyPage extends Page{
    static content = { 
        mod {module(new MyModule())}
    }

    MyModule mod(){
        return new MyModule()
    }
}

I get the following error when attempting to access the module from the script:

geb.error.ModuleInstanceNotInitializedException: Instance of module class MyModule has not been initialized. Please pass it to Navigable.module() or Navigator.module() before using it.

I guess it wants me to take an instantiated Navigator Object and and to call module(MyModule) but I am not sure how this works or how one would decide which Navigator Object to call module from.

All in all, I just want to be able to autocomplete module Names and static content from my scripts.

Solution

You're getting a GroovyCastException when returning content that contains a module from a method whose return type is a class which extends geb.Module because navigators and modules returned from content definitions get wrapped in geb.content.TemplateDerivedPageContent.

You can unwrap them using the as keyword as explained in the manual section about unwrapping modules returned from the content DSL. So, for one of your examples it would look like this:

MyModule mod(){
    mod as MyModule
}