14560783068

Committed 20 Apr 2025 03:14PM UTC coverage: 53.402% (+0.08%) from 53.324%

Build # 14560783068

Build Type

push

github

Committed by

ljacqu

Commit Message

Document all word forms with examples

Run Details

268 of 576 branches covered (46.53%)

730 of 1367 relevant lines covered (53.4%)

3.09 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

53.85

/src/main/java/ch/jalu/wordeval/DataUtils.java

package ch.jalu.wordeval;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import lombok.Getter;
import lombok.NoArgsConstructor;

import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.lang.reflect.Type;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;

/**
 * Wrapper for interaction with the file system and JSON operations.
 */
@NoArgsConstructor
public class DataUtils {
  
  @Getter
  private String root = "";
  
  @Getter
  private boolean usePrettyPrint = false;
  
  @Getter(lazy = true)
  private final Gson gson = createGson();
  
  /**
   * Initializes an instance and sets whether to use JSON Pretty Print or not.
   *
   * @param usePrettyPrint JSON pretty print setting
   */
  public DataUtils(boolean usePrettyPrint) {
    this.usePrettyPrint = usePrettyPrint;
  }
  
  /**
   * Sets the root path (the path to append to file references).
   *
   * @param root the root to append to file paths
   */
  public void setRoot(String root) {
    if (!root.isEmpty() && !root.endsWith("/") && !root.endsWith(File.separator)) {
      this.root = root + File.separator;
    } else {
      this.root = root; 
    }
  }
  
  /**
   * Writes the content to the given file.
   *
   * @param filename the name of the file to write to
   * @param content the content to write
   */
  public void writeToFile(String filename, String content) {
    try {
      Files.write(Paths.get(root + filename), content.getBytes());
    } catch (IOException e) {
      throw new UncheckedIOException("Could not write to file '" + filename + "'", e);
    }
  }
  
  /**
   * Reads a file's contents as UTF-8.
   *
   * @param filename the name of the file to read
   * @return the contents of the file
   */
  public static String readFile(String filename) {
    try {
      return Files.readString(Paths.get(filename));
    } catch (IOException e) {
      throw new UncheckedIOException("Could not read file '" + filename + "'", e);
    }
  }

  /**
   * Reads all lines of a file as UTF-8.
   *
   * @param filename the name of the file to read
   * @return the file's contents by line
   */
  public static List<String> readAllLines(String filename) {
    try {
      return Files.readAllLines(Paths.get(filename));
    } catch (IOException e) {
      throw new UncheckedIOException("Could not read from file '" + filename + "'", e);
    }
  }
  
  /**
   * Converts an object to its JSON representation.
   *
   * @param o the object to convert
   * @return the generated JSON
   */
  public String toJson(Object o) {
    return getGson().toJson(o);
  }

  /**
   * Deserializes JSON to the specified type.
   *
   * @param <T> the result type
   * @param json the JSON text to deserialize
   * @param typeOfT the type of the resulting object
   * @return resulting object
   */
  public <T> T fromJson(String json, Type typeOfT) {
    return getGson().fromJson(json, typeOfT);
  }
  
  private Gson createGson() {
    if (usePrettyPrint) {
      return new GsonBuilder().setPrettyPrinting().create();
    }
    return new Gson();
  }

}

1	package ch.jalu.wordeval;
2
3	import com.google.gson.Gson;
4	import com.google.gson.GsonBuilder;
5	import lombok.Getter;
6	import lombok.NoArgsConstructor;
7
8	import java.io.File;
9	import java.io.IOException;
10	import java.io.UncheckedIOException;
11	import java.lang.reflect.Type;
12	import java.nio.file.Files;
13	import java.nio.file.Paths;
14	import java.util.List;
15
16	/**
17	* Wrapper for interaction with the file system and JSON operations.
18	*/
19	@NoArgsConstructor
20	public class DataUtils {
21
22	@Getter	3✔
23	private String root = "";
24
25	@Getter	3✔
26	private boolean usePrettyPrint = false;
27
28	@Getter(lazy = true)	5✔
29	private final Gson gson = createGson();
30
31	/**
32	* Initializes an instance and sets whether to use JSON Pretty Print or not.
33	*
34	* @param usePrettyPrint JSON pretty print setting
35	*/
36	public DataUtils(boolean usePrettyPrint) {	2✔
37	this.usePrettyPrint = usePrettyPrint;	3✔
38	}	1✔
39
40	/**
41	* Sets the root path (the path to append to file references).
42	*
43	* @param root the root to append to file paths
44	*/
45	public void setRoot(String root) {
46	if (!root.isEmpty() && !root.endsWith("/") && !root.endsWith(File.separator)) {	11!
47	this.root = root + File.separator;	6✔
48	} else {
49	this.root = root;	3✔
50	}
51	}	1✔
52
53	/**
54	* Writes the content to the given file.
55	*
56	* @param filename the name of the file to write to
57	* @param content the content to write
58	*/
59	public void writeToFile(String filename, String content) {
60	try {
61	Files.write(Paths.get(root + filename), content.getBytes());	×
62	} catch (IOException e) {	×
63	throw new UncheckedIOException("Could not write to file '" + filename + "'", e);	×
64	}	×
65	}	×
66
67	/**
68	* Reads a file's contents as UTF-8.
69	*
70	* @param filename the name of the file to read
71	* @return the contents of the file
72	*/
73	public static String readFile(String filename) {
74	try {
75	return Files.readString(Paths.get(filename));	×
76	} catch (IOException e) {	×
77	throw new UncheckedIOException("Could not read file '" + filename + "'", e);	×
78	}
79	}
80
81	/**
82	* Reads all lines of a file as UTF-8.
83	*
84	* @param filename the name of the file to read
85	* @return the file's contents by line
86	*/
87	public static List<String> readAllLines(String filename) {
88	try {
89	return Files.readAllLines(Paths.get(filename));	×
90	} catch (IOException e) {	×
91	throw new UncheckedIOException("Could not read from file '" + filename + "'", e);	×
92	}
93	}
94
95	/**
96	* Converts an object to its JSON representation.
97	*
98	* @param o the object to convert
99	* @return the generated JSON
100	*/
101	public String toJson(Object o) {
102	return getGson().toJson(o);	5✔
103	}
104
105	/**
106	* Deserializes JSON to the specified type.
107	*
108	* @param <T> the result type
109	* @param json the JSON text to deserialize
110	* @param typeOfT the type of the resulting object
111	* @return resulting object
112	*/
113	public <T> T fromJson(String json, Type typeOfT) {
114	return getGson().fromJson(json, typeOfT);	×
115	}
116
117	private Gson createGson() {
118	if (usePrettyPrint) {	3✔
119	return new GsonBuilder().setPrettyPrinting().create();	6✔
120	}
121	return new Gson();	4✔
122	}
123
124	}

ljacqu / wordeval / 14560783068

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous