initial untested version with README

This commit is contained in:
Jesse Gumm 2013-01-14 13:58:12 -06:00
commit 9ac0e40446
3 changed files with 187 additions and 0 deletions

97
README.markdown Normal file
View file

@ -0,0 +1,97 @@
# qdate - A Wrapper for Erlang Date/Time Management
## Purpose
Erlang Date and Time management is rather primitive, but improving.
[dh_date](https://github.com/daleharvey/dh_date), of which `ec_date` in
[erlware_commons](https://github.com/erlware/erlware_commons) is a huge step
towards formatting and parsing dates in a way that compares nicely with PHP's
[date](http://php.net/manual/en/function.date.php) and
[strtotime](http://php.net/manual/en/function.strtotime.php) functions.
Unfortunately, `ec_date` doesn't deal with timezones, but conveniently,
the project [erlang_localtime](https://github.com/dmitryme/erlang_localtime)
does.
It is the express purpose of this `qdate` package to bring together the
benefits of `ec_date` and `erlang_localtime`, as well as extending the
capabilities of both to provide for other needed tools found in a single
module.
`qdate` will provide, under the roof of a single module date and time formatting
and parsing from and into:
+ Formatting Strings
+ Erlang Date Format
+ Erlang Now Format
+ Unixtime integers
All while doing so by allowing you to either set a timezone by some arbitrary
key or by using the current process's Pid is the key.
Further, while `ec_date` doesn't support PHP's timezone characters (e, I, O, P,
and T, Z), `qdate` will handle them for us.
## Exported Functions:
### Conversion Functions
+ `to_string(FormatString, Date)` - "FormatString" is a string that follows the
`date` function formatting rules. `Date` is any date, in almost any common
format
+ `to_string(FormatString)` - Formats the current time
+ `to_date(Date)` - converts any date/time format to Erlang date format.
+ `to_now(Date)` - converts any date/time format to Erlang now format.
+ `to_unixtime(Date)` - converts any date/time format to a unixtime integer
#### Conversion Functions provided for API compatibility with `ec_date`
+ `parse/1` - Same as `to_date(Date)`
+ `nparse/1` - Same as `to_now(Date)`
+ `format/1` - Same as `to_string/1`
+ `format/2` - Same as `to_string/2`
### Timezone Functions
+ `set_timezone(Key, TZ)` - Set the timezone to TZ for the key `Key`
+ `set_timezone(TZ)` - Sets the timezone, and uses the Pid from `self()` as
the `Key`. Also links the process for removal from the record when the Pid
dies.
+ `get_timezone(Key)` - Gets the timezone assigned to `Key`
+ `get_timezone()` - Gets the timezone using `self()` as the `Key`
+ `clear_timezone(Key)` - Removes the timezone record associated with `Key`.
+ `clear_timezone()` - Removes the timezone record using `self()` as `Key`.
This function is not necessary for cleanup, most of the time, since if
`Key` is a Pid, the `qdate` server will automatically clean up when the
Pid dies.
**Note:** If no timezone is set, then anything relying on the timezone will
default to GMT.
## Example:
Calling `qdate:format` will allow single-line re-encoding of a date.
Say we wanted to convert the date and time from "12/31/2013 8:15pm" to
something like "2013-12-31 (16:15:00)":
Using just `ec_date`, you would do it like this:
```erlang
OldDate = "12/31/2013 8:15pm",
Date = ec_date:parse(OldDate),
NewString = ec_date:format("Y-m-d (H:i:s)",Date).
```
With the new method, you could do it simply and clearly with one line:
```erlang
NewString = qdate:format("Y-m-d (H:i:s)",OldDate).
```
The nice thing about it this though, is that OldDate can be *any* date format,
and it will figure it out. It can be any of the following:
+ Erlang Date Format: `{{Y,M,D},{H,M,S}}`
+ Erlang Now Format: `{MegaSecs, Secs, MicroSecs}`
+ Date String: `"2013-12-31 08:15pm"`
+ Integer Unix Timestamp: 1388448000

12
src/qdate.app.src Normal file
View file

@ -0,0 +1,12 @@
{application, qdate,
[
{description, "Simple Date and Timezone handling for Erlang"},
{vsn, "0.0.1"},
{registered, []},
{applications, [
kernel,
stdlib
]},
{mod, { qdate, []}},
{env, []}
]}.

78
src/qdate.erl Normal file
View file

@ -0,0 +1,78 @@
-module(qdate).
-export([
to_string/1,
to_string/2,
to_date/1,
to_now/1,
to_unixtime/1
]).
%% Exported for API compatibility with ec_date
-export([
format/1,format/2,
nparse/1,
parse/1
]).
to_string(Format) ->
to_string(Format, now()).
to_string(Format, Date) ->
ec_date:format(Format,to_date(Date)).
format(Format) ->
to_string(Format).
format(Format, Date) ->
to_string(Format, Date).
parse(String) ->
to_date(String).
nparse(String) ->
parse_to_now(String).
to_date(Unixtime) when is_integer(Unixtime) ->
unixtime_to_date(Unixtime);
to_date(DateString) when is_list(DateString) ->
ec_date:parse(DateString);
to_date(Now = {_,_,_}) ->
calendar:now_to_datetime(Now);
to_date(Date = {{_,_,_},{_,_,_}}) ->
Date.
to_unixtime(Unixtime) when is_integer(Unixtime) ->
Unixtime;
to_unixtime(ToParse) ->
Date = to_date(ToParse),
calendar:datetime_to_gregorian_seconds(Date).
to_now(Now = {_,_,_}) ->
Now;
to_now(ToParse) ->
Unixtime = to_unixtime(ToParse),
unixtime_to_now(Unixtime).
unixtime_to_now(T) when is_integer(T) ->
MegaSec = floor(T/1000000),
Secs = T - MegaSec*1000000,
{MegaSec,Secs,0}.
unixtime_to_date(T) ->
Now = unixtime_to_now(T),
calendar:now_to_datetime(Now).
floor(N) when N >= 0 ->
trunc(N);
floor(N) when N < 0 ->
Int = trunc(N),
if
Int==N -> Int;
true -> Int-1
end.