Merge pull request #4653 from alphagov/refactor-arrested-abroad

theseanything · web-flow · commit ac4c59a5ceac · 2020-10-30T14:19:38.000Z
Move arrested abroad flow logic to calculator class
diff --git a/lib/smart_answer/calculators/arrested_abroad.rb b/lib/smart_answer/calculators/arrested_abroad.rb
@@ -1,41 +1,101 @@
 module SmartAnswer::Calculators
   class ArrestedAbroad
     # created for the help-if-you-are-arrested-abroad calculator
-    attr_reader :data
-
-    def initialize
-      @data = self.class.prisoner_packs
-    end
-
-    def generate_url_for_download(country, field, text)
-      country_data = @data.find { |c| c["slug"] == country }
-      return "" unless country_data
-
-      url = country_data[field]
-      output = []
-      if url
-        urls = url.split(" ")
-        urls.each do |u|
-          new_link = "- [#{text}](#{u})"
-          new_link += '{:rel="external"}' if u.include? "http"
-          output.push(new_link)
-        end
-        output.join("\n")
-      else
-        ""
+    attr_reader :country
+
+    PRISONER_PACKS = YAML.load_file(Rails.root.join("config/smart_answers/prisoner_packs.yml")).freeze
+    COUNTRIES_WITH_REGIONS = %w[cyprus].freeze
+    COUNTRIES_WITHOUT_TRANFSERS_BACK = %w[austria belgium croatia denmark finland hungary italy latvia luxembourg malta netherlands slovakia].freeze
+
+    def initialize(country)
+      @country = country
+    end
+
+    def country_data
+      @country_data ||= PRISONER_PACKS.find { |c| c["slug"] == country }
+    end
+
+    def generate_url_for_download(field, text)
+      return "" unless country_data && country_data[field]
+
+      urls = country_data[field].split(" ")
+      output = urls.map do |url|
+        new_link = "- [#{text}](#{url})"
+        new_link += '{:rel="external"}' if url.include? "http"
+        new_link
       end
+      output.join("\n")
+    end
+
+    def get_country_regions
+      country_data["regions"]
+    end
+
+    def location
+      @location ||= WorldLocation.find(country)
+      raise InvalidResponse unless @location
+
+      @location
+    end
+
+    def organisation
+      location.fco_organisation
+    end
+
+    def country_name
+      location.name
+    end
+
+    def pdf
+      generate_url_for_download("pdf", "Prisoner pack for #{country_name}")
     end
 
-    def self.prisoner_packs
-      @prisoner_packs ||= YAML.load_file(Rails.root.join("config/smart_answers/prisoner_packs.yml"))
+    def doc
+      generate_url_for_download("doc", "Prisoner pack for #{country_name}")
     end
 
-    def countries_with_regions
-      %w[cyprus]
+    def benefits
+      generate_url_for_download("benefits", "Benefits or legal aid in #{country_name}")
+    end
+
+    def prison
+      generate_url_for_download("prison", "Information on prisons and prison procedures in #{country_name}")
+    end
+
+    def judicial
+      generate_url_for_download("judicial", "Information on the judicial system and procedures in #{country_name}")
+    end
+
+    def police
+      generate_url_for_download("police", "Information on the police and police procedures in #{country_name}")
+    end
+
+    def consul
+      generate_url_for_download("consul", "Consul help available in #{country_name}")
+    end
+
+    def lawyer
+      generate_url_for_download("lawyer", "English speaking lawyers and translators/interpreters in #{country_name}")
+    end
+
+    def has_extra_downloads
+      extra_downloads = [police, judicial, consul, prison, lawyer, benefits, doc, pdf]
+
+      extra_downloads.any?(&:present?) || COUNTRIES_WITH_REGIONS.include?(country)
+    end
+
+    def region_downloads
+      return "" unless COUNTRIES_WITH_REGIONS.include?(country)
+
+      links = get_country_regions.values.map do |region|
+        "- [#{region['url_text']}](#{region['link']})"
+      end
+
+      links.join("\n")
     end
 
-    def get_country_regions(slug)
-      @data.find { |c| c["slug"] == slug }["regions"]
+    def transfer_back
+      COUNTRIES_WITHOUT_TRANFSERS_BACK.exclude?(country)
     end
   end
 end
diff --git a/lib/smart_answer_flows/help-if-you-are-arrested-abroad.rb b/lib/smart_answer_flows/help-if-you-are-arrested-abroad.rb
@@ -7,76 +7,13 @@ def define
       status :published
       satisfies_need "de7bf117-408b-4b26-8e08-7aa51415b4e2"
 
-      arrested_calc = Calculators::ArrestedAbroad.new
       exclude_countries = %w[holy-see british-antarctic-territory]
       british_overseas_territories = %w[anguilla bermuda british-indian-ocean-territory british-virgin-islands cayman-islands falkland-islands gibraltar montserrat pitcairn-island st-helena-ascension-and-tristan-da-cunha south-georgia-and-the-south-sandwich-islands turks-and-caicos-islands]
 
       # Q1
       country_select :which_country?, exclude_countries: exclude_countries do
-        save_input_as :country
-
-        calculate :location do
-          loc = WorldLocation.find(country)
-          raise InvalidResponse unless loc
-
-          loc
-        end
-
-        calculate :organisation do
-          location.fco_organisation
-        end
-
-        calculate :country_name do
-          location.name
-        end
-
-        calculate :pdf do
-          arrested_calc.generate_url_for_download(country, "pdf", "Prisoner pack for #{country_name}")
-        end
-
-        calculate :doc do
-          arrested_calc.generate_url_for_download(country, "doc", "Prisoner pack for #{country_name}")
-        end
-
-        calculate :benefits do
-          arrested_calc.generate_url_for_download(country, "benefits", "Benefits or legal aid in #{country_name}")
-        end
-
-        calculate :prison do
-          arrested_calc.generate_url_for_download(country, "prison", "Information on prisons and prison procedures in #{country_name}")
-        end
-
-        calculate :judicial do
-          arrested_calc.generate_url_for_download(country, "judicial", "Information on the judicial system and procedures in #{country_name}")
-        end
-
-        calculate :police do
-          arrested_calc.generate_url_for_download(country, "police", "Information on the police and police procedures in #{country_name}")
-        end
-
-        calculate :consul do
-          arrested_calc.generate_url_for_download(country, "consul", "Consul help available in #{country_name}")
-        end
-
-        calculate :lawyer do
-          arrested_calc.generate_url_for_download(country, "lawyer", "English speaking lawyers and translators/interpreters in #{country_name}")
-        end
-
-        calculate :has_extra_downloads do
-          [police, judicial, consul, prison, lawyer, benefits, doc, pdf].count { |x|
-            x != ""
-          }.positive? || arrested_calc.countries_with_regions.include?(country)
-        end
-
-        calculate :region_links do
-          links = []
-          if arrested_calc.countries_with_regions.include?(country)
-            regions = arrested_calc.get_country_regions(country)
-            regions.each_value do |val|
-              links << "- [#{val['url_text']}](#{val['link']})"
-            end
-          end
-          links
+        on_response do |response|
+          self.calculator = Calculators::ArrestedAbroad.new(response)
         end
 
         next_node do |response|
@@ -90,19 +27,7 @@ def define
         end
       end
 
-      outcome :answer_one_generic do
-        precalculate :iran do
-          country_name == "Iran"
-        end
-
-        precalculate :transfers_back_to_uk_treaty_change_countries do
-          %w[austria belgium croatia denmark finland hungary italy latvia luxembourg malta netherlands slovakia]
-        end
-
-        precalculate :region_downloads do
-          region_links.join("\n")
-        end
-      end
+      outcome :answer_one_generic
 
       outcome :answer_three_syria
 
diff --git a/lib/smart_answer_flows/help-if-you-are-arrested-abroad/outcomes/answer_one_generic.erb b/lib/smart_answer_flows/help-if-you-are-arrested-abroad/outcomes/answer_one_generic.erb
@@ -33,27 +33,27 @@
   - helping British prisoners apply for a transfer to UK where possible
   - visiting prisoners when needed
 
-  <% if has_extra_downloads %>
+  <% if calculator.has_extra_downloads %>
     ##Download prisoner packs and other helpful information
 
     The FCDO has produced guides explaining the legal and prison system in different countries for British nationals arrested abroad.
 
-    <%= pdf %>
-    <%= doc %>
-    <%= benefits %>
-    <%= judicial %>
-    <%= prison %>
-    <%= police %>
-    <%= consul %>
-    <%= lawyer %>
+    <%= calculator.pdf %>
+    <%= calculator.doc %>
+    <%= calculator.benefits %>
+    <%= calculator.judicial %>
+    <%= calculator.prison %>
+    <%= calculator.police %>
+    <%= calculator.consul %>
+    <%= calculator.lawyer %>
 
-    <%= region_downloads %>
+    <%= calculator.region_downloads %>
   <% end %>
 
-  <% if iran %>
-    <%= render partial: 'iran_downloads', locals: { transfer_back: transfers_back_to_uk_treaty_change_countries.exclude?(country) } %>
+  <% if calculator.country_name == "Iran" %>
+    <%= render partial: 'iran_downloads', locals: { transfer_back: calculator.transfer_back } %>
   <% else %>
-    <%= render partial: 'common_downloads', locals: { transfer_back: transfers_back_to_uk_treaty_change_countries.exclude?(country) } %>
+    <%= render partial: 'common_downloads', locals: { transfer_back: calculator.transfer_back } %>
   <% end %>
 
   ##What the FCDO and British consulate can’t do
diff --git a/test/integration/smart_answer_flows/help_if_you_are_arrested_abroad_test.rb b/test/integration/smart_answer_flows/help_if_you_are_arrested_abroad_test.rb
@@ -7,7 +7,7 @@ class HelpIfYouAreArrestedAbroadTest < ActiveSupport::TestCase
   include FlowTestHelper
 
   setup do
-    @location_slugs = %w[aruba belgium greece iran syria democratic-republic-of-the-congo]
+    @location_slugs = %w[aruba belgium bermuda greece iran syria democratic-republic-of-the-congo]
     stub_world_locations(@location_slugs)
     setup_for_testing_flow SmartAnswer::HelpIfYouAreArrestedAbroadFlow
   end
@@ -18,56 +18,41 @@ class HelpIfYouAreArrestedAbroadTest < ActiveSupport::TestCase
 
   context "In a country with a prisoner pack" do
     context "Answering with a country without any specific downloads / information" do
-      context "Answering Aruba" do
-        setup do
-          add_response :aruba
-        end
-
-        should "take the user to the generic answer" do
-          assert_current_node :answer_one_generic
-        end
-
-        should "correctly calculate and store the country variables" do
-          assert_state_variable :country, "aruba"
-          assert_state_variable :country_name, "Aruba"
-        end
-
-        should "correctly set up phrase lists" do
-          assert_state_variable :has_extra_downloads, false
-        end
-      end # context: Andorra
-    end # context: country without specific info
+      should "take the user to the generic answer" do
+        add_response :aruba
+        assert_current_node :answer_one_generic
+      end
+    end
 
     context "Answering with a country that has specific downloads / information" do
       context "Answering Democratic Republic of the Congo" do
-        setup do
-          add_response :"democratic-republic-of-the-congo"
-        end
-
         should "take the user to the generic answer" do
+          add_response :"democratic-republic-of-the-congo"
           assert_current_node :answer_one_generic
-        end
-
-        should "set up the country specific downloads" do
-          assert_state_variable :has_extra_downloads, true
+          assert_select outcome_body, "h2", /Download prisoner packs/
         end
       end
 
       context "Answering Greece" do
-        setup do
-          add_response :greece
-        end
-
         should "take the user to the generic answer" do
+          add_response :greece
           assert_current_node :answer_one_generic
-        end
-
-        should "set up the country specific downloads" do
-          assert_state_variable :has_extra_downloads, true
+          assert_select outcome_body, "h2", /Download prisoner packs/
         end
       end
-    end # context: country with specific info
-  end # context: non special case
+    end
+  end
+
+  context "In Iran" do
+    setup do
+      add_response :iran
+    end
+
+    should "take the user to the generic anwser with Iran specific downloads" do
+      assert_current_node :answer_one_generic
+      assert_select outcome_body, "a", /imprisoned in Iran/
+    end
+  end
 
   context "In Syria" do
     setup do
@@ -78,4 +63,11 @@ class HelpIfYouAreArrestedAbroadTest < ActiveSupport::TestCase
       assert_current_node :answer_three_syria
     end
   end
+
+  context "In a British overseas territory" do
+    setup do
+      add_response :bermuda
+      assert_current_node :answer_three_british_overseas_territories
+    end
+  end
 end
diff --git a/test/test_helper.rb b/test/test_helper.rb
@@ -43,6 +43,7 @@ class ActiveSupport::TestCase
   include GdsApi::TestHelpers::Imminence
   include GdsApi::TestHelpers::PublishingApi
   include GdsApi::TestHelpers::Worldwide
+  include ActionDispatch::Assertions
   parallelize workers: 6
 end
 
diff --git a/test/unit/calculators/arrested_abroad_calculator_test.rb b/test/unit/calculators/arrested_abroad_calculator_test.rb

-Original file line number
+Diff line change
 module SmartAnswer::Calculators
   class ArrestedAbroadCalculatorTest < ActiveSupport::TestCase
     context ArrestedAbroad do
 -      setup do
 -        @calc = ArrestedAbroad.new
 -      end
+-
       context "generating a URL" do
         should "not error if the country doesn't exist" do
           assert_nothing_raised do
 -            @calc.generate_url_for_download("doesntexist", "pdf", "hello world")
 +            calc = ArrestedAbroad.new("doesntexist")
 +            calc.generate_url_for_download("pdf", "hello world")
           end
         end
         should "generate link if country exists" do
 -          link = @calc.generate_url_for_download("argentina", "pdf", "Prisoner pack")
 +          calc = ArrestedAbroad.new("argentina")
 +          link = calc.generate_url_for_download("pdf", "Prisoner pack")
           assert_equal "- [Prisoner pack](/government/publications/argentina-prisoner-pack)", link
         end
         should "not include external tag if URL is internal" do
 -          link = @calc.generate_url_for_download("israel", "pdf", "Foo")
 +          calc = ArrestedAbroad.new("israel")
 +          link = calc.generate_url_for_download("pdf", "Foo")
           assert_not link.include?("{:rel=\"external\"}")
         end
       end
 +      context "has extra downloads" do
 +        should "return true for countries with regions" do
 +          calc = ArrestedAbroad.new("cyprus")
 +          calc.stubs(:country_name).returns("Cyprus")
 +          assert calc.has_extra_downloads
 +        end
++
 +        should "return false if not a country with regions nor has extra download links" do
 +          calc = ArrestedAbroad.new("bermuda")
 +          calc.stubs(:country_name).returns("Bermuda")
 +          assert_not calc.has_extra_downloads
 +        end
++
 +        should "return true if country has extra download links" do
 +          calc = ArrestedAbroad.new("australia")
 +          calc.stubs(:country_name).returns("Australia")
 +          assert calc.has_extra_downloads
 +        end
 +      end
++
 +      context "region downloads" do
 +        should "return list of region links for countries with regions" do
 +          calc = ArrestedAbroad.new("cyprus")
 +          calc.stubs(:get_country_regions).returns({
 +            "a": { "url_text" => "Text 1", "link" => "link1" },
 +            "b": { "url_text" => "Text 2", "link" => "link2" },
 +          })
 +          assert_equal calc.region_downloads, "- [Text 1](link1)\n- [Text 2](link2)"
 +        end
++
 +        should "return empty for countries without regions" do
 +          calc = ArrestedAbroad.new("bermuda")
 +          assert_equal calc.region_downloads, ""
 +        end
 +      end
++
       context "countries with regions" do
         should "pull out regions of the YML for Cyprus" do
 -          resp = @calc.get_country_regions("cyprus")
 +          calc = ArrestedAbroad.new("cyprus")
 +          resp = calc.get_country_regions
           assert resp["north"]
           assert resp["north_lawyer"]
           assert resp["republic"]
           assert resp["republic_lawyers"]
         end
         should "pull the regions out of the YML for Cyprus" do
 -          resp = @calc.get_country_regions("cyprus")["north"]
 +          calc = ArrestedAbroad.new("cyprus")
 +          resp = calc.get_country_regions["north"]
           expected = {
             "link" => "/government/publications/cyprus-north-prisoner-pack",
             "url_text" => "Prisoner pack for the north of Cyprus",