govuk_content_models 8.3.1 → 8.4.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 8.4.0
+
+Add support for attachments to SpecialistDocumentEdition.
+
 ## 8.3.1
 
 Added `Edition#locked_for_edits?`

data/app/models/attachment.rb

@@ -0,0 +1,22 @@
+require 'attachable'
+
+class Attachment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Attachable
+
+  field :title
+  field :filename
+  attaches :file
+
+  validates_with SafeHtml
+
+  def url
+    file.file_url
+  end
+
+  # TODO: Move this to a domain object in specialist publisher
+  def snippet
+    "[InlineAttachment:#{filename}]"
+  end
+end

data/app/models/specialist_document_edition.rb

@@ -1,4 +1,5 @@
 require "fact_check_address"
+require "state_machine"
 
 class SpecialistDocumentEdition
   include Mongoid::Document
@@ -22,6 +23,8 @@ class SpecialistDocumentEdition
 
   field :state, type: String
 
+  embeds_many :attachments, cascade_callbacks: true
+
   state_machine initial: :draft do
     event :publish do
       transition draft: :published
@@ -75,4 +78,10 @@ class SpecialistDocumentEdition
   def latest_edition?
     subsequent_siblings.empty?
   end
+
+  def build_attachment(attributes)
+    attachments.build(attributes.merge(
+      filename: attributes.fetch(:file).original_filename
+    ))
+  end
 end

data/app/validators/safe_html.rb

@@ -18,7 +18,7 @@ class SafeHtml < ActiveModel::Validator
   end
 
   def check_string(record, field_name, string)
-    if record.class::GOVSPEAK_FIELDS.include?(field_name)
+    if govspeak_fields(record).include?(field_name)
       unless Govspeak::Document.new(string).valid?
         error = "cannot include invalid Govspeak or JavaScript"
         record.errors.add(field_name, error)
@@ -30,4 +30,13 @@ class SafeHtml < ActiveModel::Validator
       end
     end
   end
+
+private
+  def govspeak_fields(record)
+    if record.class.const_defined?(:GOVSPEAK_FIELDS)
+      record.class.const_get(:GOVSPEAK_FIELDS)
+    else
+      []
+    end
+  end
 end

data/lib/govuk_content_models/version.rb

@@ -1,4 +1,4 @@
 module GovukContentModels
   # Changing this causes Jenkins to tag and release the gem into the wild
-  VERSION = "8.3.1"
+  VERSION = "8.4.0"
 end

data/test/models/attachment_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+require "ostruct"
+require 'gds_api/test_helpers/asset_manager'
+
+class AttachmentTest < ActiveSupport::TestCase
+  include GdsApi::TestHelpers::AssetManager
+
+  setup do
+    @original_asset_api_client = Attachable.asset_api_client
+    Attachable.asset_api_client = stub("asset_api_client")
+  end
+
+  teardown do
+    Attachable.asset_api_client = @original_asset_api_client
+  end
+
+  should "generate a snippet" do
+    attachment = Attachment.new(
+      title: "Supporting attachment",
+      filename: "document.pdf"
+    )
+    expected_snippet = "[InlineAttachment:document.pdf]"
+
+    assert_equal expected_snippet, attachment.snippet
+  end
+
+  should "return the url via #url" do
+    attachment = Attachment.new(
+      title: "Photo of me",
+      filename: "photo.jpg",
+      file_id: "test-id"
+    )
+
+    asset_url = stub("asset url")
+    asset_response = stub("asset response", file_url: asset_url)
+    Attachable.asset_api_client
+      .stubs(:asset)
+      .with(attachment.file_id)
+      .returns(asset_response)
+
+    assert_equal asset_url, attachment.url
+  end
+end

data/test/models/specialist_document_edition_test.rb

@@ -3,35 +3,81 @@
 require "test_helper"
 
 class SpecialistDocumentEditionTest < ActiveSupport::TestCase
-  should "have correct fields" do
-    fields = {
+  def basic_edition_fields
+    {
       slug: 'cma-cases/merger-investigation-2014',
       title: "Merger Investigation 2014",
       summary: "This is the summary of stuff going on in the Merger Investigation 2014",
-      state: "published"
+      state: "published",
+      body: "A body",
+      opened_date: '2012-04-21',
+      document_id: 'a-document-id',
+      market_sector: 'oil-and-gas',
+      case_type: 'some-case-type',
+      case_state: 'open'
     }
+  end
+
+  setup do
+    @original_asset_api_client = Attachable.asset_api_client
+    Attachable.asset_api_client = stub("asset_api_client")
+  end
+
+  teardown do
+    Attachable.asset_api_client = @original_asset_api_client
+  end
 
-    edition = SpecialistDocumentEdition.new(fields)
+  should "have correct fields" do
+    edition = SpecialistDocumentEdition.new(basic_edition_fields)
 
-    assert_equal fields[:title], edition.title
+    assert_equal basic_edition_fields[:title], edition.title
   end
 
   should "be persistable" do
-    edition = SpecialistDocumentEdition.create!(
-      slug: 'cma-cases/merger-investigation-2014',
-      title: "Merger Investigation 2014",
-      summary: "This is the summary of stuff going on in the Merger Investigation 2014",
-      body: "A body",
-      opened_date: '2012-04-21',
-      market_sector: 'oil-and-gas',
-      case_type: 'some-case-type',
-      case_state: 'open',
-      state: "published",
-      document_id: 'a-document-id'
-    )
+    edition = SpecialistDocumentEdition.create!(basic_edition_fields)
 
     found = SpecialistDocumentEdition.where(slug: edition.slug).first
     assert_equal found.attributes, edition.attributes
   end
+
+  context "building attachments" do
+    should "build an attachment" do
+      edition = SpecialistDocumentEdition.new
+      file = OpenStruct.new(original_filename: "document.pdf")
+
+      edition.build_attachment(title: "baz", file: file)
+
+      attachment = edition.attachments.first
+      assert_equal "baz", attachment.title
+      assert_equal "document.pdf", attachment.filename
+      assert_equal file, attachment.instance_variable_get(:@file_file)
+    end
+
+    should "persist attachment record when document saved" do
+      Attachable.asset_api_client.stubs(:create_asset)
+
+      edition = SpecialistDocumentEdition.new(basic_edition_fields)
+      file = OpenStruct.new(original_filename: "document.pdf")
+
+      edition.build_attachment(title: "baz", file: file)
+      edition.save!
+
+      found = SpecialistDocumentEdition.where(slug: edition.slug).first
+
+      assert_equal 1, found.attachments.count
+      assert_equal "baz", found.attachments.first.title
+    end
+
+    should "transmit attached file to asset manager when document saved" do
+      edition = SpecialistDocumentEdition.new(basic_edition_fields)
+      file = OpenStruct.new(original_filename: "document.pdf")
+
+      success_response = stub("asset manager response", id: "/test-id")
+      Attachable.asset_api_client.expects(:create_asset).with(file: file).returns(success_response)
+
+      edition.build_attachment(title: "baz", file: file)
+      edition.save!
+    end
+  end
 end
 

data/test/validators/safe_html_validator_test.rb

@@ -73,14 +73,16 @@ class SafeHtmlTest < ActiveSupport::TestCase
     should "all models should use this validator" do
       models_dir = File.expand_path("../../app/models/*", File.dirname(__FILE__))
 
-      classes = Dir[models_dir].map do |file|
-        klass = File.basename(file, ".rb").camelize.constantize
-        klass.included_modules.include?(Mongoid::Document) ? klass : nil
-      end.compact
-
-      classes.each do |klass|
-        assert_includes klass.validators.map(&:class), SafeHtml, "#{klass} must be validated with SafeHtml"
-      end
+      classes = Dir[models_dir]
+        .map { |file|
+          File.basename(file, ".rb").camelize.constantize
+        }
+        .select { |klass|
+          klass.included_modules.include?(Mongoid::Document)
+        }
+        .each { |klass|
+          assert_includes klass.validators.map(&:class), SafeHtml, "#{klass} must be validated with SafeHtml"
+        }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -348,6 +348,7 @@ files:
 - app/models/artefact.rb
 - app/models/artefact_action.rb
 - app/models/artefact_external_link.rb
+- app/models/attachment.rb
 - app/models/business_support/business_size.rb
 - app/models/business_support/business_type.rb
 - app/models/business_support/location.rb
@@ -407,6 +408,7 @@ files:
 - test/models/artefact_external_link_test.rb
 - test/models/artefact_tag_test.rb
 - test/models/artefact_test.rb
+- test/models/attachment_test.rb
 - test/models/business_support/business_size_test.rb
 - test/models/business_support/business_type_test.rb
 - test/models/business_support/location_test.rb
@@ -458,7 +460,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1454853110289158325
+      hash: 4061637163716751307
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -467,7 +469,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1454853110289158325
+      hash: 4061637163716751307
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -481,6 +483,7 @@ test_files:
 - test/models/artefact_external_link_test.rb
 - test/models/artefact_tag_test.rb
 - test/models/artefact_test.rb
+- test/models/attachment_test.rb
 - test/models/business_support/business_size_test.rb
 - test/models/business_support/business_type_test.rb
 - test/models/business_support/location_test.rb