Fix bug where markdown doesn't clear when updating with nil values

Author: joshsmith

lib/code_corps/analytics/segment_data_extractor.ex

@@ -5,6 +5,7 @@ defmodule CodeCorps.Analytics.SegmentDataExtractor do
 
   @spec get_action(Plug.Conn.t) :: atom
   def get_action(%Plug.Conn{private: %{phoenix_action: action}}), do: action
+  def get_action(_), do: nil
 
   @spec get_resource(Plug.Conn.t) :: struct
   def get_resource(%Plug.Conn{assigns: %{data: data}}), do: data

lib/code_corps/services/markdown_renderer.ex

@@ -9,6 +9,7 @@ defmodule CodeCorps.Services.MarkdownRendererService do
   def render_markdown_to_html(%Changeset{valid?: false} = changeset, _, _), do: changeset
   def render_markdown_to_html(changeset, source_field, destination_field) do
     case Changeset.get_change(changeset, source_field) do
+      "" -> Changeset.put_change(changeset, destination_field, nil)
       nil -> changeset
       markdown -> markdown |> convert_into_html() |> put_into(changeset, destination_field)
     end
@@ -23,6 +24,6 @@ defmodule CodeCorps.Services.MarkdownRendererService do
 
   @spec put_into(String.t, Changeset.t, atom) :: Changeset.t
   defp put_into(html, changeset, destination_field) do
-    Ecto.Changeset.put_change(changeset, destination_field, html)
+    Changeset.put_change(changeset, destination_field, html)
   end
 end

priv/repo/migrations/20170318032449_add_check_constraint_to_project_description_when_project_is_approved.exs

@@ -0,0 +1,7 @@
+defmodule CodeCorps.Repo.Migrations.AddCheckConstraintToProjectDescriptionWhenProjectIsApproved do
+  use Ecto.Migration
+
+  def change do
+    create constraint(:projects, "set_long_description_markdown_if_approved", check: "long_description_markdown IS NOT NULL OR approved = false")
+  end
+end

priv/repo/structure.sql

@@ -402,7 +402,8 @@ CREATE TABLE projects (
     cloudinary_public_id character varying(255),
     default_color character varying(255),
     website character varying(255),
-    should_link_externally boolean DEFAULT false
+    should_link_externally boolean DEFAULT false,
+    CONSTRAINT set_long_description_markdown_if_approved CHECK (((long_description_markdown IS NOT NULL) OR (approved = false)))
 );
 
 
@@ -2663,5 +2664,5 @@ ALTER TABLE ONLY user_tasks
 -- PostgreSQL database dump complete
 --
 
-INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611);
+INSERT INTO "schema_migrations" (version) VALUES (20160723215749), (20160804000000), (20160804001111), (20160805132301), (20160805203929), (20160808143454), (20160809214736), (20160810124357), (20160815125009), (20160815143002), (20160816020347), (20160816034021), (20160817220118), (20160818000944), (20160818132546), (20160820113856), (20160820164905), (20160822002438), (20160822004056), (20160822011624), (20160822020401), (20160822044612), (20160830081224), (20160830224802), (20160911233738), (20160912002705), (20160912145957), (20160918003206), (20160928232404), (20161003185918), (20161019090945), (20161019110737), (20161020144622), (20161021131026), (20161031001615), (20161121005339), (20161121014050), (20161121043941), (20161121045709), (20161122015942), (20161123081114), (20161123150943), (20161124085742), (20161125200620), (20161126045705), (20161127054559), (20161205024856), (20161207112519), (20161209192504), (20161212005641), (20161214005935), (20161215052051), (20161216051447), (20161218005913), (20161219160401), (20161219163909), (20161220141753), (20161221085759), (20161226213600), (20161231063614), (20170102130055), (20170102181053), (20170104113708), (20170104212623), (20170104235423), (20170106013143), (20170115035159), (20170115230549), (20170121014100), (20170131234029), (20170201014901), (20170201025454), (20170201035458), (20170201183258), (20170220032224), (20170224233516), (20170226050552), (20170228085250), (20170308214128), (20170308220713), (20170308222552), (20170313130611), (20170318032449);
 

test/lib/code_corps/services/markdown_renderer_test.exs

@@ -12,6 +12,26 @@ defmodule CodeCorps.Services.MarkdownRendererServiceTest do
     status: "open"
   }
 
+  test "renders empty strings to nil" do
+    attrs = @valid_attrs |> Map.merge(%{markdown: ""})
+    changeset =
+      %Task{}
+      |> Task.changeset(attrs)
+      |> render_markdown_to_html(:markdown, :body)
+
+    assert changeset |> Ecto.Changeset.get_change(:body) == nil
+  end
+
+  test "returns unchanged changeset when nil" do
+    attrs = @valid_attrs |> Map.merge(%{markdown: nil})
+    changeset =
+      %Task{}
+      |> Task.changeset(attrs)
+      |> render_markdown_to_html(:markdown, :body)
+
+    assert changeset == %Task{} |> Task.changeset(attrs)
+  end
+
   test "renders markdown to html" do
     changeset =
       %Task{}

test/support/factories.ex

@@ -76,6 +76,7 @@ defmodule CodeCorps.Factories do
   def project_factory do
     %CodeCorps.Project{
       approved: true,
+      long_description_markdown: sequence(:long_description_markdown, &"Description #{&1}"), # once approved, this MUST be set
       slug: sequence(:slug, &"project-#{&1}"),
       title: sequence(:title, &"Project #{&1}"),
       website: sequence(:website, &"http://test-#{&1}.com"),

web/models/project.ex

@@ -53,6 +53,9 @@ defmodule CodeCorps.Project do
     |> generate_slug(:title, :slug)
     |> validate_slug(:slug)
     |> unique_constraint(:slug, name: :index_projects_on_slug)
+    |> check_constraint(:long_description_markdown,
+                        message: "cannot be deleted once your project is approved",
+                        name: "set_long_description_markdown_if_approved")
     |> MarkdownRendererService.render_markdown_to_html(:long_description_markdown, :long_description_body)
   end