time_keeper 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "activemodel", ">= 3.0.0", "< 3.1.0"
+gem "activesupport", ">=3.0.0", "< 3.1.0"
+
+group :development do
+  gem "rspec", "~> 2.0.0"
+  gem "mocha"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.11)
+    builder (2.1.2)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.11)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (>= 3.0.0, < 3.1.0)
+  activesupport (>= 3.0.0, < 3.1.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mocha
+  rcov
+  rspec (~> 2.0.0)
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Suman Mukherjee
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= time_keeper
+
+Description goes here.
+
+== Contributing to time_keeper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Suman Mukherjee. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "time_keeper"
+  gem.homepage = "http://github.com/sumanmukherjee03/time_keeper"
+  gem.license = "MIT"
+  gem.summary = %Q{Define time without dates as strings, perform operations on time spans and collection of time spans.}
+  gem.description = %Q{A simple gem to pass time in string format without dates and perform various useful operations on it. This has been derived from an app.}
+  gem.email = "sumanmukherjee03@gmail.com"
+  gem.authors = ["Suman Mukherjee"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "time_keeper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/time_keeper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'active_model'
+module TimeKeeper
+end
+Dir["#{File.dirname(__FILE__)}/time_keeper/**/*.rb"].each do |name|
+  require name
+end

data/lib/time_keeper/custom_time.rb

@@ -0,0 +1,39 @@
+class TimeKeeper::CustomTime
+  attr_accessor :time_in_str
+
+  TIME_FORMAT_REGEX = /^((\d){1}|(\d){2})((:(\d){2}){1})?([ ])*(am|pm)?$/i
+
+  include ActiveModel::Validations
+
+  validates :time_in_str, :presence => true, :format => {:with => TimeKeeper::CustomTime::TIME_FORMAT_REGEX}
+
+  def initialize(time_in_str)
+    @time_in_str = time_in_str.downcase.strip
+  end
+
+  def parse
+    @parsed_time = TimeKeeper::Parser::Base.build(@time_in_str).parse
+    self
+  end
+
+  def in_seconds
+    raise "Please parse the time before extracting in seconds" unless @parsed_time
+    @parsed_time.hour * 3600 + @parsed_time.min * 60
+  end
+
+  def in_minutes
+    raise "Please parse the time before extracting in minutes" unless @parsed_time
+    @parsed_time.hour * 60 + @parsed_time.min
+  end
+
+  def in_hours
+    raise "Please parse the time before extracting in hours" unless @parsed_time
+    @parsed_time.hour + ((@parsed_time.min.to_f / 60) * 100).round.to_f/100
+  end
+
+  def to_s
+    h = (self.in_minutes.to_i / 60)
+    m = (self.in_minutes.to_i % 60)
+    "%.2d:%.2d" % [h,m]
+  end
+end

data/lib/time_keeper/parser.rb

@@ -0,0 +1,7 @@
+module TimeKeeper
+  module Parser
+  end
+end
+Dir["#{File.dirname(__FILE__)}/time_keeper/**/*.rb"].each do |name|
+  require name
+end

data/lib/time_keeper/parser/base.rb

@@ -0,0 +1,50 @@
+module TimeKeeper
+  module Parser
+    class Base
+      attr_accessor :time_str, :hour, :min
+
+      TIME_FORMAT_REGEX = /^((\d){1}|(\d){2})((:(\d){2}){1})?([ ])*(am|pm)?$/i
+
+      include ActiveModel::Validations
+
+      validates :time_str, :presence => true, :format => {:with => TimeKeeper::Parser::Base::TIME_FORMAT_REGEX}
+
+      validate :time_is_valid
+
+      def initialize(time_str)
+        @time_str = time_str
+        raise "#{time_str} is not a valid time" unless self.valid?
+      end
+
+      def self.build(time_in_str)
+        if self.meridian_format?(time_in_str)
+          TimeKeeper::Parser::Meridian.new(time_in_str)
+        else
+          TimeKeeper::Parser::Military.new(time_in_str)
+        end
+      end
+
+      def parse
+        raise NotImplementedError
+      end
+
+      def self.meridian_format?(time_in_str)
+        time_in_str.downcase =~ /(am|pm)/
+      end
+
+      private
+
+      def time_is_valid
+        raise NotImplementedError
+      end
+
+      def extract_hour
+        raise NotImplementedError
+      end
+
+      def extract_min(min_of_day)
+        @min = min_of_day.blank? ? 0 : min_of_day[1..-1].strip.to_i
+      end
+    end
+  end
+end

data/lib/time_keeper/parser/meridian.rb

@@ -0,0 +1,40 @@
+module TimeKeeper
+  module Parser
+    class Meridian < Base
+      TIME_FORMAT_REGEX = /^((\d){1}|(\d){2})((:(\d){2}){1})?([ ])*(am|pm)$/i
+
+      validates :time_str, :presence => true, :format => {:with => TimeKeeper::Parser::Meridian::TIME_FORMAT_REGEX}
+
+      def parse
+        matched_data = @time_str.match(TimeKeeper::Parser::Meridian::TIME_FORMAT_REGEX)
+        extract_hour(matched_data[1], matched_data[8])
+        extract_min(matched_data[4])
+        self
+      end
+
+      private
+
+      def time_is_valid
+        matched_data = @time_str.match(TimeKeeper::Parser::Meridian::TIME_FORMAT_REGEX)
+        valid = ((1..12) === matched_data[1].to_i && (0...60) === matched_data[4].gsub(':', '').to_i)
+        self.errors.add(:base, "Either hour or min is not valid") unless valid
+        valid
+      end
+
+      def extract_hour(hour_of_day, meridian_status)
+        hour_of_day = hour_of_day.strip.to_i
+        @hour = 0
+        if hour_of_day == 12 && meridian_status == "am"
+          @hour = 0
+        elsif hour_of_day == 12 && meridian_status == "pm"
+          @hour = 12
+        elsif hour_of_day > 0 && hour_of_day <= 12 && meridian_status == "am"
+          @hour = hour_of_day
+        elsif hour_of_day > 0 && hour_of_day <= 12 && meridian_status == "pm"
+          @hour = hour_of_day + 12
+        end
+        @hour
+      end
+    end
+  end
+end

data/lib/time_keeper/parser/military.rb

@@ -0,0 +1,29 @@
+module TimeKeeper
+  module Parser
+    class Military < Base
+      TIME_FORMAT_REGEX = /^((\d){1}|(\d){2})((:(\d){2}){1})?$/
+
+      validates :time_str, :presence => true, :format => {:with => TimeKeeper::Parser::Military::TIME_FORMAT_REGEX}
+
+      def parse
+        matched_data = @time_str.match(TimeKeeper::Parser::Military::TIME_FORMAT_REGEX)
+        extract_hour(matched_data[1])
+        extract_min(matched_data[4])
+        self
+      end
+
+      private
+
+      def time_is_valid
+        matched_data = @time_str.match(TimeKeeper::Parser::Military::TIME_FORMAT_REGEX)
+        valid = ((0...24) === matched_data[1].to_i && (0...60) === matched_data[4].gsub(':', '').to_i)
+        self.errors.add(:base, "Either hour or min is not valid") unless valid
+        valid
+      end
+
+      def extract_hour(hour_of_day)
+        @hour = (hour_of_day.strip.to_i || 0)
+      end
+    end
+  end
+end

data/lib/time_keeper/string_minutes_support.rb

@@ -0,0 +1,19 @@
+module TimeKeeper
+  module StringMinutesSupport
+    def to_s_helper(minutes)
+      return nil if minutes.nil?
+      h = minutes.to_i / 60
+      m = minutes.to_i % 60
+      "%.2d:%.2d" % [h,m]
+    end
+
+    def to_i_helper(time)
+      return nil if time.blank?
+      time = time.to_s
+      h,m = time.split(":")
+      m ||= "0"
+      raise ArgumentError, "#{time.inspect} is invalid" unless h =~ /^\d+$/ && m =~ /^\d+$/
+      (h.to_i*60) + m.to_i
+    end
+  end
+end

data/lib/time_keeper/time_range.rb

@@ -0,0 +1,39 @@
+class TimeKeeper::TimeRange
+  TIME_FORMAT_REGEX = /^([0-9]){1,2}(:[0-9]{2})?([ ])*(am|pm)?([ ])*(to|-)([ ])*([0-9]){1,2}(:[0-9]{2})?([ ])*(am|pm)?$/i
+
+  attr_accessor :range, :start_time, :end_time, :start_day, :end_day
+
+  include ActiveModel::Validations
+
+  validates :range, :presence => true, :format => {:with => TimeKeeper::TimeRange::TIME_FORMAT_REGEX}
+
+  def initialize(range)
+    @range = range.strip.downcase.gsub(/\s*(-|to)\s*/, '-')
+  end
+
+  def parse
+    raise "The range data (#{range.inspect}) you have provided is invalid" unless self.valid?
+    parsed_range = @range.gsub('to', '-').split('-').map(&:strip)
+    @start_time = TimeKeeper::CustomTime.new(parsed_range.first).parse
+    @end_time = TimeKeeper::CustomTime.new(parsed_range.last).parse
+    @start_day = 0
+    @end_day = days_elapsed
+    self
+  end
+
+  def days_elapsed
+    @start_time.in_seconds > @end_time.in_seconds ? 1 : 0
+  end
+
+  def duration_in_seconds
+    (days_elapsed * 24 * 60 * 60) + (@end_time.in_seconds - @start_time.in_seconds)
+  end
+
+  def duration_in_minutes
+    ((duration_in_seconds.to_f/60)*100).round.to_f/100
+  end
+
+  def duration_in_hours
+    ((duration_in_seconds.to_f/3600)*100).round.to_f/100
+  end
+end

data/lib/time_keeper/time_range_collection.rb

@@ -0,0 +1,29 @@
+class TimeKeeper::TimeRangeCollection
+  TIME_FORMAT_REGEX = /^(\s*(to|-)\s*)+$/
+
+  attr_accessor :time_ranges_str, :time_ranges
+
+  include ActiveModel::Validations
+
+  validates :time_ranges_str, :presence => true, :format => {:with => TimeKeeper::TimeRangeCollection::TIME_FORMAT_REGEX}
+
+  def initialize(time_ranges_str)
+    @time_ranges_str = time_ranges_str.strip.gsub(/\s*(-|to)\s*/, "-")
+  end
+
+  def parse
+    spans = @time_ranges_str.split(/\s*\n\s*/).map(&:strip)
+    previous_time_range = nil
+    @time_ranges = spans.inject([]) do |result, span|
+      time_range = TimeKeeper::TimeRange.new(span.strip).parse
+      if previous_time_range
+        time_range.start_day = (time_range.start_time.in_seconds < previous_time_range.end_time.in_seconds ? previous_time_range.end_day + 1 : previous_time_range.end_day)
+        time_range.end_day = time_range.start_day + time_range.days_elapsed
+      end
+      result << time_range
+      previous_time_range = time_range
+      result
+    end
+    self
+  end
+end