workdays 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fe52d73f1f4eef2999c3151a731cd9773924800
+  data.tar.gz: 376caf3fe7df1c970d6eb935f244bde249b02b3c
+SHA512:
+  metadata.gz: 79a42621e594e248f764ad7646b368e76bcffc2c017830293c7543b3cc6bc5746bfd403bd33342dcb4b88885dde8ab4a48301acc91afceca452d21e260cf46ff
+  data.tar.gz: a6d8a0a83a64d60d7a10350532157541ff72d63511165ffc1ba89b01073b7e3f3b3d524911b3e7671bc5c8dfa7baab51f0375e4d42f042484c94d7b6b96d2aa3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Julien Roger
+
+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,61 @@
+# Workdays
+
+A hard-working collection of methods to make calculating working dates easier.
+
+This gem provides a number of convenience methods to simplify calculating dates while respecting non-working days. Uses the Holiday gem so that holiday schedules can be localized and customized.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "workdays"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workdays
+
+## Usage
+
+By default, Workdays will use `:ca` as the default locale.
+
+```ruby
+Date.new(2017, 2, 8)  .workday? # => true
+Date.new(2017, 12, 25).workday? # => false
+
+fri_before_family_day = Date.new(2016, 2, 12) # Fri, 12 Feb 2016
+family_day            = Date.new(2016, 2, 15) # Mon, 15 Feb 2016
+tues_after_family_day = Date.new(2016, 2, 16) # Tue, 16 Feb 2016
+
+family_day.workday?(:ca_on)                       # => false
+family_day.workday?(:ca_qc)                       # => true
+
+tues_after_family_day.last_workday(:ca_on)        # => Fri, 12 Feb 2016
+tues_after_family_day.last_workday(:ca_qc)        # => Mon, 15 Feb 2016
+tues_after_family_day.workdays_before(1, :ca_on)  # => Fri, 12 Feb 2016
+tues_after_family_day.workdays_before(1, :ca_qc)  # => Mon, 15 Feb 2016
+tues_after_family_day.workdays_after(-1, :ca_qc)  # => Mon, 15 Feb 2016
+
+fri_before_family_day.workdays_after(1, :ca_on)   # => Tue, 16 Feb 2016
+fri_before_family_day.workdays_after(1, :ca_qc)   # => Mon, 15 Feb 2016
+
+
+Workdays.workdays_in(fri_before_family_day, family_day, :ca_on) # => 1
+Workdays.workdays_in(fri_before_family_day, family_day, :ca_qc) # => 2
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julienroger/workdays.
+
+
+## License
+
+[MIT](./LICENSE)
+
+Copyright (c) 2017 Julien Roger

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'console' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("workdays", "console")

data/bin/setup

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'setup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("workdays", "setup")

data/lib/workdays.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/time"
+require "holidays"
+
+require "workdays/version"
+require "workdays/time_extensions"
+require "workdays/core_ext/date"
+require "workdays/core_ext/time"
+require "workdays/core_ext/active_support/time_with_zone"
+
+module Workdays
+end

data/lib/workdays/core_ext/active_support/time_with_zone.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ActiveSupport::TimeWithZone
+  include Workdays::TimeExtensions
+end

data/lib/workdays/core_ext/date.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "holidays/core_extensions/date"
+
+class Date
+  include Holidays::CoreExtensions::Date
+  include Workdays::TimeExtensions
+end

data/lib/workdays/core_ext/time.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "holidays/core_extensions/time"
+
+class Time
+  include Holidays::CoreExtensions::Time
+  include Workdays::TimeExtensions
+end

data/lib/workdays/time_extensions.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# This module contains methods to help with dates
+module Workdays
+  DEFAULT_LOCALE = [:ca].freeze
+
+  module TimeExtensions
+    def workday?(locale = DEFAULT_LOCALE)
+      on_weekday? && !to_date.holiday?(locale, :observed)
+    end
+
+    def last_workday(locale = DEFAULT_LOCALE)
+      day = self - 1.day
+      day -= 1.day until day.workday?(locale)
+      day
+    end
+
+    def to_workday(locale = DEFAULT_LOCALE)
+      day = self
+      return day if day.workday?(locale)
+      day.last_workday(locale)
+    end
+
+    def workdays_after(delta = 0, locale = DEFAULT_LOCALE)
+      workdays_before(-delta, locale)
+    end
+
+    def workdays_before(delta = 0, locale = DEFAULT_LOCALE)
+      day  = self
+      days = delta.abs
+
+      while days.positive? || !day.workday?(locale)
+        days -= 1 if day.workday?(locale)
+        day  -= delta.positive? ? 1.day : -1.days
+      end
+
+      day
+    end
+  end
+
+  class << self
+    def workdays_in(start_time, end_time, locale = DEFAULT_LOCALE)
+      total_days = days_in(start_time, end_time)
+      weekends   = weekends_in(start_time, end_time)
+      holidays   = non_weekend_holidays_in(start_time, end_time, locale)
+
+      total_days - weekends - holidays
+    end
+
+    # Inclusive of start and end dates
+    def days_in(start_time, end_time)
+      (end_time.to_date - start_time.to_date).to_i + 1
+    end
+
+    private def weekends_in(start_time, end_time)
+      (start_time..end_time).map(&:on_weekend?).count(true)
+    end
+
+    private def non_weekend_holidays_in(start_time, end_time, locale = DEFAULT_LOCALE)
+      start_date  = start_time.to_date
+      end_date    = end_time.to_date
+
+      Holidays.between(start_date, end_date, locale, :observed).map do |holiday|
+        holiday[:date].on_weekday?
+      end.count(true)
+    end
+  end
+end

data/lib/workdays/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Workdays
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: workdays
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julien Roger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Provides a number of convenience methods to simplify calculating dates
+  while respecting non-working days. Uses the Holiday gem so that holiday schedules
+  can be localized and customized.
+email:
+- jroger@abletribe.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/workdays.rb
+- lib/workdays/core_ext/active_support/time_with_zone.rb
+- lib/workdays/core_ext/date.rb
+- lib/workdays/core_ext/time.rb
+- lib/workdays/time_extensions.rb
+- lib/workdays/version.rb
+homepage: https://github.com/julienroger/workdays
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A hard-working collection of methods to make calculating working dates easier.
+test_files: []