Extract Splitter class, add "ranked" and "mixed" variants

Author: ledermann

lib/loop.rb

@@ -1,6 +1,6 @@
 require 'influx_push'
 require 'influx_pull'
-require 'calculator'
+require 'processor'
 
 class Loop
   def initialize(config:)
@@ -62,7 +62,7 @@ def process_day(day)
     day_records = influx_pull.day_records(day.beginning_of_day)
     return if day_records.empty?
 
-    splitted_powers = Calculator.new(day_records:, config:).call
+    splitted_powers = Processor.new(day_records:, config:).call
     influx_push.push(splitted_powers)
   end
 

lib/calculator.rb renamed to lib/processor.rb

@@ -1,6 +1,7 @@
 require 'config'
+require 'splitter/mixed'
 
-class Calculator
+class Processor
   def initialize(day_records:, config:)
     @day_records = day_records
     @config = config
@@ -69,7 +70,7 @@ def power_value(record, sensor_name)
     record[config.field(sensor_name)] || 0.0
   end
 
-  def split_power(record) # rubocop:disable Metrics/AbcSize
+  def split_power(record)
     house_power = house_power(record)
     wallbox_power = wallbox_power(record)
     heatpump_power = heatpump_power(record)
@@ -82,30 +83,11 @@ def split_power(record) # rubocop:disable Metrics/AbcSize
     )
     house_power = [house_power, 0].max
 
-    total_power = house_power + wallbox_power + heatpump_power
-
     grid_import_power = grid_import_power(record)
 
-    house_power_grid = 0
-    wallbox_power_grid = 0
-    heatpump_power_grid = 0
-
-    unless grid_import_power.zero? || total_power.zero?
-      house_power_ratio = house_power.fdiv(total_power)
-      wallbox_power_ratio = wallbox_power.fdiv(total_power)
-      heatpump_power_ratio = heatpump_power.fdiv(total_power)
-
-      house_power_grid = grid_import_power * house_power_ratio
-      wallbox_power_grid = grid_import_power * wallbox_power_ratio
-      heatpump_power_grid = grid_import_power * heatpump_power_ratio
-    end
-
-    {
-      time: record['time'],
-
-      house_power_grid:,
-      wallbox_power_grid:,
-      heatpump_power_grid:,
-    }
+    Splitter::Mixed
+      .new(grid_import_power:, house_power:, wallbox_power:, heatpump_power:)
+      .call
+      .merge(time: record['time'])
   end
 end

lib/splitter/base.rb

@@ -0,0 +1,30 @@
+module Splitter
+  class Base
+    def initialize(
+      grid_import_power:,
+      house_power:,
+      wallbox_power:,
+      heatpump_power:
+    )
+      @grid_import_power = grid_import_power
+      @house_power = house_power
+      @wallbox_power = wallbox_power
+      @heatpump_power = heatpump_power
+    end
+
+    attr_reader :grid_import_power,
+                :house_power,
+                :wallbox_power,
+                :heatpump_power
+
+    def call
+      raise NotImplementedError
+    end
+
+    private
+
+    def total
+      @total ||= house_power + wallbox_power + heatpump_power
+    end
+  end
+end

lib/splitter/mixed.rb

@@ -0,0 +1,31 @@
+require 'splitter/base'
+
+module Splitter
+  class Mixed < Base
+    def call
+      house_power_grid = 0
+      wallbox_power_grid = 0
+      heatpump_power_grid = 0
+
+      rest = grid_import_power
+
+      # Wallbox power is prioritized over other consumers
+      if rest.positive? && wallbox_power.positive?
+        wallbox_power_grid = [wallbox_power, rest].min
+        rest -= wallbox_power_grid
+      end
+
+      # Now we have to split the remaining power between the house and the heatpump
+      house_and_heatpump_power = house_power + heatpump_power
+      if rest.positive? && house_and_heatpump_power.positive?
+        house_power_ratio = house_power.fdiv(house_and_heatpump_power)
+        heatpump_power_ratio = heatpump_power.fdiv(house_and_heatpump_power)
+
+        house_power_grid = [rest * house_power_ratio, house_power].min
+        heatpump_power_grid = [rest * heatpump_power_ratio, heatpump_power].min
+      end
+
+      { house_power_grid:, wallbox_power_grid:, heatpump_power_grid: }
+    end
+  end
+end

lib/splitter/proportional.rb

@@ -0,0 +1,34 @@
+require 'splitter/base'
+
+module Splitter
+  class Proportional < Base
+    def call
+      house_power_grid = 0
+      wallbox_power_grid = 0
+      heatpump_power_grid = 0
+
+      if grid_import_power.positive? && total.positive?
+        house_power_ratio = house_power.fdiv(total)
+        wallbox_power_ratio = wallbox_power.fdiv(total)
+        heatpump_power_ratio = heatpump_power.fdiv(total)
+
+        house_power_grid = [
+          grid_import_power * house_power_ratio,
+          house_power,
+        ].min
+
+        wallbox_power_grid = [
+          grid_import_power * wallbox_power_ratio,
+          wallbox_power,
+        ].min
+
+        heatpump_power_grid = [
+          grid_import_power * heatpump_power_ratio,
+          heatpump_power,
+        ].min
+      end
+
+      { house_power_grid:, wallbox_power_grid:, heatpump_power_grid: }
+    end
+  end
+end

lib/splitter/ranked.rb

@@ -0,0 +1,29 @@
+require 'splitter/base'
+
+module Splitter
+  class Ranked < Base
+    def call
+      house_power_grid = 0
+      wallbox_power_grid = 0
+      heatpump_power_grid = 0
+
+      rest = grid_import_power
+
+      if rest.positive? && wallbox_power.positive?
+        wallbox_power_grid = [wallbox_power, grid_import_power].min
+        rest -= wallbox_power_grid
+      end
+
+      if rest.positive? && heatpump_power.positive?
+        heatpump_power_grid = [heatpump_power, rest].min
+        rest -= heatpump_power_grid
+      end
+
+      if rest.positive? && house_power.positive?
+        house_power_grid = [house_power, rest].min
+      end
+
+      { house_power_grid:, wallbox_power_grid:, heatpump_power_grid: }
+    end
+  end
+end

spec/lib/calculator_spec.rb renamed to spec/lib/processor_spec.rb

@@ -1,7 +1,7 @@
-require 'calculator'
+require 'processor'
 
-describe Calculator do
-  subject(:calculator) { described_class.new(day_records:, config:) }
+describe Processor do
+  subject(:processor) { described_class.new(day_records:, config:) }
 
   let(:config) { Config.new(ENV) }
 
@@ -25,7 +25,7 @@
   end
 
   describe '#call' do
-    subject(:call) { calculator.call }
+    subject(:call) { processor.call }
 
     it 'returns the correct result' do
       lines = call.map(&:to_line_protocol)
@@ -37,17 +37,4 @@
       )
     end
   end
-
-  describe '#split_power' do
-    subject(:split_power) { calculator.send(:split_power, day_records.first) }
-
-    it 'returns the correct result' do
-      expect(split_power).to include(
-        time: a_kind_of(Time),
-        house_power_grid: 50,
-        wallbox_power_grid: 30,
-        heatpump_power_grid: 20,
-      )
-    end
-  end
 end

spec/lib/splitter/mixed_spec.rb

@@ -0,0 +1,114 @@
+require 'splitter/mixed'
+
+describe Splitter::Mixed do
+  subject(:splitter) { described_class.new(**record) }
+
+  describe '#call' do
+    subject(:call) { splitter.call }
+
+    context 'when grid is 100%' do
+      let(:record) do
+        {
+          grid_import_power: 100,
+          house_power: 50,
+          heatpump_power: 20,
+          wallbox_power: 30,
+        }
+      end
+
+      it 'returns full distribution' do
+        expect(call).to eq(
+          {
+            house_power_grid: 50,
+            heatpump_power_grid: 20,
+            wallbox_power_grid: 30,
+          },
+        )
+      end
+    end
+
+    context 'when grid is more than 100%' do
+      let(:record) do
+        {
+          grid_import_power: 1000,
+          house_power: 50,
+          heatpump_power: 20,
+          wallbox_power: 30,
+        }
+      end
+
+      it 'returns full distribution limited to consumption' do
+        expect(call).to eq(
+          {
+            house_power_grid: 50,
+            heatpump_power_grid: 20,
+            wallbox_power_grid: 30,
+          },
+        )
+      end
+    end
+
+    context 'when grid is 0%' do
+      let(:record) do
+        {
+          grid_import_power: 0,
+          house_power: 100,
+          heatpump_power: 40,
+          wallbox_power: 60,
+        }
+      end
+
+      it 'returns 0 distribution' do
+        expect(call).to eq(
+          {
+            house_power_grid: 0,
+            heatpump_power_grid: 0,
+            wallbox_power_grid: 0,
+          },
+        )
+      end
+    end
+
+    context 'when grid is 30%' do
+      let(:record) do
+        {
+          grid_import_power: 60,
+          house_power: 100,
+          heatpump_power: 40,
+          wallbox_power: 60,
+        }
+      end
+
+      it 'returns wallbox-first distribution' do
+        expect(call).to eq(
+          {
+            house_power_grid: 0,
+            heatpump_power_grid: 0,
+            wallbox_power_grid: 60,
+          },
+        )
+      end
+    end
+
+    context 'when grid is 60%' do
+      let(:record) do
+        {
+          grid_import_power: 120,
+          house_power: 100,
+          heatpump_power: 40,
+          wallbox_power: 60,
+        }
+      end
+
+      it 'returns wallbox-first, then others pro-rata' do
+        expect(call).to eq(
+          {
+            house_power_grid: 42.85714285714286,
+            heatpump_power_grid: 17.142857142857142,
+            wallbox_power_grid: 60,
+          },
+        )
+      end
+    end
+  end
+end