Add code coverage

Author: saturnflyer

lib/sof/cycles/end_of.rb

@@ -27,7 +27,7 @@ def self.examples
       end
 
       def to_s
-        return dormant_to_s if dormant?
+        return dormant_to_s if parser.dormant? || from_date.nil?
 
         "#{volume}x by #{final_date.to_fs(:american)}"
       end
@@ -45,12 +45,18 @@ def last_completed(_ = nil) = from_date&.to_date
       #   Cycle.for("V1E18MF2020-01-09")
       #     .expiration_of(anchor: "2020-06-04".to_date)
       #   # => #<Date: 2021-06-30>
-      def expiration_of(_ = nil, anchor: nil) = final_date
+      def expiration_of(_ = nil, anchor: nil)
+        return nil if parser.dormant? || from_date.nil?
+        final_date
+      end
 
       # Is the supplied anchor date prior to the final date?
       #
       # @return [Boolean] true if the cycle is satisfied, false otherwise
-      def satisfied_by?(_ = nil, anchor: Date.current) = anchor <= final_date
+      def satisfied_by?(_ = nil, anchor: Date.current)
+        return false if parser.dormant? || from_date.nil?
+        anchor <= final_date
+      end
 
       # Calculates the final date of the cycle
       #
@@ -61,11 +67,14 @@ def satisfied_by?(_ = nil, anchor: Date.current) = anchor <= final_date
       # @example
       #   Cycle.for("V1E18MF2020-01-09").final_date
       #   # => #<Date: 2021-06-30>
-      def final_date(_ = nil) = time_span
-        .end_date(start_date - 1.send(period))
-        .end_of_month
+      def final_date(_ = nil)
+        return nil if parser.dormant? || from_date.nil?
+        time_span
+          .end_date(start_date - 1.send(period))
+          .end_of_month
+      end
 
-      def start_date(_ = nil) = from_date.to_date
+      def start_date(_ = nil) = from_date&.to_date
 
       private
 

lib/sof/cycles/volume_only.rb

@@ -12,7 +12,7 @@ class << self
         def handles?(sym) = sym.nil? || sym.to_s == "volume_only"
 
         def validate_period(period)
-          raise InvalidPeriod, <<~ERR.squish unless period.nil?
+          raise Cycle::InvalidPeriod, <<~ERR.squish unless period.nil?
             Invalid period value of '#{period}' provided. Valid periods are:
             #{valid_periods.join(", ")}
           ERR

spec/sof/cycles/dormant_spec.rb

@@ -49,6 +49,20 @@ module SOF
       end
     end
 
+    describe "#to_s" do
+      context "with a dormant Within cycle" do
+        it "returns the cycle string representation with (dormant) suffix" do
+          expect(within_cycle.to_s).to eq "2x within 180 days (dormant)"
+        end
+      end
+
+      context "with a dormant EndOf cycle" do
+        it "returns the cycle string representation with (dormant) suffix" do
+          expect(end_of_cycle.to_s).to eq "2x by the last day of the 17th subsequent month (dormant)"
+        end
+      end
+    end
+
     describe "#kind & #kind?" do
       it "returns the correct kind" do
         expect(within_cycle.kind).to eq(:dormant)

spec/sof/cycles/end_of_spec.rb

@@ -29,7 +29,7 @@ module SOF
       "2x by #{@end_date.to_fs(:american)}"
 
     context "when the cycle is dormant" do
-      before { allow(cycle).to receive(:dormant?).and_return(true) }
+      before { allow(cycle.parser).to receive(:dormant?).and_return(true) }
 
       it_behaves_like "#to_s returns",
         "2x by the last day of the 17th subsequent month"

spec/sof/cycles/volume_only_spec.rb

@@ -49,6 +49,18 @@ module SOF
       end
     end
 
+    describe ".validate_period" do
+      it "raises an error if a period is provided" do
+        expect {
+          described_class.validate_period("D")
+        }.to raise_error(Cycle::InvalidPeriod, /Invalid period value of 'D' provided/)
+      end
+
+      it "does not raise an error if period is nil" do
+        expect { described_class.validate_period(nil) }.not_to raise_error
+      end
+    end
+
     describe "#satisfied_by?(completed_dates, anchor:)" do
       context "when the completions--judged from the anchor--satisfy the cycle" do
         it "returns true" do

spec/sof/parser_spec.rb

@@ -49,6 +49,22 @@ module SOF
       end
     end
 
+    describe "#from_data" do
+      context "when notation has no from date" do
+        it "returns an empty hash" do
+          parser = described_class.new("V1L180D")
+          expect(parser.from_data).to eq({})
+        end
+      end
+
+      context "when notation has a from date" do
+        it "returns a hash with the from date" do
+          parser = described_class.new("V1W1MF2024-01-01")
+          expect(parser.from_data).to eq({from: "F2024-01-01"})
+        end
+      end
+    end
+
     describe "#valid?" do
       it "returns true if the notation is recognized" do
         aggregate_failures do

spec/sof/time_span_spec.rb

@@ -59,5 +59,49 @@ module SOF
         expect(span.end_date_of_period("2022-01-15".to_date)).to eq Date.parse("2022-03-31")
       end
     end
+
+    describe "#begin_date_of_period" do
+      it "for a quarter period returns the beginning of the quarter" do
+        span = described_class.for("1", "Q")
+        expect(span.begin_date_of_period("2022-02-15".to_date)).to eq Date.parse("2022-01-01")
+      end
+
+      it "for a week period returns the beginning of the week" do
+        span = described_class.for("1", "W")
+        # 2022-01-15 is a Saturday, beginning of week is Monday 2022-01-10
+        expect(span.begin_date_of_period("2022-01-15".to_date)).to eq Date.parse("2022-01-10")
+      end
+
+      it "for a day period returns the same date" do
+        span = described_class.for("1", "D")
+        expect(span.begin_date_of_period("2022-01-15".to_date)).to eq Date.parse("2022-01-15")
+      end
+    end
+
+    describe "#duration" do
+      it "for quarters returns the duration in months" do
+        span = described_class.for("2", "Q")
+        expect(span.duration).to eq 6.months
+      end
+    end
+
+    describe "#final_date" do
+      it "returns nil if there is no period" do
+        span = described_class.for("", "")
+        expect(span.final_date(Date.parse("2022-01-15"))).to be_nil
+      end
+
+      it "returns the end date for a valid period" do
+        span = described_class.for("3", "M")
+        expect(span.final_date(Date.parse("2022-01-15"))).to eq Date.parse("2022-04-15")
+      end
+    end
+
+    describe "#to_h" do
+      it "returns a hash with period and period_count" do
+        span = described_class.for("3", "M")
+        expect(span.to_h).to eq({period: :month, period_count: 3})
+      end
+    end
   end
 end