rightmove_blm 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d47e3147eefd5503a6f72579b89a3009c2cd54f12e8103403d320b25f11aa414
-  data.tar.gz: 1e74f8d0a87a1ba9896525eec622d4b86612ec4c218807740b3c1a90642bd423
+  metadata.gz: 27c31f1462ef7ed1cb02253396803510703b7a3f2d14678dd359bd002ff1f113
+  data.tar.gz: 2c08d19df9a78f7ceae30a97dbd2be7dba9e6e8d3636779d1cdc3e6db14e75bc
 SHA512:
-  metadata.gz: '08f19c96d3dc41020b8d1750c3e1863745984128191911c3144319f7cbe884402288a9ef944f0f72c043cb7ce3246d2d87bebbbbdaec340243090aefcc65d0b1'
-  data.tar.gz: 1a2f3a7879e88d59ed174d9b9c46905ab8c5280737b17050c04aa20c86d93fdaf0a3cd43a76dca0894a5c2f754ef3671527c3e9ef4163440f965a126ff1bee59
+  metadata.gz: b599bc06336d93a1102b5276debb05eb285599f4169dae7fa744070c362e637107221e18a31346af2b6971314f0f1120f095627869a7ac90806023fc129b0922
+  data.tar.gz: e1c457877d3163e5b19d2570eab8d07190936cce9132c1588e5f4d8447065e45456c801df245fe8bee3d26142a585bf076e209526930fac0133d496b88f7828d

data/lib/rightmove_blm/document.rb

@@ -2,7 +2,9 @@
 
 module RightmoveBLM
   # A BLM document including its header, definition, and data content.
-  class Document
+  class Document # rubocop:disable Metrics/ClassLength
+    BLM_4_FILE_KEYWORDS = %w[HEADER VERSION EOF EOR DEFINITION DATA END].freeze
+
     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 }
@@ -15,6 +17,7 @@ module RightmoveBLM
       @definition = definition
       @name = name
       initialize_with_data(data) unless data.nil?
+      verify_source_file_structure(source) unless source.nil?
     end
 
     def inspect(safe: false, error: nil)
@@ -92,9 +95,11 @@ module RightmoveBLM
 
     def contents(section = :data)
       marker = "##{section.to_s.upcase}#"
-      start = verify(:start, @source.index(marker)) + marker.size
-      finish = verify(:end, @source.index('#END#', start)) - 1
+      start = verify_marker_presence(:start, @source.index(marker)) + marker.size
+      finish = verify_marker_presence(: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)
@@ -103,12 +108,22 @@ module RightmoveBLM
       raise_parser_error "Unable to parse document. Error found in header for key `#{key}`", e
     end
 
-    def verify(type, val)
+    # INFO : for reverse compatibility. can remove this method and it's calls within this update.
+    # verify_file_structure should cover all cases of this method calls
+    def verify_marker_presence(type, val)
       return val unless val.nil?
 
       raise_parser_error "Unable to parse document: could not detect #{type} marker."
     end
 
+    def verify_source_file_structure(source)
+      BLM_4_FILE_KEYWORDS.each do |keyword|
+        next if source.index(keyword)
+
+        raise_parser_error "Unable to process document with this structure: could not detect #{keyword} marker."
+      end
+    end
+
     def generated_date
       header[:'generated date'] || Time.now.utc.strftime('%d-%b-%Y %H:%M').upcase
     end

data/lib/rightmove_blm/version.rb

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

data/rightmove_blm.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary
   spec.description = 'Parse and generate Rightmove BLM files'
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 2.7.1'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rightmove_blm
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies: []
 description: Parse and generate Rightmove BLM files
 email: git@bob.frl
@@ -45,7 +45,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="