Rename source -> raw

Author: christhekeele

Diff for: docs/cheatsheets/adoption.cheatmd

@@ -74,11 +74,11 @@ end
 
 ### Wrapping Raw Specs
 
-You can make existing raw match specs play nice with `Matcha` APIs using [`Matcha.Spec.from_source!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_source!/2)
+You can make existing raw match specs play nice with `Matcha` APIs using [`Matcha.Spec.from_raw!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_raw!/2)
 
 ```elixir
 raw_spec = [{{:"$1", :"$2"}, [{:>, :"$1", 10}], [:"$_"]}]
-matcha_spec = Matcha.Spec.from_source!(:table, raw_spec)
+matcha_spec = Matcha.Spec.from_raw!(:table, raw_spec)
 ```
 
 ## Using Matcha Specs

Diff for: docs/guides/adoption.livemd

@@ -99,11 +99,11 @@ If you want to convince yourself that these do the same thing, see _"Reading Raw
 
 ## Wrapping Raw Specs
 
-If you are not using the [`Macro.spec/1`](https://hexdocs.pm/matcha/Matcha.html#spec/2) macro to build your specs, you can still wrap existing ones for usage with `Matcha` APIs: provide them to [`Matcha.Spec.from_source!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_source!/2) to get a `Matcha.Spec` struct. For example:
+If you are not using the [`Macro.spec/1`](https://hexdocs.pm/matcha/Matcha.html#spec/2) macro to build your specs, you can still wrap existing ones for usage with `Matcha` APIs: provide them to [`Matcha.Spec.from_raw!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_raw!/2) to get a `Matcha.Spec` struct. For example:
 
 ```elixir
 raw_spec = [{{:"$1", :"$2"}, [{:>, :"$1", 10}], [:"$_"]}]
-matcha_spec = Matcha.Spec.from_source!(:table, raw_spec)
+matcha_spec = Matcha.Spec.from_raw!(:table, raw_spec)
 ```
 
 ## Testing Specs With Erlang APIs
@@ -115,7 +115,7 @@ matcha_spec = Matcha.Spec.from_source!(:table, raw_spec)
 At this point, you have `Matcha.Spec` structs you want to use, either from:
 
 - Using the [`Matcha.spec/1`](https://hexdocs.pm/matcha/Matcha.html#spec/2) macro to build them
-- Using [`Matcha.Spec.from_source!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_source!/2) to wrap existing ones
+- Using [`Matcha.Spec.from_raw!/2`](https://hexdocs.pm/matcha/Matcha.Spec.html#from_raw!/2) to wrap existing ones
 
 <!-- livebook:{"break_markdown":true} -->
 

Diff for: lib/matcha/context.ex

@@ -70,7 +70,7 @@ defmodule Matcha.Context do
   end
 
   alias Matcha.Error
-  alias Matcha.Source
+  alias Matcha.Raw
 
   alias Matcha.Spec
 
@@ -95,12 +95,12 @@ defmodule Matcha.Context do
   @doc """
   Which primitive Erlang context this context module wraps.
   """
-  @callback __erl_spec_type__() :: Source.type()
+  @callback __erl_spec_type__() :: Raw.type()
 
   @doc """
   A default value to use when executing match specs in this context.
 
-  This function is used to provide `Matcha.Source.test/3` with a target value to test against,
+  This function is used to provide `Matcha.Raw.test/3` with a target value to test against,
   in situations where it is being used to simply validate the match spec itself,
   but we do not acutally care if the input matches the spec.
 
@@ -112,8 +112,8 @@ defmodule Matcha.Context do
   @doc """
   A validator that runs before executing a match spec against a `target` in this context.
 
-  This validator is run before any match specs are executed on inputs to `Matcha.Source.test/3`,
-  and all elements of the enumerable input to `Matcha.Source.run/2`.
+  This validator is run before any match specs are executed on inputs to `Matcha.Raw.test/3`,
+  and all elements of the enumerable input to `Matcha.Raw.run/2`.
 
   If this function returns false, the match spec will not be executed, instead
   returning a `t:Matcha.Error.error_problem` with a `t:Matcha.Error.message`
@@ -141,8 +141,8 @@ defmodule Matcha.Context do
   - `c:__transform_erl_test_result__/1`
   - `c:__emit_erl_test_result__/1`
   """
-  @callback __prepare_source__(source :: Source.uncompiled()) ::
-              {:ok, new_source :: Source.uncompiled()} | {:error, Error.problems()}
+  @callback __prepare_source__(source :: Raw.uncompiled()) ::
+              {:ok, new_source :: Raw.uncompiled()} | {:error, Error.problems()}
   @doc """
   Transforms the result of a spec match just after calling `:erlang.match_spec_test/3`.
 
@@ -252,8 +252,8 @@ defmodule Matcha.Context do
         results =
           if supports_compilation?(context) do
             source
-            |> Source.compile()
-            |> Source.run(match_targets)
+            |> Raw.compile()
+            |> Raw.run(match_targets)
           else
             do_run_without_compilation(match_targets, spec, source)
           end
@@ -353,7 +353,7 @@ defmodule Matcha.Context do
     test(spec, context.__default_match_target__())
   end
 
-  @spec test(Spec.t(), Source.match_target()) ::
+  @spec test(Spec.t(), Raw.match_target()) ::
           {:ok, any} | {:error, Error.problems()}
   @doc """
   Tests that the provided `spec` in its `Matcha.Context` correctly matches a provided `match_target`.
@@ -381,7 +381,7 @@ defmodule Matcha.Context do
 
   defp do_test(source, context, match_target) do
     source
-    |> Source.test(context.__erl_spec_type__(), match_target)
+    |> Raw.test(context.__erl_spec_type__(), match_target)
     |> context.__transform_erl_test_result__()
   end
 end

Diff for: lib/matcha/filter.ex

@@ -8,25 +8,25 @@ defmodule Matcha.Filter do
   alias Matcha.Context
   alias Matcha.Error
   alias Matcha.Rewrite
-  alias Matcha.Source
+  alias Matcha.Raw
 
   alias Matcha.Spec
 
   import Kernel, except: [match?: 2]
 
-  defstruct [:source, :bindings]
+  defstruct [:raw, :bindings]
 
   @test_spec_context Matcha.Context.Match
   @default_to_spec_context @test_spec_context
 
   @type t :: %__MODULE__{
-          source: Source.filter(),
+          raw: Raw.filter(),
           bindings: %{atom() => term()}
         }
 
-  @spec raw(t()) :: Source.filter()
-  def raw(%__MODULE__{source: source} = _filter) do
-    source
+  @spec raw(t()) :: Raw.filter()
+  def raw(%__MODULE__{raw: raw} = _filter) do
+    raw
   end
 
   @spec bindings(t()) :: %{atom() => non_neg_integer()}

Diff for: lib/matcha/pattern.ex

@@ -8,25 +8,25 @@ defmodule Matcha.Pattern do
   alias Matcha.Context
   alias Matcha.Error
   alias Matcha.Rewrite
-  alias Matcha.Source
+  alias Matcha.Raw
 
   alias Matcha.Spec
 
   import Kernel, except: [match?: 2]
 
-  defstruct [:source, :bindings]
+  defstruct [:raw, :bindings]
 
   @test_spec_context Matcha.Context.Match
   @default_to_spec_context @test_spec_context
 
   @type t :: %__MODULE__{
-          source: Source.pattern(),
+          raw: Raw.pattern(),
           bindings: %{atom() => term()}
         }
 
-  @spec raw(t()) :: Source.pattern()
-  def raw(%__MODULE__{source: source} = _pattern) do
-    source
+  @spec raw(t()) :: Raw.pattern()
+  def raw(%__MODULE__{raw: raw} = _pattern) do
+    raw
   end
 
   @spec bindings(t()) :: %{atom() => non_neg_integer()}

Diff for: lib/matcha/rewrite.ex

@@ -8,7 +8,7 @@ defmodule Matcha.Rewrite do
 
   alias Matcha.Context
   alias Matcha.Error
-  alias Matcha.Source
+  alias Matcha.Raw
 
   alias Matcha.Pattern
   alias Matcha.Filter
@@ -26,7 +26,7 @@ defmodule Matcha.Rewrite do
           }
         }
 
-  @spec code(t()) :: Source.uncompiled()
+  @spec code(t()) :: Raw.uncompiled()
   def code(%Rewrite{code: code} = _rewrite) do
     code
   end
@@ -47,16 +47,16 @@ defmodule Matcha.Rewrite do
   # Rewrite Elixir AST to Macha constructs
 
   def build_pattern(env = %Macro.Env{}, pattern) do
-    {source, bindings} =
+    {raw, bindings} =
       %Rewrite{env: env, code: pattern}
       |> pattern(pattern)
 
-    source = Macro.escape(source, unquote: true)
+    raw = Macro.escape(raw, unquote: true)
     bindings = Macro.escape(bindings, unquote: true)
 
     quote location: :keep do
       %Matcha.Pattern{
-        source: unquote(source),
+        raw: unquote(raw),
         bindings: unquote(bindings)
       }
       |> Matcha.Pattern.validate!()
@@ -78,16 +78,16 @@ defmodule Matcha.Rewrite do
   end
 
   def build_filter(env = %Macro.Env{}, filter) do
-    {source, bindings} =
+    {raw, bindings} =
       %Rewrite{env: env, code: filter}
       |> filter(filter)
 
-    source = Macro.escape(source, unquote: true)
+    raw = Macro.escape(raw, unquote: true)
     bindings = Macro.escape(bindings, unquote: true)
 
     quote location: :keep do
       %Matcha.Filter{
-        source: unquote(source),
+        raw: unquote(raw),
         bindings: unquote(bindings)
       }
       |> Matcha.Filter.validate!()
@@ -163,20 +163,20 @@ defmodule Matcha.Rewrite do
       |> perform_expansion(env)
       |> Context.resolve()
 
-    {source, bindings} =
+    {raw, bindings} =
       %Rewrite{env: env, context: context, code: clauses}
       |> spec(clauses)
       |> Enum.with_index()
-      |> Enum.reduce({[], %{}}, fn {{clause, bindings}, index}, {source, all_bindings} ->
-        {[clause | source], Map.put(all_bindings, index, bindings)}
+      |> Enum.reduce({[], %{}}, fn {{clause, bindings}, index}, {raw, all_bindings} ->
+        {[clause | raw], Map.put(all_bindings, index, bindings)}
       end)
 
-    source = Macro.escape(:lists.reverse(source), unquote: true)
+    raw = Macro.escape(:lists.reverse(raw), unquote: true)
     bindings = Macro.escape(bindings)
 
     quote location: :keep do
       %Matcha.Spec{
-        source: unquote(source),
+        raw: unquote(raw),
         context: unquote(context),
         bindings: unquote(bindings)
       }
@@ -315,7 +315,7 @@ defmodule Matcha.Rewrite do
   @spec pattern_to_spec(Context.t(), Pattern.t()) :: {:ok, Spec.t()} | {:error, Error.problems()}
   def pattern_to_spec(context, %Pattern{} = pattern) do
     %Spec{
-      source: [{Pattern.raw(pattern), [], [Source.__match_all__()]}],
+      raw: [{Pattern.raw(pattern), [], [Raw.__match_all__()]}],
       context: Context.resolve(context),
       bindings: %{0 => pattern.bindings}
     }
@@ -326,7 +326,7 @@ defmodule Matcha.Rewrite do
           {:ok, Spec.t()} | {:error, Error.problems()}
   def pattern_to_matched_variables_spec(context, %Pattern{} = pattern) do
     %Spec{
-      source: [{Pattern.raw(pattern), [], [Source.__all_matches__()]}],
+      raw: [{Pattern.raw(pattern), [], [Raw.__all_matches__()]}],
       context: Context.resolve(context),
       bindings: %{0 => pattern.bindings}
     }
@@ -338,7 +338,7 @@ defmodule Matcha.Rewrite do
     {match, conditions} = Filter.raw(filter)
 
     %Spec{
-      source: [{match, conditions, [Source.__match_all__()]}],
+      raw: [{match, conditions, [Raw.__match_all__()]}],
       context: Context.resolve(context),
       bindings: %{0 => filter.bindings}
     }
@@ -351,7 +351,7 @@ defmodule Matcha.Rewrite do
     {match, conditions} = Filter.raw(filter)
 
     %Spec{
-      source: [{match, conditions, [Source.__all_matches__()]}],
+      raw: [{match, conditions, [Raw.__all_matches__()]}],
       context: Context.resolve(context),
       bindings: %{0 => filter.bindings}
     }

Diff for: lib/matcha/rewrite/bindings.ex

@@ -7,7 +7,7 @@ defmodule Matcha.Rewrite.Bindings do
   """
 
   alias Matcha.Rewrite
-  alias Matcha.Source
+  alias Matcha.Raw
 
   import Matcha.Rewrite.AST, only: :macros
 
@@ -44,7 +44,7 @@ defmodule Matcha.Rewrite.Bindings do
   end
 
   def bound_var_to_source(_rewrite, 0) do
-    Source.__match_all__()
+    Raw.__match_all__()
   end
 
   def bound_var_to_source(_rewrite, integer) when is_integer(integer) and integer > 0 do

Diff for: lib/matcha/source.ex

@@ -1,4 +1,4 @@
-defmodule Matcha.Source do
+defmodule Matcha.Raw do
   @moduledoc """
   Functions that work with the raw Erlang terms representing a match spec.