rightmove_blm 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5290eccbda2e643b9f1958eca700510447db408f10235d565fc307ac4506e289
-  data.tar.gz: e1706ac3a50a81928c0ac1c45d38bb14ccf1f94bbea345ae8da278c62ac4be74
+  metadata.gz: d47e3147eefd5503a6f72579b89a3009c2cd54f12e8103403d320b25f11aa414
+  data.tar.gz: 1e74f8d0a87a1ba9896525eec622d4b86612ec4c218807740b3c1a90642bd423
 SHA512:
-  metadata.gz: 00dd4cb21fa63cf72e83c078aa7379a64c36dd7158c569739c75db3d5c3ffe45db16bd20c2ca2f9786973b55961cf4b90313d999577f19488c6039c8d6081b4f
-  data.tar.gz: cbb5be2c2bdcbe90d991d338374551e7091ce04f26475004c0e487315fcc7b8343b8bc4ff19348c6aada00af3abd86f1370246969c75f3ec082c7e347a65779e
+  metadata.gz: '08f19c96d3dc41020b8d1750c3e1863745984128191911c3144319f7cbe884402288a9ef944f0f72c043cb7ce3246d2d87bebbbbdaec340243090aefcc65d0b1'
+  data.tar.gz: 1a2f3a7879e88d59ed174d9b9c46905ab8c5280737b17050c04aa20c86d93fdaf0a3cd43a76dca0894a5c2f754ef3671527c3e9ef4163440f965a126ff1bee59

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

@@ -9,15 +9,22 @@ module RightmoveBLM
       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
 
@@ -86,14 +93,20 @@ module RightmoveBLM
     def contents(section = :data)
       marker = "##{section.to_s.upcase}#"
       start = verify(:start, @source.index(marker)) + marker.size
-      finish = verify(:end, @source.index('#', start)) - 1
+      finish = verify(:end, @source.index('#END#', start)) - 1
       @source[start..finish].strip
     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 +125,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.1'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rightmove_blm
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-08 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