semver (empty) → 0.1.0
raw patch · 7 files changed
+1099/−0 lines, 7 filesdep +attoparsecdep +basedep +criterionsetup-changed
Dependencies added: attoparsec, base, criterion, deepseq, semver, tasty, tasty-hunit, text
Files
- LICENSE +373/−0
- README.md +6/−0
- Setup.hs +2/−0
- bench/Main.hs +154/−0
- semver.cabal +64/−0
- src/Data/SemVer.hs +425/−0
- test/Main.hs +75/−0
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ README.md view
@@ -0,0 +1,6 @@+# Semantic Versioning++Representation, manipulation, and de/serialisation of a Version type+following the Semantic Versioning specification.++For more information see: <http://semver.org>
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ bench/Main.hs view
@@ -0,0 +1,154 @@+{-# LANGUAGE OverloadedStrings #-}++-- Module : Main+-- Copyright : (c) 2014 Brendan Hay <brendan.g.hay@gmail.com>+-- License : This Source Code Form is subject to the terms of+-- the Mozilla Public License, v. 2.0.+-- A copy of the MPL can be found in the LICENSE file or+-- you can obtain it at http://mozilla.org/MPL/2.0/.+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>+-- Stability : experimental+-- Portability : non-portable (GHC extensions)++module Main (main) where++import Criterion+import Criterion.Main+import Data.List (sort)+import Data.SemVer+import Data.Text (Text, pack)+import Data.Version (showVersion, parseVersion)+import qualified Data.Version as Ver+import Text.ParserCombinators.ReadP++main :: IO ()+main = defaultMain+ [ bgroup "decoding"+ [ bgroup "semver"+ [ bgroup "fromText . pack"+ [ bench "1.2.3"+ $ nf (sv . pack) "1.2.3"+ , bench "1.2.3-alpha"+ $ nf (sv . pack) "1.2.3-alpha"+ , bench "1.2.3-alpha.1"+ $ nf (sv . pack) "1.2.3-alpha.1"+ , bench "1.2.3+123"+ $ nf (sv . pack) "1.2.3+123"+ , bench "1.2.3+sha.2ac"+ $ nf (sv . pack) "1.2.3+sha.2ac"+ , bench "1.2.3-beta.1+sha.exp.dc2"+ $ nf (sv . pack) "1.2.3-beta.1+sha.exp.dc2"+ ]+ ]+ , bgroup "version"+ [ bgroup "parseVersion"+ [ bench "1.2.3"+ $ nf dv "1.2.3"+ , bench "1.2.3-alpha"+ $ nf dv "1.2.3-alpha"+ , bench "1.2.3-alpha.1"+ $ nf dv "1.2.3-alpha.1"+ , bench "1.2.3+123"+ $ nf dv "1.2.3+123"+ , bench "1.2.3+sha.2ac"+ $ nf dv "1.2.3+sha.2ac"+ , bench "1.2.3-beta.1+sha.exp.dc2"+ $ nf dv "1.2.3-beta.1+sha.exp.dc2"+ ]+ ]+ ]++ , bgroup "encoding"+ [ bgroup "semver"+ [ bgroup "toLazyText"+ [ bench "1.2.3"+ $ nf toLazyText sv123+ , bench "1.2.3-alpha"+ $ nf toLazyText sv123alpha+ , bench "1.2.3-alpha.1"+ $ nf toLazyText sv123alpha1+ , bench "1.2.3+123"+ $ nf toLazyText sv123123+ , bench "1.2.3+sha.2ac"+ $ nf toLazyText sv123sha2ac+ , bench "1.2.3-beta.1+sha.exp.dc2"+ $ nf toLazyText sv123beta1shaexpdc2+ ]+ , bgroup "toString"+ [ bench "1.2.3"+ $ nf toString sv123+ , bench "1.2.3-alpha"+ $ nf toString sv123alpha+ , bench "1.2.3-alpha.1"+ $ nf toString sv123alpha1+ , bench "1.2.3+123"+ $ nf toString sv123123+ , bench "1.2.3+sha.2ac"+ $ nf toString sv123sha2ac+ , bench "1.2.3-beta.1+sha.exp.dc2"+ $ nf toString sv123beta1shaexpdc2+ ]+ ]+ , bgroup "version"+ [ bgroup "showVersion"+ [ bench "1.2.3"+ $ nf showVersion dv123+ , bench "1.2.3-alpha"+ $ nf showVersion dv123alpha+ , bench "1.2.3-alpha.1"+ $ nf showVersion dv123alpha1+ , bench "1.2.3+123"+ $ nf showVersion dv123123+ , bench "1.2.3+sha.2ac"+ $ nf showVersion dv123sha2ac+ , bench "1.2.3-beta.1+sha.exp.dc2"+ $ nf showVersion dv123beta1shaexpdc2+ ]+ ]+ ]++ , bgroup "sort"+ [ bench "semver" $ nf sort+ [ sv123+ , sv123alpha+ , sv123alpha1+ , sv123123+ , sv123sha2ac+ , sv123beta1shaexpdc2+ ]+ , bench "version" $ nf sort+ [ dv123+ , dv123alpha+ , dv123alpha1+ , dv123123+ , dv123sha2ac+ , dv123beta1shaexpdc2+ ]+ ]+ ]++sv123, sv123alpha, sv123alpha1, sv123123 :: Version+sv123sha2ac, sv123beta1shaexpdc2 :: Version+sv123 = sv "1.2.3"+sv123alpha = sv "1.2.3-alpha"+sv123alpha1 = sv "1.2.3-alpha.1"+sv123123 = sv "1.2.3+123"+sv123sha2ac = sv "1.2.3+sha.2ac"+sv123beta1shaexpdc2 = sv "1.2.3-beta.1+sha.exp.dc2"++dv123, dv123alpha, dv123alpha1, dv123123 :: Ver.Version+dv123sha2ac, dv123beta1shaexpdc2 :: Ver.Version+dv123 = dv "1.2.3"+dv123alpha = dv "1.2.3-alpha"+dv123alpha1 = dv "1.2.3-alpha.1"+dv123123 = dv "1.2.3+123"+dv123sha2ac = dv "1.2.3+sha.2ac"+dv123beta1shaexpdc2 = dv "1.2.3-beta.1+sha.exp.dc2"++sv :: Text -> Version+sv t = case fromText t of+ Left e -> error e+ Right x -> x++dv :: String -> Ver.Version+dv = fst . last . readP_to_S parseVersion
+ semver.cabal view
@@ -0,0 +1,64 @@+name: semver+version: 0.1.0+synopsis: Representation, manipulation, and de/serialisation of Semantic Versions.+homepage: https://github.com/brendanhay/semver+license: OtherLicense+license-file: LICENSE+author: Brendan Hay+maintainer: brendan.g.hay@gmail.com+copyright: Copyright (c) 2014 Brendan Hay+category: Data+build-type: Simple+extra-source-files: README.md+cabal-version: >= 1.10++description:+ Representation, manipulation, and de/serialisation of a Version type+ following the Semantic Versioning specification.+ .+ For more information see: <http://semver.org>++source-repository head+ type: git+ location: git://github.com/brendanhay/semver.git++library+ default-language: Haskell2010+ hs-source-dirs: src+ ghc-options: -Wall -O2 -funbox-strict-fields++ exposed-modules:+ Data.SemVer++ build-depends:+ attoparsec >= 0.10 && < 0.13+ , base >= 4.5 && < 5.0+ , deepseq >= 1.1 && < 1.4+ , text >= 0.11 && < 1.2++benchmark semver-bench+ type: exitcode-stdio-1.0+ default-language: Haskell2010+ main-is: Main.hs+ hs-source-dirs: bench+ ghc-options: -Wall -O2 -threaded -with-rtsopts=-T++ build-depends:+ base+ , criterion >= 1.0.0.2 && < 1.1+ , semver+ , text++test-suite semver-test+ type: exitcode-stdio-1.0+ default-language: Haskell2010+ hs-source-dirs: test+ main-is: Main.hs+ ghc-options: -Wall -threaded++ build-depends:+ base+ , semver+ , tasty >= 0.8+ , tasty-hunit >= 0.8+ , text
+ src/Data/SemVer.hs view
@@ -0,0 +1,425 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}++-- Module : Data.SemVer+-- Copyright : (c) 2014 Brendan Hay <brendan.g.hay@gmail.com>+-- License : This Source Code Form is subject to the terms of+-- the Mozilla Public License, v. 2.0.+-- A copy of the MPL can be found in the LICENSE file or+-- you can obtain it at http://mozilla.org/MPL/2.0/.+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>+-- Stability : experimental+-- Portability : non-portable (GHC extensions)++-- | An implementation of the Semantic Versioning specification located at+-- <http://semver.org>.+--+-- A canonical 'Version' type and functions representing behaviour as outlined+-- in the specification are defined alongside additional lenses,+-- common manipulations, and serialisation primitives.+module Data.SemVer+ (+ -- * Version+ Identifier (..)+ , Version (..)+ , defaultVersion++ -- ** Lenses+ , versionMajor+ , versionMinor+ , versionPatch+ , versionRelease+ , versionMeta++ -- ** Incrementing+ , incrementMajor+ , incrementMinor+ , incrementPatch++ -- ** Predicates+ , isDevelopment+ , isPublic++ -- ** Encoding+ , toString+ , toText+ , toLazyText+ , toBuilder++ -- ** Decoding+ , fromText+ , fromLazyText+ , parser++ -- * Delimiters+ , Delimiters (..)+ , defaultDelimiters++ -- ** Lenses+ , delimMinor+ , delimPatch+ , delimRelease+ , delimMeta+ , delimIdent++ -- ** Encoding+ , toDelimitedBuilder++ -- ** Decoding+ , delimitedParser+ ) where++import Control.Applicative+import Control.DeepSeq+import Control.Monad+import Data.Attoparsec.Text+import Data.Char+import Data.Function (on)+import Data.List (intersperse)+import Data.Monoid+import Data.String+import Data.Text (Text)+import qualified Data.Text as Text+import qualified Data.Text.Lazy as LText+import Data.Text.Lazy.Builder (Builder)+import qualified Data.Text.Lazy.Builder as Build+import qualified Data.Text.Lazy.Builder.Int as Build+import Data.Typeable (Typeable)+import GHC.Generics+import Prelude hiding (takeWhile)++-- | A type representing an individual identifier from the release+-- or metadata components of a 'Version'.+--+-- * The 'Ord' instance implements precedence according to the semantic version+-- specification, with numeric identifiers being of _lower_ precedence than+-- textual identifiers, otherwise lexicographic ordering is used.+data Identifier+ = INum !Int+ | IText !Text+ deriving (Eq, Read, Show, Generic, Typeable)++instance Ord Identifier where+ compare a b = case (a, b) of+ (INum x, INum y) -> x `compare` y+ (IText x, IText y) -> x `compare` y+ (INum _, _) -> LT+ (IText _, _) -> GT++instance IsString Identifier where+ fromString s+ | all isDigit s = INum (read s)+ | otherwise = IText (fromString s)++instance NFData Identifier where+ rnf (INum n) = rnf n+ rnf (IText t) = rnf t++-- | A type representing a successfully decoded or constructed semantic version.+--+-- * The 'Eq' instance represents exhaustive equality with all+-- components considered.+-- * The 'Ord' instance implements the precedence rules from the semantic+-- version specification with metadata ('_versionMeta') being ignored.+data Version = Version+ { _versionMajor :: !Int+ -- ^ The major version component.+ , _versionMinor :: !Int+ -- ^ The minor version component.+ , _versionPatch :: !Int+ -- ^ The patch level component.+ , _versionRelease :: [Identifier]+ -- ^ A (potentially empty) list of release identifiers.+ , _versionMeta :: [Identifier]+ -- ^ A (potentially empty) list of metadata.+ } deriving (Eq, Read, Show, Generic, Typeable)++-- | A default 'Version' which can be used to signify initial development.+--+-- __Note:__ Equivalent to @0.0.0@+defaultVersion :: Version+defaultVersion = Version 0 0 0 [] []++instance Ord Version where+ compare a b = on compare versions a b <> on compare _versionRelease a b+ where+ versions Version{..} =+ [ _versionMajor+ , _versionMinor+ , _versionPatch+ ]++instance NFData Version where+ rnf Version{..} =+ rnf _versionMajor+ `seq` rnf _versionMinor+ `seq` rnf _versionPatch+ `seq` rnf _versionRelease+ `seq` rnf _versionMeta++versionMajor :: Functor f => (Int -> f Int) -> Version -> f Version+versionMajor f x = (\y -> x { _versionMajor = y }) <$> f (_versionMajor x)+{-# INLINE versionMajor #-}++versionMinor :: Functor f => (Int -> f Int) -> Version -> f Version+versionMinor f x = (\y -> x { _versionMinor = y }) <$> f (_versionMinor x)+{-# INLINE versionMinor #-}++versionPatch :: Functor f => (Int -> f Int) -> Version -> f Version+versionPatch f x = (\y -> x { _versionPatch = y }) <$> f (_versionPatch x)+{-# INLINE versionPatch #-}++versionRelease :: Functor f+ => ([Identifier] -> f [Identifier])+ -> Version+ -> f Version+versionRelease f x = (\y -> x { _versionRelease = y }) <$> f (_versionRelease x)+{-# INLINE versionRelease #-}++versionMeta :: Functor f+ => ([Identifier] -> f [Identifier])+ -> Version+ -> f Version+versionMeta f x = (\y -> x { _versionMeta = y }) <$> f (_versionMeta x)+{-# INLINE versionMeta #-}++-- | A set of delimiters used to encode/decode a 'Version' and specifyc+-- alternative serialisation strategies.+--+-- __Example:__ using alpha characters to encode the version as a valid+-- DNS CNAME, such as:+--+-- @+-- let Right v = fromText "1.2.3+40"+-- let alpha = Delimiters \'m\' \'p\' \'r\' \'d\' \'i\'+--+-- Data.Text.Lazy.Builder.toLazyText ("app01-" <> toDelimitedBuilder alpha v <> ".dmz.internal")+-- @+--+-- Would result in the following 'LText.Text':+--+-- @+-- app01-1m2p3d40.dmz.internal+-- @+--+-- Using the same 'Delimiters' set with 'delimitedParser' would ensure+-- correct decoding behaviour.+data Delimiters = Delimiters+ { _delimMinor :: !Char+ , _delimPatch :: !Char+ , _delimRelease :: !Char+ , _delimMeta :: !Char+ , _delimIdent :: !Char+ } deriving (Eq, Ord, Read, Show, Generic, Typeable)++-- | The default set of delimiters used in the semantic version specification.+--+-- __Example:__ Given exhaustive version components would result in the+-- following hypothetical version:+--+-- @+-- 1.2.3-alpha.1+sha.exp.12ab3d9+-- @+defaultDelimiters :: Delimiters+defaultDelimiters = Delimiters+ { _delimMinor = '.'+ , _delimPatch = '.'+ , _delimRelease = '-'+ , _delimMeta = '+'+ , _delimIdent = '.'+ }++instance NFData Delimiters where+ rnf Delimiters{..} =+ rnf _delimMinor+ `seq` rnf _delimPatch+ `seq` rnf _delimRelease+ `seq` rnf _delimMeta+ `seq` rnf _delimIdent++delimMinor :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters+delimMinor f x = (\y -> x { _delimMinor = y }) <$> f (_delimMinor x)+{-# INLINE delimMinor #-}++delimPatch :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters+delimPatch f x = (\y -> x { _delimPatch = y }) <$> f (_delimPatch x)+{-# INLINE delimPatch #-}++delimRelease :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters+delimRelease f x = (\y -> x { _delimRelease = y }) <$> f (_delimRelease x)+{-# INLINE delimRelease #-}++delimMeta :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters+delimMeta f x = (\y -> x { _delimMeta = y }) <$> f (_delimMeta x)+{-# INLINE delimMeta #-}++delimIdent :: Functor f => (Char -> f Char) -> Delimiters -> f Delimiters+delimIdent f x = (\y -> x { _delimIdent = y }) <$> f (_delimIdent x)+{-# INLINE delimIdent #-}++-- | Increment the major component of a 'Version' by 1, resetting the minor+-- and patch components.+--+-- * Major version X (X.y.z | X > 0) MUST be incremented if any backwards+-- incompatible changes are introduced to the public API.+--+-- * It MAY include minor and patch level changes.+--+-- * Patch and minor version MUST be reset to 0 when major version+-- is incremented.+incrementMajor :: Version -> Version+incrementMajor v = v+ { _versionMajor = _versionMajor v + 1+ , _versionMinor = 0+ , _versionPatch = 0+ }++-- | Increment the minor component of a 'Version' by 1, resetting the+-- patch component.+--+-- * Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards+-- compatible functionality is introduced to the public API.+--+-- * It MUST be incremented if any public API functionality is marked+-- as deprecated.+--+-- * It MAY be incremented if substantial new functionality or improvements+-- are introduced within the private code.+--+-- * It MAY include patch level changes.+--+-- * Patch version MUST be reset to 0 when minor version is incremented.+incrementMinor :: Version -> Version+incrementMinor v = v+ { _versionMinor = _versionMinor v + 1+ , _versionPatch = 0+ }++-- | Increment the patch component of a 'Version' by 1.+--+-- * Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards+-- compatible bug fixes are introduced.+--+-- * A bug fix is defined as an internal change that fixes incorrect behavior.+incrementPatch :: Version -> Version+incrementPatch v = v+ { _versionPatch = _versionPatch v + 1+ }++-- | Check if the 'Version' is considered unstable.+--+-- * Major version zero (0.y.z) is for initial development.+-- * Anything may change at any time.+-- * The public API should not be considered stable.+isDevelopment :: Version -> Bool+isDevelopment = (== 0) . _versionMajor++-- | Check if the 'Version' is considered stable.+--+-- Version 1.0.0 defines the public API. The way in which the version number+-- is incremented after this release is dependent on this public API and how+-- it changes.+isPublic :: Version -> Bool+isPublic = (>= 1) . _versionMajor++-- | Convert a 'Version' to it's readable 'String' representation.+--+-- __Note:__ This is optimised for cases where you wish to use a 'String' and+-- as such is faster than the semantically equivalent @unpack . toLazyText@.+toString :: Version -> String+toString = toMonoid (:[]) show Text.unpack defaultDelimiters++-- | Convert a 'Version' to a strict 'Text' representation.+--+-- __Note:__ Equivalent to @toStrict . toLazyText@+toText :: Version -> Text+toText = LText.toStrict . toLazyText++-- | Convert a 'Version' to a 'LText.Text' representation.+--+-- __Note:__ This uses a lower 'Builder' buffer size optimised for commonly+-- found version formats. If you have particuarly long version numbers+-- using 'toBuilder' and 'Build.toLazyTextWith' to control the buffer size+-- is recommended.+toLazyText :: Version -> LText.Text+toLazyText = Build.toLazyTextWith 24 . toBuilder++-- | Convert a 'Version' to a 'Builder'.+toBuilder :: Version -> Builder+toBuilder = toDelimitedBuilder defaultDelimiters++-- | Convert a 'Version' to a 'Builder' using the specified 'Delimiters' set.+toDelimitedBuilder :: Delimiters -> Version -> Builder+toDelimitedBuilder = toMonoid Build.singleton Build.decimal Build.fromText++toMonoid :: Monoid m+ => (Char -> m)+ -> (Int -> m)+ -> (Text -> m)+ -> Delimiters+ -> Version+ -> m+toMonoid del int txt Delimiters{..} Version{..} = mconcat+ [ int _versionMajor+ , del _delimMinor+ , int _versionMinor+ , del _delimPatch+ , int _versionPatch+ , f _delimRelease _versionRelease+ , f _delimMeta _versionMeta+ ]+ where+ f _ [] = mempty+ f c xs = del c <> mconcat (intersperse (del _delimIdent) (map g xs))++ g (INum n) = int n+ g (IText t) = txt t+{-# INLINE toMonoid #-}++-- | Parse a 'Version' from 'Text', returning an attoparsec error message+-- in the 'Left' case on failure.+fromText :: Text -> Either String Version+fromText = parseOnly parser++-- | Parse a 'Version' from 'LText.Text', returning an attoparsec error message+-- in the 'Left' case on failure.+--+-- __Note:__ The underlying attoparsec 'Parser' is based on 'Text' and this is+-- equivalent to @fromText . toStrict@+fromLazyText :: LText.Text -> Either String Version+fromLazyText = fromText . LText.toStrict++-- | A greedy attoparsec 'Parser' which requires the entire 'Text' input to match.+parser :: Parser Version+parser = delimitedParser defaultDelimiters++-- | A greedy attoparsec 'Parser' using the specified 'Delimiters' set+-- which requires the entire 'Text' input to match.+delimitedParser :: Delimiters -> Parser Version+delimitedParser Delimiters{..} = Version+ <$> (nonNegative <* char _delimMinor)+ <*> (nonNegative <* char _delimPatch)+ <*> nonNegative+ <*> option [] (try (char _delimRelease) *> identifiers)+ <*> option [] (try (char _delimMeta) *> identifiers)+ <* endOfInput+ where+ nonNegative :: (Show a, Integral a) => Parser a+ nonNegative = do+ n <- decimal+ when (n < 0) $+ fail ("Numeric value must be non-negative: " ++ show n)+ return n++ identifiers :: Parser [Identifier]+ identifiers = many (num <|> text)++ num = INum+ <$> nonNegative+ <* (void (char _delimIdent) <|> endOfInput)++ text = IText+ <$> takeWhile1 (inClass "0-9A-Za-z-")+ <* optional (char _delimIdent)
+ test/Main.hs view
@@ -0,0 +1,75 @@+{-# LANGUAGE OverloadedStrings #-}++-- Module : Main+-- Copyright : (c) 2014 Brendan Hay <brendan.g.hay@gmail.com>+-- License : This Source Code Form is subject to the terms of+-- the Mozilla Public License, v. 2.0.+-- A copy of the MPL can be found in the LICENSE file or+-- you can obtain it at http://mozilla.org/MPL/2.0/.+-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>+-- Stability : experimental+-- Portability : non-portable (GHC extensions)++module Main (main) where++import Control.Applicative+import Data.List (sort)+import Data.SemVer+import Data.Text (Text, unpack)+import Test.Tasty+import Test.Tasty.HUnit++main :: IO ()+main = defaultMain $ testGroup "tests"+ [ testGroup "serialisation"+ [ testGroup "isomorphisms"+ [ iso "0.0.0"+ , iso "1.0.0"+ , iso "1.0.0-alpha"+ , iso "1.0.0-alpha.1"+ , iso "1.0.1"+ , iso "1.1.0"+ , iso "2.0.0"+ , iso "2.1.0"+ , iso "2.1.1"+ , iso "1.2.3+sha.2ac"+ , iso "1.2.3-beta.1+sha.exp.dc2"+ ]+ ]++ , testGroup "precedence"+ [ testCase "0.0.0 < 1.0.0 < 1.0.1 < 1.1.0" $+ [sv000, sv100, sv101, sv110] @=? sort [sv101, sv110, sv100, sv000]+ , testCase "1.0.0 < 2.0.0" $+ true (sv100 < sv200)+ , testCase "1.0.0 < 1.0.0-alpha" $+ true (sv100 < sv100alpha)+ , testCase "1.0.0-alpha < 1.0.0-alpha.1" $+ true (sv100alpha < sv100alpha1)+ , testCase "1.2.3+sha.2ac < 1.2.3-beta.1+sha.exp.dc2" $+ true (sv123sha2ac < sv123beta1shaexpdc2)+ ]+ ]++iso :: Text -> TestTree+iso t = testCase (unpack t) (Right t @=? (toText <$> fromText t))++true :: Bool -> Assertion+true = (True @=?)++sv000, sv100, sv100alpha, sv100alpha1, sv101 :: Version+sv110, sv200, sv123sha2ac, sv123beta1shaexpdc2 :: Version+sv000 = defaultVersion+sv100 = sv "1.0.0"+sv100alpha = sv "1.0.0-alpha"+sv100alpha1 = sv "1.0.0-alpha.1"+sv101 = sv "1.0.1"+sv110 = sv "1.1.0"+sv200 = sv "2.0.0"+sv123sha2ac = sv "1.2.3+sha.2ac"+sv123beta1shaexpdc2 = sv "1.2.3-beta.1+sha.exp.dc2"++sv :: Text -> Version+sv t = case fromText t of+ Left e -> error e+ Right x -> x