+1. Thanks, Torben, that is quite thorough. Jody, do we have a policy for which supported modules are plugins and which are extensions? I noticed that Torben used the term "plugin" and realised that I do not know if we have rules. Is there a difference, or is this just an historical oddity?
Kind regards, Ben. On 27/01/17 07:41, Torben Barsballe wrote: > The gt-ysld module is now ready to be considered for a supported module. > > I would like to request that this module be approved for inclusion as a > supported plugin in the upcoming 16.2 / 17-beta releases. > The module conforms to the requirements > <http://docs.geotools.org/latest/developer/procedures/supported.html> for a > supported module, as follows: > Visibility / Module Status > > - Gold Star Quality Assurance Check - Plugin QA Test - 4/5 stars > > Here is how a plugin (aka hooks into the geotools library) may earn a star: > ⭐️ Passes IP check, basically has correct headers > > > - See REVIEW.md > > <https://github.com/geotools/geotools/blob/master/modules/unsupported/ysld/REVIEW.md> > > ⭐️ Releasable - has no non blocking bugs in jira > > > - GEOT-5622 <https://osgeo-org.atlassian.net/browse/GEOT-5622> is the > only open bug, not blocking. > > ⭐️ Used in anger - Used by GeoServer or uDig or Geomajas (ie some kind of > large real world datasets) > > > - Used by the gs-ysld extension in geoserver > > Optimised - has been tuned to meet hard performance requirements (example > shapefile) > > > - Not really, but only place where this is really important is > rendering, and at this point we are using the gt-api > StyledLayerDescriptor > objects > > ⭐️ Supported - user docs, module maintainer watches user list, answers > email etc.. (example referencing) > > > - User documentation here > <http://docs.geotools.org/latest/userguide/unsupported/ysld.html>. > - Module maintainers: Justin Deolivera, Kevin Smith > > Intellectual Property Check > > - Passes, See https://github.com/geotools/geotools/blob/master/modules > /unsupported/ysld/REVIEW.md > > Follow the Developers Guide > > - Analysis here: https://gist.github.com/mattkrusz/b010eb29aa784025a639 > c473b768801e > - PR here: https://github.com/geotools/geotools/pull/1440 (merged) > > Test Coverage and Maven Profiles > > - Test coverage exceeds the required 40%: Line coverage is 85%, Branch > coverage is 73% > > User Documentation > > - Has user documentation: http://docs.geotools.org/latest/userguide/uns > upported/ysld.html > > > > If the GeoTools PMC is happy with the module, I will put together a PR > moving it from unsupported to plugin. > > Thanks, > > Torben > > On Wed, Jan 25, 2017 at 3:24 PM, Torben Barsballe < > tbarsba...@boundlessgeo.com> wrote: > >> Thanks for the feedback. Class javadocs have been updated in the PR. >> >> Torben >> >> On Wed, Jan 25, 2017 at 9:56 AM, Jody Garnett <jody.garn...@gmail.com> >> wrote: >> >>> Thanks, formatting changes look good. I looked for the null returns - and >>> the "return null" statements I found were not especially documented. >>> >>> General feedback is we could take one run at class javadocs (usual >>> Class/Responsibility/Collaboration info) and we should be good. >>> >>> -- >>> Jody Garnett >>> >>> On 25 January 2017 at 09:26, Torben Barsballe < >>> tbarsba...@boundlessgeo.com> wrote: >>> >>>> Based on Matt's analysis, we have put together a pull request fixing up >>>> the outstanding issues in gt-ysld bringing it up to compliance with the >>>> developers guide: https://github.com/geotools/geotools/pull/1440 >>>> >>>> Null returns are documented, and are used sparingly. >>>> >>>> Torben >>>> >>>> On Tue, Jan 24, 2017 at 9:56 PM, Jody Garnett <jody.garn...@gmail.com> >>>> wrote: >>>> >>>>> I am not as keen as Martin was, I expect that Optionals will take the >>>>> place of the idea of null objects long term. >>>>> >>>>> What I am keen on is making our developer guide not suck; so if we are >>>>> not being strict about null we should relax the guide (citing returning a >>>>> null collection). I am kind of okay with returning null if it is clearly >>>>> documented in the javadocs (since those show up as a tooltip when >>>>> developers are working). >>>>> >>>>> -- >>>>> Jody Garnett >>>>> >>>>> On 24 January 2017 at 10:11, Andrea Aime <andrea.a...@geo-solutions.it> >>>>> wrote: >>>>> >>>>>> On Tue, Jan 24, 2017 at 6:57 PM, Matt Kruszewski < >>>>>> mkruszew...@boundlessgeo.com> wrote: >>>>>> >>>>>>> Hello everyone, >>>>>>> >>>>>>> I've started applying the developer guide standards to the gt-ysld >>>>>>> module, keeping notes in this gist: >>>>>>> >>>>>>> https://gist.github.com/mattkrusz/b010eb29aa784025a639c473b768801e >>>>>>> >>>>>> >>>>>> I don't agree on the "do not return null" applied in a blanket way (as >>>>>> a strong requirement, while I see all other bits you suggest as strong >>>>>> requirements). >>>>>> The library is just not built that way, it returns nulls in so many >>>>>> places it's impossible to count. >>>>>> I also don't see this "rule" being cited anywhere else, although I >>>>>> know Jody is keen on it. >>>>>> >>>>>> Yes, in some cases returning null is just bad (e.g., returning a null >>>>>> collection when an empty one would do), >>>>>> but for the rest I'm for a case by case evaluation. >>>>>> Or are you suggesting we should be returning Optional everywhere? >>>>>> >>>>>> Cheers >>>>>> Andrea >>>>>> >>>>>> -- >>>>>> == >>>>>> GeoServer Professional Services from the experts! Visit >>>>>> http://goo.gl/it488V for more information. >>>>>> == >>>>>> >>>>>> Ing. Andrea Aime >>>>>> @geowolf >>>>>> Technical Lead >>>>>> >>>>>> GeoSolutions S.A.S. >>>>>> Via di Montramito 3/A >>>>>> 55054 Massarosa (LU) >>>>>> phone: +39 0584 962313 <+39%200584%20962313> >>>>>> fax: +39 0584 1660272 <+39%200584%20166%200272> >>>>>> mob: +39 339 8844549 <+39%20339%20884%204549> >>>>>> >>>>>> http://www.geo-solutions.it >>>>>> http://twitter.com/geosolutions_it >>>>>> >>>>>> *AVVERTENZE AI SENSI DEL D.Lgs. 196/2003* >>>>>> >>>>>> Le informazioni contenute in questo messaggio di posta elettronica e/o >>>>>> nel/i file/s allegato/i sono da considerarsi strettamente riservate. Il >>>>>> loro utilizzo è consentito esclusivamente al destinatario del messaggio, >>>>>> per le finalità indicate nel messaggio stesso. Qualora riceviate questo >>>>>> messaggio senza esserne il destinatario, Vi preghiamo cortesemente di >>>>>> darcene notizia via e-mail e di procedere alla distruzione del messaggio >>>>>> stesso, cancellandolo dal Vostro sistema. Conservare il messaggio stesso, >>>>>> divulgarlo anche in parte, distribuirlo ad altri soggetti, copiarlo, od >>>>>> utilizzarlo per finalità diverse, costituisce comportamento contrario ai >>>>>> principi dettati dal D.Lgs. 196/2003. >>>>>> >>>>>> >>>>>> >>>>>> The information in this message and/or attachments, is intended solely >>>>>> for the attention and use of the named addressee(s) and may be >>>>>> confidential >>>>>> or proprietary in nature or covered by the provisions of privacy act >>>>>> (Legislative Decree June, 30 2003, no.196 - Italy's New Data Protection >>>>>> Code).Any use not in accord with its purpose, any disclosure, >>>>>> reproduction, >>>>>> copying, distribution, or either dissemination, either whole or partial, >>>>>> is >>>>>> strictly forbidden except previous formal approval of the named >>>>>> addressee(s). If you are not the intended recipient, please contact >>>>>> immediately the sender by telephone, fax or e-mail and delete the >>>>>> information in this message that has been received in error. The sender >>>>>> does not give any warranty or accept liability as the content, accuracy >>>>>> or >>>>>> completeness of sent messages and accepts no responsibility for changes >>>>>> made after they were sent or for other risks which arise as a result of >>>>>> e-mail transmission, viruses, etc. >>>>>> >>>>>> ------------------------------------------------------- >>>>>> >>>>>> ------------------------------------------------------------ >>>>>> ------------------ >>>>>> Check out the vibrant tech community on one of the world's most >>>>>> engaging tech sites, SlashDot.org! http://sdm.link/slashdot >>>>>> _______________________________________________ >>>>>> GeoTools-Devel mailing list >>>>>> GeoTools-Devel@lists.sourceforge.net >>>>>> https://lists.sourceforge.net/lists/listinfo/geotools-devel >>>>>> >>>>>> >>>>> >>>>> ------------------------------------------------------------ >>>>> ------------------ >>>>> Check out the vibrant tech community on one of the world's most >>>>> engaging tech sites, SlashDot.org! http://sdm.link/slashdot >>>>> _______________________________________________ >>>>> GeoTools-Devel mailing list >>>>> GeoTools-Devel@lists.sourceforge.net >>>>> https://lists.sourceforge.net/lists/listinfo/geotools-devel >>>>> >>>>> >>>> >>> >> > > > > ------------------------------------------------------------------------------ > Check out the vibrant tech community on one of the world's most > engaging tech sites, SlashDot.org! http://sdm.link/slashdot > > > > _______________________________________________ > GeoTools-Devel mailing list > GeoTools-Devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/geotools-devel > -- Ben Caradoc-Davies <b...@transient.nz> Director Transient Software Limited <http://transient.nz/> New Zealand ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, SlashDot.org! http://sdm.link/slashdot _______________________________________________ GeoTools-Devel mailing list GeoTools-Devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geotools-devel
