local_time_helper

Version, currently 0.1.04 versions

github.com/anamba/local_time_helper.cr

Crystal port of local_time view helper from local_time gem (https://github.com/basecamp/local_time)

4 stars
2 dependents
License: MIT

Nothing has been indexed for 0.1.0 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

# Add this to your shard.yml
dependencies:
  local_time_helper:
    github: anamba/local_time_helper.cr
    version: ~> 0.1.0

Then run:

shards install

shard.yml

No shard.yml has been indexed for 0.1.0. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

local_time_helper.cr

Build Status Version License

Crystal implementation of view helper from https://github.com/basecamp/local_time, with one small Crystal-specific improvement to save you some typing (both kinds): a nil_message option (a string returned when the provided time argument is nil; typically something like "never", or just "").

Installation

Add this to your application's shard.yml:

dependencies:
  local_time_helper:
    github: anamba/local_time_helper.cr

Add the local-time js to your project using npm or yarn.

Usage

Made to be used with Amber, but will probably work fine in other situations. Require/include like other helpers.

require "local_time_helper"
include LocalTimeHelper
<%= local_time(Time.utc(2018, 11, 21, 6), format: "%B %e, %Y %l:%M%p") %>

produces:

<time data-format="%B %e, %Y %l:%M%P" data-local="time" datetime="2018-11-21T06:00:00Z">November 21, 2018  6:00am</time>

See specs for more helper usage examples. Note that Crystal's %p and %P are swapped, which makes plenty of sense, but is different from other implementations (including JavaScript and Ruby).

Development

It's not a complete implementation of everything the ruby gem does, just enough to get the specs to pass (translated the relevant tests from the original). Contributions welcome if it doesn't support the options you need.

Contributing

  1. Fork it (https://github.com/anamba/local_time_helper.cr/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • anamba Aaron Namba - creator, maintainer