Add shortHand directive + javadoc

Author: jcheron

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>io.github.jeemv.springboot.vuejs</groupId>
   <artifactId>springboot-vuejs</artifactId>
-  <version>1.0.11</version>
+  <version>1.0.12</version>
 
   <name>springboot-vuejs</name>
   <url>https://github.com/jeeMv/SpringBoot-VueJS</url>
@@ -48,39 +48,39 @@
 	<dependency>
 	    <groupId>com.fasterxml.jackson.core</groupId>
 	    <artifactId>jackson-core</artifactId>
-	    <version>[2.9.8,)</version>
+	    <version>[2.10.0,)</version>
 	</dependency>
 	<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
 	<dependency>
 	    <groupId>com.fasterxml.jackson.core</groupId>
 	    <artifactId>jackson-databind</artifactId>
-	    <version>[2.9.8,)</version>
+	    <version>[2.10.0,)</version>
 	</dependency>	
 	<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
 	<dependency>
 	    <groupId>org.aspectj</groupId>
 	    <artifactId>aspectjweaver</artifactId>
-	    <version>1.9.1</version>
+	    <version>1.9.4</version>
 	</dependency>
 	<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
 	<dependency>
 	    <groupId>org.springframework</groupId>
 	    <artifactId>spring-context</artifactId>
-	    <version>5.1.0.RELEASE</version>
+	    <version>5.2.0.RELEASE</version>
 	</dependency>
 
 	<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web -->
 	<dependency>
 	    <groupId>org.springframework.boot</groupId>
 	    <artifactId>spring-boot-starter-web</artifactId>
-	    <version>2.1.3.RELEASE</version>
+	    <version>2.1.9.RELEASE</version>
 	</dependency>
 
 	<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor -->
 	<dependency>
 	    <groupId>org.springframework.boot</groupId>
 	    <artifactId>spring-boot-configuration-processor</artifactId>
-	    <version>2.1.3.RELEASE</version>
+	    <version>2.1.9.RELEASE</version>
 	</dependency>
 
   </dependencies>

src/main/java/io/github/jeemv/springboot/vuejs/AbstractVueJS.java

@@ -15,6 +15,13 @@
 import io.github.jeemv.springboot.vuejs.parts.VueWatcher;
 import io.github.jeemv.springboot.vuejs.parts.VueWatchers;
 
+/**
+ * AbstractVueJS
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public abstract class AbstractVueJS {
 	protected VueData data;
 	protected VueMethods methods;
@@ -219,6 +226,16 @@ public VueDirective addDirective(String name) {
 		return directives.add(name);
 	}
 
+	/**
+	 * Adds a new directive in the vue instance
+	 * @param name The directive name
+	 * @param shortHand Shorthand function for bind and update
+	 * @return The created directive
+	 */
+	public VueDirective addDirective(String name,String shortHand) {
+		return directives.add(name,shortHand);
+	}
+	
 	/**
 	 * Adds a new filter in the vue instance
 	 * @param name The filter name

src/main/java/io/github/jeemv/springboot/vuejs/VueJS.java

@@ -25,7 +25,7 @@
 /**
  * VueJS instance
  * This class is part of springBoot-VueJS
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @version 1.0.3
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/annotations/VueJSInstance.java

@@ -11,7 +11,7 @@
  * This class is part of spring-boot-vuejs
  * inject an instance of VueJS initialized from the parameters selector and modelName. 
  * The annotated method must take the ModelMap and VueJS type parameters at the last position.
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @since 1.0.2
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/beans/RawObject.java

@@ -4,7 +4,7 @@
 /**
  * RawObject
  * This class is part of spring-boot-vuejs
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @version 1.0.0
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/components/VueComponent.java

@@ -33,6 +33,7 @@
 /**
  * VueJS component class
  * This class is part of springBoot-VueJS
+ * Components are create in src/main/resources/static/
  * @author jc
  * @version 1.0.1
  *
@@ -84,10 +85,18 @@ public String getTemplate() {
 		return template;
 	}
 
+	/**
+	 * Defines the template string
+	 * @param template
+	 */
 	public void setTemplate(String template) {
 		this.template = template;
 	}
 
+	/**
+	 * Sets a template file
+	 * @param pathFilename
+	 */
 	public void setTemplateFile(String pathFilename) {
 		try {
 			loadTemplateFile("templates/"+pathFilename);
@@ -97,6 +106,9 @@ public void setTemplateFile(String pathFilename) {
 		}
 	}
 
+	/**
+	 * Sets the default template file (componentName+".html")
+	 */
 	public void setDefaultTemplateFile() {
 		setTemplateFile(VueConfig.getTemplateComponentFolder()+"/"+name+".html");
 	}
@@ -105,6 +117,10 @@ public boolean isInternal() {
 		return internal;
 	}
 
+	/**
+	 * Defines if the component is created in the vue instance or not
+	 * @param internal
+	 */
 	public void setInternal(boolean internal) {
 		this.internal = internal;
 	}
@@ -113,24 +129,48 @@ public VueProps getProps() {
 		return props;
 	}
 
+	/**
+	 * Sets the component properties
+	 * @param props
+	 */
 	public void setProps(String...props) {
 		for(String prop:props) {
 			this.props.add(prop);
 		}
 	}
 
+	/**
+	 * Adds a new property to the component
+	 * @param name The property name
+	 * @param defaultValue The property default value
+	 * @return
+	 */
 	public VueProp addProp(String name,Object defaultValue) {
 		VueProp prop=this.props.add(name);
 		prop.setDefaultValue(defaultValue);
 		return prop;
 	}
 
+	/**
+	 * Adds a new property to the component
+	 * defaultValue is not quoted (because it's a raw property)
+	 * @param name The property name
+	 * @param defaultValue non quoted value
+	 * @return
+	 */
 	public VueProp addPropRaw(String name,String defaultValue) {
 		VueProp prop=this.props.add(name);
 		prop.setDefaultValue(new RawObject(defaultValue));
 		return prop;
 	}
 
+	/**
+	 * Adds a required property to the component
+	 * @param name The property name
+	 * @param type The property type
+	 * @param required true if the property is required
+	 * @return
+	 */
 	public VueProp addProp(String name,String type,boolean required) {
 		VueProp prop=this.props.add(name);
 		prop.setTypes(type);

src/main/java/io/github/jeemv/springboot/vuejs/components/VueProp.java

@@ -12,7 +12,7 @@
 /**
  * Represents a VueJS property for Components
  * This class is part of springBoot-VueJS
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @version 1.0.0
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/configuration/VueConfig.java

@@ -5,7 +5,7 @@
 /**
  * VueConfig (Used for components creation)
  * This class is part of springBoot-VueJS
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @version 1.0.0
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/console/CommandAction.java

@@ -1,6 +1,13 @@
 package io.github.jeemv.springboot.vuejs.console;
 
 
+/**
+ * CommandAction
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public class CommandAction {
 	private Runnable action;
 	private String option;

src/main/java/io/github/jeemv/springboot/vuejs/console/CommandPrompt.java

@@ -4,6 +4,13 @@
 import java.util.List;
 import java.util.Scanner;
 
+/**
+ * CommandPrompt
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public class CommandPrompt {
 	private String prompt;
 	private List<CommandAction> actions;

src/main/java/io/github/jeemv/springboot/vuejs/parts/AbstractVueComposition.java

@@ -2,6 +2,13 @@
 
 import io.github.jeemv.springboot.vuejs.utilities.JsUtils;
 
+/**
+ * AbstractVueComposition
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public abstract class AbstractVueComposition {
 	protected String name;
 	protected boolean internal;

src/main/java/io/github/jeemv/springboot/vuejs/parts/VueComputed.java

@@ -4,7 +4,7 @@
  * VueComputed 
  * represents a computed property
  * This class is part of springBoot-VueJS
- * @author jc
+ * @author jcheron myaddressmail@gmail.com
  * @version 1.0.0
  *
  */

src/main/java/io/github/jeemv/springboot/vuejs/parts/VueComputeds.java

@@ -3,6 +3,13 @@
 import io.github.jeemv.springboot.vuejs.configuration.VueConfig;
 import io.github.jeemv.springboot.vuejs.utilities.JsUtils;
 
+/**
+ * VueComputeds
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public class VueComputeds extends VuePart {
 
 	public void add(String name,String get,String set) {

src/main/java/io/github/jeemv/springboot/vuejs/parts/VueData.java

@@ -1,6 +1,13 @@
 package io.github.jeemv.springboot.vuejs.parts;
 
 
+/**
+ * VueData
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public class VueData extends VuePart {
 
 	@Override

src/main/java/io/github/jeemv/springboot/vuejs/parts/VueDirective.java

@@ -1,17 +1,41 @@
 package io.github.jeemv.springboot.vuejs.parts;
 
+/**
+ * VueDirective
+ * This class is part of springBoot-VueJS
+ * @author jcheron myaddressmail@gmail.com
+ * @version 1.0.0
+ *
+ */
 public class VueDirective extends AbstractVueComposition{
 	protected VueMethods methods;
+	protected VueMethod shortHand;
 
 	public VueDirective() {
 		super();
 		methods=new VueMethods();
 	}
 
+	/**
+	 * @param name The directive name (ex: demo for v-demo directive)
+	 */
 	public VueDirective(String name) {
 		super(name);
 		methods=new VueMethods();
 	}
+	
+	/**
+	 * @param name The directive name
+	 * @param shortHand Same behavior on bind and update, but don’t care about the other hooks
+	 */
+	public VueDirective(String name,String shortHand) {
+		super(name);
+		setShortHand(shortHand);
+	}
+	
+	public void setShortHand(String shortHand) {
+		this.shortHand=new VueMethod(shortHand,"el","binding","vnode");
+	}
 
 	/**
 	 * called only once, when the directive is first bound to the element. This is where you can do one-time setup work.
@@ -66,18 +90,35 @@ public VueDirective onUnbind(String body) {
 		return on("unbind", body);
 	}
 
+	/**
+	 * Adds an event in the directive
+	 * 
+	 * @param event The associated event
+	 * @param body The javascript code associated
+	 * @return
+	 */
 	protected VueDirective on(String event,String body) {
 		methods.add(event, body, "el", "binding", "vnode");
 		return this;
 	}
 
 	@Override
 	public String toString() {
+		if(shortHand instanceof VueMethod) {
+			return shortHand.toString();
+		}
 		return methods.toString();
 	}
 
 	@Override
 	public String getType() {
 		return "directive";
 	}
+	
+	/**
+	 * To also detect nested value changes inside Objects
+	 */
+	public void setDeep() {
+		methods.addProperty("deep", true);
+	}
 }