Mailing-List: contact dev-help@brooklyn.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@brooklyn.apache.org
MIME-Version: 1.0
References: <CAH20XTYPm5-Oq72=TKdUH6UBU6SiOFSP-no6N1K=n4y0XKLmyw@mail.gmail.com>
In-Reply-To: <CAH20XTYPm5-Oq72=TKdUH6UBU6SiOFSP-no6N1K=n4y0XKLmyw@mail.gmail.com>
From: Andrew Kennedy <andrew.kennedy@cloudsoftcorp.com>
Date: Fri, 29 Jul 2016 01:34:47 +0000
Message-ID: <CAEK0Ph3uw967CU096KKeXeFHC=En_3cNZL4aDX_w_e8JM9G0zw@mail.gmail.com>
Subject: Re: [PROPOSAL] Brooklyn DSL in YAML using custom YAML types
To: dev@brooklyn.apache.org
Content-Type: multipart/alternative; boundary=001a1141795018459a0538bc42f8
archived-at: Fri, 29 Jul 2016 01:35:08 -0000

--001a1141795018459a0538bc42f8
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

Hi.

The 'formatString' example you quote would normally be written like this,
though:

  brooklyn.config:
    brooklyn.example.db.url:
      $brooklyn:formatString:
        - "jdbc:%s%s?user=3D%s\\&password=3D%s"
        - $brooklyn:component("db").attributeWhenReady("datastore.url")
        - "visitors"
        - "brooklyn"
        - "br00k11n"

So, I'm not sure what we gain here? I'll have a proper look at the YAML
spec, though, and see if I can understand it better.

Cheers,
Andrew.

On Wed, 13 Jul 2016 at 13:35 Thomas Bouron <thomas.bouron@cloudsoftcorp.com=
>
wrote:

> Hi All
>
> The YAML spec[1] has a very nice and standard way of defining custom type=
s
> by prefixing any value or object by a `!!<type_name>`. This seems like a
> perfect feature for the Brooklyn DSL instead of the `$brooklyn:<command>`=
.
> Let's me explain why.
>
> Right now, a Brooklyn DSL command needs to be written as a string such as=
:
> $brooklyn:formatString("jdbc:%s%s?user=3D%s\\&password=3D%s",
> component("db").attributeWhenReady("datastore.url"),
> "visitors", "brooklyn", "br00k11n")
> However, any good YAML library (such as js-yaml[2]) to parse and dump YAM=
L
> <--> JSON would wrap this string in quotes because it contains quotes or
> reserved characters. That is the expected behaviour based on the
> specification[3]. But this is an issue for the Brooklyn parser as the val=
ue
> will be treated as a `String` and not as a `DslCommand` object.
>
> So my proposal is as follow: support the Brooklyn DSL as a standard custo=
m
> YAML type. We obviously need to avoid any quote or reserved characters.
> That is relatively simple for commands that takes only one parameter, for
> instance:
>
>    - $brooklyn:component('my-id') could become
>       - !brooklyn:component my-id
>    - $brooklyn:entitySpec would become
>       - !brooklyn:spec
>
> For the more complex ones, I created a gist[4] that illustrates how this
> could work. It is more verbose than the current version but we get a rid =
of
> the hacky `$brooklyn` and comply fully to the YAML specification.
>
> Best.
>
> [1] http://yaml.org/spec/1.2/spec.html
> [2] https://github.com/nodeca/js-yaml
> [3] http://yaml.org/spec/1.2/spec.html#id2788859
> [4] https://gist.github.com/tbouron/67527796726e10689d8d3c34784cd7ec
>
> --
>
> Thomas Bouron =E2=80=A2 Software Engineer @ Cloudsoft Corporation =E2=80=
=A2
> http://www.cloudsoftcorp.com/
> Github: https://github.com/tbouron
> Twitter: https://twitter.com/eltibouron
>
--=20

Andrew Kennedy ; Founder clocker.io project ; @grkvlt ; Cloudsoft

--001a1141795018459a0538bc42f8--