https://github.com/dnalchemist/ratpack-form-parser

https://github.com/dnalchemist/ratpack-form-parser

extension-methods groovy parse post ratpack validation

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dnalchemist/ratpack-form-parser
• Owner: DNAlchemist
• License: mit
• Created: 2017-08-05T11:15:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-15T13:13:15.000Z (over 6 years ago)
• Last Synced: 2024-12-14T09:19:44.075Z (12 days ago)
• Topics: extension-methods, groovy, parse, post, ratpack, validation
• Language: Groovy
• Size: 83 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Build Status][travis-image]][travis-url]

[![Maven Central][maven-image]][maven-url]

[![Coverage Status][coveralls-image]][coveralls-url]

[![License][license-image]][license-url]

Usage 

-

#### Parse request into POGO object

    // curl -XPOST localhost:5050/person --data "age=18"  

    

    class Person {

        int age

    }

    

    chain.post("person", { Context ctx ->

        ctx.parse(Form) { Form form -> 

            Person person = form as Person

            assert person.age == 18

        }

    })

#### Parse request into Java Object

    // curl -XPOST localhost:5050/atomicinteger --data "value=42"

    

    import java.util.concurrent.atomic.AtomicInteger

    chain.post("atomicinteger", { Context ctx ->

        ctx.parse(Form) { Form form -> 

            AtomicInteger atomicInteger = form as AtomicInteger

            assert atomicInteger.get() == 42

        }

    })

#### Parse using custom form property name

    // curl -XPOST localhost:5050/balloon --data "mass_density=0.179"  

    

    import one.chest.ratpack.form.FormProperty

    class Balloon {

        @FormProperty("mass_density")

        float massDensity

    }

    

    chain.post("balloon", { Context ctx ->

        ctx.parse(Form) { Form form -> 

            Balloon balloon = form as Balloon

            assert balloon.massDesnity == 0.179

        }

    })

#### Parse via set interception

    // curl -XPOST localhost:5050/book \ 

    // --data "author=Edgar Allan Poe" \

    // --data "stories=The Gold-Bug, The Murders in the Rue Morgue, The Mystery of Marie Roget"  

    

    class Book {

        String author

        List stories

        def setStories(String commaSeparatedList) {

            stories = commaSeparatedList.split(",")*.trim()

        }

    }

    

    chain.post("book", { Context ctx ->

        ctx.parse(Form) { Form form -> 

            Book book = form as Book

            assert book.author == 'Edgar Allan Poe'

            assert book.stories == [

                'The Gold-Bug',

                'The Murders in the Rue Morgue', 

                'The Mystery of Marie Roget'

            ]

        }

    })

    

#### Validation

To use validation features, you must include one of the libraries that implement [JSR 303](https://jcp.org/en/jsr/detail?id=303)

    

    // curl -XPOST localhost:5050/person --data "age=15"

    

    class Person {

        @Min(value = 18, message = "You must be 18 years or older") 

        int age

    }

    

    chain.post("person", { Context ctx ->

        ctx.parse(Form) { Form form ->

            try {

                Person person = form as Person

            } catch(ValidationException e) {

                ctx.render e.message

            }

        }

    })

    

#### See also 

> [FormIgnoreProperties](src/test/groovy/one/chest/ratpack/groovy/extension/FormIgnorePropertiesTest.groovy)

#### Shadow Jar

If you use a shadow library, do not forget to merge the extension module

    shadowJar {

        mergeGroovyExtensionModules()

    } 

[travis-image]: https://travis-ci.org/DNAlchemist/ratpack-form-parser.svg?branch=master

[travis-url]: https://travis-ci.org/DNAlchemist/ratpack-form-parser

[maven-image]: https://maven-badges.herokuapp.com/maven-central/one.chest.ratpack/ratpack-form-parser/badge.svg

[maven-url]: https://maven-badges.herokuapp.com/maven-central/one.chest.ratpack/ratpack-form-parser

[coveralls-image]: https://coveralls.io/repos/github/DNAlchemist/ratpack-form-parser/badge.svg?branch=master

[coveralls-url]: https://coveralls.io/github/DNAlchemist/ratpack-form-parser?branch=master

[license-url]: https://github.com/DNAlchemist/ratpack-form-parser/blob/master/LICENSE

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat