diff --git a/AUTHORS b/AUTHORS new file mode 100644 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,1 @@ +fr33domlover diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -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. diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -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://hub.darcs.net/fr33domlover/time-cache + +There is also a web interface at 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://hub.darcs.net/fr33domlover/time-cache + +Then move into the newly created directory and run darcs: + + $ cd time-cache + $ darcs changes diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,12 @@ +Install from Hackage/Stackage: + + $ stack install time-cache + +Install from unpacked release tarball or source repo: + + $ cd time-cache + $ stack install + +Just play with it without installing: + + $ stack repl diff --git a/NEWS.md b/NEWS.md new file mode 100644 --- /dev/null +++ b/NEWS.md @@ -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-cache 0.1 2016-03-15 +================================ + +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, many bugs haven't been discovered yet) + +Dependency changes: + +* (This is the first release) diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -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: + + + +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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/src/Control/Monad/Trans/Time.hs b/src/Control/Monad/Trans/Time.hs new file mode 100644 --- /dev/null +++ b/src/Control/Monad/Trans/Time.hs @@ -0,0 +1,101 @@ +{- This file is part of time-cache. + - + - Written in 2016 by fr33domlover . + - + - ♡ 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 + - . + -} + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +module Control.Monad.Trans.Time + ( MonadTime (..) + , MonadTimeFormat (..) + , TimeT () + , runTimeT + , TimeCacheT () + , runTimeCacheT + , runTimeCacheTWithGetter + , askTimeGetter + ) +where + +import Control.Arrow ((&&&)) +import Control.AutoUpdate +import Control.Monad.Fix (MonadFix) +import Control.Monad.IO.Class +import Control.Monad.Trans.Class (MonadTrans) +import Control.Monad.Trans.Reader +import Data.Text (Text, pack) +import Data.Time.Cache +import Data.Time.Clock (UTCTime, getCurrentTime) +import Data.Time.Format (TimeLocale, formatTime) +import Data.Time.Units (TimeUnit (toMicroseconds)) + +class Monad m => MonadTime m where + askTime :: m UTCTime + +class MonadTime m => MonadTimeFormat m where + askFormattedTime :: m Text + askTimeAndFormat :: m (UTCTime, Text) + askTimeAndFormat = (,) <$> askTime <*> askFormattedTime + +newtype TimeT m a = TimeT + { unTimeT :: ReaderT (TimeLocale, String) m a + } + deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans) + +runTimeT :: TimeT m a -> TimeLocale -> String -> m a +runTimeT act locale format = runReaderT (unTimeT act) (locale, format) + +instance MonadIO m => MonadTime (TimeT m) where + askTime = liftIO getCurrentTime + +instance MonadIO m => MonadTimeFormat (TimeT m) where + askFormattedTime = do + (locale, format) <- TimeT ask + pack . formatTime locale format <$> askTime + askTimeAndFormat = do + (locale, format) <- TimeT ask + (id &&& pack . formatTime locale format) <$> askTime + +newtype TimeCacheT m a = TimeCacheT + { unTimeCacheT :: ReaderT (IO (UTCTime, Text)) m a + } + deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadTrans) + +instance MonadIO m => MonadTime (TimeCacheT m) where + askTime = fst <$> askTimeAndFormat + +instance MonadIO m => MonadTimeFormat (TimeCacheT m) where + askFormattedTime = snd <$> askTimeAndFormat + askTimeAndFormat = do + get <- TimeCacheT ask + liftIO get + +runTimeCacheT + :: (TimeUnit t, MonadIO m) + => TimeCacheT m a + -> t + -> TimeLocale + -> String + -> m a +runTimeCacheT act interval locale format = do + getter <- liftIO $ mkTimeGetter interval locale format + runTimeCacheTWithGetter act getter + +runTimeCacheTWithGetter + :: TimeCacheT m a + -> TimeGetter + -> m a +runTimeCacheTWithGetter act getter = runReaderT (unTimeCacheT act) getter + +askTimeGetter :: Monad m => TimeCacheT m TimeGetter +askTimeGetter = TimeCacheT ask diff --git a/src/Data/Time/Cache.hs b/src/Data/Time/Cache.hs new file mode 100644 --- /dev/null +++ b/src/Data/Time/Cache.hs @@ -0,0 +1,40 @@ +{- This file is part of time-cache. + - + - Written in 2016 by fr33domlover . + - + - ♡ 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 + - . + -} + +module Data.Time.Cache + ( TimeGetter + , mkTimeGetter + ) +where + +import Control.AutoUpdate +import Control.Monad.Fix (MonadFix) +import Control.Monad.IO.Class +import Control.Monad.Trans.Class (MonadTrans) +import Data.Text (Text, pack) +import Data.Time.Clock (UTCTime, getCurrentTime) +import Data.Time.Format (TimeLocale, formatTime) +import Data.Time.Units (TimeUnit (toMicroseconds)) + +type TimeGetter = IO (UTCTime, Text) + +mkTimeGetter + :: TimeUnit t => t -> TimeLocale -> String -> IO TimeGetter +mkTimeGetter interval locale format = mkAutoUpdate defaultUpdateSettings + { updateFreq = fromInteger $ toMicroseconds interval + , updateAction = do + now <- getCurrentTime + return (now, pack $ formatTime locale format now) + } diff --git a/time-cache.cabal b/time-cache.cabal new file mode 100644 --- /dev/null +++ b/time-cache.cabal @@ -0,0 +1,62 @@ +name: time-cache +version: 0.1 +cabal-version: >=1.10 +build-type: Simple +license: PublicDomain +license-file: COPYING +copyright: ♡ Copying is an act of love. Please copy, reuse and share. +maintainer: fr33domlover@riseup.net +homepage: http://rel4tion.org/projects/time-cache +bug-reports: mailto:fr33domlover@riseup.net +synopsis: Cache current time and formatted time text +description: + Suppose you have an IO action which runs very frequently, and one of the + things it does is getting the current @UTCTime@, possibly also formatting it + into a String or Text. The action cares about the current minute, and doesn't + care about seconds or milliseconds at all. Instead of reading and formatting + the time many times, using this library you can keep a cache which updates + every minute (or other interval) and allows your application to scale without + time reading and formatting ever becoming a bottleneck. + . + There are 2 modules provided. I suggest you start with the monadic one, + especially for simple usage, and switch to the other one if you need + some custom solution. + . + The "Data.Time.Cache" module allows you to create a time caching action which + returns time and a formatted time string. But instead of directly reading the + time and running a formatter, it takes the values from a cache it + periodically updates. + . + The "Control.Monad.Trans.Time" module provides a convenient monadic wrapper + for the time cache. + . + If you need the time cache in multiple threads, you can create the time + getter once and then pass to all the threads to share. +category: System, Time +author: fr33domlover +extra-source-files: + AUTHORS + ChangeLog + COPYING + INSTALL.md + NEWS.md + README.md + +source-repository head + type: darcs + location: http://hub.darcs.net/fr33domlover/time-cache + +library + exposed-modules: + Control.Monad.Trans.Time + Data.Time.Cache + build-depends: + auto-update >=0.1.3, + base >=4.8 && <5, + text >=1.2.2.0, + time >=1.5.0.1, + time-units >=1.0.0, + transformers >=0.4.2.0 + default-language: Haskell2010 + hs-source-dirs: src +