hledger-forecast 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7bd2190c7f86b3d6a1fe76583a8f7e959f4429719b9903de343d25e0bf3b51
-  data.tar.gz: 7bb59da35fc2f9f3c47b6ed8b45d2ef38fb9c5c084c6bce9d6ee66fd004157a8
+  metadata.gz: efe6bca69db97f1f08539e609f7f6db6af22d40c5cf514dce6e543fbc34cd442
+  data.tar.gz: 21ccaeb1bbfd846e5cf7afc3da4ffa17a9064a851380ed17b09d4efeb517d197
 SHA512:
-  metadata.gz: 3251f466cd2072685cf063268aca5c9ddc6231e9ac5c217049369c3e6b1c1d729967059441d4318247b7477ebaf357dc317e4f40df6b8e44dbe59a14b5005b9a
-  data.tar.gz: 55251b35a8cfea885fbbcb861ad650635a0fed4c91e618942ddd4eb76c38b9d3826d1b35e9078c1fae9c2ea96aa311cef750cc37fd88d5e4aed75ecb5c6db21f
+  metadata.gz: ede280944f144b0b055068d5f8e919ab48f2534299dbbd2ff51c599ce1f57a7a1cb7ea72474e0d08a6f3ec27ab17b9ba06ebfe8de7319d7a87d9815648297ffa
+  data.tar.gz: 1d19fdf61f57e622e734797ce304d4b0337d5942b27aaefcb90965593ecf0a769d811f457ea5424a4eb22e989d6babd562d1cf15f2a556edf103a2430301fb3c

data/README.md

@@ -73,16 +73,17 @@ Let's examine what's going on in this config file:
 
 - Firstly, we're telling the app to create two monthly transactions and repeat them, forever, starting from March 2023. In this case, forever will be the `end_date` specified when running the app
 - If you ran the app with `hledger-forecast -s 2023-04-01` then no transactions would be generated for March as the start date is greater than the periodic start date
-- Notice we're also using [virtual postings](https://hledger.org/1.29/hledger.html#virtual-postings) (designated by the brackets) to be explicit to Hledger. This also makes it easy to filter them out with the `-R` or `--real` option in Hledger
+- Notice we're also using [virtual postings](https://hledger.org/1.29/hledger.html#virtual-postings) (designated by the brackets). This makes it easy to filter them out with the `-R` or `--real` option in Hledger
 - We also have not specified a currency; the default (`USD`) will be used
 
 ### Extending the config file
 
 #### Periods
 
-If you'd like to add quarterly, yearly or one-off transactions, use the following keys:
+If you'd like to add quarterly, half-yearly, yearly or one-off transactions, use the following keys:
 
 - `quarterly`
+- `half-yearly`
 - `yearly`
 - `once`
 

data/example.yml

@@ -17,6 +17,14 @@ quarterly:
         category: "[Income:Bonus]"
         description: Bonus
 
+half-yearly:
+  - account: "[Assets:Bank]"
+    date: "2023-04-01"
+    transactions:
+      - amount: 500
+        category: "[Expenses:Holiday]"
+        description: Holiday
+
 yearly:
   - account: "[Assets:Bank]"
     date: "2023-04-01"

data/lib/hledger_forecast/generator.rb

@@ -48,6 +48,8 @@ module HledgerForecast
                          date.day == start_date.day
                        when 'quarterly'
                          date.day == start_date.day && date.month % 3 == start_date.month % 3
+                       when 'half-yearly'
+                         date.day == start_date.day && (date.month - start_date.month) % 6 == 0
                        when 'yearly'
                          date.day == start_date.day && date.month == start_date.month
                        when 'once'
@@ -81,6 +83,7 @@ module HledgerForecast
       while date <= end_date
         process_forecast(output, forecast_data, 'monthly', date)
         process_forecast(output, forecast_data, 'quarterly', date)
+        process_forecast(output, forecast_data, 'half-yearly', date)
         process_forecast(output, forecast_data, 'yearly', date)
         process_forecast(output, forecast_data, 'once', date)
 

data/lib/hledger_forecast/version.rb

@@ -1,3 +1,3 @@
 module HledgerForecast
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/half-yearly_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/hledger_forecast'
+
+RSpec.describe 'generate' do
+  it 'generates a forecast with correct HALF-YEARLY transactions' do
+    transactions = File.read('spec/stubs/transactions.journal')
+    forecast = File.read('spec/stubs/half-yearly/forecast_half-yearly.yml')
+
+    generated_journal = HledgerForecast::Generator.create_journal_entries(transactions, forecast, '2023-03-01', '2024-04-30')
+
+    expected_output = File.read('spec/stubs/half-yearly/output_half-yearly.journal')
+    expect(generated_journal).to eq(expected_output)
+  end
+end

data/spec/stubs/half-yearly/forecast_half-yearly.yml

@@ -0,0 +1,10 @@
+settings:
+  currency: GBP
+
+half-yearly:
+  - start: "2023-04-01"
+    account: "[Assets:Bank]"
+    transactions:
+      - description: Holiday
+        category: "[Expenses:Holiday]"
+        amount: 500

data/spec/stubs/half-yearly/output_half-yearly.journal

@@ -0,0 +1,20 @@
+2023-02-01 * Opening balance
+    Assets:Bank                             £1,000.00
+    Equity:Opening balance
+
+2023-02-05 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-04-01 * Holiday
+    [Expenses:Holiday]                £500.00
+    [Assets:Bank]
+
+2023-10-01 * Holiday
+    [Expenses:Holiday]                £500.00
+    [Assets:Bank]
+
+2024-04-01 * Holiday
+    [Expenses:Holiday]                £500.00
+    [Assets:Bank]
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Oli Morris
@@ -75,9 +75,12 @@ files:
 - lib/hledger_forecast/options.rb
 - lib/hledger_forecast/version.rb
 - spec/command_spec.rb
+- spec/half-yearly_spec.rb
 - spec/monthly_spec.rb
 - spec/once_spec.rb
 - spec/quarterly_spec.rb
+- spec/stubs/half-yearly/forecast_half-yearly.yml
+- spec/stubs/half-yearly/output_half-yearly.journal
 - spec/stubs/monthly/forecast_monthly.yml
 - spec/stubs/monthly/forecast_monthly_enddate.yml
 - spec/stubs/monthly/forecast_monthly_enddate_top.yml
@@ -119,9 +122,12 @@ specification_version: 4
 summary: Utility to generate forecasts in Hledger
 test_files:
 - spec/command_spec.rb
+- spec/half-yearly_spec.rb
 - spec/monthly_spec.rb
 - spec/once_spec.rb
 - spec/quarterly_spec.rb
+- spec/stubs/half-yearly/forecast_half-yearly.yml
+- spec/stubs/half-yearly/output_half-yearly.journal
 - spec/stubs/monthly/forecast_monthly.yml
 - spec/stubs/monthly/forecast_monthly_enddate.yml
 - spec/stubs/monthly/forecast_monthly_enddate_top.yml