mas-rad_core 0.0.81 → 0.0.82

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2f8947dfc7c45c34e1998ca8af771722f43f493
-  data.tar.gz: 6885e9c568e5100b60f6794e2416a6b59f88db2a
+  metadata.gz: 8aaa6855712fd187910683b20259960b00ca1472
+  data.tar.gz: 104f655a861efc082670fda527505d9e89fda40e
 SHA512:
-  metadata.gz: c715b56726070f6f800e7155434b4d418207bc22f776d19b0131997bd8f73c847928e26181a613007fad7939f7cd6d42253df5bbe41600c1a16c2e71bdc62860
-  data.tar.gz: 4ac0dec58ce440793367fbe0b3e56655cae7daf6981d4797cfd57adf322b14ac5a02709bfe2642be7db191e4392b3a71c6635d5d6e5cad83f58978dbc4e2bd81
+  metadata.gz: 588fa78f40923457266cc2d6017043c9e48792724186c247d09a4c1b930a33ce117f2a269eebb67445e361fb3bbedd0ef17967522d2ad72575fd30d206ca341f
+  data.tar.gz: d8b7e188680d827cd27a985ea7a52dad63c992d32ff3dd7c6e3ab3ef2d7c04b676619efaceb6caad789b1d82b89121312b80e578ac388cceb1976268d25700ef

data/app/models/firm.rb

@@ -1,6 +1,12 @@
 class Firm < ActiveRecord::Base
   include Geocodable
 
+  FREE_INITIAL_MEETING_VALID_VALUES = [true, false].freeze
+
+  # We use a scalar required field as a marker to detect a record saved with validation
+  REGISTERED_MARKER_FIELD = :free_initial_meeting
+  REGISTERED_MARKER_FIELD_VALID_VALUES = FREE_INITIAL_MEETING_VALID_VALUES
+
   ADVICE_TYPES_ATTRIBUTES = [
     :retirement_income_products_flag,
     :pension_transfer_flag,
@@ -10,7 +16,7 @@ class Firm < ActiveRecord::Base
     :wills_and_probate_flag
   ]
 
-  scope :registered, -> { where.not(email_address: nil) }
+  scope :registered, -> { where.not(REGISTERED_MARKER_FIELD => nil) }
   scope :sorted_by_registered_name, -> { order(:registered_name) }
 
   has_and_belongs_to_many :in_person_advice_methods
@@ -39,23 +45,13 @@ class Firm < ActiveRecord::Base
   before_validation :clear_blank_languages
   before_validation :deduplicate_languages
 
-  validates :email_address,
-    presence: true,
-    length: { maximum: 50 },
-    format: { with: /.+@.+\..+/ }
-
-  validates :telephone_number,
-    presence: true,
-    length: { maximum: 30 },
-    format: { with: /\A[0-9 ]+\z/ }
-
   validates :website_address,
     allow_blank: true,
     length: { maximum: 100 },
     format: { with: /\Ahttps?:\/\/\S+\.\S+/ }
 
   validates :free_initial_meeting,
-    inclusion: { in: [true, false] }
+    inclusion: { in: FREE_INITIAL_MEETING_VALID_VALUES }
 
   validates :initial_meeting_duration,
     presence: true,
@@ -131,17 +127,21 @@ class Firm < ActiveRecord::Base
   # This method is basically a cheap way to answer the question: has this
   # record ever been saved with validation enabled?
   def registered?
-    email_address.present?
+    # false is a valid value so we cannot use `.present?`
+    !(send(REGISTERED_MARKER_FIELD).nil?)
   end
 
-  enum status: { independent: 1, restricted: 2 }
-
-  def telephone_number
-    return nil unless self[:telephone_number]
-
-    self[:telephone_number].gsub(' ', '')
+  if Rails.env.test?
+    # A helper to shield tests from modifying the marker field directly
+    def __set_registered(state)
+      new_value = (state) ? REGISTERED_MARKER_FIELD_VALID_VALUES.first : nil
+      send("#{REGISTERED_MARKER_FIELD}=", new_value)
+    end
+    alias_method :__registered=, :__set_registered
   end
 
+  enum status: { independent: 1, restricted: 2 }
+
   def in_person_advice?
     in_person_advice_methods.present?
   end
@@ -155,8 +155,6 @@ class Firm < ActiveRecord::Base
 
   def field_order
     [
-      :email_address,
-      :telephone_number,
       :website_address,
       :address_line_one,
       :address_line_two,

data/app/serializers/firm_serializer.rb

@@ -40,6 +40,14 @@ class FirmSerializer < ActiveModel::Serializer
     object.advisers.geocoded
   end
 
+  def telephone_number
+    object.main_office.telephone_number
+  end
+
+  def email_address
+    object.main_office.email_address
+  end
+
   def postcode_searchable
     object.postcode_searchable?
   end

data/db/migrate/20150930140851_remove_firm_email_and_phone.rb

@@ -0,0 +1,26 @@
+class RemoveFirmEmailAndPhone < ActiveRecord::Migration
+  class Firm < ActiveRecord::Base; has_many :offices, -> { order created_at: :asc }; end
+  class Office < ActiveRecord::Base; belongs_to :firm; end
+
+  def up
+    remove_column :firms, :email_address
+    remove_column :firms, :telephone_number
+
+    # Data does not need to be migrated as the offices migration will have
+    # already copied these two fields into an office record.
+  end
+
+  def down
+    add_column :firms, :email_address, :string
+    add_column :firms, :telephone_number, :string
+
+    # Use the equivalent main office fields to repopulate
+    Firm.all.select { |f| f.offices.any? }.each do |firm|
+      main_office = firm.offices.first
+      firm.update!(
+        email_address: main_office.email_address,
+        telephone_number: main_office.telephone_number
+      )
+    end
+  end
+end

data/lib/mas/rad_core/version.rb

@@ -1,5 +1,5 @@
 module MAS
   module RadCore
-    VERSION = '0.0.81'
+    VERSION = '0.0.82'
   end
 end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150825090822) do
+ActiveRecord::Schema.define(version: 20150930140851) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -80,8 +80,6 @@ ActiveRecord::Schema.define(version: 20150825090822) do
   create_table "firms", force: :cascade do |t|
     t.integer  "fca_number",                                               null: false
     t.string   "registered_name",                                          null: false
-    t.string   "email_address"
-    t.string   "telephone_number"
     t.datetime "created_at",                                               null: false
     t.datetime "updated_at",                                               null: false
     t.boolean  "free_initial_meeting"
@@ -99,8 +97,8 @@ ActiveRecord::Schema.define(version: 20150825090822) do
     t.string   "website_address"
     t.boolean  "ethical_investing_flag",                   default: false, null: false
     t.boolean  "sharia_investing_flag",                    default: false, null: false
-    t.text     "languages",                                default: [],    null: false, array: true
     t.integer  "status"
+    t.text     "languages",                                default: [],    null: false, array: true
   end
 
   add_index "firms", ["initial_meeting_duration_id"], name: "index_firms_on_initial_meeting_duration_id", using: :btree

data/spec/factories/firm.rb

@@ -4,8 +4,6 @@ FactoryGirl.define do
   factory :firm, aliases: [:publishable_firm, :onboarded_firm] do
     fca_number
     registered_name
-    email_address { Faker::Internet.email }
-    telephone_number { Faker::Base.numerify('##### ### ###') }
     website_address { Faker::Internet.url }
     in_person_advice_methods { create_list(:in_person_advice_method, rand(1..3)) }
     free_initial_meeting { [true, false].sample }
@@ -49,6 +47,7 @@ FactoryGirl.define do
     factory :firm_with_advisers, traits: [:with_advisers]
     factory :firm_without_advisers, traits: [:without_advisers]
     factory :firm_with_offices, traits: [:with_offices]
+    factory :firm_without_offices, traits: [:without_offices]
     factory :firm_with_principal, traits: [:with_principal]
     factory :firm_with_no_business_split, traits: [:with_no_business_split]
     factory :firm_with_remote_advice, traits: [:with_remote_advice]
@@ -57,7 +56,8 @@ FactoryGirl.define do
     factory :invalid_firm, traits: [:invalid], aliases: [:not_onboarded_firm]
 
     trait :invalid do
-      email_address nil
+      # Invalidate the marker field without referencing it directly
+      __registered false
     end
 
     trait :with_no_business_split do
@@ -85,6 +85,10 @@ FactoryGirl.define do
       offices_count 3
     end
 
+    trait :without_offices do
+      offices_count 0
+    end
+
     trait :with_remote_advice do
       other_advice_methods { create_list(:other_advice_method, rand(1..3)) }
       in_person_advice_methods []

data/spec/models/firm_factory_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe 'Firm factory' do
     specify 'associations' do
       expect(subject.principal).not_to be_present
       expect(subject).to have(1).offices
-      expect(subject).to have(0).advisers
+      expect(subject).to have(:no).advisers
       expect(subject).to have(:no).trading_names
     end
   end
@@ -85,6 +85,25 @@ RSpec.describe 'Firm factory' do
     end
   end
 
+  describe 'factory :firm_without_offices' do
+    let(:factory) { :firm_without_offices }
+
+    specify 'expected status' do
+      expect(subject).to be_persisted
+      expect(subject).to be_valid
+      expect(subject).not_to be_publishable
+      expect(subject).not_to be_trading_name
+      expect(subject.primary_advice_method).to be(:local)
+    end
+
+    specify 'associations' do
+      expect(subject.principal).not_to be_present
+      expect(subject).to have(:no).offices
+      expect(subject).to have(1).advisers
+      expect(subject).to have(:no).trading_names
+    end
+  end
+
   describe 'factory :firm_with_trading_names' do
     let(:factory) { :firm_with_trading_names }
 

data/spec/models/firm_spec.rb

@@ -18,29 +18,19 @@ RSpec.describe Firm do
   end
 
   describe '#registered?' do
-    it 'is false if the firm has no email address' do
-      firm.email_address = nil
-      expect(firm).not_to be_registered
+    def set_marker_field(firm, value)
+      firm.send("#{Firm::REGISTERED_MARKER_FIELD}=", value)
     end
 
-    it 'is true if the firm has an email address' do
-      firm.email_address = 'acme@example.com'
-      expect(firm).to be_registered
+    it 'is false if the REGISTERED_MARKER_FIELD field is nil' do
+      set_marker_field(firm, nil)
+      expect(firm).not_to be_registered
     end
-  end
 
-  describe '#telephone_number' do
-    context 'when `nil`' do
-      it 'returns `nil`' do
-        expect(build(:firm, telephone_number: nil).telephone_number).to be_nil
-      end
-    end
-
-    context 'when provided' do
-      let(:firm) { build(:firm, telephone_number: ' 07715 930 457  ') }
-
-      it 'removes whitespace' do
-        expect(firm.telephone_number).to eq('07715930457')
+    it 'is true if the REGISTERED_MARKER_FIELD field has a valid value' do
+      Firm::REGISTERED_MARKER_FIELD_VALID_VALUES.each do |value|
+        set_marker_field(firm, value)
+        expect(firm).to be_registered
       end
     end
   end
@@ -185,34 +175,6 @@ RSpec.describe Firm do
       expect(firm.field_order).not_to be_empty
     end
 
-    describe 'email address' do
-      context 'when not present' do
-        before { firm.email_address = nil }
-
-        it { is_expected.to_not be_valid }
-      end
-
-      context 'when badly formatted' do
-        before { firm.email_address = 'not-valid' }
-
-        it { is_expected.to_not be_valid }
-      end
-    end
-
-    describe 'telephone number' do
-      context 'when not present' do
-        before { firm.telephone_number = nil }
-
-        it { is_expected.to_not be_valid }
-      end
-
-      context 'when badly formatted' do
-        before { firm.telephone_number = 'not-valid' }
-
-        it { is_expected.to_not be_valid }
-      end
-    end
-
     describe 'Website address' do
       context 'when provided' do
         it 'must not exceed 100 characters' do
@@ -450,7 +412,7 @@ RSpec.describe Firm do
       it 'the firm is published' do
         firm = create :firm
         allow(IndexFirmJob).to receive(:perform_later)
-        firm.update_attributes(email_address: 'bill@example.com')
+        firm.update_attributes(registered_name: 'A new name')
         firm.run_callbacks(:commit)
         expect(IndexFirmJob).to have_received(:perform_later).with(firm)
       end

data/spec/serializers/firm_serializer_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe FirmSerializer do
     end
 
     it 'exposes `telephone_number`' do
-      expect(subject[:telephone_number]).to eql(firm.telephone_number)
+      expect(subject[:telephone_number]).to eql(firm.main_office.telephone_number)
     end
 
     it 'exposes `website_address`' do
@@ -47,7 +47,7 @@ RSpec.describe FirmSerializer do
     end
 
     it 'exposes `email_address`' do
-      expect(subject[:email_address]).to eql(firm.email_address)
+      expect(subject[:email_address]).to eql(firm.main_office.email_address)
     end
 
     it 'exposes `free_initial_meeting`' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mas-rad_core
 version: !ruby/object:Gem::Version
-  version: 0.0.81
+  version: 0.0.82
 platform: ruby
 authors:
 - Ben Lovell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -305,6 +305,7 @@ files:
 - db/migrate/20150813103046_remove_confirmed_disclaimer_from_advisers.rb
 - db/migrate/20150817141257_add_status_to_firms.rb
 - db/migrate/20150825090822_move_firm_address_to_office.rb
+- db/migrate/20150930140851_remove_firm_email_and_phone.rb
 - lib/mas/adviser_result.rb
 - lib/mas/elastic_search_client.rb
 - lib/mas/firm_repository.rb