govuk_content_models 8.9.0 → 8.10.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 8.10.0
+
+* Adds a flag to `attaches` to have the `Attachable`
+mixin add a {field}_url attribute containing the
+attachment's public URL.
+
 ## 8.9.0
 
 * Add label fields to RenderedSpecialistDocument

data/app/models/attachment.rb

@@ -7,16 +7,12 @@ class Attachment
 
   field :title
   field :filename
-  attaches :file
+  attaches :file, with_url_field: true
 
   embedded_in :specialist_document_edition
 
   validates_with SafeHtml
 
-  def url
-    file.file_url
-  end
-
   # TODO: Move this to a domain object in specialist publisher
   def snippet
     "[InlineAttachment:#{filename}]"

data/app/traits/attachable.rb

@@ -11,9 +11,23 @@ module Attachable
 
   module ClassMethods
     def attaches(*fields)
+      if fields.last.is_a?(Hash)
+        options = fields.pop
+      else
+        options = {}
+      end
+      attaches_with_options(fields, options)
+    end
+
+  private
+
+    def attaches_with_options(fields, options = {})
       fields.map(&:to_s).each do |field|
         before_save "upload_#{field}".to_sym, :if => "#{field}_has_changed?".to_sym
         self.field "#{field}_id".to_sym, type: String
+        if options[:with_url_field]
+          self.field "#{field}_url".to_sym, type: String
+        end
 
         define_method(field) do
           raise ApiClientNotPresent unless Attachable.asset_api_client
@@ -42,7 +56,8 @@ module Attachable
           raise ApiClientNotPresent unless Attachable.asset_api_client
           begin
             response = Attachable.asset_api_client.create_asset(:file => instance_variable_get("@#{field}_file"))
-            self.send("#{field}_id=", response.id.match(/\/([^\/]+)\z/) {|m| m[1] })
+            self.send("#{field}_url=", response.file_url) if self.respond_to?("#{field}_url=")
+            self.send("#{field}_id=", response.id.split('/').last)
           rescue StandardError
             errors.add("#{field}_id".to_sym, "could not be uploaded")
           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.9.0"
+  VERSION = "8.10.0"
 end

data/test/models/attachment_test.rb

@@ -1,19 +1,6 @@
 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",
@@ -23,21 +10,4 @@ class AttachmentTest < ActiveSupport::TestCase
 
     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

@@ -8,7 +8,7 @@ class SpecialistDocumentEditionTest < ActiveSupport::TestCase
 
   setup do
     @original_asset_api_client = Attachable.asset_api_client
-    @success_response = stub("asset manager response", id: "/test-id")
+    @success_response = stub("asset manager response", id: "/test-id", file_url: "/test-id/document.pdf")
     Attachable.asset_api_client = stub("asset_api_client")
     Attachable.asset_api_client.stubs(:create_asset).returns(@success_response)
   end

data/test/traits/attachable_test.rb

@@ -12,10 +12,19 @@ class ModelWithAttachments
   attaches :image
 end
 
+class ModelWithAttachmentsAndUrl
+  include Attachable
+  include Mongoid::Document
+
+  field :title, type: String
+  attaches :image, with_url_field: true
+end
+
 class AttachableTest < ActiveSupport::TestCase
 
   setup do
     @edition = ModelWithAttachments.new
+    @edition_with_url_field = ModelWithAttachmentsAndUrl.new
     @previous_api_client = Attachable.asset_api_client
     Attachable.asset_api_client = MockAssetApi.new
   end
@@ -64,7 +73,10 @@ class AttachableTest < ActiveSupport::TestCase
   context "saving an edition" do
     setup do
       @file = File.open(File.expand_path("../../fixtures/uploads/image.jpg", __FILE__))
-      @asset = OpenStruct.new(:id => 'http://asset-manager.dev.gov.uk/assets/an_image_id')
+      @asset = OpenStruct.new(
+        id: 'http://asset-manager.dev.gov.uk/assets/an_image_id',
+        file_url: 'http://asset-manager.dev.gov.uk/media/an_image_id/image.jpg'
+      )
     end
 
     should "upload the asset" do
@@ -88,6 +100,24 @@ class AttachableTest < ActiveSupport::TestCase
       assert_equal "an_image_id", @edition.image_id
     end
 
+    should "assign the asset url to the attachment url attribute if requested" do
+      MockAssetApi.any_instance.expects(:create_asset).with({ :file => @file }).returns(@asset)
+
+      @edition_with_url_field.image = @file
+      @edition_with_url_field.save!
+
+      assert_equal 'http://asset-manager.dev.gov.uk/media/an_image_id/image.jpg', @edition_with_url_field.image_url
+    end
+
+    should "not create the attachment url attribute if not requested" do
+      MockAssetApi.any_instance.expects(:create_asset).with({ :file => @file }).returns(@asset)
+
+      @edition.image = @file
+      @edition.save!
+
+      refute @edition.respond_to?(:image_url)
+    end
+
     should "raise an exception if there is no api client present" do
       Attachable.asset_api_client = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 8.9.0
+  version: 8.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -463,7 +463,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4213322720212660807
+      hash: -2794998033139020622
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -472,7 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4213322720212660807
+      hash: -2794998033139020622
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23