sie 2.1.0 → 2.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTZiMGU5Y2JlZWE3MjJkMDIxZGQ1NzQwNjlmZDRmZDk1YTYxMTk5Ng==
+    OTRlMWFiNTRkMmRjZDllMmY2MWYzYjFiMWYxZWI1MTNjNDNhODZkYw==
   data.tar.gz: !binary |-
-    MTQzMTQ5ZTliZTc5NzA5ZGE5MWViNThkZjE1OTgwMGFkNTI3ODg5Nw==
+    MzliZThiOGNhNjZmODMyNzVkNTJhZWY0NzYzOTRjMGIyMjFkYTM1Zg==
 SHA512:
   metadata.gz: !binary |-
-    NzRiMTUwZTEyMzhmOTE4YTE2ZGU0Zjg0ZTk1Mzc5MTM0MTI0YjNhODVmMGRm
-    ZTY2ZDFjZjFlM2YxZmQ4NGZkODIzZjhmNTRlNTY2NmMwZmE4NGVlNGM3Nzk0
-    MTYxNGRiNjRkZjE2ZWI4NzJhMTllOGNmMWVmYWRiMWFhYTZjZmI=
+    ODJiZjc3ZDI5YWFiN2YxZTg0NTEwMTNjYjVjZDI4NjhlYWJhOGM4YzUyZjNi
+    Y2QxMDA2YmI4MjFiMDU3OWFhMjE5NmNjZTM2ZTRjYTdlMzFiOTA5OTcyNmQ4
+    ODdmNDAwYjZmNDRmZmM2NjY4ZDFhYzI0NTEwZDcyYTFkYmVkNzM=
   data.tar.gz: !binary |-
-    MmExNTViM2VkY2M1OGExZmM4YjcwNzFhOTliNTQ1OWY5M2IzZjI0NzRlNjUx
-    YTdhZmNlNTlkYTI5OWFhNjNlZjIyYWRjMjhkZGMzNDkxZjc3MGM2MTMzMDdm
-    YWU2OWIwYTkwOGQ5NDU2NDc5N2Y1MDU0ZWY3ZGExMTBiYmZmYTg=
+    MzBlMzIzZTAyMGVkYTE1YWYyM2E4MDQ1NjM0MjMyMmU1Yjg3NGQ5MzBiMjFj
+    ZGJlMDY1MjhhZGJiZTQ4NTRmNzg0OTFkMGNmMjA5MTlmMjdmOGU0N2M1NzMz
+    NjI5ZjFjYzBhMTg5YzFlMTVmMjg1MGM0ZWY5YjQzZDIxODNkN2Q=

data/README.md

@@ -124,6 +124,12 @@ File.open("path/to/file.se") do |f|
 end
 ```
 
+By default the parser will raise an error if it encounters unknown entry types. Use the `lenient` option to avoid this:
+
+```ruby
+parser = Sie::Parser.new(lenient: true)
+```
+
 For more info, see the specs.
 
 ## Developing
@@ -144,9 +150,10 @@ Getting the latest code and gems:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Try to be consistent with the local code style. `[ foo ]` not `[foo]`, double quotes not single quotes, small and well named methods, etc.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
 
 ## Credits and license
 

data/lib/sie/document.rb

@@ -5,10 +5,11 @@ require "active_support/core_ext/module/delegation"
 
 module Sie
   class Document
-    pattr_initialize :data_source
     # Because fortnox imposes these limits
     DESCRIPTION_LENGTH_MAX = 30
 
+    pattr_initialize :data_source
+
     def render
       add_header
       add_financial_years

data/lib/sie/parser.rb

@@ -9,6 +9,12 @@ module Sie
     END_OF_ARRAY       = "}"
     ENTRY              = /^#/
 
+    attr_private :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
     def parse(io)
       stack = []
       sie_file = SieFile.new
@@ -34,7 +40,13 @@ module Sie
     private
 
     def parse_line(line)
-      LineParser.new(line).parse
+      LineParser.new(line, lenient: lenient).parse
+    rescue BuildEntry::InvalidEntryError => ex
+      raise ex, "#{ex.message}. Pass 'lenient: true' to Parser.new to avoid this exception."
+    end
+
+    def lenient
+      options.fetch(:lenient, false)
     end
   end
 end

data/lib/sie/parser/build_entry.rb

@@ -0,0 +1,57 @@
+module Sie
+  class Parser
+    class BuildEntry
+      method_object :line, :first_token, :tokens, :lenient
+
+      InvalidEntryError = Class.new(StandardError)
+
+      def call
+        if first_token.known_entry_type?
+          build_complete_entry
+        elsif lenient
+          build_empty_entry
+        else
+          raise_invalid_entry_error
+        end
+      end
+
+      private
+
+      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
+
+          if entry_type.is_a?(Hash)
+            skip_array(tokens, i)
+            next
+          else
+            label = entry_type
+            entry.attributes[label] = tokens[i].value
+          end
+        end
+
+        entry
+      end
+
+      def build_empty_entry
+        Entry.new(first_token.label)
+      end
+
+      def raise_invalid_entry_error
+        raise InvalidEntryError, "Unknown entry type: #{first_token.label}"
+      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) }
+      end
+    end
+  end
+end

data/lib/sie/parser/line_parser.rb

@@ -1,32 +1,17 @@
 require "sie/parser/tokenizer"
 require "sie/parser/entry"
 require "sie/parser/sie_file"
+require "sie/parser/build_entry"
 
 module Sie
   class Parser
     class LineParser
-      pattr_initialize :line
+      pattr_initialize :line, [ :lenient ]
 
       def parse
         tokens = tokenize(line)
         first_token = tokens.shift
-
-        entry = Entry.new(first_token.label)
-        entry_type = first_token.entry_type
-
-        entry_type.each_with_index do |entry_type, i|
-          break if i >= tokens.size
-
-          if entry_type.is_a?(Hash)
-            skip_array(tokens, i)
-            next
-          else
-            label = entry_type
-            entry.attributes[label] = tokens[i].value
-          end
-        end
-
-        entry
+        build_entry(first_token, tokens)
       end
 
       private
@@ -35,13 +20,8 @@ module Sie
         Tokenizer.new(line).tokenize
       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 build_entry(first_token, tokens)
+        BuildEntry.call(line, first_token, tokens, lenient)
       end
     end
   end

data/lib/sie/parser/tokenizer/token.rb

@@ -10,6 +10,10 @@ module Sie
           @value = value
         end
 
+        def known_entry_type?
+          Sie::Parser::ENTRY_TYPES.has_key?(label)
+        end
+
         def entry_type
           Sie::Parser::ENTRY_TYPES.fetch(label)
         end

data/lib/sie/version.rb

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

data/spec/fixtures/sie_file_with_unknown_entries.se

@@ -0,0 +1,32 @@
+#FLAGGA 0
+#PROGRAM "fooconomic" "1.0"
+#FORMAT PC8
+#GEN 20130101
+#SIETYP 4
+#ORGNR 555555-5555
+#FNAMN "Foocorp"
+#ADRESS "Foocorp" "" "12345 City" "555-12345"
+#KONTO 1510 "Accounts receivable"
+#KTYP 1510 T
+#SRU 1510 204
+#KONTO 1930 "Bank account"
+#KTYP 1930 T
+#SRU 1930 200
+#KONTO 2440 Supplier
+#KTYP 2440 S
+#SRU 2440 300
+#KONTO 2610 "Utgaende moms, oreducerad "
+#KTYP 2610 S
+#SRU 2610 7369
+#MOMSKOD 2610 10
+#VER A 1 20130101 "Invoice" 20120105
+{
+   #TRANS 1510 {} -200 20130101 "Coffee machine"
+   #TRANS 4100 {} 180 20130101 "Coffee machine"
+   #TRANS 2611 {} -20 20130101 "VAT"
+}
+#VER A 2 20130102 "Payment" 20120105
+{
+   #TRANS 1510 {} -200 20130101 "Payment: Coffee machine"
+   #TRANS 1970 {} 200 20130101 "Payment: Coffee machine"
+}

data/spec/integration/parser_spec.rb

@@ -18,7 +18,39 @@ describe Sie::Parser do
     end
   end
 
-  def open_file(fixture_file)
-    File.open(File.join(File.dirname(__FILE__), "../#{fixture_file}"))
+  context "with unknown entries" do
+    let(:file_with_unknown_entries) { "fixtures/sie_file_with_unknown_entries.se" }
+
+    context "using a lenient parser" do
+      let(:parser) { Sie::Parser.new(lenient: true) }
+
+      it "handles unknown entries without raising error" do
+        open_file(file_with_unknown_entries) do |f|
+          expect { parser.parse(f) }.not_to raise_error
+        end
+      end
+
+      it "continues to parse the complete file after unknown entries" do
+        open_file(file_with_unknown_entries) do |f|
+          sie_file = parser.parse(f)
+
+          expect(sie_file.entries_with_label("ver").size).to eq(2)
+        end
+      end
+    end
+
+    context "with strict parser" do
+      let(:parser) { Sie::Parser.new }
+
+      it "raises error when encountering unknown entries" do
+        open_file(file_with_unknown_entries) do |f|
+          expect { parser.parse(f) }.to raise_error(/Unknown entry type: momskod.+Pass 'lenient: true'/)
+        end
+      end
+    end
+  end
+
+  def open_file(fixture_file, &block)
+    File.open(File.join(File.dirname(__FILE__), "../#{fixture_file}"), &block)
   end
 end

data/spec/unit/parser/line_parser_spec.rb

@@ -14,6 +14,26 @@ describe Sie::Parser::LineParser, "parse" do
     })
   end
 
+  context "with unknown entry" do
+    let(:line) { "#MOMSKOD 2611 10"}
+
+    context "using a lenient parser" do
+      let(:parser) { Sie::Parser::LineParser.new(line, lenient: true) }
+
+      it "raises no error when encountering unknown entries" do
+        expect { parser.parse }.not_to raise_error
+      end
+    end
+
+    context "using a strict parser" do
+      let(:parser) { Sie::Parser::LineParser.new(line) }
+
+      it "raises error when encountering unknown entries" do
+        expect { parser.parse }.to raise_error(/Unknown entry type/)
+      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/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sie
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Barsoom AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_extras
@@ -99,6 +99,7 @@ files:
 - lib/sie/document/renderer.rb
 - lib/sie/document/voucher_series.rb
 - lib/sie/parser.rb
+- lib/sie/parser/build_entry.rb
 - lib/sie/parser/entry.rb
 - lib/sie/parser/entry_types.rb
 - lib/sie/parser/line_parser.rb
@@ -113,6 +114,7 @@ files:
 - script/turbux_rspec
 - sie.gemspec
 - spec/fixtures/sie_file.se
+- spec/fixtures/sie_file_with_unknown_entries.se
 - spec/integration/parser_spec.rb
 - spec/spec_helper.rb
 - spec/unit/document/renderer_spec.rb
@@ -147,6 +149,7 @@ specification_version: 4
 summary: Parses and generates SIE files (http://sie.se/)
 test_files:
 - spec/fixtures/sie_file.se
+- spec/fixtures/sie_file_with_unknown_entries.se
 - spec/integration/parser_spec.rb
 - spec/spec_helper.rb
 - spec/unit/document/renderer_spec.rb