mirror of
https://github.com/jimeh/time_ext.git
synced 2026-02-19 05:16:40 +00:00
Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0bef341111 | |||
| 6686731651 | |||
| fceb7b8ff2 | |||
| 803ad03d6c | |||
| b29c232939 | |||
| f3b9d3751a | |||
| a612a17c54 | |||
| 71c5421587 | |||
| d564c31b93 | |||
| 29e1c7f500 | |||
| f49c6bd455 | |||
| 5ece10846a | |||
| 5afb6bc2b9 | |||
| 9bbd974a75 | |||
| ca929c6ae1 | |||
| edd828bb3e | |||
| 4afd3f84d5 | |||
| ea6d87e35f | |||
| 74574beaf0 | |||
| ba33dfec57 | |||
| c9cd80fd9e | |||
| 06e167d1ab | |||
| ac1ad2dba4 | |||
| ab6e1e8003 | |||
| 3d2b5d0b9e | |||
| b8ba272b95 | |||
| 3201485eaf | |||
| 77d9d67ed1 |
7
.gitignore
vendored
7
.gitignore
vendored
@@ -16,9 +16,10 @@ tmtags
|
||||
## PROJECT::GENERAL
|
||||
coverage
|
||||
rdoc
|
||||
pkg
|
||||
pkg/*
|
||||
*.gem
|
||||
.bundle
|
||||
|
||||
## PROJECT::SPECIFIC
|
||||
.yardoc/*
|
||||
*.gemspec
|
||||
.yardoc
|
||||
doc/*
|
||||
|
||||
9
Gemfile
Normal file
9
Gemfile
Normal file
@@ -0,0 +1,9 @@
|
||||
source 'http://rubygems.org/'
|
||||
|
||||
# Specify your gem's dependencies in time_ext.gemspec
|
||||
gemspec
|
||||
|
||||
group :development do
|
||||
gem 'rspec', '>= 2.1.0'
|
||||
gem 'yard', '>= 0.6.3'
|
||||
end
|
||||
32
Gemfile.lock
Normal file
32
Gemfile.lock
Normal file
@@ -0,0 +1,32 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
time_ext (0.2.7)
|
||||
activesupport (>= 2.3.0)
|
||||
i18n (>= 0.4.2)
|
||||
|
||||
GEM
|
||||
remote: http://rubygems.org/
|
||||
specs:
|
||||
activesupport (3.0.3)
|
||||
diff-lcs (1.1.2)
|
||||
i18n (0.4.2)
|
||||
rspec (2.1.0)
|
||||
rspec-core (~> 2.1.0)
|
||||
rspec-expectations (~> 2.1.0)
|
||||
rspec-mocks (~> 2.1.0)
|
||||
rspec-core (2.1.0)
|
||||
rspec-expectations (2.1.0)
|
||||
diff-lcs (~> 1.1.2)
|
||||
rspec-mocks (2.1.0)
|
||||
yard (0.6.3)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
activesupport (>= 2.3.0)
|
||||
i18n (>= 0.4.2)
|
||||
rspec (>= 2.1.0)
|
||||
time_ext!
|
||||
yard (>= 0.6.3)
|
||||
57
Rakefile
57
Rakefile
@@ -1,43 +1,27 @@
|
||||
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"
|
||||
|
||||
#
|
||||
# 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
|
||||
|
||||
task :console do
|
||||
exec "irb -r spec/spec_helper"
|
||||
end
|
||||
|
||||
#
|
||||
# Yard
|
||||
#
|
||||
|
||||
begin
|
||||
require 'yard'
|
||||
@@ -47,3 +31,14 @@ rescue LoadError
|
||||
abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
#
|
||||
# Misc.
|
||||
#
|
||||
|
||||
desc "Start an irb console with TimeExt pre-loaded."
|
||||
task :console do
|
||||
exec "irb -r spec/spec_helper"
|
||||
end
|
||||
task :c => :console
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
require 'rubygems'
|
||||
require 'active_support'
|
||||
|
||||
require 'time_ext/backwards_compatibility'
|
||||
# support both Active Support 2.x and 3.x
|
||||
require 'active_support/time' if !Time.respond_to?(:days_in_month)
|
||||
|
||||
require 'time_ext/calculations'
|
||||
require 'time_ext/iterations'
|
||||
require 'time_ext/method_chain'
|
||||
require 'time_ext/support'
|
||||
require 'time_ext/core_ext/time'
|
||||
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
|
||||
4
lib/time_ext/core_ext/numeric.rb
Normal file
4
lib/time_ext/core_ext/numeric.rb
Normal file
@@ -0,0 +1,4 @@
|
||||
class Numeric
|
||||
alias :sec :seconds
|
||||
alias :min :minutes
|
||||
end
|
||||
@@ -1,6 +1,5 @@
|
||||
class Time
|
||||
include TimeExt::MethodChain
|
||||
include TimeExt::BackwardsCompatibility
|
||||
include TimeExt::Support
|
||||
include TimeExt::Calculations
|
||||
include TimeExt::Iterations
|
||||
|
||||
|
||||
@@ -4,16 +4,23 @@ module TimeExt
|
||||
|
||||
# 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)
|
||||
options.reverse_merge!(:map_result => false, :beginning_of => false, :include_start => false, :include_end => true)
|
||||
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
|
||||
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)
|
||||
@@ -46,6 +53,14 @@ module TimeExt
|
||||
end
|
||||
end
|
||||
|
||||
# Let's you iterate over every unit specified in the #each or #map call for the specified unit.
|
||||
def of_the(unit, &block)
|
||||
@of_the = unit
|
||||
return call_chain(block) if block_given?
|
||||
self
|
||||
end
|
||||
alias :of :of_the
|
||||
|
||||
# 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)
|
||||
@@ -60,7 +75,6 @@ module TimeExt
|
||||
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)
|
||||
@@ -69,7 +83,14 @@ module TimeExt
|
||||
|
||||
# Dynamically define convenience methods, like #each_hour instead of #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
|
||||
|
||||
@@ -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
|
||||
27
lib/time_ext/support.rb
Normal file
27
lib/time_ext/support.rb
Normal file
@@ -0,0 +1,27 @@
|
||||
module TimeExt
|
||||
# Provides helper methods used by TimeExt::Calculations for backwards compatibility with ActiveSupport, and method chaining helpers for TimeExt::Iterations.
|
||||
module Support
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
3
lib/time_ext/version.rb
Normal file
3
lib/time_ext/version.rb
Normal file
@@ -0,0 +1,3 @@
|
||||
module TimeExt
|
||||
VERSION = "0.2.8"
|
||||
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
|
||||
|
||||
24
time_ext.gemspec
Normal file
24
time_ext.gemspec
Normal file
@@ -0,0 +1,24 @@
|
||||
# -*- 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.0'
|
||||
s.add_runtime_dependency 'i18n', '>= 0.4.2'
|
||||
end
|
||||
Reference in New Issue
Block a user