sie 2.2.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTRlMWFiNTRkMmRjZDllMmY2MWYzYjFiMWYxZWI1MTNjNDNhODZkYw==
+    YTQzMmU0NGU3NmVhMDY1OWM0OWJmZWMxY2I3M2IyZDJjZTVmMDRiYQ==
   data.tar.gz: !binary |-
-    MzliZThiOGNhNjZmODMyNzVkNTJhZWY0NzYzOTRjMGIyMjFkYTM1Zg==
+    MWNlN2E5OWE3ZGRmZmZkNmRiZmI0MGVkNGZmMThlMDI3M2EwZjE3Yw==
 SHA512:
   metadata.gz: !binary |-
-    ODJiZjc3ZDI5YWFiN2YxZTg0NTEwMTNjYjVjZDI4NjhlYWJhOGM4YzUyZjNi
-    Y2QxMDA2YmI4MjFiMDU3OWFhMjE5NmNjZTM2ZTRjYTdlMzFiOTA5OTcyNmQ4
-    ODdmNDAwYjZmNDRmZmM2NjY4ZDFhYzI0NTEwZDcyYTFkYmVkNzM=
+    NGY1ZTViZWQyNGUwMzVkNjhlMDI3ZTk4NDYyODg2MjZjYTY2M2Y5YzI0NzI1
+    NTNhODYzZmEwMWQ1ZjExYmU3YTVlMzNmMzAxNDNkNTkzOWQzMThjNGY1OTE2
+    YzQxM2Y1ZGJhZWQ5ZDhiMzljZDk4OWQ0MmVjYjliM2RjYWE0ZGQ=
   data.tar.gz: !binary |-
-    MzBlMzIzZTAyMGVkYTE1YWYyM2E4MDQ1NjM0MjMyMmU1Yjg3NGQ5MzBiMjFj
-    ZGJlMDY1MjhhZGJiZTQ4NTRmNzg0OTFkMGNmMjA5MTlmMjdmOGU0N2M1NzMz
-    NjI5ZjFjYzBhMTg5YzFlMTVmMjg1MGM0ZWY5YjQzZDIxODNkN2Q=
+    MTUyMjk5NmMwYzZkZTEyZmU5YTM3MGMwYWQ5YzQ5YzQ1OGFmODU5MmY2ODI5
+    NmVkNTE4ZjcwNDU4YjRjZmVkNTk3MDA3ZWYyOTY0NmEyMmE0OWI1NWQxMTMz
+    NWU3YjhlNWEwMDY5OTNlNzQzYWU3ODYzZjdlN2NhNzY1YzVhOGQ=

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
+  - 2.2.1
   - 2.0.0
-  - 1.9.3

data/README.md

@@ -64,6 +64,18 @@ class YourDataSource
     [ 3100 ]
   end
 
+  def dimensions
+    [
+      {
+        number: 6,
+        description: "Projekt",
+        objects: [
+          { number: 1, description: "Education" }
+        ]
+      }
+    ]
+  end
+
   # Used to calculate balance before (and on) the given date for an account.
   def balance_before(account_number, date)
     # ActiveRecord example:
@@ -90,7 +102,8 @@ class YourDataSource
           },
           {
             account_number: 3100, amount: -512.0,
-            booked_on: Date.today, description: "Item 1"
+            booked_on: Date.today, description: "Item 1",
+            dimensions: { 6 => 1 }
           },
         ]
       }

data/lib/sie/document.rb

@@ -14,6 +14,7 @@ module Sie
       add_header
       add_financial_years
       add_accounts
+      add_dimensions
       add_balances
       add_vouchers
 
@@ -24,7 +25,7 @@ module Sie
 
     delegate :program, :program_version, :generated_on, :company_name,
       :accounts, :balance_account_numbers, :closing_account_numbers,
-      :balance_before, :each_voucher,
+      :balance_before, :each_voucher, :dimensions,
       to: :data_source
 
     def add_header
@@ -66,6 +67,20 @@ module Sie
       end
     end
 
+    def add_dimensions
+      dimensions.each do |dimension|
+        dimension_number = dimension.fetch(:number)
+        dimension_description = dimension.fetch(:description)
+        add_line("DIM", dimension_number, dimension_description)
+
+        dimension.fetch(:objects).each do |object|
+          object_number = object.fetch(:number)
+          object_description = object.fetch(:description)
+          add_line("OBJEKT", dimension_number, object_number, object_description)
+        end
+      end
+    end
+
     def add_vouchers
       each_voucher do |voucher|
         add_voucher(voucher)
@@ -90,17 +105,18 @@ module Sie
           account_number = line.fetch(:account_number)
           amount         = line.fetch(:amount)
           booked_on      = line.fetch(:booked_on)
+          dimensions     = line.fetch(:dimensions, {}).flatten
           # Some SIE-importers (fortnox) cannot handle descriptions longer than 30 characters,
           # but the specification has no limit.
           description    = line.fetch(:description).slice(0, DESCRIPTION_LENGTH_MAX)
 
-          add_line("TRANS", account_number, Renderer::EMPTY_ARRAY, amount, booked_on, description)
+          add_line("TRANS", account_number, dimensions, amount, booked_on, description)
 
           # Some consumers of SIE cannot handle single voucher lines (fortnox), so add another empty one to make
           # it balance. The spec just requires the sum of lines to be 0, so single lines with zero amount would conform,
           # but break for these implementations.
           if voucher_lines.size < 2 && amount.zero?
-            add_line("TRANS", account_number, Renderer::EMPTY_ARRAY, amount, booked_on, description)
+            add_line("TRANS", account_number, dimensions, amount, booked_on, description)
           end
         end
       end

data/lib/sie/document/renderer.rb

@@ -1,7 +1,6 @@
 require "stringio"
 
 class Sie::Document::Renderer
-  EMPTY_ARRAY = :empty_array
   ENCODING = Encoding::CP437
 
   def initialize
@@ -44,8 +43,9 @@ class Sie::Document::Renderer
     case value
     when Date
       value.strftime("%Y%m%d")
-    when EMPTY_ARRAY
-      "{}"
+    when Array
+      subvalues = value.map { |subvalue| format_value(subvalue.to_s) }
+      "{#{subvalues.join(' ')}}"
     when Numeric
       value.to_s
     else

data/lib/sie/parser/build_entry.rb

@@ -19,38 +19,58 @@ module Sie
 
       def build_complete_entry
         entry = build_empty_entry
-        entry_type = first_token.entry_type
 
-        entry_type.each_with_index do |entry_type, i|
-          break if i >= tokens.size
+        attributes_with_tokens.each do |attr, *attr_tokens|
+          label = attr.is_a?(Hash) ? attr.fetch(:name) : attr
 
-          if entry_type.is_a?(Hash)
-            skip_array(tokens, i)
-            next
+          if attr_tokens.size == 1
+            entry.attributes[label] = attr_tokens.first
           else
-            label = entry_type
-            entry.attributes[label] = tokens[i].value
+            type = attr.fetch(:type)
+            values = attr_tokens.
+              each_slice(type.size).
+              map { |slice| Hash[type.zip(slice)] }
+
+            entry.attributes[label] = values
           end
         end
 
         entry
       end
 
+      def attributes_with_tokens
+        line_entry_type.map { |attr_entry_type|
+          token = tokens.shift
+          next unless token
+
+          if attr_entry_type.is_a?(String)
+            [ attr_entry_type, token.value ]
+          else
+            unless token.is_a?(Tokenizer::BeginArrayToken)
+              raise InvalidEntryError, "Unexpected token: #{token.inspect}"
+            end
+
+            hash_tokens = []
+            while token = tokens.shift
+              break if token.is_a?(Tokenizer::EndArrayToken)
+              hash_tokens << token.value
+            end
+
+            [ attr_entry_type, *hash_tokens ]
+          end
+        }.compact
+      end
+
       def build_empty_entry
         Entry.new(first_token.label)
       end
 
-      def raise_invalid_entry_error
-        raise InvalidEntryError, "Unknown entry type: #{first_token.label}"
+      def line_entry_type
+        first_token.entry_type
       end
 
-      def skip_array(tokens, i)
-        if tokens[i].is_a?(Tokenizer::BeginArrayToken) &&
-         !tokens[i+1].is_a?(Tokenizer::EndArrayToken)
-          raise "We currently don't support metadata within entries as we haven't had a need for it yet (the data between {} in #{line})."
-        end
-
-        tokens.reject! { |token| token.is_a?(Tokenizer::EndArrayToken) }
+      def raise_invalid_entry_error
+        raise InvalidEntryError, "Unknown entry type: #{first_token.label}"
       end
     end
   end

data/lib/sie/parser/tokenizer.rb

@@ -42,6 +42,7 @@ module Sie
       def consume_quoted_value
         if current_character.quote?
           @quoted = false
+          @consume = false
         else
           add_to_current_token current_character
         end

data/lib/sie/version.rb

@@ -1,4 +1,4 @@
 module Sie
   # For versioning see: http://semver.org/
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end

data/spec/unit/build_entry_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "sie/parser/build_entry"
+require "sie/parser/tokenizer"
+
+describe Sie::Parser::BuildEntry, "call" do
+  context "with an unexpected token at start of array" do
+    it "raises InvalidEntryError" do
+      line = '#TRANS 2400 [] -200 20130101 "Foocorp expense"'
+      tokens = Sie::Parser::Tokenizer.new(line).tokenize
+      first_token = tokens.shift
+      build_entry = Sie::Parser::BuildEntry.new(line, first_token, tokens, false)
+
+      expect { build_entry.call }.to raise_error(Sie::Parser::BuildEntry::InvalidEntryError)
+    end
+  end
+end

data/spec/unit/document_spec.rb

@@ -22,15 +22,35 @@ describe Sie::Document, "#render" do
       {
         creditor: false, type: :invoice, number: 1, booked_on: Date.new(2011, 9, 3), description: "Invoice 1",
         voucher_lines: [
-          { account_number: 1500, amount: 512.0, booked_on: Date.new(2011, 9, 3), description: "Item 1" },
-          { account_number: 3100, amount: -512.0, booked_on: Date.new(2011, 9, 3), description: "Item 1" },
+          {
+            account_number: 1500, amount: 512.0, booked_on: Date.new(2011, 9, 3), description: "Item 1",
+            dimensions: { 6 => 1 }
+          },
+          {
+            account_number: 3100, amount: -512.0, booked_on: Date.new(2011, 9, 3), description: "Item 1",
+            dimensions: { 6 => 1 }
+          },
         ]
       },
       {
         creditor: true, type: :payment, number: 2, booked_on: Date.new(2012, 8, 31), description: "Payout 1",
         voucher_lines: [
-          { account_number: 2400, amount: 256.0, booked_on: Date.new(2012, 8, 31), description: "Payout line 1" },
-          { account_number: 1970, amount: -256.0, booked_on: Date.new(2012, 8, 31), description: "Payout line 2" },
+          {
+            account_number: 2400, amount: 256.0, booked_on: Date.new(2012, 8, 31), description: "Payout line 1"
+          },
+          {
+            account_number: 1970, amount: -256.0, booked_on: Date.new(2012, 8, 31), description: "Payout line 2"
+          },
+        ]
+      }
+    ]
+  }
+  let(:dimensions) {
+    [
+      {
+        number: 6, description: "Project",
+        objects: [
+          { number: 1, description: "Education" }
         ]
       }
     ]
@@ -39,7 +59,7 @@ describe Sie::Document, "#render" do
   class TestDataSource
     attr_accessor :program, :program_version, :generated_on, :company_name,
       :accounts, :balance_account_numbers, :closing_account_numbers,
-      :vouchers, :financial_years
+      :vouchers, :financial_years, :dimensions
 
     # vouchers is not part of the expected interface so making it private.
     #
@@ -73,9 +93,10 @@ describe Sie::Document, "#render" do
       company_name: "Foocorp",
       financial_years: financial_years,
       balance_account_numbers: [ 1500, 2400 ],
-      closing_account_numbers: [ 3100 ]
+      closing_account_numbers: [ 3100 ],
+      dimensions: dimensions
     )
-    doc = Sie::Document.new(data_source)
+    Sie::Document.new(data_source)
   }
 
   let(:sie_file) { Sie::Parser.new.parse(doc.render) }
@@ -106,6 +127,14 @@ describe Sie::Document, "#render" do
     expect(indexed_entry_attributes("konto", 0)).to eq("kontonr" => "1500", "kontonamn" => "Customer ledger")
   end
 
+  it "has dimensions" do
+    expect(indexed_entry_attributes("dim", 0)).to eq("dimensionsnr" => "6", "namn" => "Project")
+  end
+
+  it "has objects" do
+    expect(indexed_entry_attributes("objekt", 0)).to eq("dimensionsnr" => "6", "objektnr" => "1", "objektnamn" => "Education")
+  end
+
   it "has balances brought forward (ingående balans)" do
     expect(indexed_entry_attributes("ib", 0)).to eq("arsnr" =>  "0", "konto" => "1500", "saldo" => "1600.0")
     expect(indexed_entry_attributes("ib", 1)).to eq("arsnr" =>  "0", "konto" => "2400", "saldo" => "2500.0")
@@ -137,11 +166,13 @@ describe Sie::Document, "#render" do
     )
     expect(indexed_voucher_entries(0)[0].attributes).to eq(
       "kontonr" => "1500", "belopp" =>  "512.0",
-      "transdat" => "20110903", "transtext" => "Item 1"
+      "transdat" => "20110903", "transtext" => "Item 1",
+      "objektlista" => [{"dimensionsnr" => "6", "objektnr" => "1"}]
     )
     expect(indexed_voucher_entries(0)[1].attributes).to eq(
       "kontonr" => "3100", "belopp" => "-512.0",
-      "transdat" => "20110903", "transtext" => "Item 1"
+      "transdat" => "20110903", "transtext" => "Item 1",
+      "objektlista" => [{"dimensionsnr" => "6", "objektnr" => "1"}]
     )
 
     expect(indexed_entry("ver", 1).attributes).to eq(
@@ -150,11 +181,13 @@ describe Sie::Document, "#render" do
     )
     expect(indexed_voucher_entries(1)[0].attributes).to eq(
       "kontonr" => "2400", "belopp" =>  "256.0",
-      "transdat" => "20120831", "transtext" => "Payout line 1"
+      "transdat" => "20120831", "transtext" => "Payout line 1",
+      "objektlista" => []
     )
     expect(indexed_voucher_entries(1)[1].attributes).to eq(
       "kontonr" => "1970", "belopp" => "-256.0",
-      "transdat" => "20120831", "transtext" => "Payout line 2"
+      "transdat" => "20120831", "transtext" => "Payout line 2",
+      "objektlista" => []
     )
   end
 

data/spec/unit/parser/line_parser_spec.rb

@@ -3,14 +3,15 @@ require "sie/parser/line_parser"
 
 describe Sie::Parser::LineParser, "parse" do
   it "parses lines from a sie file" do
-    parser = Sie::Parser::LineParser.new('#TRANS 2400 {} -200 20130101 "Foocorp expense"')
+    parser = Sie::Parser::LineParser.new('#TRANS 2400 {"3" "5"} -200 20130101 "Foocorp expense"')
     entry = parser.parse
     expect(entry.label).to eq("trans")
     expect(entry.attributes).to eq({
       "kontonr" => "2400",
       "belopp"  => "-200",
       "transdat" => "20130101",
-      "transtext" => "Foocorp expense"
+      "transtext" => "Foocorp expense",
+      "objektlista" => [{"dimensionsnr" => "3", "objektnr" => "5"}],
     })
   end
 
@@ -33,9 +34,4 @@ describe Sie::Parser::LineParser, "parse" do
       end
     end
   end
-
-  it "fails if you have non empty metadata arrays until there is a need to support that" do
-    parser = Sie::Parser::LineParser.new('#TRANS 2400 { 1 "2" } -200 20130101 "Foocorp expense"')
-    expect(-> { parser.parse }).to raise_error(/don't support metadata/)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sie
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Barsoom AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_extras
@@ -117,6 +117,7 @@ files:
 - spec/fixtures/sie_file_with_unknown_entries.se
 - spec/integration/parser_spec.rb
 - spec/spec_helper.rb
+- spec/unit/build_entry_spec.rb
 - spec/unit/document/renderer_spec.rb
 - spec/unit/document/voucher_series_spec.rb
 - spec/unit/document_spec.rb
@@ -152,6 +153,7 @@ test_files:
 - spec/fixtures/sie_file_with_unknown_entries.se
 - spec/integration/parser_spec.rb
 - spec/spec_helper.rb
+- spec/unit/build_entry_spec.rb
 - spec/unit/document/renderer_spec.rb
 - spec/unit/document/voucher_series_spec.rb
 - spec/unit/document_spec.rb