[xwiki-devs] [VOTE] New rule: Put ScriptService implementations out of the internal package
Hi devs, We need to solve http://jira.xwiki.org/browse/XWIKI-9157 I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule. These classes are used by introspection and as such as not used as components and thus they should not be in the internal package. Here's my +1 and I'm proposing to handle the move. I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO. Thanks -Vincent
On 05/21/2013 06:10 AM, Vincent Massol wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
+1, if we couple this with @Unstable annotations for new script services. -- Sergiu Dumitriu http://purl.org/net/sergiu
On May 21, 2013, at 1:07 PM, Sergiu Dumitriu <[email protected]> wrote:
On 05/21/2013 06:10 AM, Vincent Massol wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
+1, if we couple this with @Unstable annotations for new script services.
Yep definitely. The @Unstable rule applies. Thanks -Vincent
On Tue, May 21, 2013 at 1:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
One of the main reasons to keep the ScriptService implementations internal was to discourage their usage in Java code (as they can be injected like any other component). What do we do about this? Thanks, Marius
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On May 22, 2013, at 8:12 AM, Marius Dumitru Florea <[email protected]> wrote:
On Tue, May 21, 2013 at 1:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
One of the main reasons to keep the ScriptService implementations internal was to discourage their usage in Java code (as they can be injected like any other component). What do we do about this?
I don't think it changes anything. Right now SS can be injected in Java code already since they're components. The fact that they're in the internal package doesn't change much. If we really want to check that they are not used by Java code we could write a check but I don't feel it happens enough to be necessary to spend the time to write that check. I'd say we don't FTM and if the problems happens then we can write a check. WDYT? Thanks -Vincent
Another reason is that dynamic languages are a lot less strict than Java on what's a breakage so many changes don't actually break anything. We will need to not follow too blindly CLIRR reports on this. Since we are a bit more relaxed on these issues that we use to that should do it. +1 to move public script services out of internal package IMO the real benefit is that public script services javadoc will be included in the release javadoc. On Wed, May 22, 2013 at 8:55 AM, Vincent Massol <[email protected]> wrote:
On May 22, 2013, at 8:12 AM, Marius Dumitru Florea <[email protected]> wrote:
On Tue, May 21, 2013 at 1:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
One of the main reasons to keep the ScriptService implementations internal was to discourage their usage in Java code (as they can be injected like any other component). What do we do about this?
I don't think it changes anything. Right now SS can be injected in Java code already since they're components. The fact that they're in the internal package doesn't change much.
If we really want to check that they are not used by Java code we could write a check but I don't feel it happens enough to be necessary to spend the time to write that check. I'd say we don't FTM and if the problems happens then we can write a check.
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On Wed, May 22, 2013 at 9:55 AM, Vincent Massol <[email protected]> wrote:
On May 22, 2013, at 8:12 AM, Marius Dumitru Florea <[email protected]> wrote:
On Tue, May 21, 2013 at 1:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
One of the main reasons to keep the ScriptService implementations internal was to discourage their usage in Java code (as they can be injected like any other component). What do we do about this?
I don't think it changes anything. Right now SS can be injected in Java code already since they're components. The fact that they're in the internal package doesn't change much.
If we really want to check that they are not used by Java code we could write a check but I don't feel it happens enough to be necessary to spend the time to write that check. I'd say we don't FTM and if the problems happens then we can write a check.
WDYT?
+1 Thanks, Marius
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
The VOTE is passed with 4 +1, no 0 and no -1. Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1 Thanks -Vincent On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
On 09/19/2013 02:00 PM, Vincent Massol wrote:
The VOTE is passed with 4 +1, no 0 and no -1.
Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1
How about: org.xwiki.<module> - the real APIs org.xwiki.<module>.internal - the implementation org.xwiki.<module>.script - the script service This way the script service is not internal, but it's not mixed with the APIs so that it's more clear that it's not supposed to be used from other java classes.
Thanks -Vincent
On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu
On Sep 19, 2013, at 8:21 PM, Sergiu Dumitriu <[email protected]> wrote:
On 09/19/2013 02:00 PM, Vincent Massol wrote:
The VOTE is passed with 4 +1, no 0 and no -1.
Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1
How about:
org.xwiki.<module> - the real APIs org.xwiki.<module>.internal - the implementation org.xwiki.<module>.script - the script service
This way the script service is not internal, but it's not mixed with the APIs so that it's more clear that it's not supposed to be used from other java classes.
Sounds good to me! We already put the SS in the script package in a few places. Thanks -Vincent
Thanks -Vincent
On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
FTR I've now moved all ScriptService except for DistributionScriptService which is not supposed to be public according to Thomas. I've also added a custom checkstyle rule. It would be nice that all devs verify the ScriptService they have implemented to ensure that they have @Unstable if they've been added recently and require it (I did a quick pass on them already). Thanks -Vincent On Sep 19, 2013, at 8:33 PM, Vincent Massol <[email protected]> wrote:
On Sep 19, 2013, at 8:21 PM, Sergiu Dumitriu <[email protected]> wrote:
On 09/19/2013 02:00 PM, Vincent Massol wrote:
The VOTE is passed with 4 +1, no 0 and no -1.
Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1
How about:
org.xwiki.<module> - the real APIs org.xwiki.<module>.internal - the implementation org.xwiki.<module>.script - the script service
This way the script service is not internal, but it's not mixed with the APIs so that it's more clear that it's not supposed to be used from other java classes.
Sounds good to me! We already put the SS in the script package in a few places.
Thanks -Vincent
Thanks -Vincent
On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Thu, Sep 19, 2013 at 9:21 PM, Sergiu Dumitriu <[email protected]> wrote:
On 09/19/2013 02:00 PM, Vincent Massol wrote:
The VOTE is passed with 4 +1, no 0 and no -1.
Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1
How about:
org.xwiki.<module> - the real APIs org.xwiki.<module>.internal - the implementation org.xwiki.<module>.script - the script service
This way the script service is not internal, but it's not mixed with the APIs so that it's more clear that it's not supposed to be used from other java classes.
+1 Thanks, Marius
Thanks -Vincent
On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Fri, Sep 20, 2013 at 8:07 AM, Marius Dumitru Florea <[email protected]> wrote:
On Thu, Sep 19, 2013 at 9:21 PM, Sergiu Dumitriu <[email protected]> wrote:
On 09/19/2013 02:00 PM, Vincent Massol wrote:
The VOTE is passed with 4 +1, no 0 and no -1.
Created http://jira.xwiki.org/browse/XWIKI-9482 and planning it for 5.3M1
How about:
org.xwiki.<module> - the real APIs org.xwiki.<module>.internal - the implementation org.xwiki.<module>.script - the script service
This way the script service is not internal, but it's not mixed with the APIs so that it's more clear that it's not supposed to be used from other java classes.
+1
+1 most Script Services are in that package already but it's good to make it an official rule
Thanks, Marius
Thanks -Vincent
On May 21, 2013, at 12:10 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We need to solve http://jira.xwiki.org/browse/XWIKI-9157
I'm proposing to simply move all ScriptService implementations out of the internal package and make that a rule.
These classes are used by introspection and as such as not used as components and thus they should not be in the internal package.
Here's my +1 and I'm proposing to handle the move.
I can't think of anything that would break except some users who would have had an import in a groovy script on some internal Script Service but that's ok IMO.
Thanks -Vincent
-- Sergiu Dumitriu http://purl.org/net/sergiu _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
participants (5)
-
Marius Dumitru Florea -
Sergiu Dumitriu -
Sergiu Dumitriu -
Thomas Mortagne -
Vincent Massol