mirror of
https://github.com/jimeh/time_ext.git
synced 2026-02-19 13:26:39 +00:00
Compare commits
38 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f8912e4354 | |||
| 83655b438f | |||
| a7da13fb82 | |||
| 8a027bbff8 | |||
| b3f09c3a0b | |||
| dad55fb6f9 | |||
| 4b1327306d | |||
| 1dd64966fd | |||
| 950a57dc66 | |||
| 59c96c0246 | |||
| 8bb93bf5f1 | |||
| d84154bd5b | |||
| 6686731651 | |||
| fceb7b8ff2 | |||
| 803ad03d6c | |||
| f3b9d3751a | |||
| a612a17c54 | |||
| 71c5421587 | |||
| d564c31b93 | |||
| 29e1c7f500 | |||
| f49c6bd455 | |||
| 5ece10846a | |||
| 5afb6bc2b9 | |||
| 9bbd974a75 | |||
| ca929c6ae1 | |||
| edd828bb3e | |||
| 4afd3f84d5 | |||
| ea6d87e35f | |||
| 74574beaf0 | |||
| ba33dfec57 | |||
| c9cd80fd9e | |||
| 06e167d1ab | |||
| ac1ad2dba4 | |||
| ab6e1e8003 | |||
| 3d2b5d0b9e | |||
| b8ba272b95 | |||
| 3201485eaf | |||
| 77d9d67ed1 |
10
.gitignore
vendored
10
.gitignore
vendored
@@ -16,9 +16,11 @@ tmtags
|
||||
## PROJECT::GENERAL
|
||||
coverage
|
||||
rdoc
|
||||
pkg
|
||||
Gemfile.lock
|
||||
pkg/*
|
||||
*.gem
|
||||
.bundle
|
||||
|
||||
## PROJECT::SPECIFIC
|
||||
.yardoc/*
|
||||
*.gemspec
|
||||
doc/*
|
||||
.yardoc
|
||||
docs/*
|
||||
|
||||
4
Gemfile
Normal file
4
Gemfile
Normal file
@@ -0,0 +1,4 @@
|
||||
source 'http://rubygems.org/'
|
||||
|
||||
# Specify your gem's dependencies in time_ext.gemspec
|
||||
gemspec
|
||||
2
LICENSE
2
LICENSE
@@ -1,4 +1,4 @@
|
||||
Copyright (c) 2010 Jim Myhrberg.
|
||||
Copyright (c) 2011 Jim Myhrberg.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
|
||||
@@ -75,7 +75,7 @@ I recommend you read the complete class [documentation][docs] for the Time objec
|
||||
|
||||
## License and Copyright
|
||||
|
||||
Copyright (c) 2010 Jim Myhrberg.
|
||||
Copyright (c) 2011 Jim Myhrberg.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
@@ -99,5 +99,5 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
|
||||
[as]: http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Time/Calculations.html
|
||||
[docs]: http://rdoc.info/projects/jimeh/time_ext
|
||||
[docs]: http://rdoc.info/gems/time_ext/frames
|
||||
[rdoc.info]: http://rdoc.info/
|
||||
113
Rakefile
113
Rakefile
@@ -1,49 +1,88 @@
|
||||
require 'rubygems'
|
||||
require 'rake'
|
||||
require 'bundler'
|
||||
Bundler::GemHelper.install_tasks
|
||||
|
||||
begin
|
||||
require 'jeweler'
|
||||
Jeweler::Tasks.new do |gem|
|
||||
gem.name = "time_ext"
|
||||
gem.summary = %Q{Extends the abilities of Ruby's built-in Time class by building on top of ActiveSupport.}
|
||||
gem.description = %Q{Extends the abilities of Ruby's built-in Time class by building on top of ActiveSupport.}
|
||||
gem.email = "contact@jimeh.me"
|
||||
gem.homepage = "http://github.com/jimeh/time_ext"
|
||||
gem.authors = ["Jim Myhrberg"]
|
||||
gem.add_dependency "activesupport", ">= 2.3.0"
|
||||
gem.add_development_dependency "rspec", ">= 1.2.9"
|
||||
gem.add_development_dependency "yard", ">= 0"
|
||||
end
|
||||
Jeweler::GemcutterTasks.new
|
||||
rescue LoadError
|
||||
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
||||
require 'rake/testtask'
|
||||
require 'rake/clean'
|
||||
|
||||
|
||||
#
|
||||
# Rspec
|
||||
#
|
||||
|
||||
require 'rspec/core/rake_task'
|
||||
RSpec::Core::RakeTask.new(:spec) do |spec|
|
||||
spec.pattern = 'spec/**/*_spec.rb'
|
||||
end
|
||||
|
||||
require 'spec/rake/spectask'
|
||||
Spec::Rake::SpecTask.new(:spec) do |spec|
|
||||
spec.libs << 'lib' << 'spec'
|
||||
spec.spec_files = FileList['spec/**/*_spec.rb']
|
||||
end
|
||||
|
||||
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
||||
spec.libs << 'lib' << 'spec'
|
||||
RSpec::Core::RakeTask.new(:rcov) do |spec|
|
||||
spec.pattern = 'spec/**/*_spec.rb'
|
||||
spec.rcov = true
|
||||
end
|
||||
|
||||
task :spec => :check_dependencies
|
||||
|
||||
task :default => :spec
|
||||
|
||||
|
||||
#
|
||||
# Rocco
|
||||
#
|
||||
|
||||
begin
|
||||
require 'rocco/tasks'
|
||||
Rocco::make 'docs/'
|
||||
rescue LoadError
|
||||
warn "#$! -- rocco tasks not loaded."
|
||||
task :rocco
|
||||
end
|
||||
|
||||
desc 'Build rocco docs'
|
||||
task :docs => :rocco
|
||||
directory 'docs/'
|
||||
|
||||
desc 'Build docs and open in browser for the reading'
|
||||
task :read => :docs do
|
||||
sh 'open docs/lib/time_ext.html'
|
||||
end
|
||||
|
||||
# Make index.html a copy of rocco.html
|
||||
file 'docs/index.html' => 'docs/lib/time_ext.html' do |f|
|
||||
cp 'docs/lib/time_ext.html', 'docs/index.html', :preserve => true
|
||||
end
|
||||
task :docs => 'docs/index.html'
|
||||
CLEAN.include 'docs/index.html'
|
||||
|
||||
# Alias for docs task
|
||||
task :doc => :docs
|
||||
|
||||
# GITHUB PAGES ===============================================================
|
||||
|
||||
desc 'Update gh-pages branch'
|
||||
task :pages => ['docs/.git', :docs] do
|
||||
rev = `git rev-parse --short HEAD`.strip
|
||||
Dir.chdir 'docs' do
|
||||
sh "git add *"
|
||||
sh "git commit -m 'rebuild pages from #{rev}'" do |ok,res|
|
||||
if ok
|
||||
verbose { puts "gh-pages updated" }
|
||||
sh "git push -q o HEAD:gh-pages"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Update the pages/ directory clone
|
||||
file 'docs/.git' => ['docs/', '.git/refs/heads/gh-pages'] do |f|
|
||||
sh "cd docs && git init -q && git remote add o ../.git" if !File.exist?(f.name)
|
||||
sh "cd docs && git fetch -q o && git reset -q --hard o/gh-pages && touch ."
|
||||
end
|
||||
CLOBBER.include 'docs/.git'
|
||||
|
||||
|
||||
#
|
||||
# Misc.
|
||||
#
|
||||
|
||||
desc "Start an irb console with TimeExt pre-loaded."
|
||||
task :console do
|
||||
exec "irb -r spec/spec_helper"
|
||||
end
|
||||
|
||||
begin
|
||||
require 'yard'
|
||||
YARD::Rake::YardocTask.new
|
||||
rescue LoadError
|
||||
task :yardoc do
|
||||
abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
|
||||
end
|
||||
end
|
||||
task :c => :console
|
||||
|
||||
@@ -1 +1,7 @@
|
||||
require 'time_ext'
|
||||
# encoding: utf-8
|
||||
|
||||
# Enable use by:
|
||||
# require 'time/ext'
|
||||
# In addition to the default:
|
||||
# require 'time_ext'
|
||||
require 'time_ext'
|
||||
|
||||
@@ -1,8 +1,25 @@
|
||||
# encoding: utf-8
|
||||
|
||||
require 'rubygems'
|
||||
require 'active_support'
|
||||
require 'time_ext/version'
|
||||
|
||||
require 'time_ext/backwards_compatibility'
|
||||
# [Calculation][ca] methods such as `#floor`, `#ceil`, `#round`,
|
||||
# `#prev_week` and many more, adding on top of the defaults present in
|
||||
# ActiveSupport.
|
||||
# [ca]: /time_ext/lib/time_ext/calculations.html
|
||||
require 'time_ext/calculations'
|
||||
|
||||
# [Iteration][it] methods allowing the use of `#each`, `#map_each` and more on
|
||||
# Time objects similar to how you loop over an Array of items.
|
||||
# [it]: /time_ext/lib/time_ext/iterations.html
|
||||
require 'time_ext/iterations'
|
||||
require 'time_ext/method_chain'
|
||||
|
||||
# Core extention of [Time][ti] class to load in [Calculation][ca] and
|
||||
# [Iteration][it] modules.
|
||||
# [ti]: /time_ext/lib/time_ext/core_ext/time.html
|
||||
require 'time_ext/core_ext/time'
|
||||
|
||||
# Core extention of [Numeric][nu] class to set a couple of required aliases.
|
||||
# [nu]: /time_ext/lib/time_ext/core_ext/numeric.html
|
||||
require 'time_ext/core_ext/numeric'
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
module TimeExt
|
||||
# Provides helper methods used by TimeExt::Calculations for backwards compatibility with ActiveSupport.
|
||||
module BackwardsCompatibility
|
||||
|
||||
def days_into_week
|
||||
defined?(DAYS_INTO_WEEK) ? DAYS_INTO_WEEK : { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
|
||||
end
|
||||
|
||||
def common_year_days_in_month
|
||||
defined?(COMMON_YEAR_DAYS_IN_MONTH) ? COMMON_YEAR_DAYS_IN_MONTH : [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -1,169 +1,191 @@
|
||||
# encoding: utf-8
|
||||
|
||||
module TimeExt
|
||||
# Adds an even greater extent of calculation methods on top of those already provided by ActiveSupport.
|
||||
# Adds an even greater extent of calculation methods on top of those already
|
||||
# provided by ActiveSupport.
|
||||
module Calculations
|
||||
|
||||
# Returns a new Time representing the start of the unit specified (second by default).
|
||||
|
||||
#### Public Methods
|
||||
|
||||
# Returns a new Time representing the start of the unit specified (second
|
||||
# by default).
|
||||
def floor(unit = :sec)
|
||||
self.send("beginning_of_#{unit}")
|
||||
end
|
||||
alias :beginning_of :floor
|
||||
alias :at_beginning_of :floor
|
||||
|
||||
|
||||
# Returns a new Time representing the start of the next unit specified (second by default).
|
||||
def ceil(unit = :sec)
|
||||
self.send("next_#{unit}").send("beginning_of_#{unit}")
|
||||
end
|
||||
alias :beginning_of_next :ceil
|
||||
alias :at_beginning_of_next :ceil
|
||||
|
||||
# Returns a new Time representing the start of the current or next unit specified (second by default) depending which is closest
|
||||
|
||||
# Returns a new Time representing the start of the current or next unit
|
||||
# specified (second by default) depending which is closest
|
||||
def round(unit = :sec)
|
||||
next_unit = self.ceil(unit)
|
||||
this_unit = self.floor(unit)
|
||||
(self - this_unit) < (next_unit - self) ? this_unit : next_unit
|
||||
end
|
||||
alias :beginning_of_closest :round
|
||||
|
||||
# Returns a new Time representing the previoius unit specified (defaults to second).
|
||||
|
||||
# Returns a new Time representing the previoius unit specified (defaults
|
||||
# to second).
|
||||
def prev(unit = :sec)
|
||||
send("prev_#{unit}")
|
||||
end
|
||||
|
||||
# Returns a new Time representing the next unit specified (defaults to second).
|
||||
|
||||
# Returns a new Time representing the next unit specified (defaults to
|
||||
# second).
|
||||
def next(unit = :sec)
|
||||
send("next_#{unit}")
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for seconds_ago(1).
|
||||
def prev_second
|
||||
seconds_ago(1)
|
||||
end
|
||||
alias :prev_sec :prev_second
|
||||
|
||||
|
||||
# Short-hand for seconds_since(1).
|
||||
def next_second
|
||||
seconds_since(1)
|
||||
end
|
||||
alias :next_sec :next_second
|
||||
|
||||
|
||||
# Short-hand for minutes_ago(1).
|
||||
def prev_minute
|
||||
minutes_ago(1)
|
||||
end
|
||||
alias :prev_min :prev_minute
|
||||
|
||||
|
||||
# Short-hand for minutes_since(1).
|
||||
def next_minute
|
||||
minutes_since(1)
|
||||
end
|
||||
alias :next_min :next_minute
|
||||
|
||||
|
||||
# Short-hand for hours_ago(1).
|
||||
def prev_hour
|
||||
hours_ago(1)
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for hours_since(1).
|
||||
def next_hour
|
||||
hours_since(1)
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for days_ago(1).
|
||||
def prev_day
|
||||
days_ago(1)
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for days_since(1).
|
||||
def next_day
|
||||
days_since(1)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the start of the given day in the previous week (default is Monday).
|
||||
|
||||
# Returns a new Time representing the start of the given day in the
|
||||
# previous week (default is Monday).
|
||||
def prev_week(day = :monday)
|
||||
weeks_ago(1).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for quarters_since(1).beginning_of_quarter.
|
||||
def next_quarter
|
||||
quarters_since(1).beginning_of_quarter
|
||||
end
|
||||
|
||||
|
||||
# Short-hand for quarters_ago(1).beginning_of_quarter.
|
||||
def prev_quarter
|
||||
quarters_ago(1).beginning_of_quarter
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified minutes ago.
|
||||
|
||||
# Returns a new Time representing the time a number of specified minutes
|
||||
# ago.
|
||||
def minutes_ago(minutes)
|
||||
ago(minutes.minutes)
|
||||
end
|
||||
alias :mins_ago :minutes_ago
|
||||
|
||||
# Returns a new Time representing the time a number of specified minutes in the future.
|
||||
|
||||
# Returns a new Time representing the time a number of specified minutes
|
||||
# in the future.
|
||||
def minutes_since(minutes)
|
||||
since(minutes.minutes)
|
||||
end
|
||||
alias :mins_since :minutes_since
|
||||
|
||||
# Returns a new Time representing the time a number of specified hours ago.
|
||||
|
||||
# Returns a new Time representing the time a number of specified hours
|
||||
# ago.
|
||||
def hours_ago(hours)
|
||||
ago(hours.hours)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified hours in the future.
|
||||
|
||||
# Returns a new Time representing the time a number of specified hours in
|
||||
# the future.
|
||||
def hours_since(hours)
|
||||
since(hours.hours)
|
||||
end
|
||||
|
||||
|
||||
# Returns a new Time representing the time a number of specified days ago.
|
||||
def days_ago(days)
|
||||
ago(days.days)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified days in the future.
|
||||
|
||||
# Returns a new Time representing the time a number of specified days in
|
||||
# the future.
|
||||
def days_since(days)
|
||||
since(days.days)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified weeks ago.
|
||||
|
||||
# Returns a new Time representing the time a number of specified weeks
|
||||
# ago.
|
||||
def weeks_ago(weeks)
|
||||
ago(weeks.weeks)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified weeks in the future.
|
||||
|
||||
# Returns a new Time representing the time a number of specified weeks in
|
||||
# the future.
|
||||
def weeks_since(weeks)
|
||||
since(weeks.weeks)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified quarters (3 months) ago.
|
||||
|
||||
# Returns a new Time representing the time a number of specified quarters
|
||||
# (3 months) ago.
|
||||
def quarters_ago(quarters)
|
||||
ago((quarters * 3).months)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the time a number of specified quarters (3 months) in the future.
|
||||
|
||||
# Returns a new Time representing the time a number of specified quarters
|
||||
# (3 months) in the future.
|
||||
def quarters_since(quarters)
|
||||
since((quarters * 3).months)
|
||||
end
|
||||
|
||||
# Returns a new Time representing the end of the unit specified (defaults to second).
|
||||
|
||||
# Returns a new Time representing the end of the unit specified (defaults
|
||||
# to second).
|
||||
def end_of(unit = :sec)
|
||||
send("end_of_#{unit}")
|
||||
end
|
||||
|
||||
# Returns a new Time representing the start of the second, XX:XX:XX.000000 (.000000000 in ruby1.9).
|
||||
|
||||
# Returns a new Time representing the start of the second, XX:XX:XX.000000
|
||||
# (.000000000 in ruby1.9).
|
||||
def beginning_of_second
|
||||
change(:usec => 0)
|
||||
end
|
||||
alias :beginning_of_sec :beginning_of_second
|
||||
alias :at_beginning_of_sec :beginning_of_second
|
||||
alias :at_beginning_of_second :beginning_of_second
|
||||
|
||||
# Returns a new Time representing the end of the hour, XX:XX:XX.999999 (.999999999 in ruby1.9).
|
||||
|
||||
# Returns a new Time representing the end of the second, XX:XX:XX.999999
|
||||
# (.999999999 in ruby1.9).
|
||||
def end_of_second
|
||||
change(:usec => 999999.999)
|
||||
end
|
||||
alias :end_of_sec :end_of_second
|
||||
|
||||
|
||||
# Returns a new Time representing the start of the minute (XX:XX:00).
|
||||
def beginning_of_minute
|
||||
change(:sec => 0, :usec => 0)
|
||||
@@ -171,23 +193,38 @@ module TimeExt
|
||||
alias :beginning_of_min :beginning_of_minute
|
||||
alias :at_beginning_of_min :beginning_of_minute
|
||||
alias :at_beginning_of_minute :beginning_of_minute
|
||||
|
||||
|
||||
# Returns a new Time representing the end of the hour, XX:XX:59.999999 (.999999999 in ruby1.9).
|
||||
def end_of_minute
|
||||
change(:sec => 59, :usec => 999999.999)
|
||||
end
|
||||
alias :end_of_min :end_of_minute
|
||||
|
||||
|
||||
# Returns a new Time representing the start of the hour (XX:00:00).
|
||||
def beginning_of_hour
|
||||
change(:min => 0, :sec => 0, :usec => 0)
|
||||
end
|
||||
alias :at_beginning_of_hour :beginning_of_hour
|
||||
|
||||
# Returns a new Time representing the end of the hour, XX:59:59.999999 (.999999999 in ruby1.9).
|
||||
|
||||
# Returns a new Time representing the end of the hour, XX:59:59.999999
|
||||
# (.999999999 in ruby1.9).
|
||||
def end_of_hour
|
||||
change(:min => 59, :sec => 59, :usec => 999999.999)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
#### Private Helper Methods
|
||||
|
||||
# Definitive list of days in the week.
|
||||
def days_into_week
|
||||
defined?(DAYS_INTO_WEEK) ? DAYS_INTO_WEEK : { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
|
||||
end
|
||||
|
||||
# Definitive list of days for each month of the year.
|
||||
def common_year_days_in_month
|
||||
defined?(COMMON_YEAR_DAYS_IN_MONTH) ? COMMON_YEAR_DAYS_IN_MONTH : [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
10
lib/time_ext/core_ext/numeric.rb
Normal file
10
lib/time_ext/core_ext/numeric.rb
Normal file
@@ -0,0 +1,10 @@
|
||||
# encoding: utf-8
|
||||
|
||||
# Support both Active Support 2.x and 3.x, and also addresses rare loading
|
||||
# issue.
|
||||
require 'active_support/core_ext/numeric/time' unless Numeric.new.respond_to?(:seconds)
|
||||
|
||||
class Numeric
|
||||
alias :sec :seconds
|
||||
alias :min :minutes
|
||||
end
|
||||
@@ -1,6 +1,12 @@
|
||||
# encoding: utf-8
|
||||
|
||||
# Support both Active Support 2.x and 3.x, and also address rare loading
|
||||
# issue.
|
||||
require 'active_support/time' unless Time.respond_to?(:days_in_month)
|
||||
require 'active_support/core_ext/time/calculations' unless Time.new.respond_to?(:ago)
|
||||
|
||||
class Time
|
||||
include TimeExt::MethodChain
|
||||
include TimeExt::BackwardsCompatibility
|
||||
# Include TimeExt modules into Time object.
|
||||
include TimeExt::Calculations
|
||||
include TimeExt::Iterations
|
||||
|
||||
|
||||
@@ -1,32 +1,45 @@
|
||||
# encoding: utf-8
|
||||
|
||||
module TimeExt
|
||||
# Allows you to iterate over Time objects with #each and other methods almost as if it was an Array or Hash.
|
||||
# Allows you to iterate over Time objects with `#each` and other
|
||||
# methods almost as if it was an Array or Hash.
|
||||
module Iterations
|
||||
|
||||
# Used by #each, #map_each and similar methods to iterate over ranges of time.
|
||||
def iterate(unit, options = {}, &block)
|
||||
options.reverse_merge!(:map_result => false, :beginning_of => false, :include_start => false)
|
||||
if block_given?
|
||||
units = [:year, :month, :day, :hour, :min, :sec, :usec]
|
||||
parent_unit = units[units.index(unit)-1]
|
||||
@until ||= (!parent_unit.nil?) ? self.send("#{parent_unit}s_since", 1) : self.send("#{unit}s_since", 1)
|
||||
time = self.clone
|
||||
direction = (self < @until) ? :f : :b
|
||||
succ_method = (direction == :f) ? "next_#{unit}" : "prev_#{unit}"
|
||||
time = time.beginning_of(unit) if options[:beginning_of]
|
||||
time = time.send(succ_method) if !options[:include_start]
|
||||
results = []
|
||||
while (direction == :f && time <= @until) || (direction == :b && time >= @until)
|
||||
options[:map_result] ? results << yield(time) : yield(time)
|
||||
time = time.send(succ_method)
|
||||
end
|
||||
options[:map_result] ? results : self
|
||||
else
|
||||
add_to_chain(:iterate, unit, options)
|
||||
self
|
||||
end
|
||||
#### Iterator Methods
|
||||
|
||||
# Executes passed block for each `unit` of time specified, with
|
||||
# a new time object for each interval passed to the block.
|
||||
def each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => false), &block)
|
||||
end
|
||||
|
||||
# Used togeter with #each and other iteration methods to specify end of interation.
|
||||
|
||||
# Executes passed block for each `unit` of time specified, with
|
||||
# a new time object set to the beginning of `unit` for each
|
||||
# interval passed to the block.
|
||||
def beginning_of_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => false, :beginning_of => true), &block)
|
||||
end
|
||||
|
||||
# Executes passed block for each `unit` of time specified,
|
||||
# returning an array with the return values from the passed block.
|
||||
def map_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => true), &block)
|
||||
end
|
||||
|
||||
# Executes passed block for each `unit` of time specified,
|
||||
# returning an array with the return values from passed block.
|
||||
# Additionally the time object passed into the block is set to
|
||||
# the beginning of specified `unit`.
|
||||
def map_beginning_of_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => true, :beginning_of => true), &block)
|
||||
end
|
||||
|
||||
#### Limiter Methods
|
||||
#
|
||||
# Usually chained with an iterator method to specify at which point
|
||||
# in time the iterator should stop.
|
||||
|
||||
# Used togeter with `#each` and other iteration methods to specify
|
||||
# end of interation.
|
||||
def until(time, &block)
|
||||
time = time.to_time if time.is_a?(::Date)
|
||||
@until = time
|
||||
@@ -34,8 +47,9 @@ module TimeExt
|
||||
self
|
||||
end
|
||||
alias :till :until
|
||||
|
||||
# Used together with #each and other interation methods to specify start of iteration, and end will be current object.
|
||||
|
||||
# Used together with `#each` and other interation methods to specify
|
||||
# start of iteration, and end will be current object.
|
||||
def from(time, &block)
|
||||
time = time.to_time if time.is_a?(::Date)
|
||||
method, args = @method_chain.pop if block_given?
|
||||
@@ -45,31 +59,29 @@ module TimeExt
|
||||
time.until(self)
|
||||
end
|
||||
end
|
||||
|
||||
# Executes passed block for each "unit" of time specified, with a new time object for each interval passed to the block.
|
||||
def each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => false), &block)
|
||||
|
||||
# Let's you iterate over every unit specified in the `#each` or
|
||||
# `#map_each` call for the specified unit.
|
||||
def of_the(unit, &block)
|
||||
@of_the = unit
|
||||
return call_chain(block) if block_given?
|
||||
self
|
||||
end
|
||||
|
||||
# Executes passed block for each "unit" of time specified, with a new time object set to the beginning of "unit" for each interval passed to the block.
|
||||
def beginning_of_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => false, :beginning_of => true), &block)
|
||||
end
|
||||
|
||||
# Executes passed block for each "unit" of time specified, returning an array with the return values from the passed block.
|
||||
def map_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => true), &block)
|
||||
end
|
||||
alias :map :map_each
|
||||
|
||||
# Executes passed block for each "unit" of time specified, returning an array with the return values from passed block. Additionally the time object passed into the block is set to the beginning of specified "unit".
|
||||
def map_beginning_of_each(unit, options = {}, &block)
|
||||
iterate(unit, options.merge(:map_result => true, :beginning_of => true), &block)
|
||||
end
|
||||
|
||||
# Dynamically define convenience methods, like #each_hour instead of #each(:hour).
|
||||
alias :of :of_the
|
||||
|
||||
#### Shorthand Methods
|
||||
|
||||
# Dynamically define convenience methods, like `#each_hour` as a
|
||||
# shorthand for `#each(:hour)`.
|
||||
[:year, :month, :day, :hour, :min, :sec].each do |unit|
|
||||
[:each, :beginning_of_each, :map_each, :map_beginning_of_each, :map].each do |method|
|
||||
[:each, :beginning_of_each, :map_each, :map_beginning_of_each].each do |method|
|
||||
define_method "#{method}_#{unit}" do |*args, &block|
|
||||
send(method, unit, *args, &block)
|
||||
end
|
||||
class_eval { alias :"#{method}_minute" :"#{method}_min" } if unit == :min
|
||||
class_eval { alias :"#{method}_second" :"#{method}_sec" } if unit == :sec
|
||||
end
|
||||
[:of_the, :of].each do |method|
|
||||
define_method "#{method}_#{unit}" do |*args, &block|
|
||||
send(method, unit, *args, &block)
|
||||
end
|
||||
@@ -77,6 +89,70 @@ module TimeExt
|
||||
class_eval { alias :"#{method}_second" :"#{method}_sec" } if unit == :sec
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
|
||||
#### Private Helper Methods
|
||||
|
||||
# Default options for `#iterate`.
|
||||
def default_options
|
||||
{ :map_result => false,
|
||||
:beginning_of => false,
|
||||
:end_of => false,
|
||||
:include_start => false,
|
||||
:include_end => true }
|
||||
end
|
||||
|
||||
# Used by `#each`, `#map_each` and similar methods to iterate over
|
||||
# ranges of time.
|
||||
def iterate(unit, opts = {}, &block)
|
||||
options = default_options.merge(opts)
|
||||
|
||||
# Perform the grunt work of iteration.
|
||||
if block_given?
|
||||
units = [:year, :month, :day, :hour, :min, :sec, :usec]
|
||||
parent_unit = units[units.index(unit)-1]
|
||||
if @of_the.nil?
|
||||
time = self.clone
|
||||
@until ||= (!parent_unit.nil?) ? self.send("#{parent_unit}s_since", 1) : self.send("#{unit}s_since", 1)
|
||||
else
|
||||
time = self.beginning_of(@of_the)
|
||||
@until = self.next(@of_the).beginning_of(@of_the)
|
||||
options.merge!(:beginning_of => true, :include_start => true, :include_end => false)
|
||||
end
|
||||
direction = (self < @until) ? :f : :b
|
||||
succ_method = (direction == :f) ? "next_#{unit}" : "prev_#{unit}"
|
||||
time = time.beginning_of(unit) if options[:beginning_of]
|
||||
time = time.send(succ_method) if !options[:include_start]
|
||||
@until = @until.prev(unit).end_of(unit) if !options[:include_end]
|
||||
results = []
|
||||
while (direction == :f && time <= @until) || (direction == :b && time >= @until)
|
||||
options[:map_result] ? results << yield(time) : yield(time)
|
||||
time = time.send(succ_method)
|
||||
end
|
||||
options[:map_result] ? results : self
|
||||
|
||||
# If a block is not given, add itself to the chain list to be
|
||||
# executed when the chain ends.
|
||||
else
|
||||
add_to_chain(:iterate, unit, options)
|
||||
self
|
||||
end
|
||||
end
|
||||
|
||||
# Enables chaining of iterator methods with
|
||||
def add_to_chain(method, *args, &block)
|
||||
@method_chain ||= []
|
||||
@method_chain << [method.to_sym, args, block]
|
||||
end
|
||||
|
||||
def call_chain(custom_block = nil, &block)
|
||||
method, args, iblock = @method_chain.pop
|
||||
return nil if method.nil?
|
||||
iblock = custom_block if !custom_block.nil?
|
||||
method, args, iblock = yield(method, args, iblock) if block_given?
|
||||
self.send(method, *args, &iblock)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
module TimeExt
|
||||
# Allows iterators' #until and #from methods to chain back to the parent iteration method.
|
||||
module MethodChain
|
||||
|
||||
def add_to_chain(method, *args, &block)
|
||||
@method_chain ||= []
|
||||
@method_chain << [method.to_sym, args, block]
|
||||
end
|
||||
|
||||
def call_chain(custom_block = nil, &block)
|
||||
method, args, iblock = @method_chain.pop
|
||||
return nil if method.nil?
|
||||
iblock = custom_block if !custom_block.nil?
|
||||
method, args, iblock = yield(method, args, iblock) if block_given?
|
||||
self.send(method, *args, &iblock)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
5
lib/time_ext/version.rb
Normal file
5
lib/time_ext/version.rb
Normal file
@@ -0,0 +1,5 @@
|
||||
# encoding: utf-8
|
||||
|
||||
module TimeExt
|
||||
VERSION = "0.2.9"
|
||||
end
|
||||
19
spec/core_ext_spec.rb
Normal file
19
spec/core_ext_spec.rb
Normal file
@@ -0,0 +1,19 @@
|
||||
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
||||
|
||||
describe "Core Extensions" do
|
||||
|
||||
it "should alias Numeric class methods" do
|
||||
number = 1
|
||||
number.sec.should == number.second
|
||||
number.min.should == number.minute
|
||||
end
|
||||
|
||||
it "should alias Time instance methods" do
|
||||
time = Time.now
|
||||
time.secs_ago(10).should == time.ago(10)
|
||||
time.seconds_ago(10).should == time.ago(10)
|
||||
time.secs_since(10).should == time.since(10)
|
||||
time.seconds_since(10).should == time.since(10)
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,2 +0,0 @@
|
||||
--format specdoc
|
||||
--color
|
||||
@@ -1,9 +1,6 @@
|
||||
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
||||
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
||||
require 'time_ext'
|
||||
require 'spec'
|
||||
require 'spec/autorun'
|
||||
|
||||
Spec::Runner.configure do |config|
|
||||
|
||||
end
|
||||
require 'time_ext'
|
||||
require 'rspec'
|
||||
require 'rspec/autorun'
|
||||
|
||||
@@ -52,8 +52,6 @@ describe "Time Iterations" do
|
||||
match = (1..6).map { |i| @now + i.hours }
|
||||
@now.map_each_hour.until(@now + 6.hours) { |time| time }.should == match
|
||||
@now.until(@now + 6.hours).map_each(:hour) { |time| time }.should == match
|
||||
# check so the #map alias for #map_each works
|
||||
@now.map_hour.until(@now + 6.hours) { |time| time }.should == match
|
||||
end
|
||||
|
||||
it "should iterate over time objects backwards with #until set in the past" do
|
||||
@@ -68,4 +66,32 @@ describe "Time Iterations" do
|
||||
(@now + 6.hours).from(@now).map_each(:hour) { |time| time }.should == match
|
||||
end
|
||||
|
||||
end
|
||||
it "should iterate over time objects with #map_each and #of_the via method chaining" do
|
||||
match = (0..23).map { |i| ((@now - (@now.hour).hours) + i.hours).beginning_of_hour }
|
||||
@now.map_each_hour.of_the(:day) { |time| time }.should == match
|
||||
@now.map_each_hour.of_the_day { |time| time }.should == match
|
||||
match = @now.beginning_of_month.map_beginning_of_each_hour(:include_start => true, :include_end => false).until(@now.next_month.beginning_of_month) { |time| time }
|
||||
@now.map_each_hour.of_the(:month) { |time| time }.should == match
|
||||
end
|
||||
|
||||
it "should iterate and respect the include_start and include_end options" do
|
||||
match = (1..6).map { |i| @now + i.hours }
|
||||
@now.map_each_hour.until(@now + 6.hours) { |time| time }.should == match
|
||||
match = (1..6).map { |i| @now + i.hours }
|
||||
@now.map_each_hour(:include_end => true).until(@now + 6.hours) { |time| time }.should == match
|
||||
@now.map_each_hour(:include_start => false).until(@now + 6.hours) { |time| time }.should == match
|
||||
match = (0..6).map { |i| @now + i.hours }
|
||||
@now.map_each_hour(:include_start => true).until(@now + 6.hours) { |time| time }.should == match
|
||||
match = (0..5).map { |i| @now + i.hours }
|
||||
@now.map_each_hour(:include_start => true, :include_end => false).until(@now + 6.hours) { |time| time }.should == match
|
||||
match = (0..6).map { |i| @now + i.hours }
|
||||
@now.map_each_hour(:include_start => true, :include_end => true).until(@now + 6.hours) { |time| time }.should == match
|
||||
end
|
||||
|
||||
it "should iterate and respect the beginning_of option" do
|
||||
match = (1..6).map { |i| @now.beginning_of_hour + i.hours }
|
||||
@now.map_beginning_of_each_hour.until(@now.beginning_of_hour + 6.hours) { |time| time }.should == match
|
||||
@now.map_each_hour(:beginning_of => true).until(@now.beginning_of_hour + 6.hours) { |time| time }.should == match
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
29
time_ext.gemspec
Normal file
29
time_ext.gemspec
Normal file
@@ -0,0 +1,29 @@
|
||||
# -*- encoding: utf-8 -*-
|
||||
$:.push File.expand_path("../lib", __FILE__)
|
||||
require "time_ext/version"
|
||||
|
||||
Gem::Specification.new do |s|
|
||||
s.name = "time_ext"
|
||||
s.version = TimeExt::VERSION
|
||||
s.platform = Gem::Platform::RUBY
|
||||
s.authors = ["Jim Myhrberg"]
|
||||
s.email = ["contact@jimeh.me"]
|
||||
s.homepage = "http://github.com/jimeh/time_ext"
|
||||
s.summary = "Extends the abilities of Ruby's built-in Time class by building on top of ActiveSupport."
|
||||
s.description = "Extends the abilities of Ruby's built-in Time class by building on top of ActiveSupport."
|
||||
|
||||
s.rubyforge_project = "time_ext"
|
||||
|
||||
s.files = `git ls-files`.split("\n")
|
||||
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
||||
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
||||
s.require_paths = ["lib"]
|
||||
|
||||
s.add_runtime_dependency 'activesupport', '>= 2.3.2'
|
||||
s.add_runtime_dependency 'i18n', '>= 0.4.2'
|
||||
|
||||
s.add_development_dependency 'rake', '>= 0.8.7'
|
||||
s.add_development_dependency 'rspec', '>= 2.1.0'
|
||||
s.add_development_dependency 'rocco', '>= 0.6.0'
|
||||
s.add_development_dependency 'ruby-debug'
|
||||
end
|
||||
Reference in New Issue
Block a user