https://github.com/907th/datetime-scopes

A plugin for ActiveRecord which adds very helpful methods for querying records over time ranges (weeks/days/months/years), and it also respects time-zones!
https://github.com/907th/datetime-scopes

activerecord rails

Last synced: 25 days ago
JSON representation

A plugin for ActiveRecord which adds very helpful methods for querying records over time ranges (weeks/days/months/years), and it also respects time-zones!

• Host: GitHub
• URL: https://github.com/907th/datetime-scopes
• Owner: 907th
• License: mit
• Created: 2015-10-17T11:43:07.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-07T19:25:14.000Z (almost 9 years ago)
• Last Synced: 2024-10-04T11:57:16.465Z (about 1 month ago)
• Topics: activerecord, rails
• Language: Ruby
• Homepage:
• Size: 29.3 KB
• Stars: 16
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Date/time scopes for ActiveRecord models

[![Gem Version](https://badge.fury.io/rb/datetime-scopes.svg)](https://badge.fury.io/rb/datetime-scopes)

[![Build Status](https://travis-ci.org/907th/datetime-scopes.svg?branch=master)](https://travis-ci.org/907th/datetime-scopes)

[![Code Climate](https://codeclimate.com/github/907th/datetime-scopes/badges/gpa.svg)](https://codeclimate.com/github/907th/datetime-scopes)

[![Test Coverage](https://codeclimate.com/github/907th/datetime-scopes/badges/coverage.svg)](https://codeclimate.com/github/907th/datetime-scopes/coverage)

Date/time scopes for ActiveRecord models you always missed! With proper time-zones support.

## Quick start

```ruby

# Gemfile

gem "datetime-scopes"

```

```ruby

# app/models/my_model.rb

class MyModel < ActiveRecord::Base

  datetime_scopes :created_at  # with 'datetime' typed attribute

  date_scopes :birthday        # with 'date' typed attribute

end

```

Now your model has these scopes:

  

    

      for created_at

    

    

      for birthday

    

  

  

    

      


        
created_within(from, to)

        
created_within_days(from, to)

        
created_within_months(from, to)

        
created_within_years(from, to)

        
created_on_day(t)

        
created_on_month(t)

        
created_on_year(t)

        
created_before(t)

        
created_before_day(t)

        
created_before_month(t)

        
created_before_year(t)

        
created_after(t)

        
created_after_day(t)

        
created_after_month(t)

        
created_after_year(t)

        
created_on_or_before(t)

        
created_on_or_before_day(t)

        
created_on_or_before_month(t)

        
created_on_or_before_year(t)

        
created_on_or_after(t)

        
created_on_or_after_day(t)

        
created_on_or_after_month(t)

        
created_on_or_after_year(t)

      

    

    

      


        
birthday_within_days(from, to)

        
birthday_within_months(from, to)

        
birthday_within_years(from, to)

        
birthday_on_day(t)

        
birthday_on_month(t)

        
birthday_on_year(t)

        
birthday_before_day(t)

        
birthday_before_month(t)

        
birthday_before_year(t)

        
birthday_after_day(t)

        
birthday_after_month(t)

        
birthday_after_year(t)

        
birthday_on_or_before_day(t)

        
birthday_on_or_before_month(t)

        
birthday_on_or_before_year(t)

        
birthday_on_or_after_day(t)

        
birthday_on_or_after_month(t)

        
birthday_on_or_after_year(t)

      

    

  


Examples:

```ruby

# All records created yesterday (in current `::Time.zone`)

MyModel.created_on_day(Date.yesterday)

# Records created since 11 Sep 2001 (in current `::Time.zone`)

MyModel.created_on_or_after("2001.09.11")

# Records create since 11 Sep 2001 (in New York). Yes, the result may differ to previous example!

MyModel.created_on_or_after("2001.09.11", time_zone: "Eastern Time (US & Canada)")

# Records with birthday in 2015

MyModel.birthday_on_year(Date.new 2015)

```

## Time-zone support

You know, when it is Sunday in San Francisco, it is Monday in Manila!

All parameters passed to a date/time scopes are first converted to a

project-specific (`::Time.zone`) or specified (`time_zone: "XXX"` param) time-zone with the help

of magic ActiveSupport's `#in_time_zone` helper. See `rake time:zones:all` for

all supported time-zones.

## Additional options

You can pass a default time-zone and custom scopes' prefix to a `date(time)_scopes` method:

```ruby

# app/models/my_model.rb

class MyModel < ActiveRecord::Base

  datetime_scopes :created_at, prefix: "issued", time_zone: "Ekaterinburg"

end

# All records created yesterday (in Ekaterinburg)

MyModel.issued_on_day(Date.yesterday)

```

## TODO

- Complete pending tests!

- ...

## Contributing

Any feedback is welcome!

## License

Distributed under the MIT License (see LICENSE.txt).

Copyright © 2015. Alexey Chernenkov