time-interval (empty) → 0.1.0.0

raw patch · 9 files changed

+353/−0 lines, 9 filesdep +basedep +time-unitssetup-changed

Dependencies added: base, time-units

Files

• AUTHORS +1/−0
• COPYING +121/−0
• ChangeLog +17/−0
• INSTALL +13/−0
• NEWS +23/−0
• README.md +14/−0
• Setup.hs +2/−0
• src/Data/Time/Interval.hs +105/−0
• time-interval.cabal +57/−0

@@ -0,0 +1,1 @@+fr33domlover <fr33domlover@riseup.net>

@@ -0,0 +1,121 @@+Creative Commons Legal Code++CC0 1.0 Universal++    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED+    HEREUNDER.++Statement of Purpose++The laws of most jurisdictions throughout the world automatically confer+exclusive Copyright and Related Rights (defined below) upon the creator+and subsequent owner(s) (each and all, an "owner") of an original work of+authorship and/or a database (each, a "Work").++Certain owners wish to permanently relinquish those rights to a Work for+the purpose of contributing to a commons of creative, cultural and+scientific works ("Commons") that the public can reliably and without fear+of later claims of infringement build upon, modify, incorporate in other+works, reuse and redistribute as freely as possible in any form whatsoever+and for any purposes, including without limitation commercial purposes.+These owners may contribute to the Commons to promote the ideal of a free+culture and the further production of creative, cultural and scientific+works, or to gain reputation or greater distribution for their Work in+part through the use and efforts of others.++For these and/or other purposes and motivations, and without any+expectation of additional consideration or compensation, the person+associating CC0 with a Work (the "Affirmer"), to the extent that he or she+is an owner of Copyright and Related Rights in the Work, voluntarily+elects to apply CC0 to the Work and publicly distribute the Work under its+terms, with knowledge of his or her Copyright and Related Rights in the+Work and the meaning and intended legal effect of CC0 on those rights.++1. Copyright and Related Rights. A Work made available under CC0 may be+protected by copyright and related or neighboring rights ("Copyright and+Related Rights"). Copyright and Related Rights include, but are not+limited to, the following:++  i. the right to reproduce, adapt, distribute, perform, display,+     communicate, and translate a Work;+ ii. moral rights retained by the original author(s) and/or performer(s);+iii. publicity and privacy rights pertaining to a person's image or+     likeness depicted in a Work;+ iv. rights protecting against unfair competition in regards to a Work,+     subject to the limitations in paragraph 4(a), below;+  v. rights protecting the extraction, dissemination, use and reuse of data+     in a Work;+ vi. database rights (such as those arising under Directive 96/9/EC of the+     European Parliament and of the Council of 11 March 1996 on the legal+     protection of databases, and under any national implementation+     thereof, including any amended or successor version of such+     directive); and+vii. other similar, equivalent or corresponding rights throughout the+     world based on applicable law or treaty, and any national+     implementations thereof.++2. Waiver. To the greatest extent permitted by, but not in contravention+of, applicable law, Affirmer hereby overtly, fully, permanently,+irrevocably and unconditionally waives, abandons, and surrenders all of+Affirmer's Copyright and Related Rights and associated claims and causes+of action, whether now known or unknown (including existing as well as+future claims and causes of action), in the Work (i) in all territories+worldwide, (ii) for the maximum duration provided by applicable law or+treaty (including future time extensions), (iii) in any current or future+medium and for any number of copies, and (iv) for any purpose whatsoever,+including without limitation commercial, advertising or promotional+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each+member of the public at large and to the detriment of Affirmer's heirs and+successors, fully intending that such Waiver shall not be subject to+revocation, rescission, cancellation, termination, or any other legal or+equitable action to disrupt the quiet enjoyment of the Work by the public+as contemplated by Affirmer's express Statement of Purpose.++3. Public License Fallback. Should any part of the Waiver for any reason+be judged legally invalid or ineffective under applicable law, then the+Waiver shall be preserved to the maximum extent permitted taking into+account Affirmer's express Statement of Purpose. In addition, to the+extent the Waiver is so judged Affirmer hereby grants to each affected+person a royalty-free, non transferable, non sublicensable, non exclusive,+irrevocable and unconditional license to exercise Affirmer's Copyright and+Related Rights in the Work (i) in all territories worldwide, (ii) for the+maximum duration provided by applicable law or treaty (including future+time extensions), (iii) in any current or future medium and for any number+of copies, and (iv) for any purpose whatsoever, including without+limitation commercial, advertising or promotional purposes (the+"License"). The License shall be deemed effective as of the date CC0 was+applied by Affirmer to the Work. Should any part of the License for any+reason be judged legally invalid or ineffective under applicable law, such+partial invalidity or ineffectiveness shall not invalidate the remainder+of the License, and in such case Affirmer hereby affirms that he or she+will not (i) exercise any of his or her remaining Copyright and Related+Rights in the Work or (ii) assert any associated claims and causes of+action with respect to the Work, in either case contrary to Affirmer's+express Statement of Purpose.++4. Limitations and Disclaimers.++ a. No trademark or patent rights held by Affirmer are waived, abandoned,+    surrendered, licensed or otherwise affected by this document.+ b. Affirmer offers the Work as-is and makes no representations or+    warranties of any kind concerning the Work, express, implied,+    statutory or otherwise, including without limitation warranties of+    title, merchantability, fitness for a particular purpose, non+    infringement, or the absence of latent or other defects, accuracy, or+    the present or absence of errors, whether or not discoverable, all to+    the greatest extent permissible under applicable law.+ c. Affirmer disclaims responsibility for clearing rights of other persons+    that may apply to the Work or any use thereof, including without+    limitation any person's Copyright and Related Rights in the Work.+    Further, Affirmer disclaims responsibility for obtaining any necessary+    consents, permissions or other rights required for any use of the+    Work.+ d. Affirmer understands and acknowledges that Creative Commons is not a+    party to this document and has no duty or obligation with respect to+    this CC0 or use of the Work.

@@ -0,0 +1,17 @@+The changes are recorded by the version control system, Darcs. To see a log+quickly from the terminal, run:++  $ darcs changes --repo http://dev.rel4tion.org/fr33domlover/time-interval++There is also a web interface at <http://darcs.rel4tion.org> which, among other+things, can display the history log.++To see the log in a local clone, first get a copy of the repository if you+haven't yet:++  $ darcs get http://dev.rel4tion.org/fr33domlover/time-interval++Then move into the newly created directory and run darcs:++  $ cd time-interval+  $ darcs changes

@@ -0,0 +1,13 @@+Install from Hackage:++    $ cabal install time-interval++Install from unpacked release tarball or source repo:++    $ cd time-interval+    $ cabal install++Just play with it without installing:++    $ cabal build+    $ cabal repl

@@ -0,0 +1,23 @@+This file lists the user-visible interesting changes between releases. For a+full list of changes to the source, see the ChangeLog.++++time-interval 0.1.0.0 -- 2015-09-10+===================================++General, build and documentation changes:++* (This is the first release, so everything is new)++New APIs, features and enhancements:++* (This is the first release, so everything is a new feature)++Bug fixes:++* (This is just the first release)++Dependency changes:++* (This is the first release)

@@ -0,0 +1,14 @@+See the .cabal file for more info and link to project website the version+control.++The official download location is Hackage:++<http://hackage.haskell.org/package/time-interval>++This library is free software, and is committed to software freedom. It is+released to the public domain using the CC0 Public Domain Dedication. For the+boring "legal" details see the file 'COPYING'.++See the file 'INSTALL' for hints on installation. The file 'ChangeLog' explains+how to see the history log of the changes done in the code. 'NEWS' provides a+friendly overview of the changes for each release.

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,105 @@+{- This file is part of time-interval.+ -+ - Written in 2015 by fr33domlover <fr33domlover@rel4tion.org>.+ -+ - ♡ Copying is an act of love. Please copy, reuse and share.+ -+ - The author(s) have dedicated all copyright and related and neighboring+ - rights to this software to the public domain worldwide. This software is+ - distributed without any warranty.+ -+ - You should have received a copy of the CC0 Public Domain Dedication along+ - with this software. If not, see+ - <http://creativecommons.org/publicdomain/zero/1.0/>.+ -}++-- | Suppose you have a program which periodically reloads state and saves some+-- logs, and you'd like the intervals for these periodic actions to be+-- expressed using time units, and abstract away the internal representation+-- until the site of actual use. Your code may look like this:+--+-- > data AppState tr ts = AppState+-- >     { userName       :: String+-- >     , newMessages    :: [String]+-- >     , reloadInterval :: tr+-- >     , saveInterval   :: ts+-- >     }+-- >+-- > type App tr ts = StateT (AppState tr ts) IO+-- >+-- > setReloadInterval :: TimeUnit t => t -> App ()+-- > setReloadInterval new = modify $ \ s -> s { reloadInterval = new }+-- >+-- > syncStateWithFiles :: (TimeUnit tr, TimeUnit ts) => App tr ts ()+-- > syncStateWithFiles = do+-- >     reloadMicrosec <- liftM toMicroseconds $ gets reloadInterval+-- >     saveMicrosec <- liftM toMicroseconds $ gets saveInterval+-- >     {- ... use the values ... -}+--+-- And usage looks like this:+--+-- > setReloadInterval (5 :: Second)+--+-- So every time you add, change or remove a time field, all your type+-- signatures need to be updated and all your @App@ actions, even unrelated to+-- those times, are stuck with time type parameters in their type signatures.+--+-- An easy and common approach to avoid all the mess is to store the time as an+-- integer, i.e. applying 'toMicroseconds' when setting the value rather than+-- when using it. That makes things much easier, but then your type (and your+-- API) expose the time directly as a number of microseconds, and people end up+-- writing things like @1000 * 1000 * 60 * 5@ to say "5 minuts". It's also an+-- internal technical detail there's no reason to expose, and should be+-- possible to change without breaking anything - e.g. what if your scheduling+-- tool one day moves to a higher precision than microseconds? Your high-level+-- API would ideally not let that change float all the way up.+--+-- Here's how things can work when using this library.+--+-- > data AppState = AppState+-- >     { userName       :: String+-- >     , newMessages    :: [String]+-- >     , reloadInterval :: TimeInterval+-- >     , saveInterval   :: TimeInterval+-- >     }+-- >+-- > type App = StateT AppState IO+-- >+-- > setReloadInterval :: TimeUnit t => t -> App ()+-- > setReloadInterval new = modify $ \ s -> s { reloadInterval = time new }+-- >+-- > syncStateWithFiles :: App ()+-- > syncStateWithFiles = do+-- >     reloadMicrosec <- liftM microseconds $ gets reloadInterval+-- >     saveMicrosec <- liftM microseconds $ gets saveInterval+-- >     {- ... use the values ... -}+--+-- And usage looks the same:+--+-- > setReloadInterval (5 :: Second)+--+-- Also, even if you let the user use the 'time' function in their code, e.g.+-- like this:+--+-- > setReloadInterval $ time (5 :: Second)+--+-- ... you stil get the advantages from both worlds.+module Data.Time.Interval+    ( TimeInterval ()+    , time+    , microseconds+    )+where++import Data.Time.Units (TimeUnit (..))++-- | A time duration.+newtype TimeInterval = TimeInterval Integer deriving (Eq, Ord, Show)++-- | Convert a time value expressed in a some time unit into a 'TimeInterval'.+time :: TimeUnit t => t -> TimeInterval+time = TimeInterval . toMicroseconds++-- | Express a 'TimeInterval' in microseconds.+microseconds :: TimeInterval -> Integer+microseconds (TimeInterval i) = i

@@ -0,0 +1,57 @@+name:                time-interval+version:             0.1.0.0+synopsis:            Use a time unit class, but hold a concrete time type.+description:+  Two common ways to represent and hold short time intervals seem to be:+  .+  1. Hold time in microseconds as an 'Int' or 'Integer'+  2. Use time units abstraction, e.g. see the time-units package+  .+  While the second option is a great abstraction to use in APIs, it works for+  datatypes a bit less well than for function types. That's because a datatype+  which a 'Data.Time.Units.TimeUnit' field suddenly becomes polymorphic over+  that field, and all function type signatures involving that datatype need to+  be updated. This is less an issue for functions, because you don't specify+  the type of every function at the call site.+  .+  Perhaps there is a solution for that which involves datatype related+  language extensions, but this package tries to offer a simple clean solution+  as follows. You store time in your datatype as an integer, but it is wrapped+  by an opaque 'Data.Time.Interval.TimeInterval' type. You then get the best of+  both worlds:+  .+  * On one hand, you can set the time field using any time unit thanks to the+    time-units package, so you get a nice abstraction+  .+  * On the other hand, your datatype holds a concrete time type+  .+  The time type can be equally used to represent time intervals, time durations+  and generally time lengths. But since high precision is used (microseconds),+  you'll probably want this library for short time lengths (at most seconds,+  minutes, hours). For calendar based and related time functions and types, see+  the @time@ package.+homepage:            http://rel4tion.org/projects/time-interval/+bug-reports:         http://rel4tion.org/projects/time-interval/tickets/+license:             PublicDomain+license-file:        COPYING+author:              fr33domlover+maintainer:          fr33domlover@riseup.net+copyright:           ♡ Copying is an act of love. Please copy, reuse and share.+category:            Web+build-type:          Simple+extra-source-files:  AUTHORS ChangeLog COPYING INSTALL NEWS README.md+cabal-version:       >=1.10++source-repository head+  type:                darcs+  location:            http://dev.rel4tion.org/fr33domlover/time-interval++library+  exposed-modules:     Data.Time.Interval+  -- other-modules:       +  -- other-extensions:    +  build-depends:       base       >=4.7 && <5+                     , time-units >=1+  hs-source-dirs:      src+  default-language:    Haskell2010+  ghc-options:         -Wall