govuk_content_models 15.0.0 → 15.1.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 15.1.0
+* Add draft tag functionality to `Tag.by_tag_id/s`.
+* Permit tag type to be provided via an options
+  hash, while retaining backwards compatibility.
+
+## 15.0.0
+* Refactor tags.
+* Provide draft functionality in the `taggable` trait.
+
 ## 14.1.1
 * Use another way to transition Editions without
   validation

data/app/models/tag.rb

@@ -65,12 +65,24 @@ class Tag
     title
   end
 
-  def self.by_tag_id(tag_id, tag_type = nil)
-    by_tag_ids([tag_id], tag_type).first
+  def self.by_tag_id(tag_id, tag_type_or_options = nil)
+    by_tag_ids([tag_id], tag_type_or_options).first
   end
 
-  def self.by_tag_ids(tag_id_list, tag_type = nil)
-    tag_scope = tag_type ? Tag.where(tag_type: tag_type) : Tag
+  def self.by_tag_ids(tag_id_list, tag_type_or_options = nil)
+    if tag_type_or_options.is_a?(String)
+      # Providing the type as a string argument is deprecated in favour of providing the type as an option
+      options = {type: tag_type_or_options}
+    else
+      options = tag_type_or_options || {}
+    end
+
+    tag_scope = options[:type] ? Tag.where(tag_type: options[:type]) : Tag
+
+    unless options[:draft]
+      tag_scope = tag_scope.where(:state.ne => 'draft')
+    end
+
     tag_scope = tag_scope.any_in(tag_id: tag_id_list)
 
     # Sort by id list because MongoID 2.x doesn't preserve order
@@ -85,9 +97,10 @@ class Tag
     any_of(list)
   end
 
-  # Retrieve a list of tags by tag ID. Any missing tags raise an exception.
+  # Validate a list of tags by tag ID. Any missing tags raise an exception.
+  # Draft tags are considered present for internal validation.
   def self.validate_tag_ids(tag_id_list, tag_type = nil)
-    found_tags = by_tag_ids(tag_id_list, tag_type)
+    found_tags = by_tag_ids(tag_id_list, type: tag_type, draft: true)
     missing_tag_ids = tag_id_list - found_tags.map(&:tag_id)
     raise MissingTags.new(missing_tag_ids) if missing_tag_ids.any?
   end

data/app/traits/taggable.rb

@@ -95,12 +95,6 @@ module Taggable
   end
 
   def tags(include_draft = false)
-    all_tags = Tag.by_tag_ids(tag_ids)
-
-    if include_draft
-      all_tags
-    else
-      all_tags.reject {|tag| tag.state == 'draft' }
-    end
+    Tag.by_tag_ids(tag_ids, draft: include_draft)
   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 = "15.0.0"
+  VERSION = "15.1.0"
 end

data/test/models/tag_test.rb

@@ -37,9 +37,14 @@ class TagTest < ActiveSupport::TestCase
   end
 
   test "should load by tag ID and type" do
+    # This form is deprecated in favour of providing the type as an option
     assert_equal "Crime", Tag.by_tag_id("crime", "section").title
   end
 
+  test "accepts the tag type as an option" do
+    assert_equal "Crime", Tag.by_tag_id("crime", type: "section").title
+  end
+
   test "should not load an incorrectly-typed tag" do
     assert_nil Tag.by_tag_id("crime", "keyword")
   end
@@ -62,6 +67,23 @@ class TagTest < ActiveSupport::TestCase
     assert_equal %w(crime business housing), tags.map(&:tag_id)
   end
 
+  test "should not return draft tags unless requested" do
+    draft_tag = FactoryGirl.create(:tag,
+      tag_id: "draft-tag",
+      tag_type: "section",
+      title: "A draft tag",
+      state: "draft"
+    )
+
+    tag_ids = %w(crime business draft-tag housing)
+
+    assert_equal %w(crime business housing).to_set, Tag.by_tag_ids(tag_ids).map(&:tag_id).to_set
+    assert_equal %w(crime business draft-tag housing).to_set, Tag.by_tag_ids(tag_ids, draft: true).map(&:tag_id).to_set
+
+    assert_nil Tag.by_tag_id('draft-tag')
+    assert_equal draft_tag, Tag.by_tag_id('draft-tag', draft: true)
+  end
+
   test "should return nil for tags of the wrong type" do
     tag_ids = %w(crime business pie batman)
     tags = Tag.by_tag_ids(tag_ids, "section")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 15.0.0
+  version: 15.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -466,7 +466,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -116450993641469610
+      hash: -630092204464727193
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -475,7 +475,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -116450993641469610
+      hash: -630092204464727193
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23