ba7f69c...trunk · typeable/cassava-streams

.envrcnew file+10

@@ -0,0 +1,10 @@

1+# -*- sh -*-

2+

3+# Don't let cabal leak state to other projects:

4+export CABAL_DIR=$(pwd)/.cabal

5+

6+# Load in the shell.nix file:

7+use nix

8+

9+# Reload if these files change:

10+watch_file nix/sources.json

.github/workflows/analysis.ymlnew file+22

@@ -0,0 +1,22 @@

1+name: Analysis

2+on:

3+ pull_request:

4+jobs:

5+ check:

6+ name: pre-merge-checks

7+ runs-on: ubuntu-latest

8+ steps:

9+ - name: Clone Repository

10+ uses: actions/checkout@v2

11+

12+ - name: Setup Haskell

13+ id: setup-haskell-cabal

14+ uses: actions/setup-haskell@v1.1.3

15+ with:

16+ ghc-version: 8.8

17+

18+ - name: Cabal Check

19+ run: cabal check

20+

21+ - name: Lint

22+ run: curl -sSL https://raw.github.com/ndmitchell/hlint/master/misc/run.sh | sh -s .

.github/workflows/tests.ymlnew file+63

@@ -0,0 +1,63 @@

1+name: CI

2+on:

3+ pull_request:

4+jobs:

5+ cabal:

6+ name: ${{ matrix.os }} / ghc-${{ matrix.ghc }}

7+ runs-on: ${{ matrix.os }}

8+ strategy:

9+ fail-fast: false

10+ matrix:

11+ os: [ubuntu-latest, macOS-latest, windows-latest]

12+ cabal: ["3.2"]

13+ ghc: ["8.6.5", "8.8.4", "8.10.2"]

14+ # Newer versions of GHC are broken on Windows:

15+ # https://gitlab.haskell.org/ghc/ghc/-/issues/17926

16+ exclude:

17+ - os: windows-latest

18+ ghc: "8.8.4"

19+ - os: windows-latest

20+ ghc: "8.10.2"

21+ steps:

22+ - name: Clone Repository

23+ uses: actions/checkout@v2

24+

25+ - name: Setup Haskell

26+ id: setup-haskell-cabal

27+ uses: actions/setup-haskell@v1.1.3

28+ with:

29+ ghc-version: ${{ matrix.ghc }}

30+ cabal-version: ${{ matrix.cabal }}

31+

32+ - name: Configure and Freeze for Cache

33+ run: |

34+ cabal configure --enable-tests --enable-benchmarks --test-show-details=direct -ftutorial

35+ cabal freeze

36+

37+ - name: Cache ~/.cabal/store

38+ uses: actions/cache@v1

39+ with:

40+ path: ${{ steps.setup-haskell-cabal.outputs.cabal-store }}

41+ key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}

42+

43+ - name: Build

44+ run: cabal build '--build-log=logs/$pkgid'

45+

46+ - name: Test

47+ run: cabal test

48+

49+ - name: Upload Build Logs on Failure

50+ uses: actions/upload-artifact@v2

51+ if: failure()

52+ with:

53+ name: logs-${{ matrix.os }}-ghc${{ matrix.ghc }}

54+ path: logs/

55+

56+ - name: Install

57+ run: cabal install --installdir=artifacts --install-method=copy

58+

59+ - name: Upload Artifacts

60+ uses: actions/upload-artifact@v2

61+ with:

62+ name: ${{ matrix.os }}-ghc${{ matrix.ghc }}

63+ path: artifacts/

.gitignore+5−3

@@ -1,4 +1,6 @@

1−/dist

2−/.cabal-sandbox

3−/cabal.sandbox.config

41/test/massive.csv

2+/.stack-work

3+/build/.stack-work

4+/dist

5+/result

6+/.cabal/

.gitmodules−3

@@ -1,3 +0,0 @@

1−[submodule "util"]

2− path = util

3− url = git://pmade.com/haskell-util

CHANGELOGdeleted−8

@@ -1,8 +0,0 @@

1−2014-11-11 Peter Jones <pjones@devalot.com>

2−

3− * System/IO/Streams/Csv/Decode.hs added more descriptive error messages.

4− * cassava-streams bumped version number (0.1.1.0).

5−

6−2014-04-30 Peter Jones <pjones@devalot.com>

7−

8− * cassava-streams initial release (version 0.1.0.0).

CHANGES.mdnew file+34

@@ -0,0 +1,34 @@

1+# Change Log / Release Notes

2+

3+## 0.3 (August 11, 2016)

4+

5+ * Add some additional (convenience) exports from `Data.Csv`. (Thanks

6+ goes to Florian Hofmann.)

7+

8+ * Added `data/HLint.hs`

9+

10+ * Updated to LTS Haskell 6.7

11+

12+ * Minor updates:

13+

14+ - 0.3.0.1 (April 14, 2017): Updated dependencies

15+ - 0.3.0.2 (March 20, 2018): Updated dependencies

16+ - 0.3.0.3 (October 09, 2018): Updated dependencies

17+ - 0.3.0.4 (April 15, 2019): Updated dependencies

18+ - 0.3.0.5 (October 29, 2020): Update dependencies

19+

20+## 0.2.0.0 (February 8, 2016)

21+

22+ * Compile with GHC 7.10.3

23+

24+ * Update dependency versions

25+

26+ * Build with stack and LTS Haskell 5.2

27+

28+## 0.1.1.0 (November 11, 2014)

29+

30+ * `System/IO/Streams/Csv/Decode.hs` added more descriptive error messages.

31+

32+## 0.1.0.0 (April 30, 2014)

33+

34+ * cassava-streams initial release

GNUmakefiledeleted−27

@@ -1,27 +0,0 @@

1−################################################################################

2−# From util/haskell.mk (git submodule update --init)

3−CABAL_FLAGS = --enable-tests -fmaintainer -ftutorial

4−include util/haskell.mk

5−

6−################################################################################

7−CSV_HEADER = test/header.csv

8−CSV_MEGA = test/massive.csv

9−TUTORIAL = dist/build/tutorial/tutorial todo

10−PROF_OPTS = +RTS -sstderr -hc -pa -xc

11−

12−################################################################################

13−clean::

14− rm -f $(CSV_MEGA)

15− rm -f $(foreach e,aux hp pdf prof ps,tutorial.$(e))

16−

17−################################################################################

18−profile:: $(CSV_MEGA)

19− $(TUTORIAL) $(PROF_OPTS) < $(CSV_MEGA) > profile.stdout

20− hp2ps -M -b -c tutorial.hp

21− ps2pdf tutorial.ps

22−

23−################################################################################

24−# Generate a very large CSV file for profiling.

25−$(CSV_MEGA): $(CSV_HEADER)

26− sh test/make-huge-csv.sh $@ $(CSV_HEADER)

27− du -h $@

LICENSE+1−1

@@ -1,4 +1,4 @@

22

33All rights reserved.

44

README.md+4

@@ -1,5 +1,9 @@

11# cassava-streams

22

3+[![CI](https://github.com/pjones/cassava-streams/workflows/CI/badge.svg)](https://github.com/pjones/cassava-streams/actions)

4+[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/pjones/cassava-streams?label=release)](https://github.com/pjones/cassava-streams/releases)

5+[![Hackage](https://img.shields.io/hackage/v/cassava-streams)](https://hackage.haskell.org/package/cassava-streams)

6+

37[io-streams][] interface for the [cassava][] CSV library.

48

59[io-streams]: http://hackage.haskell.org/package/io-streams

cassava-streams.cabal+51−57

@@ -1,18 +1,17 @@

1−--------------------------------------------------------------------------------

2−name: cassava-streams

3−version: 0.1.1.0

4−synopsis: io-streams interface for the cassava CSV library.

5−license: BSD3

6−license-file: LICENSE

7−author: Peter Jones <pjones@devalot.com>

8−maintainer: Peter Jones <pjones@devalot.com>

10−category: Data, Text, CSV, IO-Streams

11−build-type: Simple

12−cabal-version: >=1.10

13−tested-with: GHC==7.8.2, GHC==7.8.3

14−homepage: https://github.com/pjones/cassava-streams

15−bug-reports: https://github.com/pjones/cassava-streams/issues

1+cabal-version: 2.2

2+name: cassava-streams

3+version: 0.3.0.5

4+synopsis: io-streams interface for the cassava CSV library.

5+license: BSD-3-Clause

6+license-file: LICENSE

7+author: Peter Jones <pjones@devalot.com>

8+maintainer: Peter Jones <pjones@devalot.com>

10+category: Data, Text, CSV, IO-Streams

11+build-type: Simple

12+homepage: https://github.com/pjones/cassava-streams

13+bug-reports: https://github.com/pjones/cassava-streams/issues

14+tested-with: GHC ==8.6.5 || ==8.8.4 || ==8.10.2

1615description:

1716 The cassava-streams library glues togeter the cassava CSV library

1817 and the io-streams streaming library.

@@ -22,76 +21,71 @@ description:

2221--------------------------------------------------------------------------------

2322extra-source-files:

2423 README.md

25− CHANGELOG

26− test/simple.csv

24+ CHANGES.md

25+ test/*.csv

2726

2827--------------------------------------------------------------------------------

2928source-repository head

3029 type: git

3130 location: https://github.com/pjones/cassava-streams.git

3231

33−--------------------------------------------------------------------------------

34−flag maintainer

35− description: Enable settings for the package maintainer.

36− manual: True

37− default: False

38−

3932--------------------------------------------------------------------------------

4033flag tutorial

4134 description: Build the tutorial binary (useful for profiling).

42− default: False

35+ manual: True

36+ default: False

37+

38+--------------------------------------------------------------------------------

39+common dependencies

40+ build-depends:

41+ , base >=4.8 && <5.0

42+ , bytestring >=0.10 && <0.12

43+ , cassava >=0.4 && <0.6

44+ , io-streams >=1.1 && <1.6

45+ , vector >=0.10 && <0.14

4346

4447--------------------------------------------------------------------------------

4548library

49+ import: dependencies

4650 exposed-modules:

4751 System.IO.Streams.Csv

4852 System.IO.Streams.Csv.Tutorial

53+

4954 other-modules:

50− System.IO.Streams.Csv.Encode

5155 System.IO.Streams.Csv.Decode

56+ System.IO.Streams.Csv.Encode

5257

53− hs-source-dirs: src

58+ hs-source-dirs: src

5459 default-language: Haskell2010

55− ghc-options: -O2 -Wall -fwarn-incomplete-uni-patterns

56− ghc-prof-options: -prof -auto-all

57−

58− if flag(maintainer)

59− ghc-options: -Werror

60−

61− build-depends: base >= 4.6 && < 5.0

62− , bytestring >= 0.10 && < 0.11

63− , cassava >= 0.4 && < 0.5

64− , io-streams >= 1.1 && < 1.2

65− , vector >= 0.10 && < 0.11

60+ ghc-options: -Wall -fwarn-incomplete-uni-patterns

61+ build-depends:

6662

6763--------------------------------------------------------------------------------

6864executable tutorial

6965 default-language: Haskell2010

70− hs-source-dirs: bin

71− main-is: tutorial.hs

72− ghc-options: -O2 -Wall -Werror -rtsopts

73− ghc-prof-options: -fprof-auto-top -fprof-cafs

66+ hs-source-dirs: bin

67+ main-is: tutorial.hs

68+ ghc-options: -Wall -fwarn-incomplete-uni-patterns -rtsopts

7469

7570 if !flag(tutorial)

7671 buildable: False

72+

7773 else

78− build-depends: base

79− , cassava-streams

80− , io-streams

74+ build-depends:

75+ , base

76+ , cassava-streams

77+ , io-streams

8178

8279--------------------------------------------------------------------------------

8380test-suite test

84− type: exitcode-stdio-1.0

81+ import: dependencies

82+ type: exitcode-stdio-1.0

8583 default-language: Haskell2010

86− hs-source-dirs: test

87− main-is: test.hs

88− ghc-options: -O2 -Wall -Werror

89− build-depends: base

90− , QuickCheck >= 2.7 && < 3.0

91− , bytestring

92− , cassava

93− , cassava-streams

94− , io-streams

95− , tasty >= 0.8 && < 1.0

96− , tasty-quickcheck >= 0.8 && < 1.0

97− , vector

84+ hs-source-dirs: test

85+ main-is: test.hs

86+ ghc-options: -Wall -fwarn-incomplete-uni-patterns

87+ build-depends:

88+ , cassava-streams

89+ , QuickCheck >=2.7 && <3.0

90+ , tasty >=0.8 && <1.5

91+ , tasty-quickcheck >=0.8 && <1.3

data/HLint.hsnew file+3

@@ -0,0 +1,3 @@

1+module HLint.HLint where

2+import "hint" HLint.Builtin.All

3+ignore "Use import/export shortcut"

default.nixnew file+11

@@ -0,0 +1,11 @@

1+{ sources ? import ./nix/sources.nix

2+, pkgs ? import sources.nixpkgs { }

3+, nix-hs ? import sources.nix-hs { inherit pkgs; }

4+, ghc ? "default"

5+}:

6+

7+nix-hs {

8+ cabal = ./cassava-streams.cabal;

9+ flags = [ "tutorial" ];

10+ compiler = ghc;

11+}

nix/sources.jsonnew file+38

@@ -0,0 +1,38 @@

1+{

2+ "niv": {

3+ "branch": "master",

4+ "description": "Easy dependency management for Nix projects",

5+ "homepage": "https://github.com/nmattia/niv",

6+ "owner": "nmattia",

7+ "repo": "niv",

8+ "rev": "f73bf8d584148677b01859677a63191c31911eae",

9+ "sha256": "0jlmrx633jvqrqlyhlzpvdrnim128gc81q5psz2lpp2af8p8q9qs",

10+ "type": "tarball",

11+ "url": "https://github.com/nmattia/niv/archive/f73bf8d584148677b01859677a63191c31911eae.tar.gz",

12+ "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

13+ },

14+ "nix-hs": {

15+ "branch": "release-20.09",

16+ "description": "Haskell + nixpkgs = nix-hs",

17+ "homepage": "",

18+ "owner": "pjones",

19+ "repo": "nix-hs",

20+ "rev": "67163bb02a8791d79136ba6914b6d6dad594533b",

21+ "sha256": "0f7sjh45wxbf2m76l37f4l4v4dkq32dm599p85acx53324nr9y8z",

22+ "type": "tarball",

23+ "url": "https://github.com/pjones/nix-hs/archive/67163bb02a8791d79136ba6914b6d6dad594533b.tar.gz",

24+ "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

25+ },

26+ "nixpkgs": {

27+ "branch": "nixos-20.09",

28+ "description": "Nix Packages collection",

29+ "homepage": "",

30+ "owner": "NixOS",

31+ "repo": "nixpkgs",

32+ "rev": "edb26126d98bc696f4f3e206583faa65d3d6e818",

33+ "sha256": "1cl4ka4kk7kh3bl78g06dhiidazf65q8miyzaxi9930d6gwyzkci",

34+ "type": "tarball",

35+ "url": "https://github.com/NixOS/nixpkgs/archive/edb26126d98bc696f4f3e206583faa65d3d6e818.tar.gz",

36+ "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

37+ }

38+}

nix/sources.nixnew file+134

@@ -0,0 +1,134 @@

1+# This file has been generated by Niv.

2+

3+let

4+

5+ #

6+ # The fetchers. fetch_<type> fetches specs of type <type>.

7+ #

8+

9+ fetch_file = pkgs: spec:

10+ if spec.builtin or true then

11+ builtins_fetchurl { inherit (spec) url sha256; }

12+ else

13+ pkgs.fetchurl { inherit (spec) url sha256; };

14+

15+ fetch_tarball = pkgs: spec:

16+ if spec.builtin or true then

17+ builtins_fetchTarball { inherit (spec) url sha256; }

18+ else

19+ pkgs.fetchzip { inherit (spec) url sha256; };

20+

21+ fetch_git = spec:

22+ builtins.fetchGit { url = spec.repo; inherit (spec) rev ref; };

23+

24+ fetch_builtin-tarball = spec:

25+ builtins.trace

26+ ''

27+ WARNING:

28+ The niv type "builtin-tarball" will soon be deprecated. You should

29+ instead use `builtin = true`.

30+

31+ $ niv modify <package> -a type=tarball -a builtin=true

32+ ''

33+ builtins_fetchTarball { inherit (spec) url sha256; };

34+

35+ fetch_builtin-url = spec:

36+ builtins.trace

37+ ''

38+ WARNING:

39+ The niv type "builtin-url" will soon be deprecated. You should

40+ instead use `builtin = true`.

41+

42+ $ niv modify <package> -a type=file -a builtin=true

43+ ''

44+ (builtins_fetchurl { inherit (spec) url sha256; });

45+

46+ #

47+ # Various helpers

48+ #

49+

50+ # The set of packages used when specs are fetched using non-builtins.

51+ mkPkgs = sources:

52+ let

53+ sourcesNixpkgs =

54+ import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) {};

55+ hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath;

56+ hasThisAsNixpkgsPath = <nixpkgs> == ./.;

57+ in

58+ if builtins.hasAttr "nixpkgs" sources

59+ then sourcesNixpkgs

60+ else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then

61+ import <nixpkgs> {}

62+ else

63+ abort

64+ ''

65+ Please specify either <nixpkgs> (through -I or NIX_PATH=nixpkgs=...) or

66+ add a package called "nixpkgs" to your sources.json.

67+ '';

68+

69+ # The actual fetching function.

70+ fetch = pkgs: name: spec:

71+

72+ if ! builtins.hasAttr "type" spec then

73+ abort "ERROR: niv spec ${name} does not have a 'type' attribute"

74+ else if spec.type == "file" then fetch_file pkgs spec

75+ else if spec.type == "tarball" then fetch_tarball pkgs spec

76+ else if spec.type == "git" then fetch_git spec

77+ else if spec.type == "builtin-tarball" then fetch_builtin-tarball spec

78+ else if spec.type == "builtin-url" then fetch_builtin-url spec

79+ else

80+ abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}";

81+

82+ # Ports of functions for older nix versions

83+

84+ # a Nix version of mapAttrs if the built-in doesn't exist

85+ mapAttrs = builtins.mapAttrs or (

86+ f: set: with builtins;

87+ listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set))

88+ );

89+

90+ # fetchTarball version that is compatible between all the versions of Nix

91+ builtins_fetchTarball = { url, sha256 }@attrs:

92+ let

93+ inherit (builtins) lessThan nixVersion fetchTarball;

94+ in

95+ if lessThan nixVersion "1.12" then

96+ fetchTarball { inherit url; }

97+ else

98+ fetchTarball attrs;

99+

100+ # fetchurl version that is compatible between all the versions of Nix

101+ builtins_fetchurl = { url, sha256 }@attrs:

102+ let

103+ inherit (builtins) lessThan nixVersion fetchurl;

104+ in

105+ if lessThan nixVersion "1.12" then

106+ fetchurl { inherit url; }

107+ else

108+ fetchurl attrs;

109+

110+ # Create the final "sources" from the config

111+ mkSources = config:

112+ mapAttrs (

113+ name: spec:

114+ if builtins.hasAttr "outPath" spec

115+ then abort

116+ "The values in sources.json should not have an 'outPath' attribute"

117+ else

118+ spec // { outPath = fetch config.pkgs name spec; }

119+ ) config.sources;

120+

121+ # The "config" used by the fetchers

122+ mkConfig =

123+ { sourcesFile ? ./sources.json

124+ , sources ? builtins.fromJSON (builtins.readFile sourcesFile)

125+ , pkgs ? mkPkgs sources

126+ }: rec {

127+ # The sources, i.e. the attribute set of spec name to spec

128+ inherit sources;

129+

130+ # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers

131+ inherit pkgs;

132+ };

133+in

134+mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); }

shell.nixnew file+2

@@ -0,0 +1,2 @@

1+# Load an interactive environment:

2+(import ./. {}).interactive

src/System/IO/Streams/Csv.hs+12

@@ -41,8 +41,20 @@ module System.IO.Streams.Csv

4141 -- ByteString@ stream into one that encodes records into CSV

4242 -- format before sending them downstream.

4343 , module System.IO.Streams.Csv.Encode

44+

45+ -- * Convenience Exports

46+ -- | Export data types from Data.Csv

47+ , module Data.Csv

4448 ) where

4549

4650--------------------------------------------------------------------------------

4751import System.IO.Streams.Csv.Decode

4852import System.IO.Streams.Csv.Encode

53+

54+import Data.Csv ( HasHeader(..)

55+ , defaultEncodeOptions

56+ , defaultDecodeOptions

57+ , DecodeOptions(..)

58+ , EncodeOptions(..)

59+ , Quoting(..)

60+ )

src/System/IO/Streams/Csv/Decode.hs+2−2

@@ -1,4 +1,4 @@

1−{-# LANGUAGE DeriveDataTypeable #-}

1+{-# LANGUAGE DeriveDataTypeable #-}

22{-# LANGUAGE ScopedTypeVariables #-}

33

44{-

@@ -37,7 +37,7 @@ import qualified System.IO.Streams as Streams

3737--------------------------------------------------------------------------------

3838-- | Exception thrown when stream decoding cannot continue due to an

3939-- error.

40−data StreamDecodingError = StreamDecodingError String

40+newtype StreamDecodingError = StreamDecodingError String

4141 deriving (Typeable, Show)

4242

4343instance Exception StreamDecodingError

src/System/IO/Streams/Csv/Encode.hs+1−1

@@ -75,7 +75,7 @@ encodeStreamByNameWith :: ToNamedRecord a

7575 -> IO (OutputStream a) -- ^ New @OutputStream@.

7676encodeStreamByNameWith opts hdr output = do

7777 ref <- newIORef opts

78− makeOutputStream $ dispatch (\opts' -> encodeByNameWith opts' hdr) ref output

78+ makeOutputStream $ dispatch (`encodeByNameWith` hdr) ref output

7979

8080--------------------------------------------------------------------------------

8181-- | Encode records, ensuring that the header is written no more than once.

src/System/IO/Streams/Csv/Tutorial.hs−1

@@ -30,7 +30,6 @@ module System.IO.Streams.Csv.Tutorial

3030 ) where

3131

3232--------------------------------------------------------------------------------

33−import Control.Applicative

3433import Control.Monad

3534import Data.Csv

3635import qualified Data.Vector as V

test/test.hs+4−4

@@ -19,7 +19,7 @@ module Main (main) where

1919import Control.Monad

2020import Data.ByteString (ByteString)

2121import qualified Data.ByteString as BS

22−import Data.Csv hiding (Record, NamedRecord, record)

22+import Data.Csv hiding (Record, NamedRecord, record, header)

2323import qualified Data.Vector as V

2424import System.IO.Streams (InputStream, OutputStream)

2525import qualified System.IO.Streams as Streams

@@ -70,7 +70,7 @@ roundTrip is os recs = do

7070 Streams.connect sourceList encoder

7171

7272 -- Decode from ByteString.

73− decoder <- fmap BS.concat encoded >>= Streams.fromByteString >>= is

73+ decoder <- (encoded >>= Streams.fromByteString . BS.concat) >>= is

7474 (decodeStream, decoded) <- Streams.listOutputStream

7575 Streams.connect decoder decodeStream

7676 decoded

@@ -96,8 +96,8 @@ prop_indexedRoundTrip recsIn = not (null recsIn) ==> monadicIO $ do

9696--------------------------------------------------------------------------------

9797tests :: TestTree

9898tests = testGroup "Tests"

99− [ QC.testProperty "namedRoundTrip" $ prop_namedRoundTrip

100− , QC.testProperty "indexedRoundTrip" $ prop_indexedRoundTrip

99+ [ QC.testProperty "namedRoundTrip" prop_namedRoundTrip

100+ , QC.testProperty "indexedRoundTrip" prop_indexedRoundTrip

101101 ]

102102

103103--------------------------------------------------------------------------------

utildeleted−1

Submodule changed.