Changelog for Tz_World v0.5.0
This is the changelog for Tz_World v0.5.0 released on May 23rd, 2020. For older changelogs please consult the release tag on GitHub
Bug Fixes
Move compile time configuration of the data directory to runtime and remove hard-coded default path
Start
:inets
and:ssl
applications in the downloader mix taskAdd certificate verification when downloading updates to the geo data
Enhancements
Document the
:data_dir
and:cacertfile
configuration options it the README.md fileThe backends
:dets
and:dets_with_index_cache
now open the:dets
file asaccess: :read
which prevents errors if the file is abnormally closed.
Changelog for Tz_World v0.4.0
This is the changelog for Tz_World v0.4.0 released on May 12th, 2020. For older changelogs please consult the release tag on GitHub
- Adds configurable backends. Each backend is a GenServer that must be added to an applications supervision tree or started manually.
Breaking change
- When specifying a
lng
,lat
toTzWorld.timezone_at/2
the coordinates must be wrapped in a tuple. For exampleTzWorld.timezone_at({3.2, 45.32})
making it consistent with theGeo.Point
andGeo.PointZ
strategies.
Configurable backends
TzWorld.Backend.Memory
which retains all data in memory for fast (but not fastest) performance at the expense of using approximately 1Gb of memoryTzWorld.Backend.Dets
which uses Erlang's:dets
data store. This uses negligible memory at the expense of slow access times (approximaltey 500ms in testing)TzWorld.Backend.DetsWithIndexCache
which balances memory usage and performance. This backend is recommended in most situations since its performance is similar toTzWorld.Backend.Memory
(about 5% slower in testing) and uses about 25Mb of memoryTzWorld.Backend.Ets
which uses:ets
for storage. With the default settings of:compressed
for the:ets
table its memory consumption is about 512Mb but with access that is over 20 times slower thanTzWorld.Backend.DetsWithIndexCache
TzWorld.Backend.EtsWithIndexCache
which uses:ets
for storage with an additional in-memory cache of the bounding boxes. This still uses about 512Mb but is faster than any of the other backends by about 40%
Enhancements
- Add
TzWorld.all_timezones_at/2
to return all timezones for a given location. In rare cases, usually disputed territory, multiple timezones may be declared for overlapping regions.TzWorld.all_timezones_at/2
returns a (potentially empty) list of all time zones known for a given point. Futher testing of this function is required and will be completed before version 1.0.
Changelog for Tz_World v0.3.0
This is the changelog for Tz_World v0.3.0 released on December 4th, 2019. For older changelogs please consult the release tag on GitHub
Breaking Changes
- Changes the error return from
{:error, :timezone_not_found}
to{:error, :time_zone_not_found}
since both Elixir and Tzdata usetime_zone
.
Enhancements
- Allows both
%Geo.Point{}
and%Geo.PointZ{}
as parameters toTzWorld.timezone_at/1
Changelog for Tz_World v0.2.0
This is the changelog for Tz_World v0.2.0 released on November 28th, 2019. For older changelogs please consult the release tag on GitHub
Breaking Changes
Requires OTP 21 and Elixir 1.6 or later due to the use of GenServer's
handle_continue/2
timezone_at/1
returns tagged tuples{:ok, result}
or{:error, reason}
. There can be at least two reasons for an error: no data file is available or no timezone is found. These return{:error, :enoent}
and{:error, :timezone_not_found}
respectivelyThe timezone geojson data is no longer included in the package. Run
mix tz_world.update
to install or update it.No longer uses Ecto or PostGIS for calculations.
Enhancements
Updated to latest shape data. Takes the geo JSON shape data directly from timezone-boundary-builder releases
Conforms TzWorker to the modern
child_spec/1
including usinghandle_continue/2
to load the data file if it exists.Updated dependencies including geo to allow
1.x
,2.x
or3.x
Added
Jason
as an optional dependency to facilitate decoding the GeoJSON fromtimezone_boundary_builder
The timezone geojson data is no longer included in the package. Its size isn't supported on hex and it bloats the repo too. A mix task
tz_world.update
downloads and processes the data. The functionTzWorld.Downloader.update_release/0
can be called at any time to look for a new release, download it and load it into the running server with no downtime.timezone_at/1
supports simplelng
,lat
arguments as well as%Geo.Point{}
structsAdded
CHANGELOG.md
Added SRID to the GeoJSON
Updated package and ran dialyzer
Added a config option :data_dir specifies the location of the compressed etf. Default is
./priv
Updated README, package and docs