address some PR feedback

Author: dtpowl

persistent/ChangeLog.md

@@ -1,8 +1,9 @@
 # Changelog for persistent
 
-# 2.15.1.1
+# 2.16.0.0
 
 * [#1584](https://github.com/yesodweb/persistent/pull/1584)
+    * Rename `Span` to `SourceSpan`
     * Parse entity definitions using Megaparsec.
     * Support Haddock-style multiline pre-comments.
 

persistent/Database/Persist/EntityDef.hs

@@ -19,7 +19,7 @@ module Database.Persist.EntityDef
     , getEntityKeyFields
     , getEntityComments
     , getEntityExtra
-    , getEntitySpan
+    , getEntitySourceSpan
     , isEntitySum
     , entityPrimary
     , entitiesPrimary
@@ -43,7 +43,7 @@ import Database.Persist.FieldDef
 
 import Database.Persist.Names
 import Database.Persist.Types.Base
-       (ForeignDef, Span, UniqueDef(..), entityKeyFields)
+       (ForeignDef, SourceSpan, UniqueDef(..), entityKeyFields)
 
 -- | Retrieve the list of 'UniqueDef' from an 'EntityDef'. This does not include
 -- a @Primary@ key, if one is defined. A future version of @persistent@ will
@@ -209,12 +209,12 @@ overEntityFields
 overEntityFields f ed =
     setEntityFields (f (getEntityFieldsDatabase ed)) ed
 
--- | Gets the 'Span' of the definition of the entity.
+-- | Gets the 'SourceSpan' of the definition of the entity.
 --
 -- Note that as of this writing the span covers the entire file or quasiquote
 -- where the item is defined due to parsing limitations. This may be changed in
 -- a future release to be more accurate.
 --
--- @since 2.15.0.0
-getEntitySpan :: EntityDef -> Maybe Span
-getEntitySpan = entitySpan
+-- @since 2.16.0.0
+getEntitySourceSpan :: EntityDef -> Maybe SourceSpan
+getEntitySourceSpan = entitySourceSpan

persistent/Database/Persist/Quasi/Internal.hs

@@ -51,6 +51,7 @@ import Prelude hiding (lines)
 import Control.Applicative (Alternative ((<|>)))
 import Control.Monad
 import Data.Char (isDigit, isLower, isSpace, isUpper, toLower)
+import Data.Foldable (toList)
 import Data.List (find, foldl')
 import Data.List.NonEmpty (NonEmpty (..))
 import qualified Data.List.NonEmpty as NEL
@@ -309,10 +310,10 @@ data UnboundEntityDef
     -- the field?" yet, so we defer those to the Template Haskell execution.
     --
     -- @since 2.13.0.0
-    , unboundEntityDefSpan :: Maybe Span
+    , unboundEntityDefSourceSpan :: Maybe SourceSpan
     -- ^ The source code span of this entity in the models file.
     --
-    -- @since 2.15.0.0
+    -- @since 2.16.0.0
     }
     deriving (Eq, Ord, Show, Lift)
 
@@ -336,7 +337,7 @@ unbindEntityDef ed =
             ed
         , unboundEntityFields =
             map unbindFieldDef (entityFields ed)
-        , unboundEntityDefSpan = entitySpan ed
+        , unboundEntityDefSourceSpan = entitySourceSpan ed
         }
 
 -- | Returns the @['UnboundFieldDef']@ for an 'UnboundEntityDef'. This returns
@@ -547,7 +548,7 @@ mkUnboundEntityDef ps parsedEntDef =
                     DefaultKey (FieldNameDB $ psIdName ps)
         , unboundEntityFields =
             cols
-        , unboundEntityDefSpan = parsedEntityDefSpan parsedEntDef
+        , unboundEntityDefSourceSpan = parsedEntityDefSourceSpan parsedEntDef
         , unboundEntityDef =
             EntityDef
                 { entityHaskell = entNameHS
@@ -571,7 +572,7 @@ mkUnboundEntityDef ps parsedEntDef =
                     case parsedEntityDefComments parsedEntDef of
                         [] -> Nothing
                         comments -> Just (T.unlines comments)
-                , entitySpan = parsedEntityDefSpan parsedEntDef
+                , entitySourceSpan = parsedEntityDefSourceSpan parsedEntDef
                 }
         }
   where
@@ -581,19 +582,11 @@ mkUnboundEntityDef ps parsedEntDef =
     attribs =
         parsedEntityDefFieldAttributes parsedEntDef
 
-    fieldComments =
-        parsedEntityDefFieldComments parsedEntDef
-
     cols :: [UnboundFieldDef]
-    cols = foldMap (f . commentedField ps) (zip attribs fieldComments)
-      where
-        f = \case
-            Just unb -> [unb]
-            _ -> []
+    cols = foldMap (toList . commentedField ps) attribs
 
     textAttribs :: [[Text]]
-    textAttribs =
-        fmap tokenContent <$> attribs
+    textAttribs = (fmap tokenContent . fst) <$> attribs
 
     entityConstraintDefs =
         foldMap
@@ -612,6 +605,13 @@ mkUnboundEntityDef ps parsedEntDef =
             SetOnce a -> Just a
             NotSet -> Nothing
 
+    commentedField :: PersistSettings
+                   -> ([Token], Maybe Text)
+                   -> Maybe UnboundFieldDef
+    commentedField ps (tokens, mCommentText) = do
+      unb <- takeColsEx ps (tokenContent <$> tokens)
+      pure $ unb{unboundFieldComments = mCommentText}
+
     autoIdField :: FieldDef
     autoIdField =
         mkAutoIdField ps entNameHS idSqlType
@@ -620,12 +620,6 @@ mkUnboundEntityDef ps parsedEntDef =
     idSqlType =
         maybe SqlInt64 (const $ SqlOther "Primary Key") primaryComposite
 
-commentedField
-    :: PersistSettings -> ([Token], Maybe Text) -> Maybe UnboundFieldDef
-commentedField ps (tokens, mCommentText) = do
-    unb <- takeColsEx ps (tokenContent <$> tokens)
-    pure $ unb{unboundFieldComments = mCommentText}
-
 defaultIdName :: PersistSettings -> FieldNameDB
 defaultIdName = FieldNameDB . psIdName