time_chunk 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "rspec", "~> 2.8.0"
10
+ gem "rdoc", "~> 3.12"
11
+ gem "bundler", "~> 1.2.0"
12
+ gem "jeweler", "~> 1.8.4"
13
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,31 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ diff-lcs (1.1.3)
5
+ git (1.2.5)
6
+ jeweler (1.8.4)
7
+ bundler (~> 1.0)
8
+ git (>= 1.2.5)
9
+ rake
10
+ rdoc
11
+ json (1.7.6)
12
+ rake (10.0.3)
13
+ rdoc (3.12)
14
+ json (~> 1.4)
15
+ rspec (2.8.0)
16
+ rspec-core (~> 2.8.0)
17
+ rspec-expectations (~> 2.8.0)
18
+ rspec-mocks (~> 2.8.0)
19
+ rspec-core (2.8.0)
20
+ rspec-expectations (2.8.0)
21
+ diff-lcs (~> 1.1.2)
22
+ rspec-mocks (2.8.0)
23
+
24
+ PLATFORMS
25
+ ruby
26
+
27
+ DEPENDENCIES
28
+ bundler (~> 1.2.0)
29
+ jeweler (~> 1.8.4)
30
+ rdoc (~> 3.12)
31
+ rspec (~> 2.8.0)
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2013 Alex Dean
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,19 @@
1
+ = time_chunk
2
+
3
+ Iterate over a time range in discrete chunks.
4
+
5
+ == Contributing to time_chunk
6
+
7
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
8
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
9
+ * Fork the project.
10
+ * Start a feature/bugfix branch.
11
+ * Commit and push until you are happy with your contribution.
12
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
13
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
14
+
15
+ == Copyright
16
+
17
+ Copyright (c) 2013 Alex Dean. See LICENSE.txt for
18
+ further details.
19
+
data/Rakefile ADDED
@@ -0,0 +1,49 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "time_chunk"
18
+ gem.homepage = "http://github.com/tedconf/time_chunk"
19
+ gem.license = "MIT"
20
+ gem.summary = "Iterate over time ranges in discrete chunks."
21
+ gem.description = "Iterate over time ranges in discrete chunks."
22
+ gem.email = "alex@crackpot.org"
23
+ gem.authors = ["Alex Dean"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rspec/core'
29
+ require 'rspec/core/rake_task'
30
+ RSpec::Core::RakeTask.new(:spec) do |spec|
31
+ spec.pattern = FileList['spec/**/*_spec.rb']
32
+ end
33
+
34
+ RSpec::Core::RakeTask.new(:rcov) do |spec|
35
+ spec.pattern = 'spec/**/*_spec.rb'
36
+ spec.rcov = true
37
+ end
38
+
39
+ task :default => :spec
40
+
41
+ require 'rdoc/task'
42
+ Rake::RDocTask.new do |rdoc|
43
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
44
+
45
+ rdoc.rdoc_dir = 'rdoc'
46
+ rdoc.title = "time_chunk #{version}"
47
+ rdoc.rdoc_files.include('README*')
48
+ rdoc.rdoc_files.include('lib/**/*.rb')
49
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
data/lib/time_chunk.rb ADDED
@@ -0,0 +1,35 @@
1
+ require 'time'
2
+
3
+ module TimeChunk
4
+
5
+ def self.each_day(range)
6
+ # &Proc.new : return a proc containing the block passed to the method
7
+ # http://www.ruby-doc.org/core-1.9.3/Proc.html#method-c-new
8
+ iterate(range, 86400, &Proc.new)
9
+ end
10
+
11
+ def self.each_hour(range)
12
+ iterate(range, 3600, &Proc.new)
13
+ end
14
+
15
+ def self.each_minute(range)
16
+ iterate(range, 60, &Proc.new)
17
+ end
18
+
19
+ def self.iterate(range, step_size)
20
+ begin_time = range.first.is_a?(Time) ? range.first : Time.parse(range.first)
21
+ end_time = range.last.is_a?(Time) ? range.last : Time.parse(range.last)
22
+ raise ArgumentError, "Given range's begin (#{begin_time.iso8601}) is after its end (#{end_time.iso8601})." if begin_time > end_time
23
+
24
+ current_end_time = begin_time - 1
25
+
26
+ begin
27
+ current_begin_time = current_end_time + 1
28
+ current_end_time = current_begin_time + step_size - 1
29
+ current_end_time = [current_end_time, end_time].min
30
+
31
+ yield current_begin_time..current_end_time
32
+ end while current_end_time < end_time
33
+ end
34
+
35
+ end
@@ -0,0 +1,12 @@
1
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
3
+ require 'rspec'
4
+ require 'time_chunk'
5
+
6
+ # Requires supporting files with custom matchers and macros, etc,
7
+ # in ./support/ and its subdirectories.
8
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
9
+
10
+ RSpec.configure do |config|
11
+
12
+ end
@@ -0,0 +1,132 @@
1
+ require 'spec_helper'
2
+ require 'time_chunk'
3
+
4
+ def t(str)
5
+ Time.parse(str)
6
+ end
7
+
8
+ describe TimeChunk do
9
+ before(:each) do
10
+ @calls = []
11
+ end
12
+
13
+ describe "iterate" do
14
+ it "should iterate a time range by the given step size" do
15
+ TimeChunk.iterate(
16
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T02:59:59Z')), 3600
17
+ ) do |range|
18
+ @calls << range
19
+ end
20
+
21
+ @calls.should eq [
22
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:59:59Z')),
23
+ (t('2013-01-01T01:00:00Z')..t('2013-01-01T01:59:59Z')),
24
+ (t('2013-01-01T02:00:00Z')..t('2013-01-01T02:59:59Z')),
25
+ ]
26
+ end
27
+
28
+ it "should not exceed given start and end times when step size is larger than the given range" do
29
+ TimeChunk.iterate(
30
+ '2013-01-01T00:00:00Z'..'2013-01-01T00:30:00Z', 3600
31
+ ) do |range|
32
+ @calls << range
33
+ end
34
+
35
+ @calls.should eq [
36
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:30:00Z'))
37
+ ]
38
+ end
39
+
40
+ it "should return a final range smaller than step size if begin to end range is not a perfect multiple of step size" do
41
+ TimeChunk.iterate(
42
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T02:29:59Z')), 3600
43
+ ) do |range|
44
+ @calls << range
45
+ end
46
+
47
+ @calls.should eq [
48
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:59:59Z')),
49
+ (t('2013-01-01T01:00:00Z')..t('2013-01-01T01:59:59Z')),
50
+ (t('2013-01-01T02:00:00Z')..t('2013-01-01T02:29:59Z')),
51
+ ]
52
+ end
53
+
54
+ it "should raise an ArgumentError if range's begin is larger than its end" do
55
+ expect {
56
+ TimeChunk.iterate(
57
+ (t('2013-01-05T00:00:00Z')..t('2013-01-01T00:00:00Z')), 3600
58
+ ) do |range|
59
+ @calls << range
60
+ end
61
+ }.to raise_error ArgumentError, "Given range's begin (2013-01-05T00:00:00Z) is after its end (2013-01-01T00:00:00Z)."
62
+ end
63
+
64
+ it "should accept a two-element array" do
65
+ TimeChunk.iterate(
66
+ [t('2013-01-01T00:00:00Z'), t('2013-01-01T02:29:59Z')], 3600
67
+ ) do |range|
68
+ @calls << range
69
+ end
70
+
71
+ @calls.should eq [
72
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:59:59Z')),
73
+ (t('2013-01-01T01:00:00Z')..t('2013-01-01T01:59:59Z')),
74
+ (t('2013-01-01T02:00:00Z')..t('2013-01-01T02:29:59Z')),
75
+ ]
76
+ end
77
+
78
+ it "should parse time strings" do
79
+ TimeChunk.iterate(
80
+ '2013-01-01T00:00:00Z'..'2013-01-01T02:59:59Z', 3600
81
+ ) do |range|
82
+ @calls << range
83
+ end
84
+
85
+ @calls.should eq [
86
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:59:59Z')),
87
+ (t('2013-01-01T01:00:00Z')..t('2013-01-01T01:59:59Z')),
88
+ (t('2013-01-01T02:00:00Z')..t('2013-01-01T02:59:59Z')),
89
+ ]
90
+ end
91
+ end
92
+
93
+ it "should iterate over each_day" do
94
+ TimeChunk.each_day('2013-01-01T00:00:00Z'..'2013-01-04T23:59:59Z') do |range|
95
+ @calls << range
96
+ end
97
+
98
+ @calls.should eq [
99
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T23:59:59Z')),
100
+ (t('2013-01-02T00:00:00Z')..t('2013-01-02T23:59:59Z')),
101
+ (t('2013-01-03T00:00:00Z')..t('2013-01-03T23:59:59Z')),
102
+ (t('2013-01-04T00:00:00Z')..t('2013-01-04T23:59:59Z')),
103
+ ]
104
+ end
105
+
106
+ it "should iterate over each_hour" do
107
+ TimeChunk.each_hour('2013-01-01T00:00:00Z'..'2013-01-01T02:59:59Z') do |range|
108
+ @calls << range
109
+ end
110
+
111
+ @calls.should eq [
112
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:59:59Z')),
113
+ (t('2013-01-01T01:00:00Z')..t('2013-01-01T01:59:59Z')),
114
+ (t('2013-01-01T02:00:00Z')..t('2013-01-01T02:59:59Z')),
115
+ ]
116
+ end
117
+
118
+ it "should iterate over each_minute" do
119
+ TimeChunk.each_minute('2013-01-01T00:00:00Z'..'2013-01-01T00:04:59Z') do |range|
120
+ @calls << range
121
+ end
122
+
123
+ @calls.should eq [
124
+ (t('2013-01-01T00:00:00Z')..t('2013-01-01T00:00:59Z')),
125
+ (t('2013-01-01T00:01:00Z')..t('2013-01-01T00:01:59Z')),
126
+ (t('2013-01-01T00:02:00Z')..t('2013-01-01T00:02:59Z')),
127
+ (t('2013-01-01T00:03:00Z')..t('2013-01-01T00:03:59Z')),
128
+ (t('2013-01-01T00:04:00Z')..t('2013-01-01T00:04:59Z'))
129
+ ]
130
+ end
131
+
132
+ end
@@ -0,0 +1,60 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = "time_chunk"
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Alex Dean"]
12
+ s.date = "2013-02-04"
13
+ s.description = "Iterate over time ranges in discrete chunks."
14
+ s.email = "alex@crackpot.org"
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".rspec",
22
+ "Gemfile",
23
+ "Gemfile.lock",
24
+ "LICENSE.txt",
25
+ "README.rdoc",
26
+ "Rakefile",
27
+ "VERSION",
28
+ "lib/time_chunk.rb",
29
+ "spec/spec_helper.rb",
30
+ "spec/time_chunk_spec.rb",
31
+ "time_chunk.gemspec"
32
+ ]
33
+ s.homepage = "http://github.com/tedconf/time_chunk"
34
+ s.licenses = ["MIT"]
35
+ s.require_paths = ["lib"]
36
+ s.rubygems_version = "1.8.24"
37
+ s.summary = "Iterate over time ranges in discrete chunks."
38
+
39
+ if s.respond_to? :specification_version then
40
+ s.specification_version = 3
41
+
42
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
43
+ s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
44
+ s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
45
+ s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
46
+ s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
47
+ else
48
+ s.add_dependency(%q<rspec>, ["~> 2.8.0"])
49
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
50
+ s.add_dependency(%q<bundler>, ["~> 1.2.0"])
51
+ s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
52
+ end
53
+ else
54
+ s.add_dependency(%q<rspec>, ["~> 2.8.0"])
55
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
56
+ s.add_dependency(%q<bundler>, ["~> 1.2.0"])
57
+ s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
58
+ end
59
+ end
60
+
metadata ADDED
@@ -0,0 +1,126 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: time_chunk
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Alex Dean
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-02-04 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: rspec
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: 2.8.0
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: 2.8.0
30
+ - !ruby/object:Gem::Dependency
31
+ name: rdoc
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ~>
36
+ - !ruby/object:Gem::Version
37
+ version: '3.12'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ~>
44
+ - !ruby/object:Gem::Version
45
+ version: '3.12'
46
+ - !ruby/object:Gem::Dependency
47
+ name: bundler
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ~>
52
+ - !ruby/object:Gem::Version
53
+ version: 1.2.0
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ~>
60
+ - !ruby/object:Gem::Version
61
+ version: 1.2.0
62
+ - !ruby/object:Gem::Dependency
63
+ name: jeweler
64
+ requirement: !ruby/object:Gem::Requirement
65
+ none: false
66
+ requirements:
67
+ - - ~>
68
+ - !ruby/object:Gem::Version
69
+ version: 1.8.4
70
+ type: :development
71
+ prerelease: false
72
+ version_requirements: !ruby/object:Gem::Requirement
73
+ none: false
74
+ requirements:
75
+ - - ~>
76
+ - !ruby/object:Gem::Version
77
+ version: 1.8.4
78
+ description: Iterate over time ranges in discrete chunks.
79
+ email: alex@crackpot.org
80
+ executables: []
81
+ extensions: []
82
+ extra_rdoc_files:
83
+ - LICENSE.txt
84
+ - README.rdoc
85
+ files:
86
+ - .document
87
+ - .rspec
88
+ - Gemfile
89
+ - Gemfile.lock
90
+ - LICENSE.txt
91
+ - README.rdoc
92
+ - Rakefile
93
+ - VERSION
94
+ - lib/time_chunk.rb
95
+ - spec/spec_helper.rb
96
+ - spec/time_chunk_spec.rb
97
+ - time_chunk.gemspec
98
+ homepage: http://github.com/tedconf/time_chunk
99
+ licenses:
100
+ - MIT
101
+ post_install_message:
102
+ rdoc_options: []
103
+ require_paths:
104
+ - lib
105
+ required_ruby_version: !ruby/object:Gem::Requirement
106
+ none: false
107
+ requirements:
108
+ - - ! '>='
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ segments:
112
+ - 0
113
+ hash: 446086649663897477
114
+ required_rubygems_version: !ruby/object:Gem::Requirement
115
+ none: false
116
+ requirements:
117
+ - - ! '>='
118
+ - !ruby/object:Gem::Version
119
+ version: '0'
120
+ requirements: []
121
+ rubyforge_project:
122
+ rubygems_version: 1.8.24
123
+ signing_key:
124
+ specification_version: 3
125
+ summary: Iterate over time ranges in discrete chunks.
126
+ test_files: []