timechunker 0.1.0

data/README.md

@@ -0,0 +1,33 @@
+# Timechunker
+
+## What it does
+
+Timechunker allows you to split a time range into pieces of a defined size, like this:
+
+	require "time"
+	require "timechunker"
+	
+	timerange = Timechunker::Timerange.new(Time.parse("2011-02-03 18:04:02"),
+	                                       Time.parse("2011-02-03 18:29:02"))
+	
+	five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+	
+	chunker = Timechunker::Chunker.new
+	chunker.get_chunks(timerange, five_minutes)
+
+This will give you a list of all 5-minute chunks this timerange fits into
+
+	=> [Thu Feb 03 18:00:00 +0100 2011,
+	    Thu Feb 03 18:05:00 +0100 2011,
+	    Thu Feb 03 18:10:00 +0100 2011,
+	    Thu Feb 03 18:15:00 +0100 2011,
+	    Thu Feb 03 18:20:00 +0100 2011,
+	    Thu Feb 03 18:25:00 +0100 2011]
+
+## Installation
+
+	gem install timechunker
+
+## TODO
+
+Only works with 'minute' chunks, other chunk types need to be supported, too.

data/Rakefile

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require "rake/testtask"
+require "timechunker/version"
+
+desc "Default: run tests"
+task :default => :test
+
+desc "Run tests."
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Build a gem from gemspec"
+task :build do
+  system "gem build timechunker.gemspec"
+end
+
+desc "Release new gem version"
+task :release => :build do
+  system "gem push timechunker-#{Timechunker::VERSION}.gem"
+end

data/lib/timechunker.rb

@@ -0,0 +1,3 @@
+require 'timechunker/chunksize'
+require 'timechunker/timerange'
+require 'timechunker/chunker'

data/lib/timechunker/chunker.rb

@@ -0,0 +1,37 @@
+module Timechunker
+  class Chunker
+
+    def get_chunks(timerange, chunksize)
+      if chunksize.type == 'minutes'
+        number_of_chunks = ((timerange.end_time - timerange.start_time) / 60 / chunksize.size).ceil.to_i
+        number_of_chunks = number_of_chunks + 1
+
+        first_chunk = find_chunk(timerange.start_time, chunksize)
+
+        chunks = []
+        number_of_chunks.times do |i|
+          chunk = first_chunk + (i * 60 * chunksize.size)
+          chunks << chunk unless chunk > timerange.end_time
+        end
+
+        return chunks
+
+      end
+    end
+
+
+    private
+
+    def find_chunk(time, chunksize)
+      if chunksize.type == 'minutes'
+        first_chunk = Time.local(time.year,
+                                 time.month,
+                                 time.day,
+                                 time.hour,
+                                 time.min / chunksize.size * chunksize.size,
+                                 0)
+      end
+    end
+
+  end
+end

data/lib/timechunker/chunksize.rb

@@ -0,0 +1,12 @@
+module Timechunker
+  class Chunksize
+
+      attr_reader :size, :type
+
+      def initialize(size, type)
+        @size = size
+        @type = type
+      end
+
+  end
+end

data/lib/timechunker/timerange.rb

@@ -0,0 +1,12 @@
+module Timechunker
+  class Timerange
+
+    attr_reader :start_time, :end_time
+
+    def initialize(start_time, end_time)
+      @start_time = start_time
+      @end_time = end_time
+    end
+
+  end
+end

data/lib/timechunker/version.rb

@@ -0,0 +1,3 @@
+module Timechunker
+  VERSION = "0.1.0".freeze
+end

data/test/unit/timechunker/chunker_test.rb

@@ -0,0 +1,112 @@
+require "test/unit"
+require "timechunker"
+
+class ChunkerTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_chunk_calculation_default
+    expected = [Time.local(2011, 1, 24, 13, 55, 0),
+                Time.local(2011, 1, 24, 14, 0, 0),
+                Time.local(2011, 1, 24, 14, 5, 0),
+                Time.local(2011, 1, 24, 14, 10, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 57, 0), Time.local(2011, 1, 24, 14, 10, 3))
+    five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, five_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_other
+    expected = [Time.local(2011, 1, 24, 14, 0, 0),
+                Time.local(2011, 1, 24, 14, 5, 0),
+                Time.local(2011, 1, 24, 14, 10, 0),
+                Time.local(2011, 1, 24, 14, 15, 0),
+                Time.local(2011, 1, 24, 14, 20, 0),
+                Time.local(2011, 1, 24, 14, 25, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 14, 4, 0), Time.local(2011, 1, 24, 14, 26, 3))
+    five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, five_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_singlechunk
+    expected = [Time.local(2011, 1, 24, 13, 55, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 57, 0), Time.local(2011, 1, 24, 13, 58, 3))
+    five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, five_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_singlechunk_boundary
+    expected = [Time.local(2011, 1, 24, 13, 55, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 55, 0), Time.local(2011, 1, 24, 13, 59, 59))
+    five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, five_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_twochunks_boundary
+    expected = [Time.local(2011, 1, 24, 13, 55, 0),
+                Time.local(2011, 1, 24, 14, 0, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 55, 0), Time.local(2011, 1, 24, 14, 0, 0))
+    five_minutes = Timechunker::Chunksize.new(5, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, five_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_fullhour
+    expected = [Time.local(2011, 1, 24, 13, 0, 0),
+                Time.local(2011, 1, 24, 13, 20, 0),
+                Time.local(2011, 1, 24, 13, 40, 0),
+                Time.local(2011, 1, 24, 14, 0, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 0, 0), Time.local(2011, 1, 24, 14, 0, 0))
+    twenty_minutes = Timechunker::Chunksize.new(20, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, twenty_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+  def test_chunk_calculation_uneven
+    expected = [Time.local(2011, 1, 24, 13, 0, 0),
+                Time.local(2011, 1, 24, 13, 21, 0),
+                Time.local(2011, 1, 24, 13, 42, 0),
+                Time.local(2011, 1, 24, 14, 3, 0),
+                Time.local(2011, 1, 24, 14, 24, 0)]
+
+    timerange = Timechunker::Timerange.new(Time.local(2011, 1, 24, 13, 0, 0), Time.local(2011, 1, 24, 14, 30, 0))
+    twentyone_minutes = Timechunker::Chunksize.new(21, 'minutes')
+
+    chunker = Timechunker::Chunker.new
+    actual = chunker.get_chunks(timerange, twentyone_minutes)
+
+    assert_equal(expected, actual)
+  end
+
+end

data/timechunker.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "timechunker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "timechunker"
+  s.version     = Timechunker::VERSION.dup
+  s.description = "Simple class to chunk a time range into ranges of a defined size."
+  s.summary     = "Simple class to chunk a time range into ranges of a defined size."
+  s.author      = "Manuel Kiessling"
+  s.email       = "manuel@kiessling.net"
+  s.homepage    = "https://github.com/ManuelKiessling/rbTimeChunker"
+
+  s.rubyforge_project = "timechunker"
+
+  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"]   
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: timechunker
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Manuel Kiessling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-04 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Simple class to chunk a time range into ranges of a defined size.
+email: manuel@kiessling.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/timechunker.rb
+- lib/timechunker/chunker.rb
+- lib/timechunker/chunksize.rb
+- lib/timechunker/timerange.rb
+- lib/timechunker/version.rb
+- test/unit/timechunker/chunker_test.rb
+- timechunker.gemspec
+has_rdoc: true
+homepage: https://github.com/ManuelKiessling/rbTimeChunker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: timechunker
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Simple class to chunk a time range into ranges of a defined size.
+test_files: 
+- test/unit/timechunker/chunker_test.rb