rightmove_blm 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3397a4adccadcad8a3879a3590cd6b18ac9c563534a2b70804731402e71a3a5
-  data.tar.gz: 78b3e9830e9b4959b73016b8f792389c9d04a3aac90a784da349341577c8f214
+  metadata.gz: adcdd9888460d3dde61600d67eb0a610fbbb971b268220a54d1eb10e66198ac2
+  data.tar.gz: ed1f65811a5f46e3462891e16db3b9e90a632fc2d7c7466c4d34983c72bfc3cd
 SHA512:
-  metadata.gz: 813c20806d366937146dd7e208284a1c2551963f126fe826172c172b483d0927b8c9c8cd954e9e7c9eaae670cb9218c8380b9034dccf6a39b25efbc184d1eb28
-  data.tar.gz: 4a525eaf7a4d0d64f432bacb44138a5ce1f68108c03fd57c9133a7dda7f3aea4ac9423109986894ed92ce46685df8601b47da0280285608bff99d5068a5a5a5e
+  metadata.gz: e1777617db9d0efacdfbecc1ba3a07302c76f7e1f5a519847e08e33b4c05c6ec9b4cb3973ae235a8ba4c6e7a04db5657fb21b51ace24c2e1b8b6017c8b2a0e86
+  data.tar.gz: 73698ab1fb45cdaa69d8628cea64c0ae79595da5803d8c71dc339453047e0058027d4faba928468f432b40bd05c2de50c908c66c832c27c2f5e0c224b93425db

data/README.md

@@ -18,6 +18,14 @@ Load a BLM file by passing the `source` parameter to `RightmoveBLM::Document.new
 blm = RightmoveBLM::Document.new(source: File.read('example_data.blm'))
 ```
 
+`RightmoveBLM::Document.new` also receives an optional argument `name` which is recommended for all documents to assist in tracking errors when processing many documents, e.g.:
+
+```ruby
+blm = RightmoveBLM::Document.new(source: File.read('example_data.blm'), name: 'example_data.blm')
+```
+
+This name will be included in all parser error messages.
+
 The returned `RightmoveBLM::Document` instance implements:
 
 * `#header` - the header containing information about the document's structure.

data/lib/rightmove_blm/document.rb

@@ -2,22 +2,29 @@
 
 module RightmoveBLM
   # A BLM document including its header, definition, and data content.
-  class Document
+  class Document # rubocop:disable Metrics/ClassLength
     def self.from_array_of_hashes(array)
       date = Time.now.utc.strftime('%d-%b-%Y %H:%M').upcase
       header = { version: '3', eof: '^', eor: '~', 'property count': array.size.to_s, 'generated date': date }
       new(header: header, definition: array.first.keys.map(&:to_sym), data: array)
     end
 
-    def initialize(source: nil, header: nil, definition: nil, data: nil)
-      @source = source
+    def initialize(source: nil, header: nil, definition: nil, data: nil, name: nil)
+      @source = source || data
       @header = header
       @definition = definition
+      @name = name
       initialize_with_data(data) unless data.nil?
     end
 
-    def inspect
-      %(<##{self.class.name} version=#{version} rows=#{rows.size} valid=#{valid?} errors=#{errors.size}>)
+    def inspect(safe: false, error: nil)
+      name = @name.nil? ? nil : %( document="#{@name}")
+      error_string = error.nil? ? nil : %( error="#{error}")
+      basic = %(<##{self.class.name}#{name}#{error_string}>)
+      return basic if safe
+
+      "<##{self.class.name}#{name}#{error_string} version=#{version} " \
+        "rows=#{rows.size} valid=#{valid?} errors=#{errors.size}>"
     end
 
     def to_s
@@ -39,7 +46,7 @@ module RightmoveBLM
         key, _, value = line.partition(':')
         next nil if value.nil?
 
-        [key.strip.downcase.to_sym, value.tr("'", '').strip]
+        [normalized_key(key), value.tr("'", '').strip]
       end.compact.to_h
     end
 
@@ -88,12 +95,20 @@ module RightmoveBLM
       start = verify(:start, @source.index(marker)) + marker.size
       finish = verify(:end, @source.index('#END#', start)) - 1
       @source[start..finish].strip
+    rescue Encoding::CompatibilityError => e
+      raise_parser_error 'Unable to parse document due to encoding error.', e
+    end
+
+    def normalized_key(key)
+      key.strip.downcase.to_sym
+    rescue ArgumentError => e
+      raise_parser_error "Unable to parse document. Error found in header for key `#{key}`", e
     end
 
     def verify(type, val)
       return val unless val.nil?
 
-      raise ParserError, "Unable to parse document: could not detect #{type} marker."
+      raise_parser_error "Unable to parse document: could not detect #{type} marker."
     end
 
     def generated_date
@@ -112,5 +127,9 @@ module RightmoveBLM
     def data_string
       ['#DATA#', *data.map { |row| "#{row.attributes.values.join('|')}~" }, '#END#']
     end
+
+    def raise_parser_error(message, cause = nil)
+      raise ParserError, "#{inspect(safe: true)}: #{message} #{cause}"
+    end
   end
 end

data/lib/rightmove_blm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RightmoveBLM
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rightmove_blm
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies: []
 description: Parse and generate Rightmove BLM files
 email: git@bob.frl
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: A parser for the Rightmove .blm format