gb_work_day 0.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gb_work_day.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov', :require => false
+  gem 'activesupport', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Kacper Kawecki
+
+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,119 @@
+# GBWorkDay
+
+Library to make calculation on work days.
+Unlike others libraries like [`business_time`](https://github.com/bokmann/business_time), 
+[`working_hours`](https://github.com/Intrepidd/working_hours), [`biz`](https://github.com/zendesk/biz)
+it operates on whole days, not hours. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gb_work_day'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gb_work_day
+
+## Usage
+
+### Work week
+
+Set default work week for current thread
+
+```ruby
+beginning_of_week = 1 #Monday 
+work_days = 5 #wrokd days are Monday-Friday
+GBWorkDay::WorkWeek.current = GBWorkWeek.new(work_days, beginning_of_week)
+```
+
+or if you want to setup per instance
+
+```ruby
+beginning_of_week = 1 #Monday 
+work_days = 5 #wrokd days are Monday-Friday
+week = GBWorkWeek.new(work_days, beginning_of_week)
+my_date = Date.today.to_work_date(week)
+```
+
+or 
+
+```ruby
+beginning_of_week = 1 #Monday 
+work_days = 5 #wrokd days are Monday-Friday
+week = GBWorkWeek.new(work_days, beginning_of_week)
+my_date = my_date
+#some code here
+my_date.week = week
+```
+
+### Date and Time operation
+
+Check if today is a work day
+ 
+```ruby
+Date.today.work?
+```
+
+or
+
+```ruby
+Time.now.work?
+```
+
+Check if today is holiday
+
+```ruby
+Date.today.free?
+```
+
+or
+
+```ruby
+Time.now.free?
+```
+
+Get next working day
+
+```ruby
+Date.today.next_work_day
+```
+
+or
+
+```ruby
+Time.now.next_work_day
+```
+
+
+You can also make more complicated calculations
+
+```ruby
+delivery_date = Date.today + 10.work_days
+```
+
+or 
+
+```ruby
+amount_of_work = (start_date.to_work_date - end_date).work_days
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/GenieBelt/gb-works-day/fork )
+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 a new Pull Request
+
+## Alternatives
+
+* [`business_time`](https://github.com/bokmann/business_time)
+* [`working_hours`](https://github.com/Intrepidd/working_hours)
+* [`biz`](https://github.com/zendesk/biz)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/gb_work_day.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gb_work_day/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gb_work_day'
+  spec.version       = GBWorkDay::VERSION
+  spec.authors       = ['Kacper Kawecki']
+  spec.email         = ['kacper@geniebelt.com']
+  spec.summary       = %q{Library extending Time and Date to do calculations for work days}
+  spec.description   = %q{Library extending Time and Date to do calculations for work days. Unlike others libraries it operates on whole days, not hours.}
+  spec.homepage      = 'https://github.com/GenieBelt/gb-works-day'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'activesupport'
+end

data/lib/gb_work_day.rb

@@ -0,0 +1,12 @@
+require 'gb_work_day/version'
+require 'gb_work_day/core_ext'
+require 'gb_work_day/duration'
+require 'gb_work_day/interval'
+require 'gb_work_day/work_week'
+require 'gb_work_day/helpers/date'
+require 'gb_work_day/helpers/time'
+
+
+module GBWorkDay
+  # Your code goes here...
+end

data/lib/gb_work_day/core_ext.rb

@@ -0,0 +1,3 @@
+require 'gb_work_day/core_ext/integer'
+require 'gb_work_day/core_ext/date'
+require 'gb_work_day/core_ext/time'

data/lib/gb_work_day/core_ext/date.rb

@@ -0,0 +1,59 @@
+require 'gb_work_day/duration'
+require 'gb_work_day/helpers/date'
+class Date
+  def plus_with_work_duration(other)
+    if GBWorkDay::Duration === other
+      other.since(self)
+    else
+      plus_without_work_duration(other)
+    end
+  end
+  alias_method :plus_without_work_duration, :+
+  alias_method :+, :plus_with_work_duration
+
+  def minus_with_work_duration(other)
+    if GBWorkDay::Duration === other
+      plus_with_work_duration(- other)
+    elsif GBWorkDay::Date === other
+      other - self
+    else
+      minus_without_work_duration(other)
+    end
+  end
+  alias_method :minus_without_work_duration, :-
+  alias_method :-, :minus_with_work_duration
+
+  # Check if it is a work day.
+  # @return [boolean]
+  def work?
+    default_week.work_day? self
+  end
+
+  # Check if it is a work day.
+  # @return [boolean]
+  def free?
+    default_week.free_day? self
+  end
+
+  # Return next working day
+  # @return [Time]
+  def next_work_day
+    self + GBWorkDay::Duration.new(1, default_week)
+  end
+
+  # Get date object for calculating working days
+  #
+  # @param week [GBWorkDay::WorkWeek] if not set, it will use week set globally. For more check {GBWorkingDay::WorkWeek#current}
+  def work_date(week=nil)
+    GBWorkDay::Date.from_date self, week
+  end
+  alias_method :to_work, :work_date
+  alias_method :to_work_date, :work_date
+
+  private
+
+  # @return [GBWorkDay::WorkWeek]
+  def default_week
+    GBWorkDay::WorkWeek.current
+  end
+end

data/lib/gb_work_day/core_ext/integer.rb

@@ -0,0 +1,8 @@
+require 'gb_work_day/duration'
+class Integer
+  def work_days(week=nil)
+    GBWorkDay::Duration.new(self, week)
+  end
+
+  alias work_day work_days
+end

data/lib/gb_work_day/core_ext/time.rb

@@ -0,0 +1,60 @@
+require 'gb_work_day/duration'
+require 'gb_work_day/helpers/time'
+class Time
+  def plus_with_work_duration(other)
+    if GBWorkDay::Duration === other
+      other.since(self)
+    else
+      plus_without_work_duration(other)
+    end
+  end
+  alias_method :plus_without_work_duration, :+
+  alias_method :+, :plus_with_work_duration
+
+  def minus_with_work_duration(other)
+    if GBWorkDay::Duration === other
+      plus_with_work_duration(-other)
+    elsif GBWorkDay::Time === other
+      other - self
+    else
+      minus_without_work_duration(other)
+    end
+  end
+  alias_method :minus_without_work_duration, :-
+  alias_method :-, :minus_with_work_duration
+
+
+  # Check if it is a work day.
+  # @return [boolean]
+  def work?
+    default_week.work_day? self
+  end
+
+  # Check if it is a work day.
+  # @return [boolean]
+  def free?
+    default_week.free_day? self
+  end
+
+  # Return next working day
+  # @return [Time]
+  def next_work_day
+    self + GBWorkDay::Duration.new(1, default_week)
+  end
+
+  # Get time object for calculating working days
+  #
+  # @param week [GBWorkDay::WorkWeek] if not set, it will use week set globally. For more check {GBWorkingDay::WorkWeek#current}
+  def work_time(week=nil)
+    GBWorkDay::Time.from_time self, week
+  end
+  alias_method :to_work, :work_time
+  alias_method :to_work_time, :work_time
+
+  private
+
+  # @return [GBWorkDay::WorkWeek]
+  def default_week
+    GBWorkDay::WorkWeek.current
+  end
+end

data/lib/gb_work_day/duration.rb

@@ -0,0 +1,107 @@
+require 'gb_work_day/work_week'
+module GBWorkDay
+  class Duration
+    SEC_IN_DAY = 86400
+    include Comparable
+
+    attr_accessor :work_days, :week
+    def initialize(days, week=nil)
+      @work_days = days
+      @week = week || WorkWeek.current
+    end
+
+    def +(other) # :nodoc:
+      if Duration === other
+        Duration.new(work_days + other.work_days, week)
+      else
+        Duration.new(work_days + other, week)
+      end
+    end
+
+    def -(other) # :nodoc:
+      self + (-other)
+    end
+
+    def -@ # :nodoc:
+      Duration.new(-work_days, week)
+    end
+
+    def is_a?(klass) # :nodoc:
+      Duration == klass || work_days.is_a?(klass)
+    end
+    alias :kind_of? :is_a?
+
+    def instance_of?(klass) # :nodoc:
+      Duration == klass || work_days.instance_of?(klass)
+    end
+
+    def ==(other) # :nodoc:
+      if Duration === other
+        other.work_days == work_days && other.week == week
+      else
+        other == work_days
+      end
+    end
+
+    # Returns the amount of seconds a duration covers as a string.
+    # For more information check to_i method.
+    #
+    #   1.work_day.to_s # => "86400"
+    def to_s
+      to_i.to_s
+    end
+
+    # Returns the number of seconds that this Duration represents.
+    def to_i(format = :seconds)
+      if format == :days
+        work_days
+      else
+        work_days * SEC_IN_DAY
+      end
+    end
+
+
+    # Returns +true+ if +other+ is also a Duration instance, which has the
+    # same parts as this one.
+    def eql?(other)
+      Duration === other && other.work_days.eql?(work_days) && other.week.eql?(week)
+    end
+
+    def inspect #:nodoc:
+      "#{self.work_days} working days in a working week: #{week}"
+    end
+
+    # Calculates a new Time or Date that is as far in the future
+    # as this Duration represents.
+    def since(time = ::Time.current)
+      sum(1, time)
+    end
+    alias :from_now :since
+
+    # Calculates a new Time or Date that is as far in the past
+    # as this Duration represents.
+    def ago(time = ::Time.current)
+      sum(-1, time)
+    end
+    alias :until :ago
+
+    private
+
+    def sum(symbol, time)
+      work_days_left = self.work_days
+      if work_days_left < 0
+        symbol *= -1
+        work_days_left *= -1
+      end
+      while work_days_left > 0
+        if time.is_a? ::Date
+          time += symbol * 1
+        else
+          time += (symbol * SEC_IN_DAY)
+        end
+        work_days_left -= 1 if @week.work_day? time
+      end
+      time
+    end
+  end
+end