govuk_content_models 15.1.2 → 16.0.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 16.0.0
+
+* Adds a workflow for Tags.
+* BREAKING CHANGE: Tags are no longer live by default. Tests which create tags
+  should migrate to use the new `:live_tag` factory when creating stub data.
+
 ## 15.1.2
 * Use string-based keys rather than symbols when manipulating
   tuple hashes for tags on an artefact.

data/app/models/tag.rb

@@ -1,5 +1,6 @@
 require "safe_html"
 require 'tag_id_validator'
+require 'state_machine'
 
 class Tag
   include Mongoid::Document
@@ -10,7 +11,7 @@ class Tag
   field :description,       type: String
   field :short_description, type: String
   field :parent_id,         type: String
-  field :state,             type: String, default: 'live'
+  field :state,             type: String, default: 'draft'
 
   GOVSPEAK_FIELDS = []
   STATES = ['draft', 'live']
@@ -24,6 +25,8 @@ class Tag
   validates_with TagIdValidator
   validates_with SafeHtml
 
+  attr_protected :state
+
   validates :state, inclusion: { in: STATES }
 
   class MissingTags < RuntimeError
@@ -39,6 +42,12 @@ class Tag
   # should go through them and set this attribute manually
   attr_accessor :uniquely_named
 
+  state_machine initial: :draft do
+    event :publish do
+      transition draft: :live
+    end
+  end
+
   def as_json(options = {})
     {
       id: self.tag_id,

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -19,6 +19,17 @@ FactoryGirl.define do
     sequence(:tag_id) { |n| "crime-and-justice-#{n}" }
     sequence(:title) { |n| "The title #{n}" }
     tag_type "section"
+
+    trait :draft do
+      state "draft"
+    end
+
+    trait :live do
+      state "live"
+    end
+
+    factory :draft_tag, traits: [:draft]
+    factory :live_tag, traits: [:live]
   end
 
   factory :artefact do

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.1.2"
+  VERSION = "16.0.0"
 end

data/test/models/artefact_tag_test.rb

@@ -8,15 +8,15 @@ class ArtefactTagTest < ActiveSupport::TestCase
   ]
 
   setup do
-    parent_section = FactoryGirl.create(:tag, :tag_id => 'crime', :tag_type => 'section', :title => 'Crime')
-    FactoryGirl.create(:tag, :tag_id => 'crime/the-police', :tag_type => 'section', :title => 'The Police', :parent_id => parent_section.id)
-    FactoryGirl.create(:tag, :tag_id => 'crime/batman', :tag_type => 'section', :title => 'Batman', :parent_id => parent_section.id)
+    parent_section = FactoryGirl.create(:live_tag, :tag_id => 'crime', :tag_type => 'section', :title => 'Crime')
+    FactoryGirl.create(:live_tag, :tag_id => 'crime/the-police', :tag_type => 'section', :title => 'The Police', :parent_id => parent_section.id)
+    FactoryGirl.create(:live_tag, :tag_id => 'crime/batman', :tag_type => 'section', :title => 'Batman', :parent_id => parent_section.id)
 
     TEST_KEYWORDS.each do |tag_id, title|
-      FactoryGirl.create(:tag, :tag_id => tag_id, :tag_type => 'keyword', :title => title)
+      FactoryGirl.create(:live_tag, :tag_id => tag_id, :tag_type => 'keyword', :title => title)
     end
     TEST_LEGACY_SOURCES.each do |tag_id, title|
-      FactoryGirl.create(:tag, :tag_id => tag_id, :tag_type => 'legacy_source', :title => title)
+      FactoryGirl.create(:live_tag, :tag_id => tag_id, :tag_type => 'legacy_source', :title => title)
     end
   end
 

data/test/models/artefact_test.rb

@@ -356,7 +356,7 @@ class ArtefactTest < ActiveSupport::TestCase
   # should continue to work in the way it has been:
   # i.e. you can edit everything but the name/title for published content in panop
   test "on save title should not be applied to already published content" do
-    FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+    FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     artefact = FactoryGirl.create(:artefact,
         slug: "foo-bar",
         kind: "answer",
@@ -503,10 +503,10 @@ class ArtefactTest < ActiveSupport::TestCase
   context "returning json representation" do
     context "returning tags" do
       setup do
-        FactoryGirl.create(:tag, :tag_type => 'section', :tag_id => 'crime', :title => 'Crime')
-        FactoryGirl.create(:tag, :tag_type => 'section', :tag_id => 'justice', :title => 'Justice', :description => "All about justice")
-        FactoryGirl.create(:tag, :tag_type => 'legacy_source', :tag_id => 'directgov', :title => 'Directgov')
-        FactoryGirl.create(:tag, :tag_type => 'legacy_source', :tag_id => 'businesslink', :title => 'Business Link')
+        FactoryGirl.create(:live_tag, :tag_type => 'section', :tag_id => 'crime', :title => 'Crime')
+        FactoryGirl.create(:live_tag, :tag_type => 'section', :tag_id => 'justice', :title => 'Justice', :description => "All about justice")
+        FactoryGirl.create(:live_tag, :tag_type => 'legacy_source', :tag_id => 'directgov', :title => 'Directgov')
+        FactoryGirl.create(:live_tag, :tag_type => 'legacy_source', :tag_id => 'businesslink', :title => 'Business Link')
 
         @a = FactoryGirl.create(:artefact, :slug => 'fooey')
       end
@@ -588,10 +588,10 @@ class ArtefactTest < ActiveSupport::TestCase
 
   context "related artefacts grouped by section tags" do
     setup do
-      FactoryGirl.create(:tag, :tag_id => "fruit", :tag_type => 'section', :title => "Fruit")
-      FactoryGirl.create(:tag, :tag_id => "fruit/simple", :tag_type => 'section', :title => "Simple fruits", :parent_id => "fruit")
-      FactoryGirl.create(:tag, :tag_id => "fruit/aggregate", :tag_type => 'section', :title => "Aggregrate fruits", :parent_id => "fruit")
-      FactoryGirl.create(:tag, :tag_id => "vegetables", :tag_type => 'section', :title => "Vegetables")
+      FactoryGirl.create(:live_tag, :tag_id => "fruit", :tag_type => 'section', :title => "Fruit")
+      FactoryGirl.create(:live_tag, :tag_id => "fruit/simple", :tag_type => 'section', :title => "Simple fruits", :parent_id => "fruit")
+      FactoryGirl.create(:live_tag, :tag_id => "fruit/aggregate", :tag_type => 'section', :title => "Aggregrate fruits", :parent_id => "fruit")
+      FactoryGirl.create(:live_tag, :tag_id => "vegetables", :tag_type => 'section', :title => "Vegetables")
 
       @artefact = Artefact.create!(slug: "apple", name: "Apple", sections: [], kind: "guide", need_ids: ["100001"], owning_app: "x")
     end

data/test/models/curated_list_test.rb

@@ -9,7 +9,7 @@ class CuratedListTest < ActiveSupport::TestCase
 
   test "should include ability to have a section tag" do
     cl = FactoryGirl.create(:curated_list)
-    tag = FactoryGirl.create(:tag, tag_id: 'batman', title: 'Batman', tag_type: 'section')
+    tag = FactoryGirl.create(:live_tag, tag_id: 'batman', title: 'Batman', tag_type: 'section')
 
     cl.sections = ['batman']
     cl.save
@@ -29,4 +29,4 @@ class CuratedListTest < ActiveSupport::TestCase
     cl = FactoryGirl.create(:curated_list, artefact_ids: [a.id.to_s])
     assert cl.artefact_ids.first.is_a?(BSON::ObjectId)
   end
-end
+end

data/test/models/edition_test.rb

@@ -366,7 +366,7 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "should create a publication based on data imported from panopticon" do
-    section = FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+    section = FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     artefact = FactoryGirl.create(:artefact,
         slug: "foo-bar",
         kind: "answer",
@@ -393,7 +393,7 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "should not change edition metadata if archived" do
-    FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+    FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     artefact = FactoryGirl.create(:artefact,
         slug: "foo-bar",
         kind: "answer",
@@ -492,8 +492,8 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "should also delete associated artefact" do
-    
-    FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+
+    FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
 
     user1 = FactoryGirl.create(:user)
     edition = AnswerEdition.find_or_create_from_panopticon_data(@artefact.id, user1, {})
@@ -504,8 +504,8 @@ class EditionTest < ActiveSupport::TestCase
   end
 
   test "should not delete associated artefact if there are other editions of this publication" do
-    
-    FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+
+    FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     user1 = FactoryGirl.create(:user)
     edition = AnswerEdition.find_or_create_from_panopticon_data(@artefact.id, user1, {})
     edition.update_attribute(:state, "published")
@@ -902,7 +902,7 @@ class EditionTest < ActiveSupport::TestCase
 
   test "should denormalise a creator's name when an edition is created" do
     @user = FactoryGirl.create(:user)
-    FactoryGirl.create(:tag, tag_id: "test-section", title: "Test section", tag_type: "section")
+    FactoryGirl.create(:live_tag, tag_id: "test-section", title: "Test section", tag_type: "section")
     artefact = FactoryGirl.create(:artefact,
         slug: "foo-bar",
         kind: "answer",

data/test/models/tag_test.rb

@@ -2,10 +2,10 @@ require "test_helper"
 
 class TagTest < ActiveSupport::TestCase
   test "should return a hash of the fields" do
-    tag = Tag.new(
+    tag = FactoryGirl.build(:live_tag,
       tag_id: "crime",
       tag_type: "section",
-      title: "Crime"
+      title: "Crime",
     )
     expected_hash = {
       id: "crime",
@@ -19,12 +19,12 @@ class TagTest < ActiveSupport::TestCase
 
   setup do
     %w(crime business housing).each do |section|
-      FactoryGirl.create(:tag, :tag_id => section, :title => section.capitalize)
+      FactoryGirl.create(:live_tag, :tag_id => section, :title => section.capitalize)
     end
 
     %w(pie mash chips).each do |keyword|
       FactoryGirl.create(
-        :tag,
+        :live_tag,
         :tag_id => keyword,
         :title => keyword.capitalize,
         :tag_type => "keyword"
@@ -68,11 +68,10 @@ class TagTest < ActiveSupport::TestCase
   end
 
   test "should not return draft tags unless requested" do
-    draft_tag = FactoryGirl.create(:tag,
+    draft_tag = FactoryGirl.create(:draft_tag,
       tag_id: "draft-tag",
       tag_type: "section",
       title: "A draft tag",
-      state: "draft"
     )
 
     tag_ids = %w(crime business draft-tag housing)
@@ -134,32 +133,56 @@ class TagTest < ActiveSupport::TestCase
       @atts = { tag_type: 'section', tag_id: 'test', title: 'Test' }
     end
 
-    should "be created in live state" do
-      tag = Tag.create(@atts.merge(state: 'live'))
+    should "be created in draft state by default" do
+      tag = Tag.create(@atts)
 
       assert tag.persisted?
+      assert_equal 'draft', tag.state
+    end
+
+    should "be able to be set to live" do
+      tag = Tag.new(@atts)
+      tag.state = 'live'
+      tag.save
+
+      tag.reload
       assert_equal 'live', tag.state
     end
 
-    should "be created in draft state" do
-      tag = Tag.create(@atts.merge(state: 'draft'))
+    should "not mass-assign the state attribute" do
+      tag = Tag.create(@atts.merge(state: 'live'))
+      tag.reload
 
-      assert tag.persisted?
-      assert_equal 'draft', tag.state
+      refute_equal 'live', tag.state
     end
 
     should "not be created in another state" do
-      tag = Tag.create(@atts.merge(state: 'foo'))
+      tag = Tag.new(@atts)
+      tag.state = 'foo'
 
       assert !tag.valid?
       assert tag.errors.has_key?(:state)
     end
 
-    should "be created in live state by default" do
+    should "be set to live when published" do
       tag = Tag.create(@atts)
 
-      assert tag.persisted?
+      assert_equal 'draft', tag.state
+      tag.publish!
+
+      tag.reload
       assert_equal 'live', tag.state
     end
+
+    should "not be published more than once" do
+      tag = Tag.create(@atts)
+
+      tag.publish!
+      tag.reload
+
+      assert_raises StateMachine::InvalidTransition do
+        tag.publish!
+      end
+    end
   end
 end

data/test/traits/taggable_test.rb

@@ -6,13 +6,13 @@ class TaggableTest < ActiveSupport::TestCase
   TEST_KEYWORDS = [['cheese', 'Cheese'], ['bacon', 'Bacon']]
 
   setup do
-    @parent_section = FactoryGirl.create(:tag, :tag_id => 'crime', :tag_type => 'section', :title => 'Crime')
-    FactoryGirl.create(:tag, :tag_id => 'crime/the-police', :tag_type => 'section', :title => 'The Police', :parent_id => @parent_section.id)
-    FactoryGirl.create(:tag, :tag_id => 'crime/batman', :tag_type => 'section', :title => 'Batman', :parent_id => @parent_section.id)
-    @draft_section = FactoryGirl.create(:tag, parent_id: @parent_section.id, state: 'draft')
+    @parent_section = FactoryGirl.create(:live_tag, :tag_id => 'crime', :tag_type => 'section', :title => 'Crime')
+    FactoryGirl.create(:live_tag, :tag_id => 'crime/the-police', :tag_type => 'section', :title => 'The Police', :parent_id => @parent_section.id)
+    FactoryGirl.create(:live_tag, :tag_id => 'crime/batman', :tag_type => 'section', :title => 'Batman', :parent_id => @parent_section.id)
+    @draft_section = FactoryGirl.create(:draft_tag, parent_id: @parent_section.id)
 
     TEST_KEYWORDS.each do |tag_id, title|
-      FactoryGirl.create(:tag, :tag_id => tag_id, :tag_type => 'keyword', :title => title)
+      FactoryGirl.create(:live_tag, :tag_id => tag_id, :tag_type => 'keyword', :title => title)
     end
 
     @item = FactoryGirl.create(:artefact)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 15.1.2
+  version: 16.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-07-24 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: -641385530309798652
+      hash: -1246027544295212288
 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: -641385530309798652
+      hash: -1246027544295212288
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23