sie-analysis 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8c3bea047da8a3e357f6d85c04f744bf52efe6c0865a4f6b2c6d0b9bb2f2d2
-  data.tar.gz: 49c8590042f39f5c5d1bf2bc2d4278dd699bc9888ca0b2258fadce4afd99ef59
+  metadata.gz: 15ee746d937f73cb9a8be5d8ac35133cfaca53d919be9df549ae073b6ef623be
+  data.tar.gz: b12af56b12387792f0f68f40cb400c01e7f63b9c98b107359209225a1e7969fa
 SHA512:
-  metadata.gz: 1765646441433ec914ad70fdb0cfe936ebcdd0892e573d920fc1d9e1ad0dc9ab0f5b7183909f5f2c5e78efd429cfc563d5a67339e9d4e789bacad9046598ebf8
-  data.tar.gz: 8ad0b9860cbd8247082b05e27b795bd7b8436a7fd23a7f94753279e9fcd2d52a03ee854c2ae255163801a32a4ca61a4f9f7940bc6c4f0506771e1633ab2df419
+  metadata.gz: de5892b81dfad72c9d895cb1a831916750bf7a406099673f91519735778be9f41f418917fa996c086bf7d7d9711aec94c92c6f0128cf65b88d059d1ea06aa49c
+  data.tar.gz: 68bf1df9481362cbd6787317016d06373ebf4e2b8e13c508bec62eb1c176f603de1916912ac58548ac32cdfaeb70755374eaa0bb00213776bcd5383645d21897

data/README.md

@@ -11,7 +11,7 @@ Requires Ruby 3.2 or newer. From a local checkout, build and install the gem:
 
 ```sh
 gem build sie-analysis.gemspec
-gem install ./sie-analysis-1.0.0.gem
+gem install ./sie-analysis-1.1.0.gem
 ```
 
 Load an export and create an analyzer:
@@ -77,7 +77,15 @@ report[:income_statement][:groups].map { |group| group.slice(:code, :label, :amo
 
 Use `dimension: :cost_center` for cost centers. `account_movements` accepts the
 same dimensions, with `dimension_code: "ABC"` to select an object.
-`analysis.available_dimensions` lists the available symbols. The export must contain the relevant object balances;
+`analysis.available_dimensions` lists standard names as symbols and other dimensions
+as integers. Supported names are `:cost_center` (1), `:cost_bearer` (2), `:project` (6),
+`:employee` (7), `:customer` (8), `:supplier` (9), and `:invoice` (10).
+Any dimension can also be selected by its SIE number, for example `dimension: 20`.
+Declared dimensions and dimensions referenced in objects, balances, budgets or
+transactions are included, even without monthly balances.
+`document.dimensions` maps declared numbers to names, e.g. `{ 20 => "Department" }`;
+`document.vouchers.first.lines.first.objects` contains pairs such as `[[20, "A"]]`.
+The export must contain the relevant object balances;
 balance-sheet totals are omitted for dimension reports.
 
 ## Inspect the postings on an account

data/lib/sie_analysis/analysis.rb

@@ -15,7 +15,12 @@ module SieAnalysis
     CURRENCY = "SEK"
     DIMENSIONS = {
       cost_center: 1,
-      project: 6
+      cost_bearer: 2,
+      project: 6,
+      employee: 7,
+      customer: 8,
+      supplier: 9,
+      invoice: 10
     }.freeze
 
     # @param document [Parser::Parsed] a decoded and parsed SIE export
@@ -26,7 +31,7 @@ module SieAnalysis
     # Summarizes all calendar months touched by the inclusive date range.
     # @param from [Date] first date
     # @param to [Date] last date
-    # @param dimension [Symbol, nil] :project or :cost_center
+    # @param dimension [Symbol, Integer, nil] standard dimension name or SIE dimension number
     # @return [Hash] income statement, balance sheet, budget, monthly totals and notes
     def overview(from:, to:, dimension: nil)
       start_date, end_date = from, to
@@ -57,7 +62,7 @@ module SieAnalysis
     # @param month [String] YYYY-MM
     # @param group_code [String, nil] report group, e.g. "revenue"
     # @param account_number [Integer, nil] BAS account number
-    # @param dimension [Symbol, nil] :project or :cost_center
+    # @param dimension [Symbol, Integer, nil] standard dimension name or SIE dimension number
     # @param dimension_code [String, nil] object code; requires dimension
     # @return [Array<Hash>] account_number, account_name, movement and group/object fields
     def account_movements(month:, group_code: nil, account_number: nil, dimension: nil, dimension_code: nil)
@@ -111,12 +116,19 @@ module SieAnalysis
       end
     end
 
-    # @return [Array<Symbol>] supported dimensions with objects declared in the export
+    # Includes declared dimensions and dimensions referenced by objects, balances or vouchers.
+    # @return [Array<Symbol, Integer>] standard names and other SIE dimension numbers
     def available_dimensions
-      dims = []
-      dims << :cost_center if @parsed.objects.keys.any? { |dim, _code| dim == 1 }
-      dims << :project if @parsed.objects.keys.any? { |dim, _code| dim == 6 }
-      dims
+      numbers = @parsed.dimensions.keys + @parsed.objects.keys.map(&:first)
+      [@parsed.period_changes, @parsed.budgets].each do |periods|
+        periods.each_value do |rows|
+          numbers.concat(rows.keys.filter_map { |key| key[1] if key.is_a?(Array) })
+        end
+      end
+      @parsed.vouchers.each do |voucher|
+        voucher.lines.each { |line| numbers.concat(line.objects.map(&:first)) }
+      end
+      numbers.uniq.sort.map { |number| DIMENSIONS.key(number) || number }
     end
 
     private
@@ -200,11 +212,16 @@ module SieAnalysis
 
     def normalize_dimension(dimension)
       return if dimension.nil?
+      return DIMENSIONS.key(dimension) || dimension if dimension.is_a?(Integer) && dimension.positive?
       raise ArgumentError, "Unsupported dimension" unless DIMENSIONS.key?(dimension)
 
       dimension
     end
 
+    def dimension_number(dimension)
+      dimension.is_a?(Integer) ? dimension : DIMENSIONS.fetch(dimension)
+    end
+
     def normalize_year_month(value)
       text = value.to_s
       raise ArgumentError, "month must be YYYY-MM" unless text.match?(/\A\d{4}-\d{2}\z/)

data/lib/sie_analysis/budgets.rb

@@ -20,7 +20,7 @@ module SieAnalysis
 
     def budget_row(month, key, raw, dimension)
       account, dim, code = dimension_parts(key)
-      return unless dim == (dimension && Analysis::DIMENSIONS.fetch(dimension))
+      return unless dim == (dimension && dimension_number(dimension))
 
       group = Groups.for_account(account)
       return unless income_group?(group)

data/lib/sie_analysis/dimension_statements.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module SieAnalysis
-  # Cost-center / project income and account-row builders for Analysis.
+  # Income and account-row builders for any SIE dimension.
   module DimensionStatements
     private
 
     def dimension_income_groups(months, dimension)
-      dim_no = Analysis::DIMENSIONS.fetch(dimension)
+      dim_no = dimension_number(dimension)
       totals = accumulate_dimension_totals(months, dim_no)
       groups = dimension_group_rows(totals, dim_no)
       revenue = totals.values.sum { |values| values[:revenue] }
@@ -56,7 +56,7 @@ module SieAnalysis
     end
 
     def dimension_account_rows(month, dimension)
-      dim_no = Analysis::DIMENSIONS.fetch(dimension)
+      dim_no = dimension_number(dimension)
       rows = []
       (@parsed.period_changes[month] || {}).each do |key, raw|
         account, dim, code = dimension_parts(key)

data/lib/sie_analysis/parser.rb

@@ -7,13 +7,15 @@ module SieAnalysis
   class Parser
     Record = Data.define(:tag, :fields)
     Voucher = Data.define(:series, :number, :date, :description, :lines)
-    Line = Data.define(:account, :amount)
+    # Voucher line with [dimension number, object code] references.
+    Line = Data.define(:account, :amount, :objects)
 
     # Parsed ledger: monetary values are BigDecimal; voucher dates are Date.
     # Period keys are YYYYMM strings; object keys are [dimension number, code].
+    # Dimensions maps declared dimension numbers to their exported names.
     Parsed = Data.define(
       :accounts, :objects, :opening_balances, :closing_balances, :results, :period_changes,
-      :financial_years, :vouchers, :budgets, :sie_type
+      :financial_years, :vouchers, :budgets, :sie_type, :dimensions
     )
 
     # @param text [String] export text already decoded to UTF-8
@@ -28,6 +30,7 @@ module SieAnalysis
       @text = text.to_s
       @accounts = {}
       @objects = {}
+      @dimensions = {}
       @opening = Hash.new(BigDecimal("0"))
       @closing = Hash.new(BigDecimal("0"))
       @results = Hash.new(BigDecimal("0"))
@@ -50,7 +53,7 @@ module SieAnalysis
       Parsed.new(
         accounts: @accounts, objects: @objects, opening_balances: @opening, closing_balances: @closing,
         results: @results, period_changes: @periods, financial_years: @years, vouchers: @vouchers,
-        budgets: @budgets, sie_type: @sie_type
+        budgets: @budgets, sie_type: @sie_type, dimensions: @dimensions
       )
     rescue ParseError
       raise
@@ -79,6 +82,7 @@ module SieAnalysis
         @sie_type = Integer(record.fields.fetch(0))
       when "KONTO" then apply_account(record.fields)
       when "OBJEKT" then apply_object(record.fields)
+      when "DIM", "UNDERDIM" then apply_dimension(record.fields)
       when "RAR" then apply_year(record.fields)
       when "IB" then apply_balance!(@opening, record.fields)
       when "UB" then apply_balance!(@closing, record.fields)
@@ -102,6 +106,13 @@ module SieAnalysis
       @objects[[dim, code]] = name if dim && !code.empty?
     end
 
+    def apply_dimension(fields)
+      number = integer_field(fields[0])
+      raise ArgumentError unless number&.positive?
+
+      @dimensions[number] = unquote(fields.fetch(1))
+    end
+
     def apply_year(fields)
       year_no = integer_field(fields[0])
       first, last = sie_date(fields[1]), sie_date(fields[2])
@@ -189,7 +200,7 @@ module SieAnalysis
 
       raise ArgumentError if object_field.start_with?("{") && !valid_budget_objects?(object_field)
 
-      @current_voucher[:lines] << Line.new(account:, amount:)
+      @current_voucher[:lines] << Line.new(account:, amount:, objects: object_refs_from(object_field))
     end
 
     def finish_voucher!

data/lib/sie_analysis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SieAnalysis
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sie-analysis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Standout AB