Merge branch 'initial_request_text-2' into rails-3-develop

7 files changed, 166 insertions, 41 deletions

diff --git a/app/models/censor_rule.rb b/app/models/censor_rule.rb
index 3b5c2d805..58170f237 100644
--- a/app/models/censor_rule.rb
+++ b/app/models/censor_rule.rb
@@ -42,6 +42,11 @@ class CensorRule < ActiveRecord::Base
                                       :user_id => nil,
                                       :public_body_id => nil } }
 
+    def apply_to_text(text_to_censor)
+        return nil if text_to_censor.nil?
+        text_to_censor.gsub(to_replace, replacement)
+    end
+
     def apply_to_text!(text_to_censor)
         return nil if text_to_censor.nil?
         text_to_censor.gsub!(to_replace, replacement)
diff --git a/app/models/info_request.rb b/app/models/info_request.rb
index 0ca3a1279..01d5f5c52 100644
--- a/app/models/info_request.rb
+++ b/app/models/info_request.rb
@@ -804,8 +804,9 @@ public
 
     # Text from the the initial request, for use in summary display
     def initial_request_text
-        return '' if outgoing_messages.empty? # mainly for use with incomplete fixtures
-        outgoing_messages.first.get_text_for_indexing
+        return '' if outgoing_messages.empty?
+        body_opts = { :censor_rules => applicable_censor_rules }
+        outgoing_messages.first.try(:get_text_for_indexing, true, body_opts) or ''
     end
 
     # Returns index of last event which is described or nil if none described.
diff --git a/app/models/outgoing_message.rb b/app/models/outgoing_message.rb
index c2c8ef4f2..4f6318b3d 100644
--- a/app/models/outgoing_message.rb
+++ b/app/models/outgoing_message.rb
@@ -140,22 +140,28 @@ class OutgoingMessage < ActiveRecord::Base
         end
     end
 
-    def body
-        ret = read_attribute(:body)
-        if ret.nil?
-            return ret
+    # Public: The body text of the OutgoingMessage. The text is cleaned and
+    # CensorRules are applied.
+    #
+    # options - Hash of options
+    #           :censor_rules - Array of CensorRules to apply. Defaults to the
+    #                           applicable_censor_rules of the associated
+    #                           InfoRequest. (optional)
+    #
+    # Returns a String
+    def body(options = {})
+        text = raw_body.dup
+        return text if text.nil?
+
+        text = clean_text(text)
+
+        # Use the given censor_rules; otherwise fetch them from the associated
+        # info_request
+        censor_rules = options.fetch(:censor_rules) do
+            info_request.try(:applicable_censor_rules) or []
         end
 
-        ret = ret.dup
-        ret.strip!
-        ret.gsub!(/(?:\n\s*){2,}/, "\n\n") # remove excess linebreaks that unnecessarily space it out
-
-        # Remove things from censor rules
-        unless info_request.nil?
-            self.info_request.apply_censor_rules_to_text!(ret)
-        end
-
-        ret
+        censor_rules.reduce(text) { |text, rule| rule.apply_to_text(text) }
     end
 
     def raw_body
@@ -227,8 +233,12 @@ class OutgoingMessage < ActiveRecord::Base
     end
 
     # Returns text for indexing / text display
-    def get_text_for_indexing(strip_salutation = true)
-        text = body.strip
+    def get_text_for_indexing(strip_salutation = true, opts = {})
+        if opts.empty?
+            text = body.strip
+        else
+            text = body(opts).strip
+        end
 
         # Remove salutation
         text.sub!(/Dear .+,/, "") if strip_salutation
@@ -332,6 +342,11 @@ class OutgoingMessage < ActiveRecord::Base
             errors.add(:what_doing_dummy, _('Please choose what sort of reply you are making.'))
         end
     end
+
+    # remove excess linebreaks that unnecessarily space it out
+    def clean_text(text)
+        text.strip.gsub(/(?:\n\s*){2,}/, "\n\n")
+    end
 end
 
 
diff --git a/spec/factories/info_requests.rb b/spec/factories/info_requests.rb
index 8052625cd..ee96bfa89 100644
--- a/spec/factories/info_requests.rb
+++ b/spec/factories/info_requests.rb
@@ -1,7 +1,7 @@
 FactoryGirl.define do
 
     factory :info_request do
-        title "Example Title"
+        sequence(:title) { |n| "Example Title #{n}" }
         public_body
         user
 
diff --git a/spec/integration/download_request_spec.rb b/spec/integration/download_request_spec.rb
index 48b42b11d..c73b85866 100644
--- a/spec/integration/download_request_spec.rb
+++ b/spec/integration/download_request_spec.rb
@@ -143,7 +143,8 @@ describe 'when making a zipfile available' do
 
         it "should update the contents of the zipfile when the request changes" do
 
-            info_request = FactoryGirl.create(:info_request_with_incoming)
+            info_request = FactoryGirl.create(:info_request_with_incoming,
+                                              :title => 'Example Title')
             request_owner = login(info_request.user)
             inspect_zip_download(request_owner, info_request) do |zip|
                 zip.count.should == 1 # just the message
diff --git a/spec/models/censor_rule_spec.rb b/spec/models/censor_rule_spec.rb
index 4ecd2d3e1..77b8cd07a 100644
--- a/spec/models/censor_rule_spec.rb
+++ b/spec/models/censor_rule_spec.rb
@@ -17,6 +17,42 @@
 
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
+describe CensorRule do
+
+    describe :apply_to_text do
+
+        it 'applies the rule to the text' do
+            rule = FactoryGirl.build(:censor_rule, :text => 'secret')
+            text = 'Some secret text'
+            expect(rule.apply_to_text(text)).to eq('Some [REDACTED] text')
+        end
+
+        it 'does not mutate the input' do
+            rule = FactoryGirl.build(:censor_rule, :text => 'secret')
+            text = 'Some secret text'
+            rule.apply_to_text(text)
+            expect(text).to eq('Some secret text')
+        end
+
+        it 'returns the text if the rule is unmatched' do
+            rule = FactoryGirl.build(:censor_rule, :text => 'secret')
+            text = 'Some text'
+            expect(rule.apply_to_text(text)).to eq('Some text')
+        end
+    end
+
+    describe :apply_to_text! do
+
+        it 'mutates the input' do
+            rule = FactoryGirl.build(:censor_rule, :text => 'secret')
+            text = 'Some secret text'
+            rule.apply_to_text!(text)
+            expect(text).to eq('Some [REDACTED] text')
+        end
+
+    end
+end
+
 describe CensorRule, "substituting things" do
 
     describe 'when using a text rule' do
diff --git a/spec/models/outgoing_message_spec.rb b/spec/models/outgoing_message_spec.rb
index a3e2d1c68..051f263d2 100644
--- a/spec/models/outgoing_message_spec.rb
+++ b/spec/models/outgoing_message_spec.rb
@@ -18,6 +18,93 @@
 
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
+describe OutgoingMessage do
+
+    describe :initialize do
+
+        it 'does not censor the #body' do
+          attrs = { :status => 'ready',
+                    :message_type => 'initial_request',
+                    :body => 'abc',
+                    :what_doing => 'normal_sort' }
+
+          message = FactoryGirl.create(:outgoing_message, attrs)
+
+          OutgoingMessage.any_instance.should_not_receive(:body).and_call_original
+          OutgoingMessage.find(message.id)
+        end
+
+    end
+
+    describe :body do
+
+        it 'returns the body attribute' do
+            attrs = { :status => 'ready',
+                      :message_type => 'initial_request',
+                      :body => 'abc',
+                      :what_doing => 'normal_sort' }
+
+            message = FactoryGirl.build(:outgoing_message, attrs)
+            expect(message.body).to eq('abc')
+        end
+
+        it 'strips the body of leading and trailing whitespace' do
+            attrs = { :status => 'ready',
+                      :message_type => 'initial_request',
+                      :body => ' abc ',
+                      :what_doing => 'normal_sort' }
+
+            message = FactoryGirl.build(:outgoing_message, attrs)
+            expect(message.body).to eq('abc')
+        end
+
+        it 'removes excess linebreaks that unnecessarily space it out' do
+            attrs = { :status => 'ready',
+                      :message_type => 'initial_request',
+                      :body => "ab\n\nc\n\n",
+                      :what_doing => 'normal_sort' }
+
+            message = FactoryGirl.build(:outgoing_message, attrs)
+            expect(message.body).to eq("ab\n\nc")
+        end
+
+        it "applies the associated request's censor rules to the text" do
+            attrs = { :status => 'ready',
+                      :message_type => 'initial_request',
+                      :body => 'This sensitive text contains secret info!',
+                      :what_doing => 'normal_sort' }
+            message = FactoryGirl.build(:outgoing_message, attrs)
+
+            rules = [FactoryGirl.build(:censor_rule, :text => 'secret'),
+                     FactoryGirl.build(:censor_rule, :text => 'sensitive')]
+            InfoRequest.any_instance.stub(:censor_rules).and_return(rules)
+
+            expected = 'This [REDACTED] text contains [REDACTED] info!'
+            expect(message.body).to eq(expected)
+        end
+
+        it "applies the given censor rules to the text" do
+            attrs = { :status => 'ready',
+                      :message_type => 'initial_request',
+                      :body => 'This sensitive text contains secret info!',
+                      :what_doing => 'normal_sort' }
+            message = FactoryGirl.build(:outgoing_message, attrs)
+
+            request_rules = [FactoryGirl.build(:censor_rule, :text => 'secret'),
+                             FactoryGirl.build(:censor_rule, :text => 'sensitive')]
+            InfoRequest.any_instance.stub(:censor_rules).and_return(request_rules)
+
+            censor_rules = [FactoryGirl.build(:censor_rule, :text => 'text'),
+                            FactoryGirl.build(:censor_rule, :text => 'contains')]
+
+            expected = 'This sensitive [REDACTED] [REDACTED] secret info!'
+            expect(message.body(:censor_rules => censor_rules)).to eq(expected)
+        end
+
+    end
+
+end
+
 describe OutgoingMessage, " when making an outgoing message" do
 
     before do
@@ -57,6 +144,7 @@ describe OutgoingMessage, " when making an outgoing message" do
         info_request = mock_model(InfoRequest, :public_body => public_body,
                                                :url_title => 'a_test_title',
                                                :title => 'A test title',
+                                               :applicable_censor_rules => [],
                                                :apply_censor_rules_to_text! => nil,
                                                :is_batch_request_template? => false)
         outgoing_message = OutgoingMessage.new({
@@ -155,27 +243,6 @@ describe OutgoingMessage, " when making an outgoing message" do
     end
 end
 
-
-describe OutgoingMessage, " when censoring data" do
-
-    before do
-        @om = outgoing_messages(:useless_outgoing_message)
-
-        @censor_rule = CensorRule.new()
-        @censor_rule.text = "dog"
-        @censor_rule.replacement = "cat"
-        @censor_rule.last_edit_editor = "unknown"
-        @censor_rule.last_edit_comment = "none"
-
-        @om.info_request.censor_rules << @censor_rule
-    end
-
-    it "should apply censor rules to outgoing messages" do
-        @om.read_attribute(:body).should match(/fancy dog/)
-        @om.body.should match(/fancy cat/)
-    end
-end
-
 describe OutgoingMessage, "when validating the format of the message body" do
 
     it 'should handle a salutation with a bracket in it' do