time_keeper 0.1.0

data/lib/time_keeper/time_range_manipulation.rb

@@ -0,0 +1,21 @@
+module TimeKeeper
+  module TimeRangeManipulation
+    def split_time_range_by_day(range)
+      return [] if range.blank?
+      if range.first.to_date < range.last.to_date
+        out = []
+        current = range.first
+        while current.to_i <= range.last.to_i
+          eod = current.end_of_day
+          eod = range.last if current.to_date == range.last.to_date
+          out << (current .. eod)
+          current = eod + 1.second
+        end
+        out
+      else
+        [range]
+      end
+    end
+    module_function :split_time_range_by_day
+  end
+end

data/lib/time_keeper/time_span_support.rb

@@ -0,0 +1,60 @@
+module TimeKeeper::TimeSpanSupport
+  include TimeKeeper::StringMinutesSupport
+
+  def display
+    [
+      [
+        start_time_string,
+        (start_day.to_i > 0) ? "Next Day" : nil,
+      ],
+      [
+        end_time_string,
+        (end_day.to_i > 0) ? "Next Day" : nil,
+      ]
+    ].map { |i| i.compact.join(" ") }.join(" to ")
+  end
+
+  def start_time_string
+    to_s_helper(self.start_time) unless self.start_time.nil?
+  end
+
+  def start_time_string=(v)
+    begin
+      self.start_time = to_i_helper(v)
+    rescue ArgumentError => e
+      self.errors.add :start_time, e.message
+    end
+  end
+
+  def end_time_string
+    to_s_helper(self.end_time) unless self.end_time.nil?
+  end
+
+  def end_time_string=(v)
+    begin
+      self.end_time = to_i_helper(v)
+    rescue ArgumentError => e
+      self.errors.add :end_time, e.message
+    end
+  end
+
+  def duration_string
+    to_s_helper(duration)
+  end
+
+  def time_range(on)
+    bak, ENV['TZ'] = ENV['TZ'], Time.zone.tzinfo.name
+    on = on.to_time
+    ENV['TZ'] = bak
+    st = on+start_day.days
+    en = on+end_day.days
+    stt = Time.zone.local(st.year, st.month, st.day, start_time/60, start_time % 60).in_time_zone
+    ent = Time.zone.local(en.year, en.month, en.day, end_time/60, end_time % 60).in_time_zone
+    stt..ent
+  end
+
+  def duration
+    ((end_day * 24 * 60) + end_time) - ((start_day * 24 * 60) + start_time)
+  end
+
+end

data/spec/lib/time_keeper/custom_time_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe TimeKeeper::CustomTime do
+  subject do
+    TimeKeeper::CustomTime.new("09:45 am")
+  end
+  describe "#initialize" do
+    it "should set the time_in_str variable" do
+      TimeKeeper::CustomTime.new("06:45 am").instance_variable_get('@time_in_str').should eq("06:45 am")
+    end
+  end
+
+  describe "#parse" do
+    it "should set the parsed time object to the appropriate time parser" do
+      subject.parse.instance_variable_get("@parsed_time").class.should eq(TimeKeeper::Parser::Meridian)
+    end
+
+    it "should call parse on the time parser object" do
+      time_parser_obj = TimeKeeper::Parser::Meridian.new("06:45 am")
+      TimeKeeper::Parser::Base.stubs(:build).returns(time_parser_obj)
+      time_parser_obj.expects(:parse)
+      subject.parse
+    end
+
+    it "should return the custom time object" do
+      subject.parse.should eq(subject)
+    end
+  end
+
+  describe "#in_seconds" do
+    context "when the time is parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', TimeKeeper::Parser::Meridian.new("06:45 am").parse)
+      end
+
+      it "should return the time in seconds" do
+        subject.in_seconds.should eq(24300)
+      end
+    end
+
+    context "when the time is not parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', nil)
+      end
+
+      it "should raise an exception" do
+        lambda{subject.in_seconds}.should raise_exception
+      end
+    end
+  end
+
+  describe "#in_minutes" do
+    context "when the time is parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', TimeKeeper::Parser::Meridian.new("06:45 am").parse)
+      end
+
+      it "should return the time in minutes" do
+        subject.in_minutes.should eq(405)
+      end
+    end
+
+    context "when the time is not parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', nil)
+      end
+
+      it "should raise an exception" do
+        lambda{subject.in_minutes}.should raise_exception
+      end
+    end
+  end
+  describe "#in_hours" do
+    context "when the time is parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', TimeKeeper::Parser::Meridian.new("06:45 am").parse)
+      end
+
+      it "should return the time in hours" do
+        subject.in_hours.should eq(6.75)
+      end
+    end
+
+    context "when the time is not parsed" do
+      before(:each) do
+        subject.instance_variable_set('@parsed_time', nil)
+      end
+
+      it "should raise an exception" do
+        lambda{subject.in_minutes}.should raise_exception
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "should return formatted hours and minutes" do
+      subject.expects(:in_minutes).twice.returns(405)
+      subject.to_s.should eq("06:45")
+    end
+  end
+end

data/spec/lib/time_keeper/parser/base_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe TimeKeeper::Parser::Base do
+
+  context "when time_is_valid method is implemented" do
+    before(:each) do
+      TimeKeeper::Parser::Base.any_instance.stubs(:time_is_valid).returns(true)
+    end
+
+    subject do
+      TimeKeeper::Parser::Base.new("11:20 am")
+    end
+
+    describe "#initialize" do
+      it "should set the time in string" do
+        TimeKeeper::Parser::Base.new("11:20 am").instance_variable_get('@time_str').should eq("11:20 am")
+      end
+
+      it "should raise an exception if the time is not valid" do
+        lambda{TimeKeeper::Parser::Base.new("11:20 xyz")}.should raise_exception
+      end
+    end
+
+    describe ".build" do
+      context "when the time is in meridian format" do
+        it "should return a meridian time parser object" do
+          TimeKeeper::Parser::Base.build("11:20 am").class.should eq(TimeKeeper::Parser::Meridian)
+        end
+      end
+
+      context "when the time is in military format" do
+        it "should return a military time parser object" do
+          TimeKeeper::Parser::Base.build("14:20").class.should eq(TimeKeeper::Parser::Military)
+        end
+      end
+    end
+
+    describe "#parse" do
+      it "should raise an exception" do
+        lambda{subject.parse}.should raise_exception(NotImplementedError)
+      end
+    end
+
+    describe "#extract_hour" do
+      it "should raise an exception" do
+        lambda{subject.send(:extract_hour)}.should raise_exception(NotImplementedError)
+      end
+    end
+
+    describe "#extract_min" do
+      it "should assign minute to the @min variable" do
+        subject.send(:extract_min, ":45")
+        subject.instance_variable_get('@min').should eq(45)
+      end
+
+      context "when min is present" do
+        it "should return the number of mins in integer" do
+          subject.send(:extract_min, ":45").should eq(45)
+        end
+      end
+
+      context "when min is nil or blank" do
+        it "should return 0" do
+          subject.send(:extract_min, "").should eq(0)
+        end
+      end
+    end
+  end
+
+  context "when time_is_valid method is not implemented" do
+    before(:each) do
+      TimeKeeper::Parser::Base.any_instance.stubs(:valid?).returns(true)
+    end
+
+    subject do
+      TimeKeeper::Parser::Base.new("06:35")
+    end
+
+    describe "#time_is_valid" do
+      it "should raise an exception" do
+        lambda{subject.send(:time_is_valid)}.should raise_exception(NotImplementedError)
+      end
+    end
+  end
+
+  describe ".meridian_format?" do
+    context "when the time contains am or pm" do
+      it "should return true" do
+        TimeKeeper::Parser::Base.meridian_format?("6:45 Pm").should be_true
+      end
+    end
+
+    context "when the time does not contain am or pm" do
+      it "should return false" do
+        TimeKeeper::Parser::Base.meridian_format?("18:45").should be_false
+      end
+    end
+  end
+end

data/spec/lib/time_keeper/parser/meridian_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe TimeKeeper::Parser::Meridian do
+  subject do
+    TimeKeeper::Parser::Meridian.new("7:45 pm")
+  end
+
+  describe "#time_is_valid" do
+    context "when hour and mins are both valid" do
+      it "should return true" do
+        subject.send(:time_is_valid).should be_true
+      end
+    end
+
+    context "when either hour or min is not valid" do
+      before(:each) do
+        subject.instance_variable_set('@time_str', "07:60 pm")
+      end
+
+      it "should return false" do
+        subject.send(:time_is_valid).should be_false
+      end
+
+      it "should attach an error to the object" do
+        subject.send(:time_is_valid)
+        subject.errors[:base].should_not be_empty
+      end
+    end
+  end
+
+  describe "#extract_hour" do
+    context "when the time contains 12 am" do
+      it "should set hour as 0" do
+        subject.send(:extract_hour, "12", "am")
+        subject.instance_variable_get('@hour').should == 0
+      end
+    end
+
+    context "when the time contains 12 pm" do
+      it "should set hour as 12" do
+        subject.send(:extract_hour, "12", "pm")
+        subject.instance_variable_get('@hour').should == 12
+      end
+    end
+
+    context "when the time is between 1 and 11 am" do
+      it "should set hour between 1 to 11" do
+        subject.send(:extract_hour, "9", "am")
+        subject.instance_variable_get('@hour').should == 9
+      end
+    end
+
+    context "when the time is between 1 and 12 pm" do
+      it "should set hour between 12 to 23" do
+        subject.send(:extract_hour, "3", "pm")
+        subject.instance_variable_get('@hour').should == 15
+      end
+    end
+
+    it "should return back the hour object" do
+      subject.send(:extract_hour, "3", "pm").should eq(15)
+    end
+  end
+
+  describe "#parse" do
+    it "should parse the time and set the hours and mins" do
+      subject.parse
+      subject.instance_variable_get('@hour').should eq(19)
+      subject.instance_variable_get('@min').should eq(45)
+    end
+
+    it "should return back the time parser object" do
+      subject.parse.should eq(subject)
+    end
+  end
+end

data/spec/lib/time_keeper/parser/military_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe TimeKeeper::Parser::Military do
+  subject do
+    TimeKeeper::Parser::Military.new("19:45")
+  end
+
+  describe "#time_is_valid" do
+    context "when hour and mins are both valid" do
+      it "should return true" do
+        subject.send(:time_is_valid).should be_true
+      end
+    end
+
+    context "when either hour or min is not valid" do
+      before(:each) do
+        subject.instance_variable_set('@time_str', "19:60")
+      end
+
+      it "should return false" do
+        subject.send(:time_is_valid).should be_false
+      end
+
+      it "should attach an error to the object" do
+        subject.send(:time_is_valid)
+        subject.errors[:base].should_not be_empty
+      end
+    end
+  end
+
+  describe "#extract_hour" do
+    context "when hour is present" do
+      it "should set hour" do
+        subject.send(:extract_hour, "15")
+        subject.instance_variable_get("@hour").should eq(15)
+      end
+    end
+
+    context "when hour is not present" do
+      it "should set hour to zero" do
+        subject.send(:extract_hour, "")
+        subject.instance_variable_get("@hour").should eq(0)
+      end
+    end
+
+    it "should return back the hour object" do
+      subject.send(:extract_hour, "3").should eq(3)
+    end
+  end
+
+  describe "#parse" do
+    it "should parse the time and set the hours and mins" do
+      subject.parse
+      subject.instance_variable_get('@hour').should eq(19)
+      subject.instance_variable_get('@min').should eq(45)
+    end
+
+    it "should return back the time parser object" do
+      subject.parse.should eq(subject)
+    end
+  end
+end

data/spec/lib/time_keeper/time_range_collection_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe TimeKeeper::TimeRangeCollection do
+  subject do
+    TimeKeeper::TimeRangeCollection.new("06:00 pm - 03:00 am\n07:00 - 17:00")
+  end
+
+  describe "#initialize" do
+    it "should set the time_ranges_str variable" do
+      TimeKeeper::TimeRangeCollection.new("06:00 pm - 03:00 am\n07:00 - 17:00").instance_variable_get('@time_ranges_str').should eq("06:00 pm-03:00 am\n07:00-17:00")
+    end
+  end
+
+  describe "#parse" do
+    it "should match return proper range sets count" do
+      subject.parse
+      subject.instance_variable_get("@time_ranges").count.should eq(2)
+    end
+
+    it "should set the time ranges properly" do
+      subject.parse
+      subject.time_ranges.first.start_time.in_minutes.should eq(1080)
+      subject.time_ranges.first.end_time.in_minutes.should eq(180)
+      subject.time_ranges.first.start_day.should eq(0)
+      subject.time_ranges.first.end_day.should eq(1)
+      subject.time_ranges.last.start_time.in_minutes.should eq(420)
+      subject.time_ranges.last.end_time.in_minutes.should eq(1020)
+      subject.time_ranges.last.start_day.should eq(1)
+      subject.time_ranges.last.end_day.should eq(1)
+    end
+
+    it "should return the time ranges collection object" do
+      subject.parse.should eq(subject)
+    end
+  end
+end