Update docs, add runBeam* functions (#207)

Author: tathougies

beam-postgres/ChangeLog.md

@@ -1,3 +1,7 @@
+# 0.3.1.0
+
+Add `runBeamPostgres` and `runBeamPostgresDebug` functions.
+
 # 0.3.0.0
 
 Initial hackage beam-postgres

beam-postgres/Database/Beam/Postgres/Connection.hs

@@ -14,6 +14,8 @@ module Database.Beam.Postgres.Connection
   ( PgRowReadError(..), PgError(..)
   , Pg(..), PgF(..)
 
+  , runBeamPostgres, runBeamPostgresDebug
+
   , pgRenderSyntax, runPgRowReader, getFields
 
   , withPgDebug
@@ -300,11 +302,16 @@ newtype Pg a = Pg { runPg :: F PgF a }
 instance MonadIO Pg where
     liftIO x = liftF (PgLiftIO x id)
 
+runBeamPostgresDebug :: (String -> IO ()) -> Pg.Connection -> Pg a -> IO a
+runBeamPostgresDebug dbg conn action =
+    withPgDebug dbg conn action >>= either throwIO pure
+
+runBeamPostgres :: Pg.Connection -> Pg a -> IO a
+runBeamPostgres = runBeamPostgresDebug (\_ -> pure ())
+
 instance MonadBeam PgCommandSyntax Postgres Pg.Connection Pg where
-    withDatabase conn action =
-      withPgDebug (\_ -> pure ()) conn action >>= either throwIO pure
-    withDatabaseDebug dbg conn action =
-      withPgDebug dbg conn action >>= either throwIO pure
+    withDatabase = runBeamPostgres
+    withDatabaseDebug = runBeamPostgresDebug
 
     runReturningMany cmd consume =
         liftF (PgRunReturning cmd consume id)

beam-postgres/beam-docs.sh

@@ -3,7 +3,7 @@
 set -e
 
 CHINOOK_POSTGRES_URL="https://raw.githubusercontent.com/lerocha/chinook-database/master/ChinookDatabase/DataSources/Chinook_PostgreSql.sql"
-EXPECTED_SHA256="013d267b57b31193adad64412ee4d0800807b39b4006028ce7fb958e0667a7e0"
+EXPECTED_SHA256="6945d59e3bca94591e2a96451b9bd69084b026f7fb7dbda3d15d06114ffb34c4"
 
 PGCONNSTR=$1
 PGDB=$2

beam-postgres/beam-postgres.cabal

@@ -1,5 +1,5 @@
 name:                 beam-postgres
-version:              0.3.0.0
+version:              0.3.1.0
 synopsis:             Connection layer between beam and postgres
 description:          Beam driver for <https://www.postgresql.org/ PostgreSQL>, an advanced open-source RDBMS
 homepage:             http://tathougies.github.io/beam/user-guide/backends/beam-postgres

beam-sqlite/ChangeLog.md

@@ -1,3 +1,7 @@
+# 0.3.1.0
+
+Add `runBeamSqlite` and `runBeamSqliteDebug` functions
+
 # 0.3.0.0
 
 * Re-introduce backend parameter to `Database` class

beam-sqlite/Database/Beam/Sqlite/Connection.hs

@@ -7,10 +7,12 @@ module Database.Beam.Sqlite.Connection
   ( Sqlite(..), SqliteM(..)
   , sqliteUriSyntax
 
+  , runBeamSqlite, runBeamSqliteDebug
+
     -- * Emulated @INSERT RETURNING@ support
   , SqliteInsertReturning
   , insertReturning, runInsertReturningList
-  , ) where
+  ) where
 
 import           Database.Beam.Backend
 import           Database.Beam.Backend.SQL
@@ -182,9 +184,15 @@ sqliteUriSyntax =
         hdl <- open sqliteName
         pure (hdl, close hdl))
 
+runBeamSqliteDebug :: (String -> IO ()) -> Connection -> SqliteM a -> IO a
+runBeamSqliteDebug debugStmt conn x = runReaderT (runSqliteM x) (debugStmt, conn)
+
+runBeamSqlite :: Connection -> SqliteM a -> IO a
+runBeamSqlite = runBeamSqliteDebug (\_ -> pure ())
+
 instance MonadBeam SqliteCommandSyntax Sqlite Connection SqliteM where
-  withDatabase = withDatabaseDebug (\_ -> pure ())
-  withDatabaseDebug printStmt conn x = runReaderT (runSqliteM x) (printStmt, conn)
+  withDatabase = runBeamSqlite
+  withDatabaseDebug = runBeamSqliteDebug
 
   runNoReturn (SqliteCommandSyntax (SqliteSyntax cmd vals)) =
     SqliteM $ do

beam-sqlite/beam-docs.sh

@@ -4,7 +4,7 @@ set -e
 
 SQLITE_DB=$1
 CHINOOK_SQLITE_URL="https://raw.githubusercontent.com/lerocha/chinook-database/master/ChinookDatabase/DataSources/Chinook_Sqlite.sql"
-EXPECTED_SHA256="40215158e0dc3443d16565e3ae96c2f5d640ff00a92de3910568dc34fa086a82"
+EXPECTED_SHA256="b2e430ec8cb389509d25ec5bda2f958bbf6f0ca42e276fa5eb3de45eb816a460"
 
 print_open_statement() {
     echo "chinook <- open \"chinook.db\""

beam-sqlite/beam-sqlite.cabal

@@ -1,6 +1,6 @@
 
 name:                beam-sqlite
-version:             0.3.0.0
+version:             0.3.1.0
 synopsis:            Beam driver for SQLite
 description:         Beam driver for the <https://sqlite.org/ SQLite> embedded database.
                      See <http://tathougies.github.io/beam/user-guide/backends/beam-sqlite/ here>

docs/beam-docs-library.sh

@@ -29,18 +29,19 @@ download () {
         DIR=$(dirname $TMP_FILE)
         mkdir -p $DIR
 
-        if [ -z $CONV ]; then
-	    curl $URL | sed -e 's/\r$//' > $TMP_FILE
-	else
-	    curl $URL | $CONV | sed -e 's/\r$//' > $TMP_FILE
-	fi
+        curl $URL > $TMP_FILE
 
         ACTUAL_SUM=$(sha256 $TMP_FILE)
         if [ "$ACTUAL_SUM" != "$EXPECTED_SHA256" ]; then
             status "Sum mismatch, got $ACTUAL_SUM, expected $EXPECTED_SHA256"
             exit 1
         else
-            mv $TMP_FILE $CACHED_FILE
+            if [ -z $CONV ]; then
+	        cat $TMP_FILE | sed -e 's/\r$//' > $CACHED_FILE
+	    else
+                cat $TMP_FILE | bash -c "$CONV" | sed -e 's/\r$//' > $CACHED_FILE
+	    fi
+            rm $TMP_FILE
         fi
 
         status "Finished downloading"

docs/beam-templates/chinook.hs

@@ -34,6 +34,8 @@ main =
      stmts <- newIORef id
 
      let onStmt s = modifyIORef stmts (. (s:))
+
+         record :: BEAM_BACKEND_MONAD a -> IO a
          record = withDatabaseDebug onStmt chinook
 
      handle (\BeamDone -> pure ()) $