dateoperations 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f19df6a25abae9ad889b538a8433e6d9042e11e
-  data.tar.gz: 840efdbbcf12b5890d2784614c6d0d36c6db6d91
+  metadata.gz: cfd90d8293a749a6fd266508ca029f366a0b08e0
+  data.tar.gz: 74dcfa904f08b166e10dd3c1d294d83b6082ba2e
 SHA512:
-  metadata.gz: f60650e26a01faf2548077cd813bfb403d1b6de0d833e16d7c8a6844eb72e896192699ed98cf70ae994d523eb6d4ee12d8e640b5aeeca8b1eb3bfce219770bd9
-  data.tar.gz: 78f138ee77cdffb4a455c46999782cf042629b38a113e1111aec1919ddb2dfbb4fc88ba37c79e9d4861be63498650292e2213f12c3195dd4f33cdca230201738
+  metadata.gz: f9cb3fc95767df4055e7c7c942e3fb334bd171a5810f694d511a7006c4e6c5b487d8e15d6b78f596726ef6659db0ac273a4bc36c896b7107ad9c566e8188f6d9
+  data.tar.gz: 4eb2a8cb59bba7d0906fe79e36f02091e0b712ab03189b2cfa88ffd9bf4cb89bd4dffea27180f3be622835736cec5916eb071d2cfd87e42e77315a1bbd1b2314

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Michael Schwarze
+
+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

@@ -13,10 +13,19 @@ Download the gem, then install it:
 	require 'dateoperations'
 	...
 	DateOperations.country #=> :de
+	
 	DateOperations.holiday?(Date.new(2016, 10, 3)) #=> true
+	
 	DateOperations.country = :us #=> :us
 	DateOperations.holiday?(Date.new(2016, 10, 3)) # => false
+	
 	DateOperations.country = :de #=> :de
 	DateOperations.number_of_business_days_between(Date.new(2016, 10, 1), Date.new(2016, 10, -1)) #=> 20
+	
 	DateOperations.country = :au #=> :au
 	DateOperations.number_of_business_days_between(Date.new(2016, 10, 1), Date.new(2016, 10, -1)) #=> 21
+	
+	DateOperations.weekend?(DateOperations.weekend?(Date.new(2016, 6, 18)) #=> true
+
+## Documentation
+[Documentation](http://dateoperations.schwarze-web.de/DateOperations.html)

data/lib/dateoperations.rb

@@ -1,38 +1,57 @@
 require 'date'
 require 'holidays'
 
-# Class: DateOperations -- Different date operations, primarily around business days
+##
+# Different date operations, primarily around business days, based on the Holidays[https://github.com/holidays/holidays] Gem.
+# - Home[]https://github.com/msc01/dateoperations
+# - Documentation[http://dateoperations.schwarze-web.de/DateOperations.html]
 class DateOperations
   @country = :de
 
   class << self
+    # Switches to the calendar of the respective country:
+    # - :de = Germany
+    # - :us = USA
+    # - ...
     attr_accessor :country
   end
 
+  # Returns an array with dates for the "week days" (= Monday to Friday) between a given start and end date.
   def self.week_days_between(start_date, end_date)
     week_day_nbrs = (1..5)
     (start_date..end_date).select { |w| week_day_nbrs.include?(w.wday) }
   end
 
+  # returns the number of "week days" (= Monday to Friday) between a given start and end date.
   def self.number_of_week_days_between(start_date, end_date)
     week_days = week_days_between(start_date, end_date)
     week_days.length
   end
 
+  # Returns an array with dates
+  # for the "business days" = "week days" (= Monday to Friday)
+  # without <tt>holidays</tt>
+  # between a given start and end date.
   def self.business_days_between(start_date, end_date)
     week_days = week_days_between(start_date, end_date)
     week_days.reject { |b| holiday?(b) }
   end
 
+  # Returns the number of "business days"
+  # = "week days" (= Monday to Friday)
+  # without <tt>holidays</tt>
+  # between a given start and end date.
   def self.number_of_business_days_between(start_date, end_date)
     business_days = business_days_between(start_date, end_date)
     business_days.length
   end
 
+  # Checks whether a given date is a weekend (Saturday, Sunday).
   def self.weekend?(date)
     date.saturday? || date.sunday?
   end
 
+  # Checks whether a given date is a holiday based on the calendar for the respective <tt>country</tt>.
   def self.holiday?(date)
     return false if Holidays.on(date, DateOperations.country, :informal).empty?
     true

metadata

@@ -1,27 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: dateoperations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Schwarze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
-dependencies: []
-description: Different date operations, primarily around business days.
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+description: Simple date operations to determine weekends, holidays, and esp. business
+  days. Based on the Holidays Gem.
 email: michael@schwarze-web.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
-- Rakefile
 - lib/dateoperations.rb
-- test/dateoperations_test.rb
-- test/test_helper.rb
-homepage: http://rubygems.org/gems/dateoperations
+homepage: https://github.com/msc01/dateoperations
 licenses:
 - MIT
 metadata: {}

data/Rakefile

@@ -1,13 +0,0 @@
-require 'rake/testtask'
-require 'rubocop/rake_task'
-
-Rake::TestTask.new do |t|
-  t.pattern = 'test/*_test.rb'
-end
-
-RuboCop::RakeTask.new
-
-desc 'test'
-
-task default: :test
-task default: :rubocop

data/test/dateoperations_test.rb

@@ -1,46 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative 'test_helper'
-
-# Test class for Minitest Unit Tests for class DateOperations
-class DateOperationsTest < Minitest::Test
-  def test_december_2016_has_22_week_days
-    d1 = Date.new(2016, 12, 1)
-    d2 = Date.new(2016, 12, -1)
-    assert_equal 22, DateOperations.number_of_week_days_between(d1, d2)
-  end
-
-  def test_december_2016_has_21_business_days
-    d1 = Date.new(2016, 12, 1)
-    d2 = Date.new(2016, 12, -1)
-    assert_equal 21, DateOperations.number_of_business_days_between(d1, d2)
-  end
-
-  def test_24th_of_december_2016_is_a_holiday
-    assert DateOperations.holiday?(Date.new(2016, 12, 24))
-  end
-
-  def test_23th_of_december_2016_is_not_a_holiday
-    assert !DateOperations.holiday?(Date.new(2016, 12, 23))
-  end
-
-  def test_11th_of_june_2016_is_weekend
-    assert DateOperations.weekend?(Date.new(2016, 6, 11))
-  end
-
-  def test_10th_of_june_2016_is_not_weekend
-    assert !DateOperations.weekend?(Date.new(2016, 6, 10))
-  end
-
-  def test_june_2016_has_22_week_days
-    d1 = Date.new(2016, 6, 1)
-    d2 = Date.new(2016, 6, 30)
-    assert_equal 22, DateOperations.number_of_week_days_between(d1, d2)
-  end
-
-  def test_startdate_greater_enddate_returns_0_week_days
-    d1 = Date.new(2016, 6, 1)
-    d2 = Date.new(2016, 6, 30)
-    assert_equal 0, DateOperations.number_of_week_days_between(d2, d1)
-  end
-end

data/test/test_helper.rb

@@ -1,8 +0,0 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/test/'
-end
-
-require 'minitest/autorun'
-
-require_relative '../lib/dateoperations'