How to use Stamp to configure Rails date formats?

In a Rails initializer, define formats using Proc objects with stamp examples, like setting Date::DATE_FORMATS[:short] to use stamp('Sun Jan 5'), then call to_s(:short) on dates. This integrates seamlessly with Rails' existing date formatting system.

Stamp or strftime for Ruby date formatting?

Stamp is better for readability and maintainability with example-based templates, while strftime offers more precise, locale-flexible control with standard directives. Choose Stamp for self-documenting code, but strftime for complex or internationalized formats.

Can Stamp format dates in languages other than English?

No, Stamp primarily recognizes English month and weekday names in examples, as shown in the usage. For non-English formats, you'd need to adapt examples or use strftime for better locale support.

How does Stamp handle ambiguous date examples like 01/09?

Stamp infers intent from context but may misinterpret; the README recommends using unambiguous values like '12/31' to clarify meaning, which adds an extra step for developers.

Is Stamp compatible with DateTime objects in Ruby?

Stamp should inherit behavior from Date for DateTime, but the README notes it hasn't been thoroughly tested, so caution is advised in production environments using DateTime extensively.

How to include labels like 'DOB:' in Stamp formatted dates?

Simply include the text in the example string, such as 'DOB: 12/31/2000', and Stamp will preserve it in the output, as demonstrated in the date formatting examples.

What time zone abbreviations does Stamp support?

Stamp recognizes standard abbreviations like UTC, PST, and EST, as mentioned in the features, but may not handle less common or custom time zone codes without modification.

Open-Awesome

stamp

MITRuby

A Ruby gem that formats dates and times using human-friendly example strings instead of strftime directives.

GitHub

960 stars17 forks0 contributors

What is stamp?

Stamp is a Ruby gem that formats dates and times by using example strings as templates instead of traditional strftime directives. It solves the problem of memorizing complex format codes by allowing developers to provide a human-readable example (like "March 1, 1999") and automatically applying that format to their dates and times.

Target Audience

Ruby developers who work with date and time formatting in their applications, particularly those who find strftime directives difficult to remember or read in code.

Value Proposition

Developers choose Stamp because it makes date formatting more intuitive and maintainable—code becomes self-documenting with clear example strings, reducing the cognitive load of format specifiers.

Overview

Date and time formatting for humans.

Use Cases

Best For

Formatting dates in Ruby without memorizing strftime codes
Making date/time formatting code more readable and self-documenting
Configuring Rails date formats with human-friendly examples
Including static text alongside formatted dates (e.g., labels like 'DOB:')
Handling ordinal day formatting (like '1st', '2nd', '3rd')
Quickly prototyping date formats by copying example strings

Not Ideal For

Applications requiring locale-specific date formats beyond English examples
Projects that depend on untested DateTime behavior for critical functionality
High-performance scenarios where the overhead of parsing example strings is prohibitive

Pros & Cons

Pros

Intuitive Example-Based Formatting

Uses human-readable examples like 'March 1, 1999' instead of cryptic strftime codes, making code self-documenting and easier to maintain, as shown in the usage examples.

Flexible Text and Ordinal Support

Recognizes ordinal days (e.g., '5th') and preserves extraneous text (e.g., 'DOB:'), demonstrated in the stamp method examples for dates and times.

Seamless Rails Integration

Easily configures Rails date formats using Stamp's examples, as highlighted in the Rails integration section with DATE_FORMATS configuration.

Time Zone Abbreviation Recognition

Supports standard time zone abbreviations like UTC, PST, and EST, making time formatting straightforward without additional parsing.

Cons

Ambiguity in Example Parsing

The README admits that examples like '01/09' can be ambiguous, forcing developers to use explicit values to avoid confusion, which reduces intuitiveness.

Untested DateTime Support

Stamp's integration with DateTime is not thoroughly tested, as noted in the limitations, posing risks for applications relying on DateTime objects.

English-Centric Formatting

Relies on English month and weekday names in examples, limiting its usefulness for international applications requiring multi-language or locale-specific formats.

Frequently Asked Questions

Related Projects

groupdate

The simplest way to group temporal data

Stars3,885

Forks240

Last commit23 days ago

chronic

Chronic is a pure Ruby natural language date parser.

Stars3,252

Forks449

Last commit2 years ago

ice_cube

Ruby Date Recurrence Library - Allows easy creation of recurrence rules and fast querying

Stars2,465

Forks354

Last commit7 months ago

local_time

Rails engine for cache-friendly, client-side local time

Stars2,001

Forks125

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub