Merge pull request #4 from co-cddo/add-summary-step

Add summary step to workflow

app/controllers/items_controller.rb

@@ -31,7 +31,8 @@ def create
   # PATCH/PUT /items/1
   def update
     if form.save
-      redirect_to item_url(form.item), notice: "Item was successfully updated."
+      target_url = ItemWorkflow.last_step?(item:) ? item_url(item) : edit_item_url(item)
+      redirect_to target_url, notice: "Item was successfully updated."
     else
       render :edit, status: :unprocessable_entity
     end

app/forms/summary_form.rb

@@ -0,0 +1,5 @@
+class SummaryForm < BaseForm
+  def update_item
+    item.metadata["summary"] = params.dig(:item, :summary).presence
+  end
+end

app/views/items/edit.html.erb

@@ -1,6 +1,13 @@
 <h1 class="govuk-heading-l">Editing item</h1>
 
-<%= render "items/forms/#{@form.template}", form: @form %>
+<%= form_with(model: @form.item) do |f| %>
+  <%= render 'shared/form_errors', model: @form %>
+  <%= render "items/forms/#{@form.template}", form: f %>
+
+  <div>
+    <%= f.govuk_submit %>
+  </div>
+<% end %>
 
 <div>
   <%= govuk_link_to "Show this item", @item %> |

app/views/items/forms/_alternative_title.html.erb

@@ -1,9 +1,5 @@
-<%= form_with(model: @form.item) do |form| %>
-  <%= render 'shared/form_errors', model: @form %>
-
-  <%= form.govuk_text_field :alternative_title, label: { text: 'Alternative title'} %>
-
-  <div>
-    <%= form.govuk_submit %>
-  </div>
-<% end %>
+<%= form.govuk_text_field(
+      :alternative_title,
+      label: { text: 'Alternative title'},
+      value: form.object.metadata['alternativeTitle']
+    ) %>

app/views/items/forms/_summary.html.erb

@@ -0,0 +1 @@
+<%= form.govuk_text_area :summary, value: form.object.metadata['summary'] %>

app/views/items/forms/_title.html.erb

@@ -1,9 +1 @@
-<%= form_with(url: items_path, model: @form.item) do |form| %>
-  <%= render 'shared/form_errors', model: @form %>
-
-  <%= form.govuk_text_field :title %>
-
-  <div>
-    <%= form.govuk_submit %>
-  </div>
-<% end %>
+<%= form.govuk_text_field :title, value: form.object.metadata['title'] %>

app/views/items/new.html.erb

@@ -1,6 +1,13 @@
 <h1 class="govuk-heading-l">New item</h1>
 
-<%= render "items/forms/title", form: @form %>
+<%= form_with(url: items_path, model: @form.item) do |f| %>
+  <%= render 'shared/form_errors', model: @form %>
+  <%= render "items/forms/title", form: f %>
+
+  <div>
+    <%= f.govuk_submit %>
+  </div>
+<% end %>
 
 <div>
   <%= govuk_link_to "Back to items", items_path %>

app/workflows/item_workflow.rb

@@ -2,12 +2,17 @@ class ItemWorkflow
   STEPS = {
     title: TitleForm,
     alternative_title: AlternativeTitleForm,
+    summary: SummaryForm,
   }.freeze
 
   def self.form_for(**options)
     new(**options).form
   end
 
+  def self.last_step?(**options)
+    new(**options).last_step?
+  end
+
   attr_reader :item, :params
 
   def initialize(item:, params: {})
@@ -18,7 +23,7 @@ def initialize(item:, params: {})
   def current_step
     return first_step if item.last_completed_step.blank?
 
-    STEPS.keys[STEPS.keys.index(item.last_completed_step.to_sym) - 1].presence || first_step
+    STEPS.keys[STEPS.keys.index(item.last_completed_step.to_sym) + 1].presence || first_step
   end
 
   def first_step
@@ -28,4 +33,8 @@ def first_step
   def form
     STEPS[current_step].new(item:, params:)
   end
+
+  def last_step?
+    item.last_completed_step&.to_sym == STEPS.keys.last
+  end
 end

spec/forms/summary_form_spec.rb

@@ -0,0 +1,26 @@
+require "rails_helper"
+
+RSpec.describe SummaryForm, type: :model do
+  let(:item) { create :item }
+  let(:summary) { Faker::Lorem.paragraph }
+  let(:params) do
+    { item: { summary: } }
+  end
+  let(:summary_form) { described_class.new(item:, params:) }
+
+  describe "#save" do
+    it "saves the summary to metadata" do
+      summary_form.save
+      expect(item.reload.metadata["summary"]).to eq(summary)
+    end
+
+    context "with blank entry" do
+      let(:summary) { "" }
+
+      it "saves an empty array to alternative title" do
+        summary_form.save
+        expect(item.reload.metadata["summary"]).to be_nil
+      end
+    end
+  end
+end

spec/requests/item_workflow_intergration_spec.rb

@@ -0,0 +1,31 @@
+require "rails_helper"
+
+RSpec.describe "items workflow", type: :request do
+  let(:steps) do
+    {
+      title: Faker::Company.name,
+      alternative_title: Faker::Company.name,
+      summary: Faker::Lorem.paragraph,
+    }
+  end
+
+  it "visits each step in the flow" do
+    item = nil
+    steps.each do |step, input|
+      if step == steps.keys.first
+        post items_url, params: { item: { step => input } }
+        item = Item.last
+      else
+        patch item_url(item), params: { item: { step => input } }
+      end
+
+      if step == steps.keys.last
+        expect(response).to redirect_to(item_url(item))
+      else
+        expect(response).to redirect_to(edit_item_url(item)), "#{step} didn't redirect to next step"
+      end
+
+      expect(item.reload.metadata[step.to_s.camelize(:lower)]).to include(input), "#{step} in metadata was not: #{input}"
+    end
+  end
+end

spec/requests/items_spec.rb

@@ -83,7 +83,7 @@
 
     it "redirects to the item" do
       patch item_url(item), params: { item: { alternative_title: } }
-      expect(response).to redirect_to(item_url(item))
+      expect(response).to redirect_to(edit_item_url(item))
     end
   end
 

spec/workflows/item_workflow_spec.rb

@@ -41,4 +41,20 @@
       expect(item_workflow.form.params).to eq(params)
     end
   end
+
+  describe "#last_step?" do
+    it "defaults to false" do
+      expect(item_workflow.last_step?).to be_falsy
+    end
+
+    context "when items is at last step" do
+      # Item has completed penultimate and is currently at last
+      # So item last completed step is two from end
+      let(:item) { create :item, last_completed_step: steps.keys.last }
+
+      it "returns true" do
+        expect(item_workflow.last_step?).to be_truthy
+      end
+    end
+  end
 end