acts_as_flux_capacitor 0.5.0

data/spec/acts_as_flux_capacitor_spec.rb

@@ -0,0 +1,190 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "The Temporal mixin" do
+
+  before(:all) do
+    @present_time       = Time.parse "Sun May 18 16:41:58 2008"
+    @twenty_mins_later  = Time.parse "Sun May 18 17:01:58 2008"
+  end
+
+  it "should make Time, Date and DateTime into Temporal objects" do
+    [Time, Date, DateTime].each do |klass|
+      klass.included_modules.should include(Temporal)
+    end
+  end
+
+  it "should determine the length of time between two Temporal objects" do
+    Time.period_between(@present_time,@twenty_mins_later).should == 20.minutes
+  end
+  
+  it "should determine the length of time until a Temporal object" do
+    Time.length_of_time_until(@twenty_mins_later,@present_time).should == 20.minutes
+  end
+  
+  it "should determine if a temporal object is in the future" do
+    @twenty_mins_later.in_the_future?(@present_time).should be_true
+    @present_time.in_the_future?(@twenty_mins_later).should be_false
+  end
+  
+  it "should determine the length of time since a Temporal object" do
+    Time.length_of_time_since(@present_time,@twenty_mins_later).should == 20.minutes
+  end
+  
+  it "should determine if a temporal object is in the past" do
+    @present_time.in_the_past?(@twenty_mins_later).should be_true
+    @twenty_mins_later.in_the_past?(@present_time).should be_false
+  end
+  
+  it "should determine if one Temporal object is before another" do
+    @present_time.before?(@twenty_mins_later).should be_true
+    @twenty_mins_later.before?(@present_time).should be_false
+  end
+  
+  it "should determine if one Temporal object is after another" do
+    @twenty_mins_later.before?(@present_time).should be_false
+    @present_time.before?(@twenty_mins_later).should be_true
+  end
+  
+end
+
+describe "The class TimePeriod < ActiveRecord::Base" do
+
+  it "should be a flux capacitor" do
+    TimePeriod.flux_capacitor?.should be_true
+  end
+  
+  it "should be a Temporal object" do
+    TimePeriod.should include(Temporal)
+  end
+  
+  it "should possess all four bitemporal database attributes" do
+    TimePeriod.column_names.should include(
+      'begins_at','ends_at','created_at','deleted_at' )
+  end
+  
+  it "should not be valid if either of the two time spans are 0 or less" do
+    time_period = TimePeriod.new
+    time_period.should_not be_valid
+    
+    time_period.created_at = @present_time
+    time_period.begins_at  = @present_time
+    
+    time_period.deleted_at  = @twenty_mins_later
+    time_period.ends_at   = @twenty_mins_later
+  end
+end
+
+describe "The TimePeriod.find extensions" do
+
+  include TimePeriodFixtures
+  
+  it "should find time_periods in the present" do
+    TimePeriod.find(:first,:present=>true   ,:current_time => present_time).
+      happening_now?(present_time).should be_true
+  end
+  
+  it "should find time_periods in the past" do
+    TimePeriod.find(:first,:past=>true      ,:current_time => present_time).
+      in_the_past?(present_time).should be_true
+  end
+  
+  it "should find time_periods in the future" do
+    TimePeriod.find(:first,:future=>true    ,:current_time => present_time).
+      in_the_future?(present_time).should be_true
+  end
+  
+  it "should find time_periods occuring at a specific time" do
+    TimePeriod.find(:first,:at=>future_time).at?(future_time).should be_true
+  end
+  
+  it "should find time_periods occuring within a specific range of time" do
+    TimePeriod.find(:first,:from => more_past_time , :to => more_future_time).
+    at?(present_time).should be_true
+  end
+  
+end
+
+describe "The TimePeriod comparison helpers" do
+
+  include TimePeriodFixtures
+
+  it "should calculate the time between time_periods" do
+    TimePeriod.period_between(past_period,future_period).should == 140.minutes
+  end
+  
+  it "should determine whether two time_periods overlap" do
+    past_period.overlaps_with?(future_period).should be_false
+  end
+  
+  it "should determine the length of time by which two time_periods overlap" do
+    future_period.overlap_with(long_period).should == 3.hours
+  end
+
+  it "should determine if two time_periods are back-to-back" do
+    long_period.back_to_back_with?(future_period).should be_false
+    past_period.back_to_back_with?(present_period).should be_true
+  end
+  
+  it "should determine if a time_period is between two other time_periods" do
+    present_period.between?(past_period,future_period).should be_true
+    future_period.between?(past_period,present_period).should be_false
+  end
+end
+
+describe "The TimePeriod status helpers" do
+
+  it "should determine if a time_period has started" do
+    past_period.started?(present_time).should be_true
+    present_period.started?(present_time).should be_true
+    future_period.started?(present_time).should be_false
+  end
+  
+  it "should determine how much time has elapsed since an event started" do
+    past_period.elapsed(present_time).should be_nil
+    present_period.elapsed(present_time).should == 2.hours
+    future_period.elapsed(present_time).should be_nil
+  end
+  
+  it "should determine what percentage of time has elapsed since an event started" do
+    past_period.percent_elapsed(present_time).should be_nil
+    present_period.percent_elapsed(present_time).should eql(7200.0 / (7200+1200) * 100)
+    future_period.percent_elapsed(present_time).should be_nil    
+  end
+  
+  it "should determine how much time is remaining until an event ends" do
+    past_period.remaining(present_time).should be_nil
+    present_period.remaining(present_time).should == 20.minutes
+    future_period.remaining(present_time).should be_nil
+  end
+  
+  it "should determine what percentage of time is remaining until an event ends" do
+    past_period.percent_remaining(present_time).should be_nil
+    present_period.percent_remaining(present_time).should eql(1200.0 / (7200+1200) * 100)
+    future_period.percent_remaining(present_time).should be_nil    
+  end
+  
+  it "should determine if a time_period has ended" do
+    past_period.ended?(present_time).should be_true
+    present_period.ended?(present_time).should be_false
+    future_period.ended?(present_time).should be_false
+  end
+  
+  it "should determine the duration of a time_period" do
+    future_period.duration.should == 3.hours
+  end
+
+end
+
+describe "The TimePeriod modification helpers" do
+  
+  it "should shift a time_period into the past or future" do
+    less_future_period = future_period.shift(-7200)
+    
+    less_future_period.duration.should == future_period.duration
+    TimePeriod.length_of_time_until(future_period.begins_at,less_future_period.begins_at).
+      should == 2.hours
+    TimePeriod.length_of_time_until(future_period.ends_at,less_future_period.ends_at).
+      should == 2.hours
+  end
+  
+end

data/spec/database.yml

@@ -0,0 +1,8 @@
+mysql:
+  adapter: mysql
+  encoding: utf8
+  database: acts_as_flux_capacitor_test
+  username: root
+  password:
+  host: localhost
+  socket: /var/run/mysqld/mysqld.sock

data/spec/fixtures.rb

@@ -0,0 +1,57 @@
+module TimePeriodFixtures
+
+#	require 'time'
+	
+	def more_past_time
+		Time.parse "Sun May 18 11:41:58 2008"
+	end
+	
+	def past_time
+		Time.parse "Sun May 18 14:41:58 2008"
+	end
+	
+	def present_time
+		Time.parse "Sun May 18 16:41:58 2008"
+	end
+
+	def future_time
+		Time.parse "Sun May 18 17:01:58 2008"
+	end
+	
+	def more_future_time
+		Time.parse "Sun May 18 20:01:58 2008"
+	end
+	
+	###################################
+	
+	def present_period
+		time_period = TimePeriod.find_or_initialize_by_begins_at_and_ends_at past_time,future_time
+		time_period.save!
+		time_period
+	end
+	
+	def past_period
+		time_period = TimePeriod.find_or_initialize_by_begins_at_and_ends_at more_past_time , past_time
+		time_period.save!
+		time_period
+	end
+	
+	def future_period
+		time_period = TimePeriod.find_or_initialize_by_begins_at_and_ends_at future_time,more_future_time
+		time_period.save!
+		time_period
+	end
+	
+	def long_period
+		time_period = TimePeriod.find_or_initialize_by_begins_at_and_ends_at past_time , more_future_time
+		time_period.save!
+		time_period
+	end
+	
+	def put_fixtures_in_db!
+		present_period
+		past_period
+		future_period
+		long_period
+	end
+end

data/spec/report/report.html

@@ -0,0 +1,274 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>RSpec results</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Expires" content="-1" />
+  <meta http-equiv="Pragma" content="no-cache" />
+  <style type="text/css">
+  body {
+    margin: 0;
+    padding: 0;
+    background: #fff;
+    font-size: 80%;
+  }
+  </style>
+</head>
+<body>
+<div class="rspec-report">
+  <script type="text/javascript">
+    // <![CDATA[
+function moveProgressBar(percentDone) {
+  document.getElementById("rspec-header").style.width = percentDone +"%";
+}
+function makeRed(element_id) {
+  document.getElementById(element_id).style.background = '#C40D0D';
+  document.getElementById(element_id).style.color = '#FFFFFF';
+}
+
+function makeYellow(element_id) {
+  if (element_id == "rspec-header" && document.getElementById(element_id).style.background != '#C40D0D')
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
+  }
+  else
+  {
+    document.getElementById(element_id).style.background = '#FAF834';
+    document.getElementById(element_id).style.color = '#000000';
+  }
+}
+
+    // ]]>
+  </script>
+  <style type="text/css">
+#rspec-header {
+  background: #65C400; color: #fff;
+}
+
+.rspec-report h1 {
+  margin: 0px 10px 0px 10px;
+  padding: 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  font-size: 1.8em;
+}
+
+#summary {
+  margin: 0; padding: 5px 10px;
+  font-family: "Lucida Grande", Helvetica, sans-serif;
+  text-align: right;
+  position: absolute;
+  top: 0px;
+  right: 0px;
+}
+
+#summary p {
+  margin: 0 0 0 2px;
+}
+
+#summary #totals {
+  font-size: 1.2em;
+}
+
+.example_group {
+  margin: 0 10px 5px;
+  background: #fff;
+}
+
+dl {
+  margin: 0; padding: 0 0 5px;
+  font: normal 11px "Lucida Grande", Helvetica, sans-serif;
+}
+
+dt {
+  padding: 3px;
+  background: #65C400;
+  color: #fff;
+  font-weight: bold;
+}
+
+dd {
+  margin: 5px 0 5px 5px;
+  padding: 3px 3px 3px 18px;
+}
+
+dd.spec.passed {
+  border-left: 5px solid #65C400;
+  border-bottom: 1px solid #65C400;
+  background: #DBFFB4; color: #3D7700;
+}
+
+dd.spec.failed {
+  border-left: 5px solid #C20000;
+  border-bottom: 1px solid #C20000;
+  color: #C20000; background: #FFFBD3;
+}
+
+dd.spec.not_implemented {
+  border-left: 5px solid #FAF834;
+  border-bottom: 1px solid #FAF834;
+  background: #FCFB98; color: #131313;
+}
+
+dd.spec.pending_fixed {
+  border-left: 5px solid #0000C2;
+  border-bottom: 1px solid #0000C2;
+  color: #0000C2; background: #D3FBFF;
+}
+
+.backtrace {
+  color: #000;
+  font-size: 12px;
+}
+
+a {
+  color: #BE5C00;
+}
+
+/* Ruby code, style similar to vibrant ink */
+.ruby {
+  font-size: 12px;
+  font-family: monospace;
+  color: white;
+  background-color: black;
+  padding: 0.1em 0 0.2em 0;
+}
+
+.ruby .keyword { color: #FF6600; }
+.ruby .constant { color: #339999; }
+.ruby .attribute { color: white; }
+.ruby .global { color: white; }
+.ruby .module { color: white; }
+.ruby .class { color: white; }
+.ruby .string { color: #66FF00; }
+.ruby .ident { color: white; }
+.ruby .method { color: #FFCC00; }
+.ruby .number { color: white; }
+.ruby .char { color: white; }
+.ruby .comment { color: #9933CC; }
+.ruby .symbol { color: white; }
+.ruby .regex { color: #44B4CC; }
+.ruby .punct { color: white; }
+.ruby .escape { color: white; }
+.ruby .interp { color: white; }
+.ruby .expr { color: white; }
+
+.ruby .offending { background-color: gray; }
+.ruby .linenum {
+  width: 75px;
+  padding: 0.1em 1em 0.2em 0;
+  color: #000000;
+  background-color: #FFFBD3;
+}
+
+  </style>
+
+<div id="rspec-header">
+  <h1>RSpec Results</h1>
+
+  <div id="summary">
+    <p id="totals">&nbsp;</p>
+    <p id="duration">&nbsp;</p>
+  </div>
+</div>
+
+<div class="results">
+<div class="example_group">
+  <dl>
+  <dt id="example_group_1">The Temporal mixin</dt>
+    <script type="text/javascript">moveProgressBar('3.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should make Time, Date and DateTime into Temporal objects</span></dd>
+    <script type="text/javascript">moveProgressBar('6.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine the length of time between two Temporal objects</span></dd>
+    <script type="text/javascript">moveProgressBar('10.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine the length of time until a Temporal object</span></dd>
+    <script type="text/javascript">moveProgressBar('13.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if a temporal object is in the future</span></dd>
+    <script type="text/javascript">moveProgressBar('16.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine the length of time since a Temporal object</span></dd>
+    <script type="text/javascript">moveProgressBar('20.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if a temporal object is in the past</span></dd>
+    <script type="text/javascript">moveProgressBar('23.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if one Temporal object is before another</span></dd>
+    <script type="text/javascript">moveProgressBar('26.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if one Temporal object is after another</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_2">The class TimePeriod &lt; ActiveRecord::Base</dt>
+    <script type="text/javascript">moveProgressBar('30.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should be a flux capacitor</span></dd>
+    <script type="text/javascript">moveProgressBar('33.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should be a Temporal object</span></dd>
+    <script type="text/javascript">moveProgressBar('36.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should possess all four bitemporal database attributes</span></dd>
+    <script type="text/javascript">moveProgressBar('40.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should not be valid if either of the two time spans are 0 or less</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_3">The TimePeriod.find extensions</dt>
+    <script type="text/javascript">moveProgressBar('43.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should find time_periods in the present</span></dd>
+    <script type="text/javascript">moveProgressBar('46.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should find time_periods in the past</span></dd>
+    <script type="text/javascript">moveProgressBar('50.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should find time_periods in the future</span></dd>
+    <script type="text/javascript">moveProgressBar('53.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should find time_periods occuring at a specific time</span></dd>
+    <script type="text/javascript">moveProgressBar('56.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should find time_periods occuring within a specific range of time</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_4">The TimePeriod comparison helpers</dt>
+    <script type="text/javascript">moveProgressBar('60.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should calculate the time between time_periods</span></dd>
+    <script type="text/javascript">moveProgressBar('63.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine whether two time_periods overlap</span></dd>
+    <script type="text/javascript">moveProgressBar('66.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine the length of time by which two time_periods overlap</span></dd>
+    <script type="text/javascript">moveProgressBar('70.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if two time_periods are back-to-back</span></dd>
+    <script type="text/javascript">moveProgressBar('73.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if a time_period is between two other time_periods</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_5">The TimePeriod status helpers</dt>
+    <script type="text/javascript">moveProgressBar('76.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if a time_period has started</span></dd>
+    <script type="text/javascript">moveProgressBar('80.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine how much time has elapsed since an event started</span></dd>
+    <script type="text/javascript">moveProgressBar('83.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine what percentage of time has elapsed since an event started</span></dd>
+    <script type="text/javascript">moveProgressBar('86.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine how much time is remaining until an event ends</span></dd>
+    <script type="text/javascript">moveProgressBar('90.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine what percentage of time is remaining until an event ends</span></dd>
+    <script type="text/javascript">moveProgressBar('93.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine if a time_period has ended</span></dd>
+    <script type="text/javascript">moveProgressBar('96.6');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should determine the duration of a time_period</span></dd>
+  </dl>
+</div>
+<div class="example_group">
+  <dl>
+  <dt id="example_group_6">The TimePeriod modification helpers</dt>
+    <script type="text/javascript">moveProgressBar('100.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should shift a time_period into the past or future</span></dd>
+  </dl>
+</div>
+<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.292237 seconds</strong>";</script>
+<script type="text/javascript">document.getElementById('totals').innerHTML = "30 examples, 0 failures";</script>
+</div>
+</div>
+</body>
+</html>