timeshifter 0.1.0

data/README.md

@@ -0,0 +1,31 @@
+Timeshifter
+===========
+
+## DESCRIPTION
+
+Timeshifter is a library for shifting time around within a day. You can set
+valid hour ranges and Timeshifter will spread a time out within those ranges.
+
+For example, say your valid ranges are outside business hours (midnight until
+9am and 5pm until midnight). You can set those as your valid ranges and shift
+your time within those ranges:
+
+	# Create a shifter for 12am-9am, 5pm-12am
+	shifter = Timeshifter.new([0..9, 17..24])
+	shifter.total_hours  # => 16
+	shifter.shift(Time.utc(2010, 1, 1, 0, 0, 0))     # => "Fri Jan 01 00:00:00 UTC 2010"
+	shifter.shift(Time.utc(2010, 1, 1, 12, 0, 0))    # => "Fri Jan 01 08:00:00 UTC 2010"
+	shifter.shift(Time.utc(2010, 1, 1, 18, 0, 0))    # => "Fri Jan 01 20:00:00 UTC 2010"
+	shifter.shift(Time.utc(2010, 1, 1, 23, 59, 59))  # => "Fri Jan 01 23:59:59 UTC 2010"
+
+Timeshifter follows the rules of [Semantic Versioning](http://semver.org/) and
+uses [TomDoc](http://tomdoc.org/) for inline documentation.
+
+
+## CONTRIBUTE
+
+Have a great idea for Timeshifter? Awesome. Fork the repository and add a
+feature or fix a bug. There are a couple things I ask:
+
+1. You must have tests for all code you check in.
+1. Create an appropriately named topic branch that contains your change.

data/lib/timeshifter.rb

@@ -0,0 +1,97 @@
+lib = File.expand_path('../lib', File.dirname(__FILE__))
+$:.unshift lib unless $:.include?(lib)
+
+require 'timeshifter/version'
+
+class Timeshifter
+  ##############################################################################
+  #
+  # Constructor
+  #
+  ##############################################################################
+  
+  # Initializes an object that will shift time within a valid set of ranges.
+  #
+  # ranges - A list of ranges to shift time within.
+  def initialize(ranges)
+    raise "Ranges are required" if ranges.nil?
+    @ranges = ranges.compact.sort {|x,y| x.begin <=> y.begin}
+  end
+  
+
+  ##############################################################################
+  #
+  # Properties
+  #
+  ##############################################################################
+
+  # The list of valid ranges.
+  def ranges
+    Array.new(@ranges)
+  end
+
+
+  ##############################################################################
+  #
+  # Methods
+  #
+  ##############################################################################
+  
+  # Shifts the time to a valid time in the day based on the ranges provided.
+  #
+  # time - The time to shift.
+  #
+  # Returns a time that is within the valid ranges.
+  def shift(time)
+    return nil if time.nil?
+    
+    # Check if it's UTC
+    is_utc = time.utc?
+    
+    # Determine the total available seconds from the ranges.
+    tsec = (total_hours * 3600).to_f
+    raise "No hours available to shift within" if tsec == 0
+    
+    # Determine original seconds in time for the day
+    osec = ((time.hour*3600) + (time.min*60) + time.sec).to_f
+
+    # Determine time shifted seconds in time for the day
+    sec  = osec * (tsec/86400)
+    
+    # Work through ranges and compact time
+    current = 0.0
+    ranges.each do |range|
+      rsec = ((range.end - range.begin) * 3600).to_f
+      
+      # If time time is within this range calculate the position
+      if sec < current+rsec
+        shifted_time = Time.at(time.to_i - osec.to_i + (range.begin*3600)+(sec-current).to_i)
+
+        # Return UTC if that's what was passed in
+        if is_utc
+          shifted_time = shifted_time.getutc()
+        end
+        
+        return shifted_time
+      end
+
+      # Add range second total to current seconds
+      current += rsec
+    end
+    
+    # We should have been able to shift within a range by now
+    raise "Time could not be shifted inside range: #{osec} #{sec} #{current}"
+  end
+  
+  # Calculates the total hours available based on the ranges provided.
+  def total_hours
+    total = 0
+
+    # Calculate total
+    ranges.each do |range|
+      total += range.end - range.begin
+    end
+    
+    return total
+  end
+end

data/lib/timeshifter/version.rb

@@ -0,0 +1,3 @@
+class Timeshifter
+  VERSION = "0.1.0"
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+lib = File.expand_path('../lib', File.dirname(__FILE__))
+$:.unshift lib unless $:.include?(lib)
+
+require 'rubygems'
+require 'minitest/autorun'
+require 'timeshifter'

data/test/test_timeshifter.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TimeshifterTestCase < MiniTest::Unit::TestCase
+  ## Initialization ############################################################
+
+  def test_raise_error_for_nil_ranges
+    assert_raises RuntimeError do
+      shifter = Timeshifter.new(nil)
+    end
+  end
+
+
+  ## Total Hours ###############################################################
+
+  def test_should_calculate_total_hours_simple
+    shifter = Timeshifter.new([0..12])
+    assert_equal 12, shifter.total_hours
+  end
+
+  def test_should_calculate_total_hours_complex
+    shifter = Timeshifter.new([0..8, 18..24])
+    assert_equal 14, shifter.total_hours
+  end
+
+  def test_should_calculate_total_hours_for_empty_ranges
+    shifter = Timeshifter.new([])
+    assert_equal 0, shifter.total_hours
+  end
+
+
+  ## Shifting ##################################################################
+
+  def test_should_shift_to_original_time
+    shifter = Timeshifter.new([0..24])
+    assert_equal 'Fri Jan 01 12:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 12, 0, 0)).to_s
+  end
+
+  def test_should_shift_simple
+    shifter = Timeshifter.new([0..12])
+    assert_equal 'Fri Jan 01 04:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 8, 0, 0)).to_s
+  end
+
+  def test_should_shift_complex
+    shifter = Timeshifter.new([0..8, 16..24])
+    assert_equal 'Fri Jan 01 06:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 9, 0, 0)).to_s
+  end
+
+  def test_should_shift_to_secondary_range
+    shifter = Timeshifter.new([0..8, 16..24])
+    assert_equal 'Fri Jan 01 16:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 12, 0, 0)).to_s
+  end
+
+  def test_should_shift_to_secondary_range2
+    shifter = Timeshifter.new([0..8, 16..24])
+    assert_equal 'Fri Jan 01 20:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 18, 0, 0)).to_s
+  end
+
+  def test_should_shift_to_end_of_ranges
+    shifter = Timeshifter.new([0..8, 16..24])
+    assert_equal 'Fri Jan 01 23:59:59 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 23, 59, 59)).to_s
+  end
+
+
+  def test_should_shift_ranges_specified_in_readme
+    shifter = Timeshifter.new([0..9, 17..24])
+    assert_equal 'Fri Jan 01 00:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 0, 0, 0)).to_s
+    assert_equal 'Fri Jan 01 08:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 12, 0, 0)).to_s
+    assert_equal 'Fri Jan 01 20:00:00 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 18, 0, 0)).to_s
+    assert_equal 'Fri Jan 01 23:59:59 UTC 2010', shifter.shift(Time.utc(2010, 1, 1, 23, 59, 59)).to_s
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: timeshifter
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-30 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- benbjohnson@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/timeshifter/version.rb
+- lib/timeshifter.rb
+- README.md
+- test/helper.rb
+- test/test_timeshifter.rb
+has_rdoc: true
+homepage: 
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for shifting time.
+test_files: 
+- test/helper.rb
+- test/test_timeshifter.rb