time_clock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16d6a4d558f242cca80a3c248bcb66a3a47ab024
+  data.tar.gz: 5c71d2e18dc9b22873b464eb823f4207a1053ea9
+SHA512:
+  metadata.gz: 14622660e5e94c0fe9dd90c3384ef646c8fdea527ea848259691bc7e0d4a2e4c64af0a0920feaa28ae0794288c5eff58daab6c262ae3e88af144977e4bd96759
+  data.tar.gz: cf7839ecd504452949a56e8310d262982f6fd4a63a6407fd1ba5d3b5d648a8dfe754de1f0641a86dc7fb11d5ccef80049894d13d0204fdf66c83c2007f514456

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in time_clock.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 barelyknown
+
+MIT License
+
+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.md

@@ -0,0 +1,60 @@
+# TimeClock
+
+    gem 'time_clock'
+
+Calculate the amount of business time between two times based on any arbitrary work calendar.
+
+    Time.now.business_seconds_until(Time.now + 1.day)
+    => 43200
+    Time.now.business_minutes_until(Time.now + 1.day)
+    => 720
+    Time.now.business_hours_until(Time.now + 1.day)
+    => 12
+
+Things you may like about this library:
+
+- No dependencies.
+- Extremely simple codebase. Only 80 lines of code.
+- Works with any kind of `Time`, including mixed types.
+- Easy to customize with totally custom business calendars.
+
+## Configuration
+
+Set a `default_calendar` for all comparisons to use for their calculation.
+
+For example, in a Rails initializer:
+
+    # Time zones aren't required. Used here to make it easier to read.
+    time_zone = ActiveSupport::TimeZone.new("America/Chicago")
+
+    # The TimeClock::Calendar object stores the shifts for the business calendar.
+    calendar = TimeClock::Calendar.new
+
+    # Add all the work days (or individual shifts) to the calendar
+    # This example adds non week days between 6am and 6pm.
+    (Date.new(2011,1,1)..Date.new(2015,1,1)).each do |date|
+      next unless (1..5).cover?(date.wday)
+      calendar.add_shift(
+        TimeClock::Shift.new(
+          time_zone.local(date.year,date.month,date.day,6),
+          time_zone.local(date.year,date.month,date.day,18),
+        )
+      )
+    end
+
+    # Set the default calendar
+    TimeClock.default_calendar = calendar
+
+## Calendars
+
+If you want to use a separate calendar for an individual calculation, use a `TimeClock::Comparison` instance. Refer back to the configuration example to understand how to build a calendar.
+
+    TimeClock::Comparison.new(Time.now, Time.now + 1.day, custom_calendar).seconds
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/time_clock/calendar.rb

@@ -0,0 +1,22 @@
+module TimeClock
+  class Calendar
+    class OverlappingShiftError < ArgumentError; end
+
+    attr_reader :shifts
+
+    def initialize
+      @shifts = []
+    end
+
+    def add_shift(new_shift)
+      starting_shift_count = @shifts.size
+      @shifts.each_with_index do |shift, i|
+        raise OverlappingShiftError if new_shift.overlaps?(shift)
+        break @shifts.insert(i, new_shift) if shift.start_time > new_shift.end_time
+      end
+      @shifts << new_shift unless @shifts.size > starting_shift_count
+      @shifts
+    end
+
+  end
+end

data/lib/time_clock/comparison.rb

@@ -0,0 +1,21 @@
+module TimeClock
+  class Comparison
+
+    attr_reader :start_time, :end_time, :calendar
+
+    def initialize(start_time, end_time, calendar=TimeClock.default_calendar)
+      @start_time, @end_time, @calendar = start_time, end_time, calendar
+    end
+
+    def period
+      @period ||= Shift.new(start_time, end_time)
+    end
+
+    def seconds
+      calendar.shifts.inject(0) do |total_seconds, shift|
+        total_seconds + period.overlapping_seconds(shift)
+      end
+    end
+
+  end
+end

data/lib/time_clock/core_ext/time.rb

@@ -0,0 +1,15 @@
+class Time
+
+  def business_seconds_until(time)
+    TimeClock::Comparison.new(self, time).seconds.to_i
+  end
+
+  def business_minutes_until(time)
+    (business_seconds_until(time).to_f / 60).ceil
+  end
+
+  def business_hours_until(time)
+    (business_seconds_until(time).to_f / 3600).ceil
+  end
+
+end

data/lib/time_clock/shift.rb

@@ -0,0 +1,25 @@
+module TimeClock
+  class Shift
+    class EndTimeAfterStartTimeError < ArgumentError; end
+
+    attr_reader :start_time, :end_time
+
+    def initialize(start_time, end_time)
+      raise EndTimeAfterStartTimeError unless end_time > start_time
+      @start_time, @end_time = start_time, end_time
+    end
+
+    def overlaps?(shift)
+      start_time <= shift.end_time && end_time >= shift.start_time
+    end
+
+    def overlapping_seconds(shift)
+      [[end_time,shift.end_time].min - [start_time,shift.start_time].max,0].max
+    end
+
+    def ==(value)
+      start_time == value.start_time && end_time == value.end_time
+    end
+
+  end
+end

data/lib/time_clock/version.rb

@@ -0,0 +1,3 @@
+module TimeClock
+  VERSION = "0.0.1"
+end

data/lib/time_clock.rb

@@ -0,0 +1,19 @@
+require "time_clock/version"
+
+require "time_clock/core_ext/time"
+
+require "time_clock/shift"
+require "time_clock/calendar"
+require "time_clock/comparison"
+
+module TimeClock
+
+  def self.default_calendar=(value)
+    @default_calendar = value
+  end
+
+  def self.default_calendar
+    @default_calendar
+  end
+
+end

data/spec/lib/time_clock/calendar_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module TimeClock
+  describe Calendar do
+
+    let(:base_shift) { Shift.new(Time.new(2013,8,19,6,0),Time.new(2013,8,19,18,0)) }
+
+    it "should have an array of shifts" do
+      expect(subject.shifts).to be_a_kind_of Array
+    end
+
+    context "with an empty array of shifts" do
+      it "should add a shift to the array" do
+        subject.add_shift(base_shift)
+        expect(subject.shifts).to include base_shift
+      end
+    end
+
+    context "after the base shift is added" do
+      before do
+        subject.add_shift(base_shift)
+      end
+
+      context "when adding a shift that should come before" do
+        let(:new_shift) { Shift.new(Time.new(2013,8,18,6,0),Time.new(2013,8,18,18)) }
+        it "adds it to the beginning" do
+          subject.add_shift(new_shift)
+          expect(subject.shifts.first).to eq new_shift
+        end
+      end
+
+      context "when adding a shift that should come after" do
+        let(:new_shift) { Shift.new(Time.new(2013,8,20,6,0),Time.new(2013,8,20,18,0))}
+        it "adds it to the end" do
+          subject.add_shift(new_shift)
+          expect(subject.shifts.last).to eq new_shift
+        end
+      end
+
+      context "when adding a shift that overlaps" do
+        let(:new_shift) { Shift.new(Time.new(2013,8,19,8),Time.new(2013,8,19,15)) }
+        it "should raise an error" do
+          expect{subject.add_shift(new_shift)}.to raise_error Calendar::OverlappingShiftError
+        end
+      end
+      
+    end
+
+  end
+end

data/spec/lib/time_clock/comparison_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module TimeClock
+  describe Comparison do
+
+    let(:start_time) { Time.now }
+    let(:end_time) { Time.now + 3600 }
+    let(:calendar) { Calendar.new }
+
+    subject do
+      described_class.new(start_time, end_time, calendar)
+    end
+
+    it "should set the start time" do
+      expect(subject.start_time).to eq start_time
+    end
+
+    it "should set the end time" do
+      expect(subject.end_time).to eq end_time
+    end
+
+    it "should set the calendar" do
+      expect(subject.calendar).to eq calendar
+    end
+
+    it "should create a period" do
+      expect(subject.period).to eq Shift.new(start_time, end_time)
+    end
+
+    context "when calculating seconds between" do
+      let(:calendar) do
+        Calendar.new.tap do |c|
+          c.add_shift(Shift.new(Time.new(2013,8,19,6),Time.new(2013,8,19,18)))
+          c.add_shift(Shift.new(Time.new(2013,8,20,6),Time.new(2013,8,20,18)))
+          c.add_shift(Shift.new(Time.new(2013,8,21,6),Time.new(2013,8,21,18)))
+          c.add_shift(Shift.new(Time.new(2013,8,23,6),Time.new(2013,8,23,18)))
+        end
+      end
+      context "when the times are within one shift" do
+        let(:start_time) { Time.new(2013,8,20,10) }
+        let(:end_time) { Time.new(2013,8,20,14) }
+        subject do
+          described_class.new(start_time, end_time, calendar)
+        end
+        it "should calculate seconds between" do
+          expect(subject.seconds).to eq 60 * 60 * 4
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/time_clock/core_ext/time_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Time do
+  subject { Time.new(2013,8,13,14,15) }
+
+  it "should respond to #seconds_until" do
+    expect(subject).to respond_to :business_seconds_until
+  end
+
+end

data/spec/lib/time_clock/shift_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module TimeClock
+  describe Shift do
+
+    let(:start_time) { Time.new(2013,8,19,6,0) }
+    let(:end_time) { Time.new(2013,8,19,18,0) }
+
+    subject do
+      described_class.new(start_time, end_time)
+    end
+
+    it "should set the start time" do
+      expect(subject.start_time).to eq start_time
+    end
+
+    it "should set the end time" do
+      expect(subject.end_time).to eq end_time
+    end
+
+    it "should raise the right exception if the end time is before the start time" do
+      expect{described_class.new(end_time, start_time)}.to raise_error Shift::EndTimeAfterStartTimeError
+    end
+
+    it "should be eq if the times are equal" do
+      expect(subject).to eq subject.dup
+    end
+
+    context "when evaluating overlaps" do
+      let(:overlapping_shift) { Shift.new(Time.new(2013,8,19,5), Time.new(2013,8,19,10)) }
+      let(:non_overlapping_shift) { Shift.new(Time.new(2013,8,18,5), Time.new(2013,8,18,10)) }
+      it "should know when it does" do
+        expect(overlapping_shift.overlaps?(subject)).to be_true
+      end
+      it "should know when it doesn't" do
+        expect(non_overlapping_shift.overlaps?(subject)).to_not be_true
+      end
+      it "should calculate the overlapping seconds when there is an overlap" do
+        expect(overlapping_shift.overlapping_seconds(subject)).to eq 4 * 60 * 60
+      end
+      it "should calculate the overlapping seconds when there isn't an overlap" do
+        expect(non_overlapping_shift.overlapping_seconds(subject)).to eq 0
+      end
+    end
+
+
+  end
+end

data/spec/lib/time_clock_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe TimeClock do
+  let(:default_calendar) { TimeClock::Calendar.new }
+  it "should set a default calendar" do
+    described_class.default_calendar = default_calendar
+    expect(described_class.default_calendar).to eq default_calendar
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'time_clock'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/time_clock.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_clock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_clock"
+  spec.version       = TimeClock::VERSION
+  spec.authors       = ["barelyknown"]
+  spec.email         = ["sean@buytruckload.com"]
+  spec.description   = %q{Calculate the business time for a period of time.}
+  spec.summary       = %q{Calculate the business time for a period of time.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "metric_fu"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: time_clock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- barelyknown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: metric_fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculate the business time for a period of time.
+email:
+- sean@buytruckload.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/time_clock.rb
+- lib/time_clock/calendar.rb
+- lib/time_clock/comparison.rb
+- lib/time_clock/core_ext/time.rb
+- lib/time_clock/shift.rb
+- lib/time_clock/version.rb
+- spec/lib/time_clock/calendar_spec.rb
+- spec/lib/time_clock/comparison_spec.rb
+- spec/lib/time_clock/core_ext/time_spec.rb
+- spec/lib/time_clock/shift_spec.rb
+- spec/lib/time_clock_spec.rb
+- spec/spec_helper.rb
+- time_clock.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Calculate the business time for a period of time.
+test_files:
+- spec/lib/time_clock/calendar_spec.rb
+- spec/lib/time_clock/comparison_spec.rb
+- spec/lib/time_clock/core_ext/time_spec.rb
+- spec/lib/time_clock/shift_spec.rb
+- spec/lib/time_clock_spec.rb
+- spec/spec_helper.rb