cremul-parser 0.9.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d083658a516a52adfa34bc6abaf9d04f2b6a99d
-  data.tar.gz: ee10da7935b25f234bf917902a6aaf559f4cd92b
+  metadata.gz: 73475b78efc88d6c6c8b91046683993923d2b12d
+  data.tar.gz: 37f2784f9535c093efce3e8730c575704784d1dd
 SHA512:
-  metadata.gz: 9cffc876591698f408a50864729be327c026690193ed67ff9ff205aae1b7489eef27eef84ad7a9e8075bc301ae7b7c9d76339b7080edb2f95159ab0227ab9f6a
-  data.tar.gz: 7380b7fbc17037d8b414720798a39bb27bc4e7eda9878cd337612cc25fab398018397186e3b9d17f921444bafda1cde4f087d0b4c48da206650d157b256063f1
+  metadata.gz: ff2d5e418c684a50fd9772d7779ad6a7d1f8e9b383bdeedc5f10212d67d47428de5da87b9a7df73f784aa81b6d1d9d06d6f9e31fb4d199e4868a4d5d90f04255
+  data.tar.gz: c21a9f65afbbf58ac1f5ac4ad16158bd1af4c417554583f2bc33cc875516ad263df5840bd35e8b76a36a580bc75f9bb1d6ceeeb35fde38cbf5c1c32977f47d88

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.0.0
+
+This library has been used successfully in production for a while now, so I decided it was ok to bump the
+version to 1.0.0. 
+
+- CremulParser.to_csv_file(csv_filename) : Converts a Cremul file to CSV.
+- CremulParser::get_file_hash_value(file) : Returns a unique MD5 hash value for a file
+- CremulParser.create_unique_tx_index(cremul_msg, cremul_msg_line, cremul_tx) : Creates a unique id for each TX in the file  
+
 ## 0.9.3
 
 Fixed an error related to logging when used in Rails.

data/cremul-parser.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Per Spilling"]
   gem.email         = ["per@perspilling.net"]
   gem.summary       = %q{A parser for CREMUL payment transaction files}
-  gem.description   = %q{A parser for CREMUL payment transaction files. It parses the CREMUL file and creates a Ruby object structure corresponding to the elements in the file.}
+  gem.description   = %q{A parser for CREMUL payment transaction files. It parses the CREMUL file and creates a Ruby
+object structure corresponding to the elements in the file. Also supports converting a CREMUL fil to a CSV file format.}
   gem.homepage      = "https://github.com/perspilling/cremul-parser"
   gem.license       = "MIT"
 

data/lib/cremul/cremul_name_and_address.rb

@@ -27,13 +27,18 @@ class CremulNameAndAddress
     @nad_lines = []
     if s.size <= 5 # structured form
       addr = s[s.size-1].split(':')
-      addr.size.times do |i|
-        @nad_lines << addr[i]
-      end
+      addr.each { |l| @nad_lines << l }
     else
       5.times do |i|
         @nad_lines << s[i+4]
       end
     end
   end
+
+  def to_csv
+    csv = ''
+    @nad_lines.each { |l| csv << l << ',' }
+    csv.chomp(',')
+  end
+
 end

data/lib/cremul/cremul_payment_tx.rb

@@ -46,6 +46,15 @@ class CremulPaymentTx
     init_name_and_addresses(segments, tx_segment_pos)
   end
 
+  def to_csv(decimal_separator)
+    if decimal_separator == ','
+      amount = @money.amount.to_s.gsub('.', ',')
+    else
+      amount = @money.amount.to_s
+    end
+    "#{@posting_date};#{amount};#{@money.currency};#{@payer_account_number};#{invoice_ref_type};#{invoice_ref};#{free_text};#{@payer_nad.to_csv}"
+  end
+
   private
 
   def init_free_text(segments, tx_segment_pos)

data/lib/cremul/version.rb

@@ -1,3 +1,3 @@
 module Cremul
-  VERSION = '0.9.3'
+  VERSION = '1.0.0'
 end

data/lib/cremul_parser.rb

@@ -70,6 +70,7 @@ class CremulParser
       end
       file_as_a_string += line.chomp # remove \n and \r from the end of the line
     end
+    @cremul_file_hash = CremulParser::get_file_hash_value(file)
     @segments = file_as_a_string.split("'")
     @segments.each { |s| s.strip! }
     # remove last segment if it is an empty string
@@ -91,5 +92,45 @@ class CremulParser
     end
   end
 
+  # Returns a unique hash value for the file. Can be used to check if the file has been read before.
+  def self.get_file_hash_value(file)
+    cremul_file_hash = Digest::MD5.hexdigest(file.read)
+    file.rewind
+    cremul_file_hash
+  end
+
+  # Writes the parsed Cremul-file to a CSV-file.
+  def to_csv_file(csv_filename, decimal_separator=',')
+    File.open(csv_filename, 'w') do |csv_file|
+      csv_file.puts 'tx_id;posting_date;amount;currency;payer_account_number;invoice_ref_type;invoice_ref;free_text;payer name and address'
+      @messages.each do |cremul_msg|
+        cremul_msg.lines.each do |cremul_msg_line|
+          cremul_msg_line.transactions.each do |cremul_tx|
+            tx_index = create_unique_tx_index(cremul_msg, cremul_msg_line, cremul_tx)
+            csv_file.puts to_csv(tx_index, cremul_tx, decimal_separator)
+          end
+        end
+      end
+    end
+
+  end
+
+  # Creates a unique id for each TX in the file
+  def create_unique_tx_index(cremul_msg, cremul_msg_line, cremul_tx)
+    file_hash = @cremul_file_hash[0, 8].force_encoding('utf-8')
+    "#{file_hash}:msg#{cremul_msg.message_index}:line#{cremul_msg_line.line_index}:tx#{cremul_tx.tx_index}"
+  end
+
+  private
+
+  def tx_id(cremul_msg, cremul_msg_line, cremul_tx)
+    "M#{cremul_msg.message_index}.L#{cremul_msg_line.line_index}.TX#{cremul_tx.tx_index}"
+  end
+
+
+  def to_csv(tx_id, cremul_tx, decimal_separator)
+    "#{tx_id};" + cremul_tx.to_csv(decimal_separator)
+  end
+
 end
 

data/test/unit/parser_test.rb

@@ -160,6 +160,8 @@ describe CremulParser do
 
     it 'should convert a non-utf-8 file to utf-8 on the fly' do
       @parser.parse(File.open('files/CREMUL0001.dat'), 'ISO-8859-1')
+      # @parser.parse(File.open('files/20150121_0925_02IB1__CREMUL.Dat'), 'ISO-8859-1')
+      # @parser.parse(File.open('files/20150302_0853_02IB1__CREMUL.DAT'), 'ISO-8859-1')
       @parser.segments.must_be_instance_of Array
       @parser.messages[0].must_be_instance_of CremulMessage
 
@@ -199,32 +201,9 @@ describe CremulParser do
       msg.lines[0].transactions[0].payer_account_number.must_be_nil
     end
 
-
-    # ----------------------------------------------------------------------
-    # the following tests are commented out as the corresponding cremul test file is not included in the Git repo
-    # ----------------------------------------------------------------------
-
-
-=begin
-    it 'should parse a long file with multiple payment transactions' do
-      @parser.parse(File.open('files/CREMUL0002_23-05-14.dat'), 'ISO-8859-1')
-      @parser.segments.must_be_instance_of Array
-      @parser.messages[0].must_be_instance_of CremulMessage
-
-      msg = @parser.messages[0]
-
-      froland_tx = msg.lines[1].transactions[1]
-      froland_tx.must_be_instance_of CremulPaymentTx
-      froland_tx.free_text.must_include 'kr 3.384.686,- Fradrag kr.106:.408,- Beregn.g.lag kr.3.278.2          78,-'
-
-      braekstad_tx = msg.lines[2].transactions[0]
-      braekstad_tx.invoice_ref.must_equal '20140453869'
-    end
-=end
-
-
     it 'should parse a multi-message file' do
-      @parser.parse(File.open('files/CREMUL_multi_message.dat'), 'ISO-8859-1')
+      filename = 'files/CREMUL_multi_message.dat'
+      @parser.parse(File.open(filename), 'ISO-8859-1')
       @parser.segments.must_be_instance_of Array
       @parser.messages.size.must_equal 3
       @parser.messages[0].must_be_instance_of CremulMessage
@@ -232,6 +211,25 @@ describe CremulParser do
       #write_segments_to_file(@parser.segments, File.open('files/CREMUL_multi_message_segments.txt', 'w'))
     end
 
+    it 'should print the Cremul-file to a CSV-file' do
+      # filename = 'files/2016/Trello91_CREMUL'
+      filename = 'files/CREMUL0003'
+      @parser.parse(File.open(filename + '.DAT'), 'ISO-8859-1')
+      @parser.to_csv_file(filename + '.csv')
+    end
+
+    it 'should pretty-print the file' do
+      # filename = 'files/20150302_0853_02IB1__CREMUL'
+      # filename = 'files/20150121_0925_02IB1__CREMUL'
+      # filename = 'files/20150413_0746_02IB1__CREMUL'
+      # filename = 'files/CREMUL_16-12-15'
+      # filename = 'files/2016/cremul'
+      # filename = 'files/2016/Trello91_CREMUL'
+      filename = 'files/CREMUL_multi_message'
+      @parser.parse(File.open(filename + '.DAT'), 'ISO-8859-1')
+      write_segments_to_file(@parser.segments, File.open(filename + '.txt', 'w'))
+    end
+
     def write_segments_to_file(msg, file)
       begin
         msg.each { |segment| file.puts segment }
@@ -240,6 +238,25 @@ describe CremulParser do
       end
     end
 
+    # ----------------------------------------------------------------------
+    # the following tests are commented out as the corresponding cremul test file is not included in the Git repo
+    # ----------------------------------------------------------------------
+
+    # it 'should parse a long file with multiple payment transactions' do
+    #   @parser.parse(File.open('files/CREMUL0002_23-05-14.dat'), 'ISO-8859-1')
+    #   @parser.segments.must_be_instance_of Array
+    #   @parser.messages[0].must_be_instance_of CremulMessage
+    #
+    #   msg = @parser.messages[0]
+    #
+    #   froland_tx = msg.lines[1].transactions[1]
+    #   froland_tx.must_be_instance_of CremulPaymentTx
+    #   froland_tx.free_text.must_include 'kr 3.384.686,- Fradrag kr.106:.408,- Beregn.g.lag kr.3.278.2          78,-'
+    #
+    #   braekstad_tx = msg.lines[2].transactions[0]
+    #   braekstad_tx.invoice_ref.must_equal '20140453869'
+    # end
+
 
     # ----------------------------------------------------------------------
     # Some tests to handle file format errors (?) that we have encountered

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cremul-parser
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Per Spilling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: A parser for CREMUL payment transaction files. It parses the CREMUL file
-  and creates a Ruby object structure corresponding to the elements in the file.
+description: |-
+  A parser for CREMUL payment transaction files. It parses the CREMUL file and creates a Ruby
+  object structure corresponding to the elements in the file. Also supports converting a CREMUL fil to a CSV file format.
 email:
 - per@perspilling.net
 executables: []