isbn: ISBN Validation and Manipulation

[ apache, data, library ] [ Propose Tags ]

Flags

Manual Flags

NameDescriptionDefault
dev

Turn on development settings, where all warnings are errors

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

Versions [RSS] 1.0.0.0, 1.1.0.0, 1.1.0.1, 1.1.0.2, 1.1.0.3
Change log CHANGELOG.md
Dependencies base (>=4.9 && <5.0), text (>=1.2 && <1.3) [details]
License Apache-2.0
Copyright © 2022 Christian Charukiewicz
Author Christian Charukiewicz
Maintainer charukiewicz@protonmail.com
Category Data
Home page https://github.com/charukiewicz/hs-isbn
Bug tracker https://github.com/charukiewicz/hs-isbn/issues
Source repo head: git clone https://github.com/charukiewicz/hs-isbn.git
Uploaded by charukiewicz at 2022-01-11T00:07:47Z
Distributions LTSHaskell:1.1.0.3, NixOS:1.1.0.3, Stackage:1.1.0.3
Downloads 538 total (18 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for isbn-1.1.0.3

[back to package description]

isbn: ISBN Validation and Manipulation

Build Status Hackage Hackage CI Stackage LTS Stackage Nightly Apache-2.0

All books published by major publishers since 1970 have an International Standard Book Number (ISBN) associated with them. Prior to 2007, all ISBNs issued were ten digit ISBN-10 format. Since 2007, new ISBNs have been issued in the thirteen digit ISBN-13 format. See the ISBN Wikipedia article for more information.

Overview

This library provides data types and functions both validating and working with ISBNs. For general use, only importing the Data.ISBN module is required, as it reexports all functionality for validating and converting between ISBN-10 and ISBN-13 values. The specific implementations for validation are located in the Data.ISBN.ISBN10 and Data.ISBN.ISBN13 modules, respectively.

Usage Example: Validating an ISBN and printing the error

import Data.ISBN (ISBN, validateISBN, renderISBNValidationError)

validateUserSuppliedISBN :: Text -> Either Text ISBN
validateUserSuppliedISBN userIsbnInput =
    either (Left . renderISBNValidationError) Right (validateISBN userIsbnInput)


someValidISBN10 =
    validateUserSuppliedISBN "0345816021"    -- Right (ISBN10 "0345816021")

someValidISBN13 =
    validateUserSuppliedISBN "9780807014295" -- Right (ISBN13 "9780807014295")

tooShortISBN =
    validateUserSuppliedISBN "0-345-816"     -- Left "An ISBN must be 10 or 13 characters, not counting hyphens"

invalidISBN10 =
    validateUserSuppliedISBN "0-345-81602-3" -- Left "The supplied ISBN-10 is not valid"

Development

This library is developed using a Nix shell. The environment is specified in shell.nix. You can enter the environment with nix installed via nix-shell. The nix-shell will install sandboxed copies of cabal-install, ghcid, entr, and gnumake, which are the utilities necessary to build the project, run the tests, and create a local copy of the documentation.

Entering the development environment and runnning tests

$ cd <path-to-repo>
$ nix-shell                       # assumes `nix` is installed
(nix-shell) $ make help           # show all of the make targets
(nix-shell) $ make tests-watch    # build the library and run the tests in `ghcid`
(nix-shell) $ make docs           # build a local copy of the haddock documentation