Skip to content

Commit 69a02d3

Browse files
committed
init hnix-store-nar
Closes #233
1 parent 72524cf commit 69a02d3

File tree

24 files changed

+361
-43
lines changed

24 files changed

+361
-43
lines changed

cabal.project

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
packages:
22
./hnix-store-core/hnix-store-core.cabal
33
./hnix-store-db/hnix-store-db.cabal
4+
./hnix-store-nar/hnix-store-nar.cabal
45
./hnix-store-readonly/hnix-store-readonly.cabal
56
./hnix-store-remote/hnix-store-remote.cabal
67
./hnix-store-tests/hnix-store-tests.cabal
@@ -12,5 +13,8 @@ allow-newer:
1213
package hnix-store-db
1314
flags: +build-readme +build-bench
1415

16+
package hnix-store-nar
17+
flags: +bounded_memory
18+
1519
package hnix-store-remote
1620
flags: +build-readme +io-testsuite

cabal.project.local.ci

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ package hnix-store-core
66
package hnix-store-db
77
ghc-options: -Wunused-packages -Wall -Werror
88

9+
package hnix-store-nar
10+
ghc-options: -Wunused-packages -Wall -Werror
11+
912
package hnix-store-readonly
1013
ghc-options: -Wunused-packages -Wall -Werror
1114

default.nix

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ in {
2222
inherit (haskellPackages)
2323
hnix-store-core
2424
hnix-store-db
25+
hnix-store-nar
2526
hnix-store-readonly
2627
hnix-store-remote
2728
hnix-store-tests;

hie.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ cradle:
1212
- path: "./hnix-store-db/tests"
1313
component: "hnix-store-db:test:db"
1414

15+
- path: "./hnix-store-nar/src"
16+
component: "lib:hnix-store-nar"
17+
18+
- path: "./hnix-store-nar/tests"
19+
component: "hnix-store-nar:test:nar"
20+
1521
- path: "./hnix-store-readonly/src"
1622
component: "lib:hnix-store-readonly"
1723

hnix-store-core/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# hnix-store-core
22

3-
Core effects for interacting with the Nix store.
3+
Core types and functions for interacting with the Nix store.
44

5-
See `NarEffects` in [System.Nix.Nar.Effects] and the [System.Nix.StorePath] for the available operations
6-
on the store.
7-
8-
[System.Nix.Nar.Effects]: ./src/System/Nix/Nar/Effects.hs
95
[System.Nix.StorePath]: ./src/System/Nix/StorePath.hs
10-
11-
12-
# Tests
13-
14-
- `ghcid --command "cabal repl test-suite:format-tests" --test="Main.main"`

hnix-store-core/hnix-store-core.cabal

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
cabal-version: 2.2
22
name: hnix-store-core
33
version: 0.8.0.0
4-
synopsis: Core effects for interacting with the Nix store.
4+
synopsis: Core types used for interacting with the Nix store.
55
description:
66
This package contains types and functions needed to describe
7-
interactions with the Nix store abstracted away from
8-
specific effectful context.
7+
interactions with the Nix store.
98
homepage: https://github.com/haskell-nix/hnix-store
109
license: Apache-2.0
1110
license-file: LICENSE
@@ -19,7 +18,6 @@ extra-source-files:
1918
, README.md
2019
, tests/samples/example0.drv
2120
, tests/samples/example1.drv
22-
, tests/fixtures/case-conflict.nar
2321

2422
common commons
2523
ghc-options: -Wall
@@ -66,24 +64,16 @@ library
6664
, System.Nix.DerivedPath
6765
, System.Nix.Hash
6866
, System.Nix.Hash.Truncation
69-
, System.Nix.Nar
70-
, System.Nix.Nar.Parser
71-
, System.Nix.Nar.Streamer
72-
, System.Nix.Nar.Effects
73-
, System.Nix.Nar.Options
7467
, System.Nix.Signature
7568
, System.Nix.Store.Types
7669
, System.Nix.StorePath
7770
, System.Nix.StorePath.Metadata
7871
build-depends:
7972
base >=4.12 && <5
8073
, attoparsec
81-
, algebraic-graphs >= 0.5 && < 0.8
8274
, base16-bytestring >= 1.0
8375
, base64-bytestring >= 1.2.1
8476
, bytestring
85-
, case-insensitive
86-
, cereal
8777
, containers
8878
, constraints-extras
8979
, data-default-class
@@ -92,36 +82,24 @@ library
9282
-- Required for cryptonite low-level type convertion
9383
, memory
9484
, cryptonite
95-
, directory
9685
, filepath
9786
, hashable
98-
, lifted-base
99-
, monad-control
10087
, mtl
10188
, nix-derivation >= 1.1.1 && <2
10289
, saltine >= 0.2 && < 0.3
10390
, some > 1.0.5 && < 2
10491
, time
10592
, text
106-
, unix
10793
, unordered-containers
10894
, vector
10995
hs-source-dirs: src
11096

111-
Flag bounded_memory
112-
description: Run tests of constant memory use (requires +RTS -T)
113-
default: False
114-
11597
test-suite format-tests
11698
import: commons
117-
if flag(bounded_memory)
118-
cpp-options: -DBOUNDED_MEMORY
119-
ghc-options: -rtsopts -fprof-auto
12099
type: exitcode-stdio-1.0
121100
main-is: Driver.hs
122101
other-modules:
123102
Derivation
124-
NarFormat
125103
Hash
126104
hs-source-dirs:
127105
tests
@@ -133,20 +111,11 @@ test-suite format-tests
133111
, base
134112
, base16-bytestring
135113
, base64-bytestring
136-
, binary
137114
, bytestring
138-
, containers
139115
, cryptonite
140116
, data-default-class
141-
, directory
142-
, filepath
143-
, process
144117
, tasty
145118
, tasty-golden
146119
, hspec
147120
, tasty-hspec
148-
, tasty-hunit
149-
, tasty-quickcheck
150-
, temporary
151121
, text
152-
, unix

hnix-store-nar/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Version [0.1.0.0](https://github.com/haskell-nix/hnix-store/compare/nar-0.1.0.0...nar-0.1.1.0) (2023-11-27)
2+
3+
* Initial release
4+
5+
---
6+
7+
`hnix-store-nar` uses [PVP Versioning][1].
8+
9+
[1]: https://pvp.haskell.org
10+

hnix-store-nar/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018 Shea Levy.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

hnix-store-nar/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# hnix-store-nar
2+
3+
`NAR` file format packing and unpacking.
4+
5+
For a description of the NAR format, see [`Eelco's thesis`](https://nixos.org/~eelco/pubs/phd-thesis.pdf).
6+
7+
[System.Nix.Nar]: ./src/System/Nix/Nar.hs
8+
[System.Nix.Nar.Effects]: ./src/System/Nix/Nar/Effects.hs

0 commit comments

Comments
 (0)