Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support transformation schema for XML #549

Merged
merged 13 commits into from
Nov 14, 2022
Merged

Support transformation schema for XML #549

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5c8367a
Add XML transformer
RVRhub Nov 8, 2022
9bb7849
Add test for XML transformer
RVRhub Nov 8, 2022
da76153
Add test for XML transformer
RVRhub Nov 8, 2022
84b3271
Update schema docs for XML Transformer and YAML Transformer
RVRhub Nov 10, 2022
8971216
Add XML transformer
RVRhub Nov 8, 2022
b39ad8a
Add test for XML transformer
RVRhub Nov 8, 2022
43c90c9
Add test for XML transformer
RVRhub Nov 8, 2022
2deb6d4
Update schema docs for XML Transformer and YAML Transformer
RVRhub Nov 10, 2022
48fd268
Merge remote-tracking branch 'origin/xml' into xml
RVRhub Nov 10, 2022
8867be5
Update schema doc for XML Transformer
RVRhub Nov 10, 2022
0c15926
Update schema doc for YAML Transformer
RVRhub Nov 10, 2022
7a76170
Merge remote-tracking branch 'upstream/main' into xml
RVRhub Nov 11, 2022
904850b
Simplify code for XML transformer
RVRhub Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 217 additions & 0 deletions docs/documentation/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ It also provides a set of ready to use transformers
* JSON
* SQL
* YAML
* XML
* Java Object

## Schema
Expand Down Expand Up @@ -165,3 +166,219 @@ will lead to
```
INSERT INTO "MyTable" ("row") VALUES (ROW('2'));
```

## YAML transformation
YAML transformation is very similar to CSV.

The following is an example on how to use it:

=== "Java"

``` java
final BaseFaker faker = new BaseFaker();

YamlTransformer<Object> transformer = new YamlTransformer<>();
Schema<Object, ?> schema = Schema.of(
field("name", () -> faker.name().firstName()),
field("lastname", () -> faker.name().lastName()),
field("phones", () -> Schema.of(
field("worknumbers", () -> faker.<String>collection().suppliers(() -> faker.phoneNumber().phoneNumber()).maxLen(2).build().get().toString()),
field("cellphones", () -> faker.<String>collection().suppliers(() -> faker.phoneNumber().cellPhone()).maxLen(3).build().get().toString())
)),
field("address", () -> Schema.of(
field("city", () -> faker.address().city()),
field("country", () -> faker.address().country()),
field("streetAddress", () -> faker.address().streetAddress())
))
);

System.out.println(transformer.generate(schema, 1));
```

will generate yaml with nested fields:

```
name: Katharyn
lastname: Predovic
phones:
worknumbers: [(715) 228-3360 x9556, (936) 907-6813 x7053]
cellphones: [410.609.5559, 1-720-415-7634, 786-631-7588]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm...
that's not good it should generate
like

name: Katharyn
lastname: Predovic
phones:
  worknumbers: 
     - (715) 228-3360 x9556
     - (936) 907-6813 x7053
  cellphones: 
     - 410.609.5559
     - 1-720-415-7634
     - 786-631-7588

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, you are right.

address:
city: South Bruce
country: Cyprus
streetAddress: 320 Howell Roads
```

## XML

XML transformation could be build with help of `new XmlTransformer.XmlTransformerBuilder<>().build()`.

`XmlTransformer.XmlTransformerBuilder.pretty` allows you to specify that the document should be formatted.

### Elements and attributes

In case you want to generate XML, Datafaker provides a facility to build XML elements and
attributes using randomly generated data in the following way:

=== "Java"

``` java
public static void main(String[] args) {
final BaseFaker faker = new BaseFaker();
FakeStream<Object> address =
(FakeStream<Object>) faker.stream()
.suppliers(() ->
compositeField("address",
new Field[]{
field("country", () -> faker.address().country()),
field("city", () -> faker.address().city()),
field("streetAddress", () -> faker.address().streetAddress())}))
.maxLen(3).build();

FakeStream<Object> persons =
(FakeStream<Object>) faker.stream()
.suppliers(() ->
compositeField("person",
new Field[]{
field("firstname", () -> faker.name().firstName()),
field("lastname", () -> faker.name().lastName()),
field(null, () -> Collections.singletonList(
field("addresses", () -> address.get().collect(Collectors.toList()))))}))
.maxLen(3).build();

XmlTransformer<Object> xmlTransformer = new XmlTransformer.XmlTransformerBuilder<>().pretty(true).build();
System.out.println(xmlTransformer.generate(Schema.of(field("persons", () -> persons.get().collect(Collectors.toList()))), 1));
}
```

This will produce the following output:

```xml
<persons>
<person firstname="Dianna" lastname="Langworth">
<addresses>
<address country="Burundi" city="Robbimouth" streetAddress="731 Haley Valleys"/>
<address country="Guam" city="McKenziechester" streetAddress="7653 Sonny Crossing"/>
<address country="Bangladesh" city="New Rodrigoland" streetAddress="9653 Lester Highway"/>
</addresses>
</person>
<person firstname="Emilie" lastname="Bednar">
<addresses>
<address country="Iceland" city="Port Garret" streetAddress="4013 Luciano Terrace"/>
<address country="Micronesia" city="West Murrayshire" streetAddress="109 Weber Streets"/>
<address country="United States Minor Outlying Islands" city="Port Cortney" streetAddress="085 Laci Expressway"/>
</addresses>
</person>
<person firstname="Lina" lastname="Purdy">
<addresses>
<address country="Liechtenstein" city="New Andree" streetAddress="08276 Treutel Street"/>
<address country="Somalia" city="Shirelytown" streetAddress="8482 Hansen Valleys"/>
<address country="Indonesia" city="New Earlie" streetAddress="814 Londa Flat"/>
</addresses>
</person>
</persons>
```

### Elements only

In case you only want to generate XML elements, without any attributes, that possible too:


=== "Java"

``` java
final BaseFaker faker = new BaseFaker();
FakeStream<?> address = (FakeStream<SimpleField<String, List<Object>>>)
faker.<SimpleField<String, List<Object>>>stream()
.suppliers(() ->
field("address",
() -> Arrays.asList(
field("country", () -> faker.address().country()),
field("city", () -> faker.address().city()),
field("streetAddress", () -> faker.address().streetAddress()))))
.maxLen(3).build();

FakeStream<?> persons = (FakeStream<SimpleField<Object, List<Object>>>)
faker.<SimpleField<Object, List<Object>>>stream()
.suppliers(() ->
field("person",
() -> Arrays.asList(
field("firstname", () -> faker.name().firstName()),
field("lastname", () -> faker.name().lastName()),
field("addresses", () -> address.get().collect(Collectors.toList())))))
.maxLen(3).build();


XmlTransformer<Object> xmlTransformer = new XmlTransformer.XmlTransformerBuilder<>().pretty(true).build();
System.out.println(xmlTransformer.generate(Schema.of(field("persons", () -> persons.get().collect(Collectors.toList()))), 1));
```

Executing the above will result in:

```xml
<persons>
<person>
<firstname>Rosario</firstname>
<lastname>Mayert</lastname>
<addresses>
<address>
<country>Marshall Islands</country>
<city>Stiedemannside</city>
<streetAddress>435 Doyle Harbors</streetAddress>
</address>
<address>
<country>Democratic People&apos;s Republic of Korea</country>
<city>Dominiquefort</city>
<streetAddress>25135 Hansen Terrace</streetAddress>
</address>
<address>
<country>Greenland</country>
<city>Carrollstad</city>
<streetAddress>8802 Lueilwitz Tunnel</streetAddress>
</address>
</addresses>
</person>
<person>
<firstname>Cyrstal</firstname>
<lastname>Spinka</lastname>
<addresses>
<address>
<country>Andorra</country>
<city>East Lanny</city>
<streetAddress>3488 Alejandro Crossroad</streetAddress>
</address>
<address>
<country>Cameroon</country>
<city>Lake Kira</city>
<streetAddress>30136 Watsica Squares</streetAddress>
</address>
<address>
<country>Ukraine</country>
<city>Cassandrabury</city>
<streetAddress>5764 Koepp Throughway</streetAddress>
</address>
</addresses>
</person>
<person>
<firstname>Leigh</firstname>
<lastname>Satterfield</lastname>
<addresses>
<address>
<country>Mali</country>
<city>South Simonne</city>
<streetAddress>0870 Corkery Green</streetAddress>
</address>
<address>
<country>Mongolia</country>
<city>Margotland</city>
<streetAddress>4280 Lonnie Haven</streetAddress>
</address>
<address>
<country>Zimbabwe</country>
<city>Boyleland</city>
<streetAddress>4972 Medhurst Extensions</streetAddress>
</address>
</addresses>
</person>
</persons>
```
1 change: 1 addition & 0 deletions src/main/java/net/datafaker/formats/Xml.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import java.util.HashMap;
import java.util.Map;

@Deprecated
public class Xml {
private static final Map<Character, String> ESCAPING_MAP = createEscapeMap();
private static final int INDENTATION_STEP = 4;
Expand Down
Loading