rightmove_blm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72f7f143280413db6a1bfd9b5088adf48f703f8dff4e8d0c9f83f9809a5da899
+  data.tar.gz: 555f455ce456dd538bab99b94945bcb0792a15422bdaca37236e4243c0f60bab
+SHA512:
+  metadata.gz: 5ca2e04480899cd352c48c3ce59c21993dc33c91c3638a165cee55c40cb8de285d008e59ef7332477d43ea67d00798e271e5e45f9ebe9a0071aeef57dd84c747
+  data.tar.gz: 38736bdc6fbf9b73a4e1ef0b6c6cb8fbe43e9b9a0aeb38b25fb106632ccd4bc845e6286866d5c664fa216d2d1abfc10f0429e4de9c93d422a98d780a6dfba481

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,43 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+.rspec_status
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper.rb

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/blm_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+group :development, :test do
+  gem 'devpack', '~> 0.3.2'
+  gem 'rspec', '~> 3.10'
+  gem 'rspec-file_fixtures', '~> 0.1.3'
+  gem 'rspec-its', '~> 1.3'
+  gem 'rubocop', '~> 1.13'
+  gem 'rubocop-rspec', '~> 2.2'
+  gem 'strong_versions', '~> 0.4.5'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    devpack (0.3.2)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    paint (2.2.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-file_fixtures (0.1.3)
+      rspec (~> 3.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
+      paint (~> 2.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devpack (~> 0.3.2)
+  rspec (~> 3.10)
+  rspec-file_fixtures (~> 0.1.3)
+  rspec-its (~> 1.3)
+  rubocop (~> 1.13)
+  rubocop-rspec (~> 2.2)
+  strong_versions (~> 0.4.5)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Robert May, Robert Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,45 @@
+# Rightmove BLM
+
+A simple parser for the _Rightmove_ `.blm` [Bulk Load Mass](https://www.rightmove.co.uk/ps/pdf/guides/RightmoveDatafeedFormatV3iOVS_1.6.pdf) file format.
+
+Originally forked from the [BLM](https://github.com/robotmay/blm) gem by Robert May.
+
+This library is not affiliated with or endorsed by _Rightmove Plc_ in any way.
+
+## Usage
+
+### Loading a BLM file
+
+Load a BLM file by passing the `source` parameter to `RightmoveBLM::Document.new`:
+
+```ruby
+blm = RightmoveBLM::Document.new(source: File.read('example_data.blm'))
+```
+
+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).
+
+`RightmoveBLM::Row` also implements `#to_h` which provides a _Hash_ of the row data.
+
+#### Example
+
+```ruby
+blm.data.each do |row|
+  puts row.address_1
+  puts row.to_h
+end
+```
+
+### Writing BLM data
+
+An array of _hashes_ can be converted to a `RightmoveBLM::Document` object which can then be used to create an output string by calling `#to_blm`.
+
+The keys from the first _hash_ in the provided _array_ are used to provide the field definition. All _hashes_ **must** contain the same keys.
+
+```ruby
+document = RightmoveBLM::Document.from_array_of_hashes([{ field1: 'foo', field2: 'bar' }, { field1: 'baz', field2: 'foobar' }])
+File.write('my_data.blm', document.to_blm)
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.5

data/lib/rightmove_blm.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rightmove_blm/document'
+require 'rightmove_blm/row'
+
+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
+end

data/lib/rightmove_blm/document.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RightmoveBLM
+  # A BLM document including its header, definition, and data content.
+  class Document
+    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
+      @header = header
+      @definition = definition
+      @data = data&.map { |row| Row.new(row) }
+    end
+
+    def to_blm
+      [
+        header_string,
+        definition_string,
+        data_string
+      ].join("\n")
+    end
+
+    def header
+      @header ||= contents(:header).each_line.map do |line|
+        next nil if line.empty?
+
+        key, _, value = line.partition(' : ')
+        next nil if value.nil?
+
+        [key.downcase.to_sym, value.tr("'", '').strip]
+      end.compact.to_h
+    end
+
+    def definition
+      @definition ||= contents(:definition).split(header[:eor]).first.split(header[:eof]).map do |field|
+        next nil if field.empty?
+
+        field.downcase.strip
+      end.compact
+    end
+
+    def data
+      @data ||= contents.split(header[:eor]).map do |line|
+        row(line)
+      end
+    end
+
+    private
+
+    def contents(section = :data)
+      marker = "##{section.to_s.upcase}#"
+      start = @source.index(marker) + marker.size
+      finish = @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)
+    end
+
+    def generated_date
+      header[:'generated date'] || Time.now.utc.strftime('%d-%b-%Y %H:%M').upcase
+    end
+
+    def header_string
+      ['#HEADER#', "VERSION : #{header[:version]}", "EOF : '|'", "EOR : '~'",
+       "Property Count : #{data.size}", "Generated Date : #{generated_date}", '']
+    end
+
+    def definition_string
+      ['#DEFINITION#', "#{definition.join('|')}|~", '']
+    end
+
+    def data_string
+      ['#DATA#', *data.map { |row| "#{row.attributes.values.join('|')}~" }, '#END#']
+    end
+  end
+end

data/lib/rightmove_blm/row.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RightmoveBLM
+  # A row in a BLM document.
+  class Row
+    attr_accessor :attributes
+
+    def initialize(hash)
+      @attributes = hash
+    end
+
+    def to_h
+      @attributes
+    end
+
+    def method_missing(method, *_arguments)
+      return @attributes[method] unless @attributes[method].nil?
+    end
+
+    def respond_to_missing?(method, _ = false)
+      !@attributes[method].nil?
+    end
+  end
+end

data/lib/rightmove_blm/version.rb

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

data/rightmove_blm.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rightmove_blm/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rightmove_blm'
+  spec.version = RightmoveBLM::VERSION
+  spec.authors = ['Robert Farrell']
+  spec.email = 'git@bob.frl'
+
+  spec.summary
+  spec.description = 'Parse and generate Rightmove BLM files'
+  spec.required_ruby_version = '~> 2.5'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.homepage = 'http://github.com/robertmay/blm'
+  spec.licenses = ['MIT']
+  spec.require_paths = ['lib']
+  spec.rubygems_version = '1.3.7'
+  spec.summary = 'A parser for the Rightmove .blm format'
+  spec.test_files = [
+    'spec/blm_spec.rb',
+    'spec/spec_helper.rb'
+  ]
+end

data/spec/blm_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe RightmoveBLM do
+  context 'reading a .blm file' do
+    let(:data) { fixture('example_data.blm') }
+    let(:blm) { RightmoveBLM::Document.new(source: data.read) }
+
+    it 'should parse settings from the header' do
+      expect(blm.header).to be_a(Hash)
+      expect(blm.header[:version]).to_not be_nil
+      expect(blm.header[:eof]).to_not be_nil
+      expect(blm.header[:eor]).to_not be_nil
+    end
+
+    it 'should parse the column definition' do
+      expect(blm.definition).to be_a(Array)
+      expect(blm.definition.size).to be >= 1
+    end
+
+    it 'should parse the data into an array of hashes' do
+      expect(blm.data).to be_a(Array)
+      expect(blm.data.size).to be >= 1
+      expect(blm.data).to respond_to(:each, :each_with_index)
+      blm.data.each { |row| expect(row).to be_a(RightmoveBLM::Row) }
+    end
+
+    it 'should allow access to data values via methods' do
+      blm.data.each { |row| expect(row.address_1).to_not be_nil }
+    end
+
+    it 'should allow access to the @attributes hash directly' do
+      blm.data.each { |row| expect(row.attributes).to be_a(Hash) }
+    end
+  end
+
+  context 'creating a .blm file' do
+    subject(:document) { RightmoveBLM::Document.from_array_of_hashes(data) }
+
+    let(:data) do
+      [{ field1: 'row 1 field 1 data', field2: 'row 1 field 2 data', field3: 'row 1 field 3 data' },
+       { field1: 'row 2 field 1 data', field2: 'row 2 field 2 data', field3: 'row 2 field 3 data' }]
+    end
+
+    its(:header) { is_expected.to include({ 'property count': '2' }) }
+    its(:header) { is_expected.to include({ version: '3' }) }
+    its(:definition) { is_expected.to eql %i[field1 field2 field3] }
+
+    describe '#to_blm' do
+      let(:loaded_document) { RightmoveBLM::Document.new(source: subject.to_blm) }
+
+      it 'has a property count' do
+        expect(loaded_document.header[:'property count']).to eql '2'
+      end
+
+      it 'has a version' do
+        expect(loaded_document.header[:version]).to eql '3'
+      end
+
+      it 'has a "generated date" timestamp' do
+        expect(loaded_document.header[:'generated date']).to start_with Time.now.utc.strftime('%d-%b-%Y').upcase
+      end
+
+      it 'has property data' do
+        expect(loaded_document.data.map(&:to_h)).to eql data
+      end
+
+      it 'has a field definition' do
+        expect(loaded_document.definition).to eql %w[field1 field2 field3]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'devpack'
+require 'rightmove_blm'
+
+require 'rspec/file_fixtures'
+require 'rspec/its'
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = '.rspec_status'
+  config.disable_monkey_patching!
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rightmove_blm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Farrell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-02 00:00:00.000000000 Z
+dependencies: []
+description: Parse and generate Rightmove BLM files
+email: git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- VERSION
+- lib/rightmove_blm.rb
+- lib/rightmove_blm/document.rb
+- lib/rightmove_blm/row.rb
+- lib/rightmove_blm/version.rb
+- rightmove_blm.gemspec
+- spec/blm_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/robertmay/blm
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: A parser for the Rightmove .blm format
+test_files:
+- spec/blm_spec.rb
+- spec/spec_helper.rb