Copyright	(c) 2021 berberman
License	MIT
Maintainer	berberman <berberman@yandex.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

NvFetcher.Types

Contents

Common types
Nvchecker types
Nix fetcher types
Package types

Description

Types used in this program.

Synopsis

newtype Version = Version Text
newtype SHA256 = SHA256 Text
type NixExpr = Text
data VersionChange = VersionChange {
- vcName :: PackageName
- vcOld :: Maybe Version
- vcNew :: Version
}
newtype WithPackageKey k = WithPackageKey (k, PackageKey)
data Core = Core
data VersionSource
- = GitHubRelease {
  - owner :: Text
  - repo :: Text
  }
- | Git {
  - vurl :: Text
  }
- | Pypi {
  - pypi :: Text
  }
- | ArchLinux {
  - archpkg :: Text
  }
- | Aur {
  - aur :: Text
  }
- | Manual {
  - manual :: Text
  }
- | Repology {
  - repology :: Text
  - repo :: Text
  }
data NvcheckerResult = NvcheckerResult {
- nvNow :: Version
- nvOld :: Maybe Version
}
data NixFetcher (k :: Prefetch)
- = FetchGit {
  - furl :: Text
  - rev :: Version
  - branch :: Maybe Text
  - deepClone :: Bool
  - fetchSubmodules :: Bool
  - leaveDotGit :: Bool
  - sha256 :: PrefetchResult k
  }
- | FetchUrl {
  - furl :: Text
  - sha256 :: PrefetchResult k
  }
data Prefetch
- = Fresh
- | Prefetched
type family PrefetchResult (k :: Prefetch) where ...
type PackageName = Text
type PackageFetcher = Version -> NixFetcher Fresh
data Package = Package {
- pname :: PackageName
- pversion :: VersionSource
- pfetcher :: PackageFetcher
}
newtype PackageKey = PackageKey PackageName

Common types

newtype Version Source #

Package version

Constructors

Version Text

Instances

Instances details

Eq Version Source #
Instance details Defined in NvFetcher.Types Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in NvFetcher.Types Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
Show Version Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
IsString Version Source #
Instance details Defined in NvFetcher.Types Methods fromString :: String -> Version #
Generic Version Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep Version :: Type -> Type # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Semigroup Version Source #
Instance details Defined in NvFetcher.Types Methods (<>) :: Version -> Version -> Version # sconcat :: NonEmpty Version -> Version # stimes :: Integral b => b -> Version -> Version #
Monoid Version Source #
Instance details Defined in NvFetcher.Types Methods mempty :: Version # mappend :: Version -> Version -> Version # mconcat :: [Version] -> Version #
Hashable Version Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> Version -> Int # hash :: Version -> Int #
ToJSON Version Source #
Instance details Defined in NvFetcher.Types Methods toJSON :: Version -> Value # toEncoding :: Version -> Encoding # toJSONList :: [Version] -> Value # toEncodingList :: [Version] -> Encoding #
FromJSON Version Source #
Instance details Defined in NvFetcher.Types Methods parseJSON :: Value -> Parser Version # parseJSONList :: Value -> Parser [Version] #
Binary Version Source #
Instance details Defined in NvFetcher.Types Methods put :: Version -> Put # get :: Get Version # putList :: [Version] -> Put #
NFData Version Source #
Instance details Defined in NvFetcher.Types Methods rnf :: Version -> () #
ToNixExpr Version Source #
Instance details Defined in NvFetcher.NixFetcher Methods toNixExpr :: Version -> NixExpr Source #
type Rep Version Source #
Instance details Defined in NvFetcher.Types type Rep Version = D1 ('MetaData "Version" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'True) (C1 ('MetaCons "Version" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype SHA256 Source #

SHA 256 sum

Constructors

SHA256 Text

Instances

Instances details

Eq SHA256 Source #
Instance details Defined in NvFetcher.Types Methods (==) :: SHA256 -> SHA256 -> Bool # (/=) :: SHA256 -> SHA256 -> Bool #
Show SHA256 Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> SHA256 -> ShowS # show :: SHA256 -> String # showList :: [SHA256] -> ShowS #
Generic SHA256 Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep SHA256 :: Type -> Type # Methods from :: SHA256 -> Rep SHA256 x # to :: Rep SHA256 x -> SHA256 #
Hashable SHA256 Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> SHA256 -> Int # hash :: SHA256 -> Int #
Binary SHA256 Source #
Instance details Defined in NvFetcher.Types Methods put :: SHA256 -> Put # get :: Get SHA256 # putList :: [SHA256] -> Put #
NFData SHA256 Source #
Instance details Defined in NvFetcher.Types Methods rnf :: SHA256 -> () #
type Rep SHA256 Source #
Instance details Defined in NvFetcher.Types type Rep SHA256 = D1 ('MetaData "SHA256" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'True) (C1 ('MetaCons "SHA256" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type NixExpr = Text Source #

Nix expression

data VersionChange Source #

Version change of a package

>>> VersionChange "foo" Nothing "2.3.3"
foo: ∅ → 2.3.3

>>> VersionChange "bar" (Just "2.2.2") "2.3.3"
bar: 2.2.2 → 2.3.3

Constructors

VersionChange
Fields vcName :: PackageName vcOld :: Maybe Version vcNew :: Version

Instances

Instances details

Eq VersionChange Source #
Instance details Defined in NvFetcher.Types Methods (==) :: VersionChange -> VersionChange -> Bool # (/=) :: VersionChange -> VersionChange -> Bool #
Show VersionChange Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> VersionChange -> ShowS # show :: VersionChange -> String # showList :: [VersionChange] -> ShowS #

newtype WithPackageKey k Source #

Decorate a rule's key with PackageKey

Constructors

WithPackageKey (k, PackageKey)

Instances

Instances details

Eq k => Eq (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types Methods (==) :: WithPackageKey k -> WithPackageKey k -> Bool # (/=) :: WithPackageKey k -> WithPackageKey k -> Bool #
Show k => Show (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> WithPackageKey k -> ShowS # show :: WithPackageKey k -> String # showList :: [WithPackageKey k] -> ShowS #
Hashable k => Hashable (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> WithPackageKey k -> Int # hash :: WithPackageKey k -> Int #
Binary k => Binary (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types Methods put :: WithPackageKey k -> Put # get :: Get (WithPackageKey k) # putList :: [WithPackageKey k] -> Put #
NFData k => NFData (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types Methods rnf :: WithPackageKey k -> () #
type RuleResult (WithPackageKey k) Source #
Instance details Defined in NvFetcher.Types type RuleResult (WithPackageKey k) = RuleResult k

data Core Source #

The key type of nvfetcher rule. See NvFetcher.Core

Constructors

Core

Instances

Instances details

Eq Core Source #
Instance details Defined in NvFetcher.Types Methods (==) :: Core -> Core -> Bool # (/=) :: Core -> Core -> Bool #
Ord Core Source #
Instance details Defined in NvFetcher.Types Methods compare :: Core -> Core -> Ordering # (<) :: Core -> Core -> Bool # (<=) :: Core -> Core -> Bool # (>) :: Core -> Core -> Bool # (>=) :: Core -> Core -> Bool # max :: Core -> Core -> Core # min :: Core -> Core -> Core #
Show Core Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> Core -> ShowS # show :: Core -> String # showList :: [Core] -> ShowS #
Generic Core Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep Core :: Type -> Type # Methods from :: Core -> Rep Core x # to :: Rep Core x -> Core #
Hashable Core Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> Core -> Int # hash :: Core -> Int #
Binary Core Source #
Instance details Defined in NvFetcher.Types Methods put :: Core -> Put # get :: Get Core # putList :: [Core] -> Put #
NFData Core Source #
Instance details Defined in NvFetcher.Types Methods rnf :: Core -> () #
type Rep Core Source #
Instance details Defined in NvFetcher.Types type Rep Core = D1 ('MetaData "Core" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Core" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult Core Source #
Instance details Defined in NvFetcher.Types type RuleResult Core = NixExpr

Nvchecker types

data VersionSource Source #

The input of nvchecker

Constructors

GitHubRelease
Fields owner :: Text repo :: Text
Git
Fields vurl :: Text
Pypi
Fields pypi :: Text
ArchLinux
Fields archpkg :: Text
Aur
Fields aur :: Text
Manual
Fields manual :: Text
Repology
Fields repology :: Text repo :: Text

Instances

Instances details

Eq VersionSource Source #
Instance details Defined in NvFetcher.Types Methods (==) :: VersionSource -> VersionSource -> Bool # (/=) :: VersionSource -> VersionSource -> Bool #
Ord VersionSource Source #
Instance details Defined in NvFetcher.Types Methods compare :: VersionSource -> VersionSource -> Ordering # (<) :: VersionSource -> VersionSource -> Bool # (<=) :: VersionSource -> VersionSource -> Bool # (>) :: VersionSource -> VersionSource -> Bool # (>=) :: VersionSource -> VersionSource -> Bool # max :: VersionSource -> VersionSource -> VersionSource # min :: VersionSource -> VersionSource -> VersionSource #
Show VersionSource Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> VersionSource -> ShowS # show :: VersionSource -> String # showList :: [VersionSource] -> ShowS #
Generic VersionSource Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep VersionSource :: Type -> Type # Methods from :: VersionSource -> Rep VersionSource x # to :: Rep VersionSource x -> VersionSource #
Hashable VersionSource Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> VersionSource -> Int # hash :: VersionSource -> Int #
Binary VersionSource Source #
Instance details Defined in NvFetcher.Types Methods put :: VersionSource -> Put # get :: Get VersionSource # putList :: [VersionSource] -> Put #
NFData VersionSource Source #
Instance details Defined in NvFetcher.Types Methods rnf :: VersionSource -> () #
type Rep VersionSource Source #
Instance details Defined in NvFetcher.Types type Rep VersionSource = D1 ('MetaData "VersionSource" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'False) ((C1 ('MetaCons "GitHubRelease" 'PrefixI 'True) (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "repo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "Git" 'PrefixI 'True) (S1 ('MetaSel ('Just "vurl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Pypi" 'PrefixI 'True) (S1 ('MetaSel ('Just "pypi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: ((C1 ('MetaCons "ArchLinux" 'PrefixI 'True) (S1 ('MetaSel ('Just "archpkg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Aur" 'PrefixI 'True) (S1 ('MetaSel ('Just "aur") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "Manual" 'PrefixI 'True) (S1 ('MetaSel ('Just "manual") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Repology" 'PrefixI 'True) (S1 ('MetaSel ('Just "repology") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "repo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))
type RuleResult VersionSource Source #
Instance details Defined in NvFetcher.Types type RuleResult VersionSource = NvcheckerResult

data NvcheckerResult Source #

The result of running nvchecker

Constructors

NvcheckerResult
Fields nvNow :: Version nvOld :: Maybe Version nvchecker doesn't give this value, but shake restores it from last run

Instances

Instances details

Eq NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods (==) :: NvcheckerResult -> NvcheckerResult -> Bool # (/=) :: NvcheckerResult -> NvcheckerResult -> Bool #
Show NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> NvcheckerResult -> ShowS # show :: NvcheckerResult -> String # showList :: [NvcheckerResult] -> ShowS #
Generic NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep NvcheckerResult :: Type -> Type # Methods from :: NvcheckerResult -> Rep NvcheckerResult x # to :: Rep NvcheckerResult x -> NvcheckerResult #
Hashable NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> NvcheckerResult -> Int # hash :: NvcheckerResult -> Int #
FromJSON NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods parseJSON :: Value -> Parser NvcheckerResult # parseJSONList :: Value -> Parser [NvcheckerResult] #
Binary NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods put :: NvcheckerResult -> Put # get :: Get NvcheckerResult # putList :: [NvcheckerResult] -> Put #
NFData NvcheckerResult Source #
Instance details Defined in NvFetcher.Types Methods rnf :: NvcheckerResult -> () #
type Rep NvcheckerResult Source #
Instance details Defined in NvFetcher.Types type Rep NvcheckerResult = D1 ('MetaData "NvcheckerResult" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'False) (C1 ('MetaCons "NvcheckerResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "nvNow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Just "nvOld") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Version))))

Nix fetcher types

data NixFetcher (k :: Prefetch) Source #

If the package is prefetched, then we can obtain the SHA256

Constructors

FetchGit
Fields furl :: Text rev :: Version branch :: Maybe Text deepClone :: Bool fetchSubmodules :: Bool leaveDotGit :: Bool sha256 :: PrefetchResult k
FetchUrl
Fields furl :: Text sha256 :: PrefetchResult k

Instances

Instances details

Eq (PrefetchResult k) => Eq (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods (==) :: NixFetcher k -> NixFetcher k -> Bool # (/=) :: NixFetcher k -> NixFetcher k -> Bool #
Ord (PrefetchResult k) => Ord (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods compare :: NixFetcher k -> NixFetcher k -> Ordering # (<) :: NixFetcher k -> NixFetcher k -> Bool # (<=) :: NixFetcher k -> NixFetcher k -> Bool # (>) :: NixFetcher k -> NixFetcher k -> Bool # (>=) :: NixFetcher k -> NixFetcher k -> Bool # max :: NixFetcher k -> NixFetcher k -> NixFetcher k # min :: NixFetcher k -> NixFetcher k -> NixFetcher k #
Show (PrefetchResult k) => Show (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> NixFetcher k -> ShowS # show :: NixFetcher k -> String # showList :: [NixFetcher k] -> ShowS #
Generic (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep (NixFetcher k) :: Type -> Type # Methods from :: NixFetcher k -> Rep (NixFetcher k) x # to :: Rep (NixFetcher k) x -> NixFetcher k #
Hashable (PrefetchResult k) => Hashable (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> NixFetcher k -> Int # hash :: NixFetcher k -> Int #
Binary (PrefetchResult k) => Binary (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods put :: NixFetcher k -> Put # get :: Get (NixFetcher k) # putList :: [NixFetcher k] -> Put #
NFData (PrefetchResult k) => NFData (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types Methods rnf :: NixFetcher k -> () #
ToNixExpr (NixFetcher 'Fresh) Source #
Instance details Defined in NvFetcher.NixFetcher Methods toNixExpr :: NixFetcher 'Fresh -> NixExpr Source #
ToNixExpr (NixFetcher 'Prefetched) Source #
Instance details Defined in NvFetcher.NixFetcher Methods toNixExpr :: NixFetcher 'Prefetched -> NixExpr Source #
type Rep (NixFetcher k) Source #
Instance details Defined in NvFetcher.Types type Rep (NixFetcher k) = D1 ('MetaData "NixFetcher" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'False) (C1 ('MetaCons "FetchGit" 'PrefixI 'True) ((S1 ('MetaSel ('Just "furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "rev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :: S1 ('MetaSel ('Just "branch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "deepClone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "fetchSubmodules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "leaveDotGit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PrefetchResult k))))) :+: C1 ('MetaCons "FetchUrl" 'PrefixI 'True) (S1 ('MetaSel ('Just "furl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sha256") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PrefetchResult k))))
type RuleResult (NixFetcher 'Fresh) Source #
Instance details Defined in NvFetcher.Types type RuleResult (NixFetcher 'Fresh) = NixFetcher 'Prefetched

data Prefetch Source #

Prefetch status

Constructors

Fresh
Prefetched

type family PrefetchResult (k :: Prefetch) where ... Source #

Prefetched fetchers hold hashes

Equations

PrefetchResult Fresh = ()
PrefetchResult Prefetched = SHA256

Package types

type PackageName = Text Source #

Package name, used in generating nix expr

type PackageFetcher = Version -> NixFetcher Fresh Source #

How to create package source fetcher given a version

data Package Source #

A package is defined with:

its name
how to track its version
how to fetch it as we have the version

INVARIANT: Version passed to PackageFetcher MUST be used textually, i.e. can only be concatenated with other strings, in case we can't check the equality between fetcher functions.

Constructors

Package
Fields pname :: PackageName pversion :: VersionSource pfetcher :: PackageFetcher

newtype PackageKey Source #

Package key is the name of a package. We use this type to index packages.

Constructors

PackageKey PackageName

Instances

Instances details

Eq PackageKey Source #
Instance details Defined in NvFetcher.Types Methods (==) :: PackageKey -> PackageKey -> Bool # (/=) :: PackageKey -> PackageKey -> Bool #
Ord PackageKey Source #
Instance details Defined in NvFetcher.Types Methods compare :: PackageKey -> PackageKey -> Ordering # (<) :: PackageKey -> PackageKey -> Bool # (<=) :: PackageKey -> PackageKey -> Bool # (>) :: PackageKey -> PackageKey -> Bool # (>=) :: PackageKey -> PackageKey -> Bool # max :: PackageKey -> PackageKey -> PackageKey # min :: PackageKey -> PackageKey -> PackageKey #
Show PackageKey Source #
Instance details Defined in NvFetcher.Types Methods showsPrec :: Int -> PackageKey -> ShowS # show :: PackageKey -> String # showList :: [PackageKey] -> ShowS #
Generic PackageKey Source #
Instance details Defined in NvFetcher.Types Associated Types type Rep PackageKey :: Type -> Type # Methods from :: PackageKey -> Rep PackageKey x # to :: Rep PackageKey x -> PackageKey #
Hashable PackageKey Source #
Instance details Defined in NvFetcher.Types Methods hashWithSalt :: Int -> PackageKey -> Int # hash :: PackageKey -> Int #
Binary PackageKey Source #
Instance details Defined in NvFetcher.Types Methods put :: PackageKey -> Put # get :: Get PackageKey # putList :: [PackageKey] -> Put #
NFData PackageKey Source #
Instance details Defined in NvFetcher.Types Methods rnf :: PackageKey -> () #
type Rep PackageKey Source #
Instance details Defined in NvFetcher.Types type Rep PackageKey = D1 ('MetaData "PackageKey" "NvFetcher.Types" "nvfetcher-0.1.0.0-inplace" 'True) (C1 ('MetaCons "PackageKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName)))