Implement the SharePriceMovementPerMinute projection

model/src/main/java/io/spine/examples/shareaware/market/SharePriceMovement.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.spine.examples.shareaware.market;
+
+import com.google.errorprone.annotations.Immutable;
+import com.google.protobuf.Duration;
+import com.google.protobuf.Timestamp;
+import io.spine.annotation.GeneratedMixin;
+import io.spine.base.EntityState;
+import io.spine.examples.shareaware.ShareId;
+import io.spine.examples.shareaware.SharePriceMovementId;
+
+/**
+ * Common interface for projections that display the movements of the share price.
+ */
+@Immutable
+@GeneratedMixin
+public interface SharePriceMovement extends EntityState {
+
+    /**
+     * Returns the ID of the {@code SharePriceMovement} projection.
+     */
+    SharePriceMovementId getId();
+
+    /**
+     * Returns the time when the projection was created.
+     */
+    default Timestamp whenCreated() {
+        return getId().getWhenCreated();
+    }
+
+    /**
+     * Returns the activity period of the projection.
+     *
+     * <p>The period when it is collecting data about the share price movements.
+     */
+    default Duration activityTime() {
+        return getId().getActivityTime();
+    }
+
+    /**
+     * Returns the ID of the share which price movements the projection displays.
+     */
+    default ShareId share() {
+        return getId().getShare();
+    }
+}

model/src/main/java/io/spine/examples/shareaware/market/WithShares.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.spine.examples.shareaware.market;
+
+import com.google.errorprone.annotations.Immutable;
+import io.spine.annotation.GeneratedMixin;
+import io.spine.base.EventMessage;
+import io.spine.examples.shareaware.ShareId;
+import io.spine.examples.shareaware.share.Share;
+
+import java.util.List;
+
+import static io.spine.util.Exceptions.newIllegalArgumentException;
+
+/**
+ * Common interface for signals which operate with a list of shares.
+ */
+@Immutable
+@GeneratedMixin
+public interface WithShares extends EventMessage {
+
+    /**
+     * Returns the list of shares.
+     */
+    List<Share> getShareList();
+
+    /**
+     * Finds the share with provided ID from the shares list.
+     *
+     * @throws IllegalArgumentException when the share with provided ID is not found in the list
+     */
+    default Share find(ShareId id) {
+        List<Share> shares = getShareList();
+        var optionalShare = shares
+                .stream()
+                .filter(share -> share.getId().equals(id))
+                .findAny();
+        if (optionalShare.isEmpty()) {
+            throw newIllegalArgumentException(
+                    "Cannot find the share with the provided ID `%s` in the list of shares `%s`.",
+                    id, shares);
+        }
+        return optionalShare.get();
+    }
+}

model/src/main/proto/spine_examples/shareaware/identifiers.proto

@@ -36,6 +36,8 @@ option java_outer_classname = "IdentifiersProto";
 option java_multiple_files = true;
 
 import "spine/core/user_id.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
 
 // Identifies a watchlist.
 message WatchlistId {
@@ -119,3 +121,16 @@ message ReplenishmentOperationId {
         SaleId sale = 2;
     }
 }
+
+// Identifies the share price movement view.
+message SharePriceMovementId {
+
+    // The ID of share, for which the movements are collected.
+    ShareId share = 1;
+
+    // The duration during which the share price movements are collected.
+    google.protobuf.Duration activity_time = 2 [(required) = true];
+
+    // The time when the share price movement view was created.
+    google.protobuf.Timestamp when_created = 3 [(required) = true];
+}

model/src/main/proto/spine_examples/shareaware/market/events.proto

@@ -38,6 +38,7 @@ option java_multiple_files = true;
 import "spine_examples/shareaware/identifiers.proto";
 import "spine/money/money.proto";
 import "spine_examples/shareaware/share.proto";
+import "google/protobuf/timestamp.proto";
 
 // Shares have been obtained from the market.
 message SharesObtained {
@@ -90,10 +91,14 @@ message MarketClosed {
 
 // Shares on market have been updated.
 message MarketSharesUpdated {
+    option (is).java_type = "io.spine.examples.shareaware.market.WithShares";
 
     // The ID of the shares market.
     MarketId market = 1;
 
     // Updated shares.
     repeated Share share = 2 [(required) = true];
+
+    // Time when shares were updated.
+    google.protobuf.Timestamp when_updated = 3 [(required) = true];
 }

model/src/main/proto/spine_examples/shareaware/market/share_price_movement.proto

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+syntax = "proto3";
+
+package spine_examples.shareaware.market;
+
+import "spine/options.proto";
+
+option (type_url_prefix) = "type.shareaware.spine.io";
+option java_package = "io.spine.examples.shareaware.market";
+option java_outer_classname = "SharesPriceMovementPerMinuteProto";
+option java_multiple_files = true;
+
+import "spine_examples/shareaware/identifiers.proto";
+import "google/protobuf/timestamp.proto";
+import "spine/money/money.proto";
+
+// Displays the share price movement per minute on a timeline.
+message SharePriceMovementPerMinute {
+    option (entity) = {kind: PROJECTION};
+    option (is).java_type = "io.spine.examples.shareaware.market.SharePriceMovement";
+
+    // The ID of the share price movement.
+    SharePriceMovementId id = 1;
+
+    // The ID of the share, which price movement to display.
+    ShareId share = 2 [(required) = true, (column) = true];
+
+    // The list of the price-to-time points.
+    repeated PriceAtTime point = 3;
+}
+
+// The share price at a particular time.
+message PriceAtTime {
+
+    // The share price.
+    spine.money.Money price = 1 [(required) = true];
+
+    // Point in time when the share price was set.
+    google.protobuf.Timestamp when = 2 [(required) = true];
+}

server/build.gradle.kts

@@ -46,6 +46,7 @@ spine {
 dependencies {
     implementation(project(":model"))
     testImplementation(project(":model", "test"))
+    testImplementation(project(":testutil-server"))
 }
 
 application {

server/src/main/java/io/spine/examples/shareaware/server/TradingContext.java

@@ -32,6 +32,7 @@
 import io.spine.examples.shareaware.server.investment.SharesSaleRepository;
 import io.spine.examples.shareaware.server.market.AvailableMarketSharesRepository;
 import io.spine.examples.shareaware.server.market.MarketProcess;
+import io.spine.examples.shareaware.server.market.SharePriceMovementPerMinuteRepository;
 import io.spine.examples.shareaware.server.paymentgateway.PaymentGatewayProcess;
 import io.spine.examples.shareaware.server.wallet.WalletAggregate;
 import io.spine.examples.shareaware.server.wallet.WalletBalanceRepository;
@@ -75,6 +76,7 @@ public static BoundedContextBuilder newBuilder() {
                 .add(new SharesPurchaseRepository())
                 .add(new SharesSaleRepository())
                 .add(new InvestmentViewRepository())
-                .add(new AvailableMarketSharesRepository());
+                .add(new AvailableMarketSharesRepository())
+                .add(new SharePriceMovementPerMinuteRepository());
     }
 }

server/src/main/java/io/spine/examples/shareaware/server/market/MarketDataProvider.java

@@ -39,6 +39,7 @@
 import java.util.function.Consumer;
 
 import static com.google.common.util.concurrent.Uninterruptibles.sleepUninterruptibly;
+import static io.spine.base.Time.currentTime;
 import static java.util.concurrent.Executors.newSingleThreadExecutor;
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 
@@ -159,6 +160,7 @@ private MarketSharesUpdated emitEvent() {
                 .newBuilder()
                 .setMarket(MarketProcess.ID)
                 .addAllShare(updatedShares)
+                .setWhenUpdated(currentTime())
                 .vBuild();
         marketContext.emittedEvent(event, actor);
         return event;

server/src/main/java/io/spine/examples/shareaware/server/market/SharePriceMovementPerMinuteProjection.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2023, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.spine.examples.shareaware.server.market;
+
+import io.spine.core.External;
+import io.spine.core.Subscribe;
+import io.spine.examples.shareaware.SharePriceMovementId;
+import io.spine.examples.shareaware.market.PriceAtTime;
+import io.spine.examples.shareaware.market.SharePriceMovementPerMinute;
+import io.spine.examples.shareaware.market.event.MarketSharesUpdated;
+import io.spine.server.projection.Projection;
+
+/**
+ * The view of the share price movements per minute.
+ */
+final class SharePriceMovementPerMinuteProjection
+        extends Projection<SharePriceMovementId,
+                           SharePriceMovementPerMinute,
+                           SharePriceMovementPerMinute.Builder> {
+
+    @Subscribe
+    void on(@External MarketSharesUpdated e) {
+        var shareId = builder()
+                .getId()
+                .getShare();
+        var price = e.find(shareId)
+                     .getPrice();
+        var priceAtTime = PriceAtTime
+                .newBuilder()
+                .setPrice(price)
+                .setWhen(e.getWhenUpdated())
+                .vBuild();
+        builder().setShare(shareId)
+                 .addPoint(priceAtTime);
+    }
+}