govuk_content_models 11.3.0 → 11.4.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 11.4.0
+
+* Add `RenderedManual` model.
+
 ## 11.3.0
 
 * When an artefact is saved, no longer attempt to update attributes on the

data/app/models/prerendered_entity.rb

@@ -0,0 +1,13 @@
+module PrerenderedEntity
+  def create_or_update_by_slug!(attributes)
+    find_or_initialize_by(
+      slug: attributes.fetch(:slug)
+    ).tap do |doc|
+      doc.update_attributes!(attributes)
+    end
+  end
+
+  def find_by_slug(slug)
+    where(slug: slug).first
+  end
+end

data/app/models/rendered_manual.rb

@@ -0,0 +1,20 @@
+require "prerendered_entity"
+
+class RenderedManual
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  extend PrerenderedEntity
+
+  field :manual_id, type: String
+  field :slug, type: String
+  field :title, type: String
+  field :summary, type: String
+  field :section_groups, type: Array
+
+  index "slug", unique: true
+
+  GOVSPEAK_FIELDS = []
+
+  validates_with SafeHtml
+  validates_uniqueness_of :slug
+end

data/app/models/rendered_specialist_document.rb

@@ -1,6 +1,9 @@
+require "prerendered_entity"
+
 class RenderedSpecialistDocument
   include Mongoid::Document
   include Mongoid::Timestamps
+  extend PrerenderedEntity
 
   field :document_id,            type: String
   field :slug,                   type: String
@@ -25,16 +28,4 @@ class RenderedSpecialistDocument
 
   validates :slug, uniqueness: true
   validates_with SafeHtml
-
-  def self.create_or_update_by_slug!(attributes)
-    RenderedSpecialistDocument.find_or_initialize_by(
-      slug: attributes.fetch(:slug)
-    ).tap do |doc|
-      doc.update_attributes!(attributes)
-    end
-  end
-
-  def self.find_by_slug(slug)
-    where(slug: slug).first
-  end
 end

data/lib/govuk_content_models/test_helpers/factories.rb

@@ -255,6 +255,12 @@ FactoryGirl.define do
     case_state 'open'
   end
 
+  factory :rendered_manual do
+    sequence(:slug) {|n| "test-rendered-manual-#{n}" }
+    sequence(:title) {|n| "Test Rendered Manual #{n}" }
+    summary "My summary"
+  end
+
   factory :simple_smart_answer_edition, :parent => :edition, :class => "SimpleSmartAnswerEdition" do
     title "Simple smart answer"
     body "Introduction to the smart answer"

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 = "11.3.0"
+  VERSION = "11.4.0"
 end

data/test/models/prerendered_entity_tests.rb

@@ -0,0 +1,46 @@
+# include in a test class and define a #model_class instance method
+
+module PrerenderedEntityTests
+  def test_duplicate_slug_not_allowed
+    model_class.create(slug: "my-slug")
+    second = model_class.create(slug: "my-slug")
+
+    refute second.valid?
+    assert_equal 1, model_class.count
+  end
+
+  def test_has_no_govspeak_fields
+    assert_equal [], model_class::GOVSPEAK_FIELDS
+  end
+
+  def test_create_or_update_by_slug
+    slug = "a-slug"
+    original_body = "Original body"
+
+    version1_attrs= {
+      slug: slug,
+      body: original_body,
+    }
+
+    created = model_class.create_or_update_by_slug!(version1_attrs)
+
+    assert created.is_a?(model_class)
+    assert created.persisted?
+
+    version2_attrs = version1_attrs.merge(
+      body: "Updated body",
+    )
+
+    version2 = model_class.create_or_update_by_slug!(version2_attrs)
+
+    assert version2.persisted?
+    assert_equal "Updated body", version2.body
+  end
+
+  def test_find_by_slug
+    created = model_class.create!(slug: "find-by-this-slug")
+    found = model_class.find_by_slug("find-by-this-slug")
+
+    assert_equal created, found
+  end
+end

data/test/models/rendered_manual_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+require_relative "prerendered_entity_tests"
+
+class RenderedManualTest < ActiveSupport::TestCase
+  include PrerenderedEntityTests
+
+  def model_class
+    RenderedManual
+  end
+end

data/test/models/rendered_specialist_document_test.rb

@@ -1,8 +1,14 @@
 require "test_helper"
 require "fixtures/specialist_document_fixtures"
+require "models/prerendered_entity_tests"
 
 class RenderedSpecialistDocumentTest < ActiveSupport::TestCase
   include SpecialistDocumentFixtures
+  include PrerenderedEntityTests
+
+  def model_class
+    RenderedSpecialistDocument
+  end
 
   def label_fields
     {
@@ -49,18 +55,6 @@ class RenderedSpecialistDocumentTest < ActiveSupport::TestCase
     assert_equal 1, RenderedSpecialistDocument.where(slug: r.slug).count
   end
 
-  test "duplicate slugs disallowed" do
-    RenderedSpecialistDocument.create(slug: "my-slug")
-    second = RenderedSpecialistDocument.create(slug: "my-slug")
-
-    refute second.valid?
-    assert_equal 1, RenderedSpecialistDocument.count
-  end
-
-  test "has no govspeak fields" do
-    assert_equal [], RenderedSpecialistDocument::GOVSPEAK_FIELDS
-  end
-
   test "can store headers hash" do
     sample_headers = [
       {
@@ -76,35 +70,4 @@ class RenderedSpecialistDocumentTest < ActiveSupport::TestCase
     found = RenderedSpecialistDocument.where(slug: r.slug).first
     assert_equal sample_headers, found.headers
   end
-
-  test ".create_or_update_by_slug!" do
-    slug = "a-slug"
-    original_body = "Original body"
-
-    version1_attrs= {
-      slug: slug,
-      body: original_body,
-    }
-
-    created = RenderedSpecialistDocument.create_or_update_by_slug!(version1_attrs)
-
-    assert created.is_a?(RenderedSpecialistDocument)
-    assert created.persisted?
-
-    version2_attrs = version1_attrs.merge(
-      body: "Updated body",
-    )
-
-    version2 = RenderedSpecialistDocument.create_or_update_by_slug!(version2_attrs)
-
-    assert version2.persisted?
-    assert_equal "Updated body", version2.body
-  end
-
-  test ".find_by_slug" do
-    created = RenderedSpecialistDocument.create!(slug: "find-by-this-slug")
-    found = RenderedSpecialistDocument.find_by_slug("find-by-this-slug")
-
-    assert_equal created, found
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_content_models
 version: !ruby/object:Gem::Version
-  version: 11.3.0
+  version: 11.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -374,7 +374,9 @@ files:
 - app/models/part.rb
 - app/models/parted.rb
 - app/models/place_edition.rb
+- app/models/prerendered_entity.rb
 - app/models/programme_edition.rb
+- app/models/rendered_manual.rb
 - app/models/rendered_specialist_document.rb
 - app/models/simple_smart_answer_edition.rb
 - app/models/simple_smart_answer_edition/node.rb
@@ -429,6 +431,8 @@ files:
 - test/models/local_service_test.rb
 - test/models/local_transaction_edition_test.rb
 - test/models/overview_dashboard_test.rb
+- test/models/prerendered_entity_tests.rb
+- test/models/rendered_manual_test.rb
 - test/models/rendered_specialist_document_test.rb
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb
@@ -463,7 +467,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3691821515300644876
+      hash: 2714656676464909163
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -472,7 +476,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3691821515300644876
+      hash: 2714656676464909163
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -506,6 +510,8 @@ test_files:
 - test/models/local_service_test.rb
 - test/models/local_transaction_edition_test.rb
 - test/models/overview_dashboard_test.rb
+- test/models/prerendered_entity_tests.rb
+- test/models/rendered_manual_test.rb
 - test/models/rendered_specialist_document_test.rb
 - test/models/simple_smart_answer_edition_test.rb
 - test/models/simple_smart_answer_node_test.rb