Ruby Hints Plugin

[Philipp Marcus]

Hi,

first thanks for the fantastic help concerning my last post! Now i`m
trying to create a Netbeans module to provide additional ruby hints and
first
of all i copied the NestedLocal.java from the ruby hints project to my
own netbeans module project
in order to modify it for my needs. But i have the following problems:

I can`t load the imports specified in the copy of NestedLocal.java in my
project, though i`ve added the following libraries in the "project
properties":
Common Scripting Language API
Datasystems API
Editor Library
File System API
JRuby Implementation
Ruby Editing
Ruby Hints
Ruby Platform
Utilities API

The Imports that are not working are the following:

import org.netbeans.modules.gsf.api.Hint;
import org.netbeans.modules.gsf.api.EditList;
import org.netbeans.modules.gsf.api.HintFix;
import org.netbeans.modules.gsf.api.HintSeverity;
import org.netbeans.modules.gsf.api.PreviewableFix;
import org.netbeans.modules.gsf.api.RuleContext;
import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
import org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;

What can i do to get these imports working?

Thank you for your help
best regards
    Philipp Marcus


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...

[Tor Norbye]

The Ruby Hints API is not stable. Therefore, the module does not  
expose any packages.
The Ruby Extra Hints module is a friend module, which means that the  
ruby module specifically lists access for it.

If your hints will be useful in general, not just to something very  
specific about your own code, it would be cool if you could write your  
hints as part of the Extra Hints module. That module isn't part of the  
general distribution - it's on the update center, so it doesn't have  
to follow all the normal release rules (we're past feature freeze for  
6.5 etc).  It's a good place to add hints to.  Almost all the hints in  
our distribution started there; after a hint has been in Extra Hints  
for a while and I feel solid about it, I move the hint into the  
standard hints module.

If on the other hand your hints aren't generally useful (e.g. it's for  
research only), or you're not ready to develop hints for the  
ruby.extrahints module for other reasons (e.g. license concerns etc),  
then you can use the following workaround:

In your nbproject/project.xml, change your dependency on the  
ruby.hints module from <specification-version> to <implementation-
version>.

(There might be a way to do this through the project customizer - e.g.  
make an implementation dependency - but I always do these edits  
directly since I know how.)

What this does is say that your module has an implementation  
dependency on the ruby.hints module. This lets you access all of its  
packages. But it comes at a cost. It will tie your module to EXACTLY  
this version of the ruby.hints module. Whenever the IDE module is  
updated, your module won't get its dependencies satisfied.  So, you  
can for example write a module that will work perfectly with 6.5, but  
if users upgrade to 7.0beta1 etc., the module will be disabled until  
you release one compiled for 7.0beta1.

Anyway, implementation-version should get you going on development.  I  
can add friend access to your module later if you get further along.  
Just keep in mind that these APIs are not public so they can change  
incompatibly from time to time.

-- Tor


On Jul 23, 2008, at 11:08 AM, Philipp Marcus wrote:

> Hi,
>
> first thanks for the fantastic help concerning my last post! Now i`m  
> trying to create a Netbeans module to provide additional ruby hints  
> and first
> of all i copied the NestedLocal.java from the ruby hints project to  
> my own netbeans module project
> in order to modify it for my needs. But i have the following problems:
>
> I can`t load the imports specified in the copy of NestedLocal.java  
> in my
> project, though i`ve added the following libraries in the "project
> properties":
> Common Scripting Language API
> Datasystems API
> Editor Library
> File System API
> JRuby Implementation
> Ruby Editing
> Ruby Hints
> Ruby Platform
> Utilities API
>
> The Imports that are not working are the following:
>
> import org.netbeans.modules.gsf.api.Hint;
> import org.netbeans.modules.gsf.api.EditList;
> import org.netbeans.modules.gsf.api.HintFix;
> import org.netbeans.modules.gsf.api.HintSeverity;
> import org.netbeans.modules.gsf.api.PreviewableFix;
> import org.netbeans.modules.gsf.api.RuleContext;
> import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
> import org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;
>
> What can i do to get these imports working?
>
> Thank you for your help
> best regards
>   Philipp Marcus
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@...
> For additional commands, e-mail: dev-help@...
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...

[Philipp Marcus]

Hi,

thanks for your quick reply. I`ve allready tried to set the dependency
from specification to implementation but it seems to have no impact on
the issue. The weird thing about it is, that some imports from the
package org.netbeans.modules.gsf.api. are working and some are not:

Those have no errors:

import org.netbeans.modules.gsf.api.CompilationInfo;
import org.netbeans.modules.gsf.api.EditRegions;
import org.netbeans.modules.gsf.api.OffsetRange;

Those are marked with "cannot find symbol":

import org.netbeans.modules.gsf.api.Hint;
import org.netbeans.modules.gsf.api.EditList;
import org.netbeans.modules.gsf.api.HintFix;
import org.netbeans.modules.gsf.api.HintSeverity;
import org.netbeans.modules.gsf.api.PreviewableFix;
import org.netbeans.modules.gsf.api.RuleContext;

Additionally those two imports are marked with "cannot find symbol"
import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
import org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;

Is there any other chance to get this module working as a standalone
version? It would be very helpful because i`d like to try some specific
things.

Best Regards
    Philipp Marcus




Tor Norbye schrieb:

> The Ruby Hints API is not stable. Therefore, the module does not
> expose any packages.
> The Ruby Extra Hints module is a friend module, which means that the
> ruby module specifically lists access for it.
>
> If your hints will be useful in general, not just to something very
> specific about your own code, it would be cool if you could write your
> hints as part of the Extra Hints module. That module isn't part of the
> general distribution - it's on the update center, so it doesn't have
> to follow all the normal release rules (we're past feature freeze for
> 6.5 etc).  It's a good place to add hints to.  Almost all the hints in
> our distribution started there; after a hint has been in Extra Hints
> for a while and I feel solid about it, I move the hint into the
> standard hints module.
>
> If on the other hand your hints aren't generally useful (e.g. it's for
> research only), or you're not ready to develop hints for the
> ruby.extrahints module for other reasons (e.g. license concerns etc),
> then you can use the following workaround:
>
> In your nbproject/project.xml, change your dependency on the
> ruby.hints module from <specification-version> to
> <implementation-version>.
>
> (There might be a way to do this through the project customizer - e.g.
> make an implementation dependency - but I always do these edits
> directly since I know how.)
>
> What this does is say that your module has an implementation
> dependency on the ruby.hints module. This lets you access all of its
> packages. But it comes at a cost. It will tie your module to EXACTLY
> this version of the ruby.hints module. Whenever the IDE module is
> updated, your module won't get its dependencies satisfied.  So, you
> can for example write a module that will work perfectly with 6.5, but
> if users upgrade to 7.0beta1 etc., the module will be disabled until
> you release one compiled for 7.0beta1.
>
> Anyway, implementation-version should get you going on development.  I
> can add friend access to your module later if you get further along.  
> Just keep in mind that these APIs are not public so they can change
> incompatibly from time to time.
>
> -- Tor
>
>
> On Jul 23, 2008, at 11:08 AM, Philipp Marcus wrote:
>
>> Hi,
>>
>> first thanks for the fantastic help concerning my last post! Now i`m
>> trying to create a Netbeans module to provide additional ruby hints
>> and first
>> of all i copied the NestedLocal.java from the ruby hints project to
>> my own netbeans module project
>> in order to modify it for my needs. But i have the following problems:
>>
>> I can`t load the imports specified in the copy of NestedLocal.java in my
>> project, though i`ve added the following libraries in the "project
>> properties":
>> Common Scripting Language API
>> Datasystems API
>> Editor Library
>> File System API
>> JRuby Implementation
>> Ruby Editing
>> Ruby Hints
>> Ruby Platform
>> Utilities API
>>
>> The Imports that are not working are the following:
>>
>> import org.netbeans.modules.gsf.api.Hint;
>> import org.netbeans.modules.gsf.api.EditList;
>> import org.netbeans.modules.gsf.api.HintFix;
>> import org.netbeans.modules.gsf.api.HintSeverity;
>> import org.netbeans.modules.gsf.api.PreviewableFix;
>> import org.netbeans.modules.gsf.api.RuleContext;
>> import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
>> import org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;
>>
>> What can i do to get these imports working?
>>
>> Thank you for your help
>> best regards
>>   Philipp Marcus
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@...
>> For additional commands, e-mail: dev-help@...
>>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...

[Tor Norbye]

On Jul 23, 2008, at 11:31 AM, Philipp Marcus wrote:

> Hi,
>
> thanks for your quick reply. I`ve allready tried to set the  
> dependency from specification to implementation but it seems to have  
> no impact on the issue. The weird thing about it is, that some  
> imports from the package org.netbeans.modules.gsf.api. are working  
> and some are not:
>
> Those have no errors:
>
> import org.netbeans.modules.gsf.api.CompilationInfo;
> import org.netbeans.modules.gsf.api.EditRegions;
> import org.netbeans.modules.gsf.api.OffsetRange;
>
> Those are marked with "cannot find symbol":
>
> import org.netbeans.modules.gsf.api.Hint;
> import org.netbeans.modules.gsf.api.EditList;
> import org.netbeans.modules.gsf.api.HintFix;
> import org.netbeans.modules.gsf.api.HintSeverity;
> import org.netbeans.modules.gsf.api.PreviewableFix;
> import org.netbeans.modules.gsf.api.RuleContext;

Are you by any chance using NetBeans 6.1 or something like that?
These APIs have changed in 6.5 since 6.1, and it looks to me like the  
classes which you're succeeding in importing are those that were there  
in 6.1, and the ones that are not are new in 6.5.

Make sure you're using a current daily build of NetBeans for this  
stuff, at least if you want to line up the hint sources with modules  
to build against.

> Additionally those two imports are marked with "cannot find symbol"
> import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
> import org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;

Yep, also new in 6.5.

> Is there any other chance to get this module working as a standalone  
> version? It would be very helpful because i`d like to try some  
> specific things.

I'm not sure what you mean by having the module working as a  
standalone version.  If you can attach your nbproject/project.xml file  
I can check to make sure that your module dependencies are correct.

Oh yeah -- you'll also need an implementation dependency on the  
gsf.api module (but you probably already figured that out).

-- Tor

>
>
> Best Regards
>   Philipp Marcus
>
>
>
>
> Tor Norbye schrieb:
>> The Ruby Hints API is not stable. Therefore, the module does not  
>> expose any packages.
>> The Ruby Extra Hints module is a friend module, which means that  
>> the ruby module specifically lists access for it.
>>
>> If your hints will be useful in general, not just to something very  
>> specific about your own code, it would be cool if you could write  
>> your hints as part of the Extra Hints module. That module isn't  
>> part of the general distribution - it's on the update center, so it  
>> doesn't have to follow all the normal release rules (we're past  
>> feature freeze for 6.5 etc).  It's a good place to add hints to.  
>> Almost all the hints in our distribution started there; after a  
>> hint has been in Extra Hints for a while and I feel solid about it,  
>> I move the hint into the standard hints module.
>>
>> If on the other hand your hints aren't generally useful (e.g. it's  
>> for research only), or you're not ready to develop hints for the  
>> ruby.extrahints module for other reasons (e.g. license concerns  
>> etc), then you can use the following workaround:
>>
>> In your nbproject/project.xml, change your dependency on the  
>> ruby.hints module from <specification-version> to <implementation-
>> version>.
>>
>> (There might be a way to do this through the project customizer -  
>> e.g. make an implementation dependency - but I always do these  
>> edits directly since I know how.)
>>
>> What this does is say that your module has an implementation  
>> dependency on the ruby.hints module. This lets you access all of  
>> its packages. But it comes at a cost. It will tie your module to  
>> EXACTLY this version of the ruby.hints module. Whenever the IDE  
>> module is updated, your module won't get its dependencies  
>> satisfied.  So, you can for example write a module that will work  
>> perfectly with 6.5, but if users upgrade to 7.0beta1 etc., the  
>> module will be disabled until you release one compiled for 7.0beta1.
>>
>> Anyway, implementation-version should get you going on  
>> development.  I can add friend access to your module later if you  
>> get further along.  Just keep in mind that these APIs are not  
>> public so they can change incompatibly from time to time.
>>
>> -- Tor
>>
>>
>> On Jul 23, 2008, at 11:08 AM, Philipp Marcus wrote:
>>
>>> Hi,
>>>
>>> first thanks for the fantastic help concerning my last post! Now  
>>> i`m trying to create a Netbeans module to provide additional ruby  
>>> hints and first
>>> of all i copied the NestedLocal.java from the ruby hints project  
>>> to my own netbeans module project
>>> in order to modify it for my needs. But i have the following  
>>> problems:
>>>
>>> I can`t load the imports specified in the copy of NestedLocal.java  
>>> in my
>>> project, though i`ve added the following libraries in the "project
>>> properties":
>>> Common Scripting Language API
>>> Datasystems API
>>> Editor Library
>>> File System API
>>> JRuby Implementation
>>> Ruby Editing
>>> Ruby Hints
>>> Ruby Platform
>>> Utilities API
>>>
>>> The Imports that are not working are the following:
>>>
>>> import org.netbeans.modules.gsf.api.Hint;
>>> import org.netbeans.modules.gsf.api.EditList;
>>> import org.netbeans.modules.gsf.api.HintFix;
>>> import org.netbeans.modules.gsf.api.HintSeverity;
>>> import org.netbeans.modules.gsf.api.PreviewableFix;
>>> import org.netbeans.modules.gsf.api.RuleContext;
>>> import org.netbeans.modules.ruby.hints.infrastructure.RubyAstRule;
>>> import  
>>> org.netbeans.modules.ruby.hints.infrastructure.RubyRuleContext;
>>>
>>> What can i do to get these imports working?
>>>
>>> Thank you for your help
>>> best regards
>>>  Philipp Marcus
>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@...
>>> For additional commands, e-mail: dev-help@...
>>>
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@...
> For additional commands, e-mail: dev-help@...
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@...
For additional commands, e-mail: dev-help@...