spok 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 153ba620fe617dfbf11f0bee61b1b44c778bc63a47ec1b36ccd049b93c9c108f
-  data.tar.gz: 66bc9d95d5661f9e51085df266a7be1a177ee1002037bc2e85667d3cc7598c29
+  metadata.gz: 8203f05d9317b3b0e4e0043d7ed4894f97d56d10d990df315ddfeb4dc9c458ef
+  data.tar.gz: 60d008280404cc98f1682df8ab7338e6c16ed7c50ec1529fe8211a166e098a6a
 SHA512:
-  metadata.gz: d2ce9269c7ac0e3a7957acbc6723aa843ddddb524f5917f21ef15afc66eb949a000b8a0662fdd42b7640531e2dff47cb07958765ec746e154f9f24a06a919343
-  data.tar.gz: 86f46c75c1f1a9ee1f98e6dbcdfc31902b028cfd828cde516506f9e7189ea8aaa4d2f1ca8c3a45031f509dd7bf17b098eb0f8ad2257c74273386debb7917e04a
+  metadata.gz: 1a71ef39e9b0092271ecd301968039700b0bf7600b873360cc33a445d2ff252fcebc3a50293ebcf988f4331a0d7f76ecdbba449ce3edab41fc6a8ae656cf0997
+  data.tar.gz: b398c9efc2c68a675e2773b586a0652b46f0037b6e0bcd9820bf47958c525fee9aee704b14fbca4b7e6226f3017d5d3199209a381574501aafca5e5205abcad1

data/CHANGELOG.md

@@ -3,7 +3,24 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [2.0.0] - 2019-10-24
+## [2.1.0] - 2020-04-13
+
+* Replace the access of `Spok::Workday` by `Spok` interface. 
+
+All methods before accessed by `Spok::Workday` module now is accessible by `Spok` interface.
+
+```ruby
+  Spok.restday?
+  Spok.workday?
+  Spok.weekend?
+  Spok.holiday?
+  Spok.last_workday
+  Spok.next_workday
+```
+
+You can still use the `Spok::Workday` interface but it will warn you about the deprecation. We are planning to drop the support of `Spok::Workday` by the end of 2020.
+
+## [2.0.1] - 2019-10-24
 
 * Relax `activesupport` dependency to include the `6.x` series
 

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    spok (2.0.0)
-      activesupport (~> 5.1)
+    spok (2.0.1)
+      activesupport (>= 5.1, < 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    minitest (5.12.2)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    minitest (5.14.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -45,4 +47,4 @@ DEPENDENCIES
   spok!
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -25,17 +25,20 @@ Or install it yourself as:
 
 ### Dealing with workdays
 
-You can use the `Spok::Workday` module to check if a date is either a restday or a workday:
+You can use the Spok to check if a date is either a rest day or a workday:
 
 ```ruby
 require 'spok'
 
-Spok::Workday.workday?(Date.new(2012, 12, 24))
+Spok.restday?(Date.new(2012, 12, 24))
+# => false
+
+Spok.workday?(Date.new(2012, 12, 24))
 # => true
 ```
 
 Spok also supports different calendars for checking if a date is a workday or a
-restday
+restday.
 
 ```ruby
 require 'spok'

data/lib/spok.rb

@@ -117,6 +117,96 @@ class Spok
     (@start_date..@end_date).to_a.delete_if{ |date| Workday.restday?(date, calendar: calendar) }
   end
 
+  # Public: Checks if a given day is a restday.
+  #
+  # date     - The Date to be checked.
+  # calendar - Symbol informing in which calendar the date will be checked
+  #            (default: :brazil).
+  #
+  # Examples
+  #
+  #   Spok.restday?(Date.new(2012, 8, 6))
+  #   # => false
+  #
+  # Returns a boolean.
+  def self.restday?(date, calendar: Spok.default_calendar)
+    Workday.restday?(date, calendar: calendar)
+  end
+
+  # Public: Checks if a given day is a workday.
+  #
+  # date     - The Date to be checked.
+  # calendar - Symbol informing in which calendar the date will be checked
+  #            (default: :brazil).
+  #
+  # Examples
+  #
+  #   Spok.workday?(Date.new(2012, 8, 6))
+  #   # => true
+  #
+  # Returns a boolean.
+  def self.workday?(date, calendar: Spok.default_calendar)
+    Workday.workday?(date, calendar: calendar)
+  end
+
+  # Public: Checks if a given Date is on a weekend.
+  #
+  # date - The Date to be checked.
+  #
+  # Examples
+  #
+  #   Spok.weekend?(Date.new(2012, 8, 6))
+  #   # => false
+  #
+  # Returns a boolean.
+  def self.weekend?(date)
+    Workday.weekend?(date)
+  end
+
+  # Public: Checks if a given Date is on a holiday.
+  #
+  # date     - The Date to be checked.
+  # calendar - Symbol informing in which calendar the date will be checked
+  #            (default: :brazil).
+  #
+  # Examples
+  #
+  #   Spok.holiday?(Date.new(2012, 5, 1))
+  #   # => true
+  #
+  # Returns a boolean.
+  def self.holiday?(date, calendar: Spok.default_calendar)
+    Workday.holiday?(date, calendar: calendar)
+  end
+
+  # Public: Returns the last workday until the informed date.
+  # It returns the informed date in case it is a workday.
+  #
+  # date     - End Date to check for workdays.
+  # calendar - Symbol informing in which calendar the date will be checked
+  #            (default: :brazil).
+  #
+  # Examples
+  #   Spok.last_workday(Date.new(2012, 10, 21))
+  #   # => #<Date: 2012-10-19 ((2456220j,0s,0n),+0s,2299161j)>
+  def self.last_workday(date, calendar: Spok.default_calendar)
+    Workday.last_workday(date, calendar: calendar)
+  end
+
+  # Public: Returns the next workday starting from the informed date.
+  # It returns the informed date in case it is a workday.
+  #
+  # date     - Start Date to check for workdays.
+  # calendar - Symbol informing in which calendar the date will be checked
+  #            (default: :brazil).
+  #
+  # Examples
+  #   Spok.next_workday(Date.new(2012, 10, 21))
+  #   # => #<Date: 2012-10-19 ((2456220j,0s,0n),+0s,2299161j)>
+  def self.next_workday(date, calendar: Spok.default_calendar)
+    Workday.next_workday(date, calendar: calendar)
+  end
+
   # Public: Returns a Spok containing the same dates in a different calendar.
   #
   # calendar - Symbol informing calendar for new Spok (default: :brazil).

data/lib/spok/version.rb

@@ -1,3 +1,3 @@
 class Spok
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/spok/workday.rb

@@ -1,12 +1,13 @@
 require 'active_support'
 require 'active_support/core_ext'
+require 'spok'
 
 class Spok
-  # Public: Various methods useful for checking for restdays and workdays.
+  # Internal: Various methods useful for checking for restdays and workdays.
   # All methods are module methods and should be called on the Spok::Workday
   # module.
   module Workday
-    # Public: Hash containing all weekdays.
+    # Internal: Hash containing all weekdays.
     WEEKDAYS = {
       sunday: 0,
       monday: 1,
@@ -17,7 +18,7 @@ class Spok
       saturday: 6
     }.freeze
 
-    # Public: Checks if a given day is a restday.
+    # Internal: Checks if a given day is a restday.
     #
     # date     - The Date to be checked.
     # calendar - Symbol informing in which calendar the date will be checked
@@ -33,7 +34,7 @@ class Spok
       self.weekend?(date) || self.holiday?(date, calendar: calendar)
     end
 
-    # Public: Checks if a given day is a workday.
+    # Internal: Checks if a given day is a workday.
     #
     # date     - The Date to be checked.
     # calendar - Symbol informing in which calendar the date will be checked
@@ -49,7 +50,7 @@ class Spok
       !restday?(date, calendar: calendar)
     end
 
-    # Public: Checks if a given Date is on a weekend.
+    # Internal: Checks if a given Date is on a weekend.
     #
     # date - The Date to be checked.
     #
@@ -65,7 +66,7 @@ class Spok
       [WEEKDAYS[:saturday], WEEKDAYS[:sunday]].include? weekday
     end
 
-    # Public: Checks if a given Date is on a holiday.
+    # Internal: Checks if a given Date is on a holiday.
     #
     # date     - The Date to be checked.
     # calendar - Symbol informing in which calendar the date will be checked
@@ -82,7 +83,7 @@ class Spok
       dates.include?(date.to_date)
     end
 
-    # Public: Returns the last workday until the informed date.
+    # Internal: Returns the last workday until the informed date.
     # It returns the informed date in case it is a workday.
     #
     # date     - End Date to check for workdays.
@@ -98,7 +99,7 @@ class Spok
       last_workday((date - 1.day), calendar: calendar)
     end
 
-    # Public: Returns the next workday starting from the informed date.
+    # Internal: Returns the next workday starting from the informed date.
     # It returns the informed date in case it is a workday.
     #
     # date     - Start Date to check for workdays.
@@ -113,5 +114,16 @@ class Spok
 
       next_workday((date + 1.day), calendar: calendar)
     end
+
+    class << self
+      extend Gem::Deprecate
+
+      deprecate :restday?, 'Spok.restday?', 2020, 12
+      deprecate :workday?, 'Spok.workday?', 2020, 12
+      deprecate :weekend?, 'Spok.weekend?', 2020, 12
+      deprecate :holiday?, 'Spok.holiday?', 2020, 12
+      deprecate :last_workday, 'Spok.last_workday', 2020, 12
+      deprecate :next_workday, 'Spok.next_workday', 2020, 12
+    end
   end
 end

data/spec/lib/spok_spec.rb

@@ -216,4 +216,64 @@ describe Spok do
       expect(default_calendar_was).to eq(:brazil)
     end
   end
+
+  describe '#restday?' do
+    it 'calls for the restday implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:restday?).with(date, calendar: :brazil).and_call_original
+
+      Spok.restday?(date)
+    end
+  end
+
+  describe '.workday?' do
+    it 'calls for the workday implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:workday?).with(date, calendar: :brazil).and_call_original
+
+      Spok.workday?(date)
+    end
+  end
+
+  describe '.weekend?' do
+    it 'calls for the weekend implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:weekend?).with(date).and_call_original
+
+      Spok.weekend?(date)
+    end
+  end
+
+  describe '.holiday?' do
+    it 'calls for the holiday implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:holiday?).with(date, calendar: :brazil).and_call_original
+
+      Spok.holiday?(date)
+    end
+  end
+
+  describe '.last_workday' do
+    it 'calls for the last workday implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:last_workday).with(date, calendar: :brazil).and_call_original
+
+      Spok.last_workday(date)
+    end
+  end
+
+  describe '.next_workday' do
+    it 'calls for the next workday implementation' do
+      date = Date.new(2020, 4, 9)
+
+      expect(Spok::Workday).to receive(:next_workday).with(date, calendar: :brazil).and_call_original
+
+      Spok.next_workday(date)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spok
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Magnetis Staff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,7 +116,7 @@ files:
 - lib/spok/config/vietnam.yml
 - lib/spok/version.rb
 - lib/spok/workday.rb
-- pkg/spok-2.0.0.gem
+- pkg/spok-2.1.0.gem
 - spec/fixtures/custom-calendar.yml
 - spec/lib/spok/calendars_spec.rb
 - spec/lib/spok/workday_spec.rb
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem to work with periods of dates