mas-rad_core 0.0.94 → 0.0.95

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17774aeb4e9da3bb4753dea23b904b0eec7f7cc1
-  data.tar.gz: f509893a0e1f105581b713cc0f0c23e1556653e4
+  metadata.gz: 2d69336ba464137daf9b2b5c75caf488380f704e
+  data.tar.gz: 96b5d9ddabcbb1d2f5fa22c9162c8fcd343ad999
 SHA512:
-  metadata.gz: 36922d7ebb281fbf003837e53bf25c2ba5f4eff37685ec3bfaeba678ddfda6e609a40a07050cb1043fea60caaaa83fc2fe4ac1dfe86e744a01087180fc0cdbbd
-  data.tar.gz: 2fa9c442b64770106e69d24868deb227e94c232929f53c60c15a5e8b25a5db83340e59f6d54b64450833648da148ab78bd06a158cc7033d57423b640cf8be189
+  metadata.gz: 99f998d199dffad79993f6c0b4c39f6998d06966b5aea5ba0522ab5b1efa032d77f45417fea8331f5045b20caf5b87bcad2ecdb1a21292aa7745e8402574702b
+  data.tar.gz: 4419dfe1cd4c769a647c30a8d73436007174d157c230cfcf0c89a9f30d86b49935ff8908eb5eb94955bb1836947045f9f7a1c32226dc136b957887ccfeba52ae

data/app/models/adviser.rb

@@ -1,6 +1,5 @@
 class Adviser < ActiveRecord::Base
   include Geocodable
-  include GeocodableSync
 
   attr_reader :old_firm_id
 

data/app/models/geocodable.rb

@@ -25,8 +25,26 @@ module Geocodable
     self.latitude, self.longitude = coordinates
   end
 
-  def update_coordinates!(coordinates)
-    self.coordinates = coordinates
-    update_columns(latitude: latitude, longitude: longitude)
+  def geocode
+    return false unless valid?
+    return true unless needs_to_be_geocoded?
+
+    self.coordinates = ModelGeocoder.geocode(self)
+    add_geocoding_failed_error unless geocoded?
+
+    geocoded?
+  end
+
+  def needs_to_be_geocoded?
+    !geocoded? || has_address_changes?
+  end
+
+  def save_with_geocoding
+    geocode && save
+  end
+
+  def update_with_geocoding(params)
+    self.attributes = params
+    save_with_geocoding
   end
 end

data/app/models/office.rb

@@ -1,6 +1,5 @@
 class Office < ActiveRecord::Base
   include Geocodable
-  include GeocodableSync
 
   ADDRESS_FIELDS = [
     :address_line_one,

data/lib/mas/model_geocoder.rb

@@ -2,10 +2,4 @@ module ModelGeocoder
   def self.geocode(geocodable)
     Geocoder.coordinates(geocodable.full_street_address)
   end
-
-  def self.geocode!(geocodable)
-    coordinates = geocode(geocodable)
-    geocodable.update_coordinates!(coordinates)
-    coordinates.present?
-  end
 end

data/lib/mas/office_result.rb

@@ -15,4 +15,10 @@ class OfficeResult
     @disabled_access  = data['disabled_access']
     @location = Location.new data['location']['lat'], data['location']['lon']
   end
+
+  def telephone_number
+    return nil unless @telephone_number
+
+    UKPhoneNumbers.format(@telephone_number)
+  end
 end

data/lib/mas/rad_core/version.rb

@@ -1,5 +1,5 @@
 module MAS
   module RadCore
-    VERSION = '0.0.94'
+    VERSION = '0.0.95'
   end
 end

data/spec/lib/mas/model_geocoder_spec.rb

@@ -1,9 +1,7 @@
 RSpec.describe ModelGeocoder do
   let(:model_class) do
     Class.new do
-      attr_accessor :address_line_one, :address_line_two, :address_postcode, :longitude, :latitude
-
-      def update_coordinates!(*args); end
+      attr_accessor :address_line_one, :address_line_two, :address_postcode
 
       def full_street_address
         [address_line_one, address_line_two, address_postcode, 'United Kingdom'].reject(&:blank?).join(', ')
@@ -45,37 +43,4 @@ RSpec.describe ModelGeocoder do
       end
     end
   end
-
-  describe '#geocode!' do
-    context 'when the model address can be geocoded' do
-      before do
-        allow(ModelGeocoder).to receive(:geocode).and_return(expected_coordinates)
-      end
-
-      it 'calls model.update_coordinates! with the coordinates' do
-        expect(model).to receive(:update_coordinates!).with(expected_coordinates)
-        ModelGeocoder.geocode!(model)
-      end
-
-      it 'returns the true' do
-        expect(ModelGeocoder.geocode!(model)).to be(true)
-      end
-    end
-
-    context 'when model address cannot be geocoded' do
-      before do
-        allow(ModelGeocoder).to receive(:geocode).and_return(nil)
-      end
-
-      # This side effect is required while the geocoding is done on a background job
-      it 'calls model.update_coordinates! with nil' do
-        expect(model).to receive(:update_coordinates!).with(nil)
-        ModelGeocoder.geocode!(model)
-      end
-
-      it 'returns false' do
-        expect(ModelGeocoder.geocode!(model)).to be(false)
-      end
-    end
-  end
 end

data/spec/lib/mas/office_result_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe OfficeResult do
       'address_county'   => 'Cumbria',
       'address_postcode' => 'LA8 9BE',
       'email_address'    => 'postie@example.com',
-      'telephone_number' => '5555 555 5555',
+      'telephone_number' => '02085952346',
       'disabled_access'  => true,
       'location' => { 'lat' => 51.5180697, 'lon' => -0.1085203 }
     }
@@ -24,7 +24,7 @@ RSpec.describe OfficeResult do
     specify { expect(subject.address_county).to eq('Cumbria') }
     specify { expect(subject.address_postcode).to eq('LA8 9BE') }
     specify { expect(subject.email_address).to eq('postie@example.com') }
-    specify { expect(subject.telephone_number).to eq('5555 555 5555') }
+    specify { expect(subject.telephone_number).to eq('020 8595 2346') }
     specify { expect(subject.disabled_access).to eq(true) }
 
     it 'maps the location with latitude and longitude' do

data/spec/models/adviser_spec.rb

@@ -103,10 +103,6 @@ RSpec.describe Adviser do
   end
 
   it_should_behave_like 'geocodable' do
-    subject { create(:adviser) }
-  end
-
-  it_should_behave_like 'synchronously geocodable' do
     let(:invalid_geocodable) { Adviser.new }
     let(:valid_new_geocodable) { FactoryGirl.build(:adviser) }
     let(:saved_geocodable) { FactoryGirl.create(:adviser) }

data/spec/models/office_spec.rb

@@ -5,10 +5,6 @@ RSpec.describe Office do
   subject(:office) { firm.offices.first }
 
   it_should_behave_like 'geocodable' do
-    subject { office }
-  end
-
-  it_should_behave_like 'synchronously geocodable' do
     let(:invalid_geocodable) { Office.new }
     let(:valid_new_geocodable) { FactoryGirl.build(:office, firm: firm) }
     let(:saved_geocodable) { office }

data/spec/support/shared_examples/geocodable_examples.rb

@@ -1,4 +1,21 @@
 RSpec.shared_examples 'geocodable' do
+  describe 'the interface the geocodable must implement' do
+    subject { valid_new_geocodable }
+
+    # needed for the ModelGeocoder
+    it { is_expected.to respond_to(:full_street_address) }
+
+    # used by #needs_to_be_geocoded?
+    it { is_expected.to respond_to(:has_address_changes?) }
+
+    # used by #geocode
+    it { is_expected.to respond_to(:add_geocoding_failed_error) }
+  end
+
+  def modify_address(subject)
+    subject.send("#{address_field_name}=", address_field_updated_value)
+  end
+
   describe '#latitude=' do
     let(:latitude) { Faker::Address.latitude }
 
@@ -35,60 +52,232 @@ RSpec.shared_examples 'geocodable' do
     end
   end
 
-  describe '#update_coordinates!' do
-    let(:coordinates) { [Faker::Address.latitude, Faker::Address.longitude] }
+  describe '#geocoded?' do
+    context 'when the subject has lat/long' do
+      before do
+        subject.latitude, subject.longitude = [1.0, 1.0]
+      end
 
-    before do
-      subject.update_coordinates!(coordinates)
-      subject.reload
+      it 'is classed as geocoded' do
+        expect(subject.geocoded?).to be(true)
+      end
     end
 
-    it 'the model is persisted' do
-      expect(subject).to be_persisted
+    context 'when the subject does not have lat/long' do
+      before do
+        subject.latitude, subject.longitude = [nil, nil]
+      end
+
+      it 'is not classed as geocoded' do
+        expect(subject.geocoded?).to be(false)
+      end
     end
+  end
+
+  describe '#geocode' do
+    context 'when the subject is not valid' do
+      subject { invalid_geocodable }
 
-    context 'with valid coordinates' do
-      it 'the latitude is updated' do
-        expect(subject.latitude).to eql(coordinates.first.to_f.round(6))
+      it 'does not call the geocoder' do
+        expect(ModelGeocoder).not_to receive(:geocode)
+        subject.geocode
       end
 
-      it 'the longitude is updated' do
-        expect(subject.longitude).to eql(coordinates.last.to_f.round(6))
+      it 'returns false' do
+        expect(subject.geocode).to be(false)
       end
     end
 
-    context 'with no coordinates' do
-      let(:coordinates) { nil }
+    context 'when the subject is valid' do
+      subject { valid_new_geocodable }
 
-      it 'the latitude is updated' do
-        expect(subject.latitude).to be_nil
+      context 'when the subject does not need to be geocoded' do
+        before do
+          subject.coordinates = [1.0, 1.0]
+          subject.save!
+        end
+
+        it 'does not call the geocoder' do
+          expect(ModelGeocoder).not_to receive(:geocode)
+          subject.geocode
+        end
+
+        it 'returns true' do
+          expect(subject.geocode).to be(true)
+        end
       end
 
-      it 'the longitude is updated' do
-        expect(subject.longitude).to be_nil
+      context 'when the subject needs to be geocoded' do
+        before do
+          subject.coordinates = nil
+        end
+
+        context 'when geocoding succeeds' do
+          before do
+            allow(ModelGeocoder).to receive(:geocode).and_return([1.0, 1.0])
+          end
+
+          it 'returns true' do
+            expect(subject.geocode).to be(true)
+          end
+
+          specify 'subject.errors.count is 0' do
+            subject.geocode
+            expect(subject.errors.count).to be(0)
+          end
+
+          context 'no persistence' do
+            before do
+              subject.save!
+              expect(subject).not_to be_changed
+              expect(subject.coordinates).to eq([nil, nil])
+              subject.geocode
+            end
+
+            it 'sets the new coordinates on the in-memory instance' do
+              expect(subject.coordinates).to eq([1.0, 1.0])
+            end
+
+            it 'does not persist the changed fields' do
+              expect(subject).to be_changed
+              expect(subject.reload.coordinates).to eq([nil, nil])
+            end
+          end
+        end
+
+        context 'when geocoding fails' do
+          before do
+            allow(ModelGeocoder).to receive(:geocode).and_return(nil)
+          end
+
+          it 'adds an error to subject.errors' do
+            subject.geocode
+            expect(subject.errors).to have_key(:geocoding)
+          end
+
+          it 'returns false' do
+            expect(subject.geocode).to be(false)
+          end
+
+          context 'no persistence' do
+            before do
+              subject.coordinates = [1.0, 1.0]
+              subject.save!
+              modify_address(subject)
+              subject.geocode
+            end
+
+            it 'blanks out the in-memory instance coordinates' do
+              expect(subject.coordinates).to eq([nil, nil])
+            end
+
+            it 'does not persist the changed fields' do
+              expect(subject).to be_changed
+              expect(subject.reload.coordinates).to eq([1.0, 1.0])
+            end
+          end
+        end
       end
     end
   end
 
-  describe '#geocoded?' do
-    context 'when the subject has lat/long' do
+  describe '#needs_to_be_geocoded?' do
+    subject { saved_geocodable }
+
+    context 'when the model has not been geocoded' do
       before do
-        subject.latitude, subject.longitude = [1.0, 1.0]
+        subject.coordinates = nil
+        expect(subject).not_to be_geocoded
       end
 
-      it 'is classed as geocoded' do
-        expect(subject.geocoded?).to be(true)
+      it 'returns true' do
+        expect(subject.needs_to_be_geocoded?).to be(true)
       end
     end
 
-    context 'when the subject does not have lat/long' do
+    context 'when the model has been geocoded' do
       before do
-        subject.latitude, subject.longitude = [nil, nil]
+        subject.coordinates = [1.0, 1.0]
+        subject.save!
+        expect(subject).to be_geocoded
       end
 
-      it 'is not classed as geocoded' do
-        expect(subject.geocoded?).to be(false)
+      context 'when the model address fields have not changed' do
+        before do
+          expect(subject).not_to have_address_changes
+        end
+
+        it 'returns false' do
+          expect(subject.needs_to_be_geocoded?).to be(false)
+        end
+      end
+
+      context 'when the model address fields have changed' do
+        before do
+          modify_address(subject)
+          expect(subject).to have_address_changes
+        end
+
+        it 'returns true' do
+          expect(subject.needs_to_be_geocoded?).to be(true)
+        end
       end
     end
   end
+
+  describe '#save_with_geocoding' do
+    before { allow(saved_geocodable).to receive(:geocode).and_return(result_of_geocoding) }
+    subject { saved_geocodable.save_with_geocoding }
+
+    context 'when geocoding fails' do
+      let(:result_of_geocoding) { false }
+
+      it { is_expected.to be(false) }
+
+      it 'does not call save' do
+        expect(saved_geocodable).not_to receive(:save)
+        subject
+      end
+    end
+
+    context 'when geocoding succeeds' do
+      let(:result_of_geocoding) { true }
+      let(:result_of_saving) { true }
+      before { allow(saved_geocodable).to receive(:save).and_return(result_of_saving) }
+
+      it 'calls save' do
+        expect(saved_geocodable).to receive(:save)
+        subject
+      end
+
+      context 'when saving fails' do
+        let(:result_of_saving) { false }
+        it { is_expected.to be(false) }
+      end
+
+      context 'when saving succeeds' do
+        it { is_expected.to be(true) }
+      end
+    end
+  end
+
+  describe '#update_with_geocoding' do
+    subject { saved_geocodable.update_with_geocoding(updated_address_params) }
+
+    it 'updates the geocodable with new attributes' do
+      allow(saved_geocodable).to receive(:save_with_geocoding)
+      subject
+      expect(saved_geocodable.changed_attributes).to include(updated_address_params.keys.first)
+    end
+
+    it 'calls #save_with_geocoding' do
+      expect(saved_geocodable).to receive(:save_with_geocoding)
+      subject
+    end
+
+    it 'returns the return value of #save_with_geocoding' do
+      allow(saved_geocodable).to receive(:save_with_geocoding).and_return(:return_marker)
+      expect(subject).to eq(:return_marker)
+    end
+  end
 end