Re: CFWheels integration with ColdDoc

[Mark Mandel]

Just testing... emails aren't seeming to go to the group for some reason?

On Fri, Mar 12, 2010 at 8:09 AM, Mike Henke <henk...@gmail.com> wrote:

Would it be possible to use ColdDoc with Wheels?  Do you have
examples?  I don't know much about ColdDoc but could help with a
Wheels plugin.

--
E: mark....@gmail.com
T: http://www.twitter.com/neurotic
W: www.compoundtheory.com

Hands-on ColdFusion ORM Training @ cf.Objective() 2010
www.ColdFusionOrmTraining.com/

[Mike]

Does problem have to do with google group moderating setting?

Sent from my iPhone

[Mike Henke]

[Mark Mandel]

Yeah, that was moderated, but now when I reply it's okay, and is going to the group.

That is so weird.

Mark

[Mike Henke]

Hey Mark,

Everything seems to be woking, but I can't pass in multiple locations.

paths = [
    { colddoc = expandPath("/colddoc")
    }
];
    colddoc.generate(paths);

give me Message key [INPUTDIR] doesn't exist in struct (keys:COLDDOC)

Any ideas?

Thanks,

henke...@gmail.com
http://www.henke.ws

[Mike Henke]

I had to do something like this

    paths=ArrayNew(1);
    paths[1] = StructNew();
     StructInsert(paths[1], "INPUTDIR", "colddoc");
     StructInsert(paths[1], "INPUTMAPPING", expandPath("/colddoc"));

colddoc.generate(paths);

henke...@gmail.com
http://www.henke.ws

[Mark Mandel]

Oh shoot, you are right. I totally messed up the documentation.

Got messed up in my head how it was implemented.

I'll fix that up in the doco shortly.

Mark

[Mark Mandel]

Documentation fixed.

Thanks for that.

Mark

[Mike Henke]

MarK,

The Wheels framework uses includes in cfcs to organize code like:

wheels/dispatch.cfc
<cfcomponent output="false">
<cfinclude template="global/functions.cfm">
<cfinclude template="dispatch/functions.cfm">
<cfinclude template="plugins/injection.cfm">
</cfcomponent>

I don't think ColdDoc is able to handle this. Should I submit a
ticket?

[Mark Mandel]

Yeah, ColdDoc can't handle that because it doesn't show up in the meta data.

How would you like ColdDoc to handle these anyway? Got any ideas for the how in terms of implementation and/or how you would see the documentation be written?

Mark

To unsubscribe from this group, send email to colddoc-dev+unsubscribegooglegroups.com or reply to this email with the words "REMOVE ME" as the subject.

[Mike Henke]

I am wondering, to see the functions in the cfinclude, if a clone/duplication of the cfc object needs to be created then the getMetaData would work?

Basically, it an issue with getMetaData not seeing the cfc at runtime from my understanding.

henke...@gmail.com
http://www.henke.ws

[Mark Mandel]

getMetaData() won't pick up run time method inclusion.

The problem with creating instances of the object is that people can often create dependencies within pseudo constructors and the like - which will fall over when the object is created.

So that sort of implementation really doesn't work.

Maybe some sort of annotation to point to what UDFs are being included?

<component colddoc:mixins="/foo/bar.cfm,/foo/dog.cfm">

That would be ideal. But we could do a <cffile> on the CFC and go hunting for the <cfinclude> or include; statement.

The only issue here is that the cfm page has to be executed to get the meta data of the functions out of it.  It depends what code is in there as to whether or not that will actually work.. which is not the best.

It may be better to <cffile> the includes and try and parse them that way.

<cffile> parsing is a pain however, as we have both script and tag syntax now, and I'd like to avoid it wherever possible, as it is rather error prone.

Also fun stuff -

How do you know a .cfm is a mixin? It should probably be listed as a mixin, or something similar in the Class listing box, and have its own detail page.

Then when looking at a class, there should be a section, much like methods that come from super classes, that outlines what methods come from the mixins.

Mark