Reword comments about TEXT_DATETIME pseudo-type to remove HACK warnings. (#147)

Author: scouten

lib/sqlite_db_connection/query.ex

@@ -135,12 +135,10 @@ defimpl DBConnection.Query, for: Sqlite.DbConnection.Query do
     {String.to_integer(hr), String.to_integer(mi), String.to_integer(se), fr}
   end
 
-  # HACK: We have to do a special conversion if the user is trying to cast to
-  # a DATETIME type.  Sqlitex cannot determine that the type of the cast is a
-  # datetime value because datetime defaults to an integer type in SQLite.
-  # Thus, we cast the value to a TEXT_DATETIME pseudo-type to preserve the
-  # datetime string.  Then when we get here, we convert the string to an Ecto
-  # datetime tuple if it looks like a cast was attempted.
+  # We use a special conversion for when the user is trying to cast to a
+  # DATETIME type. We introduce a TEXT_DATETIME psudo-type to preserve the
+  # datetime string. When we get here, we look for a CAST function as a signal
+  # to convert that back to Elixir date types.
   defp cast_any_datetimes(row) do
     Enum.map row, fn {value, column_name} ->
       if String.contains?(column_name, "CAST (") && String.contains?(column_name, "TEXT_DATE") do

lib/sqlite_ecto/connection.ex

@@ -534,11 +534,16 @@ if Code.ensure_loaded?(Sqlitex.Server) do
     defp ecto_to_db(:binary), do: "BLOB"
     defp ecto_to_db(:float), do: "NUMERIC"
     defp ecto_to_db(:string), do: "TEXT"
-    defp ecto_to_db(:utc_datetime), do: "TEXT_DATETIME"    # HACK see: cast_any_datetimes/1
-    defp ecto_to_db(:naive_datetime), do: "TEXT_DATETIME"  # HACK see: cast_any_datetimes/1
+    defp ecto_to_db(:utc_datetime), do: "TEXT_DATETIME"    # see below
+    defp ecto_to_db(:naive_datetime), do: "TEXT_DATETIME"  # see below
     defp ecto_to_db(:map), do: "TEXT"
     defp ecto_to_db(other), do: other |> Atom.to_string |> String.upcase
 
+    # We use a special conversion for when the user is trying to cast to a
+    # DATETIME type. We introduce a TEXT_DATETIME psudo-type to preserve the
+    # datetime string. When we get here, we look for a CAST function as a signal
+    # to convert that back to Elixir date types.
+
     defp create_names(%{prefix: prefix, sources: sources}, stmt) do
       create_names(prefix, sources, 0, tuple_size(sources), stmt)
       |> prohibit_subquery_if_necessary(stmt)