I438 implement smartypants

RELEASE.md

@@ -1,4 +1,10 @@
-# 1.4.17 2021-10-27
+## 1.4.18 2021-10-30
+
+- [Remove SmartyPants option for Parser](https://github.com/robertdober/earmark_parser/issues/438)
+
+- Updated dependency to [EarmarkParser v1.4.17](https://github.com/RobertDober/earmark_parser/blob/v1.4.17/RELEASE.md)
+
+## 1.4.17 2021-10-27
 
 - [436 Better EEx integration into CLI with recursive includes of markdown files](https://github.com/pragdave/earmark/pull/436)
 

lib/earmark.ex

@@ -219,6 +219,7 @@ defmodule Earmark do
   """
 
   alias Earmark.{Internal, Options, Transform}
+  alias Earmark.EarmarkParserProxy, as: Proxy
 
   defdelegate as_ast!(markdown, options \\ []), to: Internal
   defdelegate as_html(lines, options \\ []), to: Internal
@@ -265,11 +266,11 @@ defmodule Earmark do
   defp _as_ast(lines, options)
 
   defp _as_ast(lines, %Options{} = options) do
-    EarmarkParser.as_ast(lines, options |> Map.delete(:__struct__) |> Enum.into([]))
+    Proxy.as_ast(lines, options |> Map.delete(:__struct__) |> Enum.into([]))
   end
 
   defp _as_ast(lines, options) do
-    EarmarkParser.as_ast(lines, options)
+    Proxy.as_ast(lines, options)
   end
 end
 # SPDX-License-Identifier: Apache-2.0

lib/earmark/earmark_parser_proxy.ex

@@ -0,0 +1,26 @@
+defmodule Earmark.EarmarkParserProxy do
+  @moduledoc ~S"""
+  This acts as a proxy to adapt to changes in `EarmarkParser`'s API
+
+  If no changes are needed it can delegate `as_ast` to `EarmarkParser`
+
+  If changes are needed they will be realised in this modules `as_ast`
+  function.
+
+  For that reason `EarmarkParser.as_ast/*` **SHALL NOT** be invoked
+  anywhere else in this code base
+  """
+
+  @doc ~S"""
+  An adapter to `EarmarkParser.as_ast/*`
+  """
+  def as_ast(input, options)
+  def as_ast(input, options) when is_list(options)  do
+    EarmarkParser.as_ast(input, Keyword.delete(options, :smartypants))
+  end
+  def as_ast(input, options) when is_map(options)  do
+    EarmarkParser.as_ast(input, Map.delete(options, :smartypants))
+  end
+
+end
+#  SPDX-License-Identifier: Apache-2.0

lib/earmark/internal.ex

@@ -6,6 +6,7 @@ defmodule Earmark.Internal do
   """
 
   alias Earmark.{Error, Message, Options, SysInterface, Transform}
+  alias Earmark.EarmarkParserProxy, as: Proxy
   import Message, only: [emit_messages: 2]
 
   @doc ~S"""
@@ -21,7 +22,7 @@ defmodule Earmark.Internal do
   """
   def as_ast!(markdown, options \\ [])
   def as_ast!(markdown, options) do
-    case EarmarkParser.as_ast(markdown, options) do
+    case Proxy.as_ast(markdown, options) do
       {:ok, result, _} -> result
       {:error, _, messages} -> raise Earmark.Error, inspect(messages)
     end

lib/earmark/options.ex

@@ -9,7 +9,9 @@ defmodule Earmark.Options do
   - `eex`: Allows usage of an `EEx` template to be expanded to markdown before conversion
   - `file`: Name of file passed in from the CLI
   - `line`: 1 but might be set to an offset for better error messages in some integration cases
+  - `smartypants`: boolean use [Smarty Pants](https://daringfireball.net/projects/smartypants/) in the output
   - `ignore_strings`, `postprocessor` and `registered_processors`: processors that modify the AST returned from
+
      EarmarkParser.as_ast/`2` before rendering (`post` because preprocessing is done on the markdown, e.g. `eex`)
      Refer to the moduledoc of Earmark.`Transform` for details
 

lib/earmark/transform.ex

@@ -4,6 +4,7 @@
 
   alias Earmark.Options
   alias Earmark.TagSpecificProcessors, as: TSP
+  alias Earmark.EarmarkParserProxy, as: Proxy
 
   @compact_tags ~w[a code em strong del]
 
@@ -183,9 +184,9 @@
   def postprocessed_ast(lines, options) when is_binary(lines), do: lines |> String.split(@line_end) |> postprocessed_ast(options)
   # This is an optimisation (buuuuuh) but we want a minimal impact of postprocessing code when it is not required
   # It is also a case of the mantra "Handle the simple case first" (yeeeeah)
-  def postprocessed_ast(lines, %Options{registered_processors: [], postprocessor: nil}=options), do: EarmarkParser.as_ast(lines, options)
+  def postprocessed_ast(lines, %Options{registered_processors: [], postprocessor: nil}=options), do: Proxy.as_ast(lines, options)
   def postprocessed_ast(lines, %Options{}=options) do
-    {status, ast, messages} = EarmarkParser.as_ast(lines, options)
+    {status, ast, messages} = Proxy.as_ast(lines, options)
     prep = make_postprocessor(options)
     ast1 = map_ast(ast, prep, Map.get(options, :ignore_strings))
     {status, ast1, messages}

mix.exs

@@ -1,13 +1,13 @@
     defmodule Earmark.Mixfile do
   use Mix.Project
 
-  @version "1.4.17"
+  @version "1.4.18"
 
   @url "https://github.com/pragdave/earmark"
 
 
   @deps [
-    {:earmark_parser, ">= 1.4.16"},
+    {:earmark_parser, ">= 1.4.17"},
     {:dialyxir, "~> 1.1", only: [:dev, :test], runtime: false},
     {:benchfella, "~> 0.3.0", only: [:dev]},
     {:earmark_ast_dsl, "~> 0.2.5", only: [:test]},

mix.lock

@@ -3,7 +3,7 @@
   "certifi": {:hex, :certifi, "2.6.1", "dbab8e5e155a0763eea978c913ca280a6b544bfa115633fa20249c3d396d9493", [:rebar3], [], "hexpm", "524c97b4991b3849dd5c17a631223896272c6b0af446778ba4675a1dff53bb7e"},
   "dialyxir": {:hex, :dialyxir, "1.1.0", "c5aab0d6e71e5522e77beff7ba9e08f8e02bad90dfbeffae60eaf0cb47e29488", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "07ea8e49c45f15264ebe6d5b93799d4dd56a44036cf42d0ad9c960bc266c0b9a"},
   "earmark_ast_dsl": {:hex, :earmark_ast_dsl, "0.2.5", "e44146944eebe83b33e3597da27fb9b37af7287c55e8cc3bd014cfcd5e57c355", [:mix], [], "hexpm", "da14595fcc283fa8d3ada8adb0b934cab791917b82cc5149cc4c404545cdc2b1"},
-  "earmark_parser": {:hex, :earmark_parser, "1.4.16", "607709303e1d4e3e02f1444df0c821529af1c03b8578dfc81bb9cf64553d02b9", [:mix], [], "hexpm", "69fcf696168f5a274dd012e3e305027010658b2d1630cef68421d6baaeaccead"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.17", "6f3c7e94170377ba45241d394389e800fb15adc5de51d0a3cd52ae766aafd63f", [:mix], [], "hexpm", "f93ac89c9feca61c165b264b5837bf82344d13bebc634cd575cb711e2e342023"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "excoveralls": {:hex, :excoveralls, "0.14.2", "f9f5fd0004d7bbeaa28ea9606251bb643c313c3d60710bad1f5809c845b748f0", [:mix], [{:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "ca6fd358621cb4d29311b29d4732c4d47dac70e622850979bc54ed9a3e50f3e1"},
   "extractly": {:hex, :extractly, "0.5.3", "ca6afc3430e63cc9017d50eb03bdf1a3499c7e888037d2279b0ec0ea393af390", [:mix], [], "hexpm", "858f7a285ffb767937e75bb8866f03fecb3b7e5b42728a9677d2ebb6ea885503"},