feat: update with changes

Author: Totremont

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,5 +1,5 @@
 name: Bug Report
-description: Please report issues related to TEMPLATE_ADDON here.
+description: Please report issues related to DateTimeRangePicker here.
 body:
   - type: textarea
     id: problem-description

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,5 +1,5 @@
 name: Feature Request
-description: Please add feature suggestions related to TEMPLATE_ADDON here.
+description: Please add feature suggestions related to DateTimeRangePicker here.
 body:
   - type: textarea
     id: feature-proposal

README.md

@@ -1,7 +1,7 @@
 [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/date-time-range-picker-add-on)
-[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/template-add-on.svg)](https://vaadin.com/directory/component/date-time-range-picker-add-on)
-[![Build Status](https://jenkins.flowingcode.com/job/template-addon/badge/icon)](https://jenkins.flowingcode.com/job/date-time-range-picker-addon)
-[![Maven Central](https://img.shields.io/maven-central/v/com.flowingcode.vaadin.addons/template-addon)](https://mvnrepository.com/artifact/com.flowingcode.vaadin.addons/date-time-range-picker-addon)
+[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/date-time-range-picker-add-on.svg)](https://vaadin.com/directory/component/date-time-range-picker-add-on)
+[![Build Status](https://jenkins.flowingcode.com/job/date-time-range-picker-addon/badge/icon)](https://jenkins.flowingcode.com/job/date-time-range-picker-addon)
+[![Maven Central](https://img.shields.io/maven-central/v/com.flowingcode.vaadin.addons/date-time-range-picker-addon)](https://mvnrepository.com/artifact/com.flowingcode.vaadin.addons/date-time-range-picker-addon)
 [![Javadoc](https://img.shields.io/badge/javadoc-00b4f0)](https://javadoc.flowingcode.com/artifact/com.flowingcode.vaadin.addons/date-time-range-picker-addon)
 
 # DateTimeRangePicker Add-on for Vaadin 24
@@ -109,8 +109,8 @@ The API is exposed through the **DateTimeRange** class.
     binder.forField(addon).bind(Pojo::getDateTimeRange, Pojo::setDateTimeRange);    (2) 
     binder.setBean(pojo);                                                           (3)
 ```
- - (1) The **Pojo** class is binded using its getter and setter methods (2).
- - (2) The **DateTimeRangePicker** is binded. Its [value](https://vaadin.com/api/platform/current/com/vaadin/flow/component/HasValue.html) can be operated now.
+ - (1) The **Pojo** class is bound using its getter and setter methods (2).
+ - (2) The **DateTimeRangePicker** is bound. Its [value](https://vaadin.com/api/platform/current/com/vaadin/flow/component/HasValue.html) can be operated now.
  - (3) The **DateTimeRange** instance is saved in the **Pojo** class or returned from it.
 
 

pom.xml

@@ -7,8 +7,8 @@
     <groupId>com.flowingcode.vaadin.addons</groupId>
     <artifactId>date-time-range-picker-addon</artifactId>
     <version>1.0.0-SNAPSHOT</version>
-    <name>DateTimeRangePicker</name>
-    <description>DateTimeRangePicker Vaadin Add-on</description>
+    <name>Date Time Range Picker Add-on</name>
+    <description>Component that facilitates the selection of a date and time range</description>
     <url>https://www.flowingcode.com/en/open-source/</url>
 
     <properties>
@@ -38,9 +38,9 @@
     </licenses>
 
     <scm>
-        <url>https://github.com/FlowingCode/AddonStarter24</url>
-        <connection>scm:git:git://github.com/FlowingCode/AddonStarter24.git</connection>
-        <developerConnection>scm:git:ssh://git@github.com:/FlowingCode/AddonStarter24.git</developerConnection>
+        <url>https://github.com/FlowingCode/DateTimeRangePicker</url>
+        <connection>scm:git:git://github.com/FlowingCode/DateTimeRangePicker.git</connection>
+        <developerConnection>scm:git:ssh://git@github.com:/FlowingCode/DateTimeRangePicker.git</developerConnection>
         <tag>master</tag>
     </scm>
 

src/main/java/com/flowingcode/vaadin/addons/datetimerangepicker/api/DateTimeRange.java

@@ -32,7 +32,7 @@
 import java.util.Set;
 
 /**
- * A class to operate {@link TimeInterval} instances based on defined date and time constraints<br>
+ * A class to operate {@link TimeInterval} instances based on defined date and time constraints
  *
  * @author Izaguirre, Ezequiel
  * @see TimeInterval
@@ -53,6 +53,9 @@ public class DateTimeRange implements Serializable {
 
 
   public DateTimeRange(LocalDate startDate, LocalDate endDate, Set<DayOfWeek> weekDays) {
+    if (!startDate.isBefore(endDate)) {
+      throw new IllegalArgumentException("startDate must be before endDate");
+    }
     this.startDate = startDate;
     this.endDate = endDate;
     setWeekDays(weekDays);
@@ -65,8 +68,7 @@ public DateTimeRange(LocalDate startDate, LocalDate endDate) {
   public DateTimeRange(LocalDate startDate, LocalDate endDate, LocalTime startTime, LocalTime endTime,
       Set<DayOfWeek> weekDays) {
     this(startDate, endDate, weekDays);
-    this.endTime = endTime;
-    this.startTime = startTime;
+    setDayDuration(startTime, endTime);
   }
 
   public DateTimeRange(LocalDate startDate, LocalDate endDate, LocalTime startTime, LocalTime endTime) {
@@ -80,6 +82,9 @@ public DateTimeRange(LocalDate startDate, LocalDate endDate, LocalTime startTime
    * @param endTime   the ending point (exclusive).
    */
   public void setDayDuration(LocalTime startTime, LocalTime endTime) {
+    if (!startTime.isBefore(endTime)) {
+      throw new IllegalArgumentException("startTime must be before endTime");
+    }
     this.startTime = startTime;
     this.endTime = endTime;
   }
@@ -90,6 +95,9 @@ public void setDayDuration(LocalTime startTime, LocalTime endTime) {
    * @param weekDays a list of days
    */
   public void setWeekDays(Set<DayOfWeek> weekDays) {
+    if(weekDays == null) {
+      throw new IllegalArgumentException("weekDays can't be null");
+    }
     DayOfWeek[] allWeekDays = DayOfWeek.values();
 
     for (int i = 0; i < allWeekDays.length; i++) {
@@ -263,9 +271,9 @@ public Duration getDayDuration() {
   }
 
   /**
-   * Gets the amount of days between the start and (exclusive) end dates
+   * Gets the period between the start and (exclusive) end dates
    */
-  public Period getDaysSpan() {
+  public Period getDatesPeriod() {
     return Period.between(startDate, endDate);
   }
 
@@ -321,8 +329,8 @@ private List<TimeInterval> generateIntervals(LocalDateTime from, LocalDateTime t
     LocalDate startDate = from.toLocalDate();
     LocalTime startTime = from.toLocalTime();
     LocalDate endDate = to.toLocalDate();
-    int days = Period.between(startDate, endDate).getDays();
-    int i = 0;
+    long days = java.time.temporal.ChronoUnit.DAYS.between(startDate, endDate);
+    long i = 0;
     List<TimeInterval> entities = new ArrayList<>();
     DayOfWeek firstDay = startDate.getDayOfWeek();
     if (this.weekDays[firstDay.getValue() - 1] == null || !this.endTime.isAfter(startTime)) {

src/main/java/com/flowingcode/vaadin/addons/datetimerangepicker/api/TimeInterval.java

@@ -35,6 +35,9 @@ public class TimeInterval implements Serializable, Comparable<TimeInterval> {
   private final LocalDateTime endDate;
 
   public TimeInterval(LocalDateTime start, LocalDateTime end) {
+    if (!start.isBefore(end)) {
+      throw new IllegalArgumentException("start time must be before end time");
+    }
     this.startDate = start;
     this.endDate = end;
   }

src/main/java/com/flowingcode/vaadin/addons/datetimerangepicker/ui/ChipGroup.java

@@ -39,25 +39,31 @@
 import com.vaadin.flow.theme.lumo.LumoUtility.Margin;
 import com.vaadin.flow.theme.lumo.LumoUtility.Padding;
 import com.vaadin.flow.theme.lumo.LumoUtility.Padding.Horizontal;
+import com.vaadin.flow.theme.lumo.LumoUtility.Padding.Left;
 import com.vaadin.flow.theme.lumo.LumoUtility.Padding.Vertical;
 import com.vaadin.flow.theme.lumo.LumoUtility.TextColor;
 import java.util.HashSet;
 import java.util.Set;
 
-// A single selection ChipGroup
+/**
+ * A UI component representing a group of single-selection chips.
+ * The group can be set to read-only mode, disabling user interaction.
+ * This component is styled using the "fc-dtrp" CSS classes.
+ */
 @CssImport("./styles/styles.css")
 class ChipGroup extends HorizontalLayout {
 
   private final Set<Chip> chips = new HashSet<>();
   private Chip checkedChip;
+  private boolean readOnly = false;
 
   public ChipGroup() {
     addClassNames(
         AlignItems.CENTER,
         JustifyContent.END,
         Gap.SMALL,
         FlexWrap.WRAP,
-        Horizontal.SMALL,
+        Left.SMALL,
         Vertical.SMALL
     );
   }
@@ -72,16 +78,11 @@ public ChipGroup(Chip... chips) {
   public Chip addChip(Chip chip) {
     chips.add(chip);
     chip.setParent(this);
+    chip.setReadOnly(readOnly);
     add(chip);
     return chip;
   }
 
-  public boolean deleteChip(Chip chip) {
-    chip.setParent(null);
-    remove(chip);
-    return chips.remove(chip);
-  }
-
   private void onChipChange(Chip chip) {
     if (checkedChip != null) {
       if (!checkedChip.equals(chip)) {
@@ -96,6 +97,7 @@ private void onChipChange(Chip chip) {
   }
 
   public void setReadOnly(boolean readOnly) {
+    this.readOnly = readOnly;
     chips.forEach(c -> c.setReadOnly(readOnly));
   }
 
@@ -120,7 +122,6 @@ public Chip(String text) {
           Display.INLINE_FLEX,
           Gap.SMALL
       );
-      getStyle().setCursor("pointer");
       checkIcon = VaadinIcon.CHECK.create();
       checkIcon.setSize("14px");
 
@@ -193,14 +194,12 @@ public void setReadOnly(boolean readOnly) {
         removeClassName("fc-dtrp-hoverable");
         removeClassName(TextColor.BODY);
         addClassName(TextColor.SECONDARY);
-        getStyle().setCursor("default");
-        getElement().getStyle().set("border-style", "dashed");
+        addClassName("fc-dtrp-readonly");
       } else {
-        addClassName("fc-dtrp-hoverable");
+        removeClassName("fc-dtrp-readonly");
         removeClassName(TextColor.SECONDARY);
+        addClassName("fc-dtrp-hoverable");
         addClassName(TextColor.BODY);
-        getElement().getStyle().set("border-style", "solid");
-        getStyle().setCursor("pointer");
       }
     }
 

src/main/java/com/flowingcode/vaadin/addons/datetimerangepicker/ui/Circle.java

@@ -20,30 +20,20 @@
 package com.flowingcode.vaadin.addons.datetimerangepicker.ui;
 
 import com.vaadin.flow.component.html.Div;
-import com.vaadin.flow.theme.lumo.LumoUtility.AlignItems;
-import com.vaadin.flow.theme.lumo.LumoUtility.Display;
-import com.vaadin.flow.theme.lumo.LumoUtility.JustifyContent;
-import com.vaadin.flow.theme.lumo.LumoUtility.Padding.Vertical;
-import com.vaadin.flow.theme.lumo.LumoUtility.Position;
-import com.vaadin.flow.theme.lumo.LumoUtility.Width;
-
-// Indicator circle
+
+/**
+ * A simple UI component representing a circular indicator.
+ * The circle's background color can be customized using the {@link #setColor(String)} method.
+ * This component is styled with the "fc-dtrp-circle" CSS class.
+ */
 class Circle extends Div {
 
   private final Div circle;
 
   public Circle() {
     circle = new Div();
 
-    addClassNames(
-        Display.INLINE_FLEX,
-        AlignItems.CENTER,
-        JustifyContent.CENTER,
-        Vertical.XSMALL,
-        Position.ABSOLUTE,
-        Width.AUTO,
-        "fc-dtrp-circle"
-    );
+    addClassName("fc-dtrp-circle");
 
     add(circle);
   }