rightmove_blm 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d86b0d52da5fad3fdac5c44ad7cc0ee515b67b6f4bdb7b2abd25ae92cd65aad3
-  data.tar.gz: 84d91eda581f2a813bd5da72db9f2a9384262505913074077ba78fe104169bd8
+  metadata.gz: a4ec5f3eee9950c331f0a1dd23129b47d6917c332fae762df37346f67c3ae15b
+  data.tar.gz: e803eb23307b33115103e2cd99c94398d272576db5206670eff24c64f13f72af
 SHA512:
-  metadata.gz: 653deacb786ab85ba54a77318e62f36fc570c2da370163b475191003190db55d7d77e4019924e2643c56ad00b2a04060ae142fc57eb65f5997f0aa41ee53e9dc
-  data.tar.gz: e16d71c8a41018d8d4adbeedf69059e5b111a3dbb22a23f818ab36c7d6545529eed67d1f6cbba0d900811bf0abda5ebab79792f55852aecdce449021bc1e41d0
+  metadata.gz: 784c8aad75336281c6e7bc59a0a16866929f62268542d0ebf93c5bccb5a21b1e651a91b1edeca885d571ab18bdd35289afd27937316ff8a5c473d44ad612c760
+  data.tar.gz: 9f8dc40c0e294360d4ca3b7b713da7922b4c9a90795517f98fcd71d13b9ba22e21435aa5f984618d3d30aabb91a6ffa0fad7640d248339a2b59c1c20453e4f96

data/.rubocop.yml

@@ -1,6 +1,9 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
 
 Metrics/BlockLength:
   Exclude:
-  - 'spec/blm_spec.rb'
+  - 'spec/**/*_spec.rb'

data/README.md

@@ -10,6 +10,8 @@ This library is not affiliated with or endorsed by _Rightmove Plc_ in any way.
 
 ### Loading a BLM file
 
+#### RightmoveBLM::Document
+
 Load a BLM file by passing the `source` parameter to `RightmoveBLM::Document.new`:
 
 ```ruby
@@ -20,17 +22,32 @@ The returned `RightmoveBLM::Document` instance implements:
 
 * `#header` - the header containing information about the document's structure.
 * `#definition` - the field list contained in the document.
-* `#data` - an array of `RightmoveBLM::Row` objects (use dot notation to access fields, e.g. `row.foo` to access the "foo" field).
+* `#rows` - an array of `RightmoveBLM::Row` objects.
+* `#valid?` - `true` if no rows have errors, `false` if any rows have errors.
+* `#errors` - all error messages for all invalid rows.
+* `#version` - the version of the document format as a string (e.g. `'3'`).
+* `#international?` - `true` if document meets the [Rightmove International](https://www.rightmove.co.uk/ps/pdf/guides/RightmoveDatafeedFormatV3iOVS_1.6.pdf) specification, `false` otherwise.
+
+#### RightmoveBLM::Row
+
+`RightmoveBLM::Row` implements:
 
-`RightmoveBLM::Row` also implements `#to_h` which provides a _Hash_ of the row data.
+* `#valid?` - `true` if no errors were encountered, false otherwise.
+* `#errors` - an array of error strings (empty if no errors present).
+* `#to_h` (or `#attributes`) - a hash of row attributes (`nil` if errors encountered).
+* `#method_missing` - allows accessing row attributes by dot notation (e.g. `row.address_1`).
 
 #### Example
 
 ```ruby
-blm.data.each do |row|
+blm.data.select(&:valid?).each do |row|
   puts row.address_1
   puts row.to_h
 end
+
+blm.data.reject(&:valid?).each do |row|
+  puts "Errors: #{row.errors.join(', ')}"
+end
 ```
 
 ### Writing BLM data

data/lib/rightmove_blm/document.rb

@@ -13,7 +13,15 @@ module RightmoveBLM
       @source = source
       @header = header
       @definition = definition
-      @data = data&.map { |row| Row.new(row) }
+      initialize_with_data(data) unless data.nil?
+    end
+
+    def inspect
+      %(<##{self.class.name} version=#{version} rows=#{rows.size} valid=#{valid?} errors=#{errors.size}>)
+    end
+
+    def to_s
+      inspect
     end
 
     def to_blm
@@ -43,27 +51,49 @@ module RightmoveBLM
       end.compact
     end
 
-    def data
-      @data ||= contents.split(header[:eor]).map do |line|
-        row(line)
-      end
+    def rows
+      data
+    end
+
+    def errors
+      @errors ||= data.reject(&:valid?).flat_map(&:errors)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def version
+      header[:version]
+    end
+
+    def international?
+      %w[H1 3I].include?(version)
     end
 
     private
 
+    def initialize_with_data(data)
+      @data = data.each_with_index.map { |hash, index| Row.from_attributes(hash, index: index) }
+    end
+
+    def data
+      @data ||= contents.split(header[:eor]).each_with_index.map do |line, index|
+        Row.new(index: index, data: line, separator: header[:eof], definition: definition)
+      end
+    end
+
     def contents(section = :data)
       marker = "##{section.to_s.upcase}#"
-      start = @source.index(marker) + marker.size
-      finish = @source.index('#', start) - 1
+      start = verify(:start, @source.index(marker)) + marker.size
+      finish = verify(:end, @source.index('#', start)) - 1
       @source[start..finish].strip
     end
 
-    def row(line)
-      entry = {}
-      line.split(header[:eof]).each_with_index do |field, index|
-        entry[definition[index].to_sym] = field.strip
-      end
-      Row.new(entry)
+    def verify(type, val)
+      return val unless val.nil?
+
+      raise ParserError, "Unable to parse document: could not detect #{type} marker."
     end
 
     def generated_date

data/lib/rightmove_blm/row.rb

@@ -3,22 +3,72 @@
 module RightmoveBLM
   # A row in a BLM document.
   class Row
-    attr_accessor :attributes
+    attr_reader :index
 
-    def initialize(hash)
-      @attributes = hash
+    def self.from_attributes(attributes, index:)
+      new(index: index, data: nil, separator: nil, definition: attributes.keys, attributes: attributes)
+    end
+
+    def initialize(index:, data:, separator:, definition:, attributes: nil)
+      @index = index
+      @data = data
+      @separator = separator
+      @definition = definition
+      @attributes = attributes
+      @fields = attributes.keys unless attributes.nil?
     end
 
     def to_h
-      @attributes
+      attributes
+    end
+
+    def valid?
+      return false unless field_size_valid?
+
+      true
+    end
+
+    def errors
+      return [] if valid?
+
+      errors = []
+      errors << field_size_mismatch_message unless field_size_valid?
+      errors
+    end
+
+    def attributes
+      return nil unless valid?
+
+      @attributes ||= fields.each_with_index.to_h do |field, field_index|
+        [definition[field_index].to_sym, field.strip]
+      end
+    end
+
+    private
+
+    attr_reader :data, :separator, :definition
+
+    def field_size_mismatch_message
+      "Field size mismatch in row #{index}. Expected: #{definition.size} fields, found: #{fields.size}"
+    end
+
+    def fields
+      @fields ||= data.split(separator)
+    end
+
+    def field_size_valid?
+      definition.size >= fields.size
     end
 
     def method_missing(method, *_arguments)
-      return @attributes[method] unless @attributes[method].nil?
+      return super if attributes.nil?
+      return attributes[method] unless attributes[method].nil?
+
+      super
     end
 
     def respond_to_missing?(method, _ = false)
-      !@attributes[method].nil?
+      !attributes[method].nil?
     end
   end
 end

data/lib/rightmove_blm/version.rb

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

data/lib/rightmove_blm.rb

@@ -8,4 +8,6 @@ require 'time'
 # Rightmove BLM (Bulk Load Mass) data format parsing tools.
 # https://www.rightmove.co.uk/ps/pdf/guides/RightmoveDatafeedFormatV3iOVS_1.6.pdf
 module RightmoveBLM
+  class Error < StandardError; end
+  class ParserError < Error; end
 end

data/rightmove_blm.gemspec

@@ -5,7 +5,7 @@ require_relative 'lib/rightmove_blm/version'
 Gem::Specification.new do |spec|
   spec.name = 'rightmove_blm'
   spec.version = RightmoveBLM::VERSION
-  spec.authors = ['Robert Farrell']
+  spec.authors = ['Bob Farrell']
   spec.email = 'git@bob.frl'
 
   spec.summary

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rightmove_blm
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
-- Robert Farrell
+- Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Parse and generate Rightmove BLM files
 email: git@bob.frl
@@ -27,7 +27,6 @@ files:
 - Makefile
 - README.md
 - Rakefile
-- VERSION
 - lib/rightmove_blm.rb
 - lib/rightmove_blm/document.rb
 - lib/rightmove_blm/row.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.6