spok 2.0.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d490966e3e874d1bd9d6b7f58d0624b4d289fee8f682602c7f0b83efa2fed975
-  data.tar.gz: c7bf5a468befc59655b8dfb2fe9545cf4a28b399e2562e8928fe2d79a8cce535
+  metadata.gz: bad6a856cfcef094c9d9791cc1ae7e0e3431ef676d14c9f38cf0e1e055a3f077
+  data.tar.gz: c480cec8388c406da6752bffc197f0ede4cce333142b2370304f9d149e95b1eb
 SHA512:
-  metadata.gz: a2047afcb781e7c6c53ef76389f4beb99cb14d98becab02589432d2f9e8f2313f7b1bc5f1694a87fe337f35f29c6c1579448fab0c144a50871e2eb19e12ccda1
-  data.tar.gz: cf914c3b6ff784d12939a373e8b43dac7dc6c2291cf44d1c8473cb9ae8684fdd20c6e1540261a339623f20868dc4b95ddba463df745744e260aac0e72de700f3
+  metadata.gz: b4508d77222fa85698bcfdf7878ab7cf52faf6e71caaaa5493841bf89555394ff75e9939a8735178f5d193595f5f79547e66283ace77697a1770355ae05350ca
+  data.tar.gz: 8f3e6839a98f3b0541275fa1a13c35257acffb5b4ab964ddeb30b3cb1d1bb1437c860a214d42e397c7ef8c5787a1ed9b957854a8235da2a0f2ac37f3adde1b48

data/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.3] - 2020-11-17
+
+* Remove 2020-11-20 holiday from Bovespa calendar due to their note about
+the day.
+Check it here: http://www.b3.com.br/pt_br/noticias/funcionamento-da-b3-8AE490C97215B74E0172959F18F11323.htm
+
+## [2.1.2] - 2020-04-29
+
+* Add 2020's Good Friday holiday on US calendar
+
+## [2.1.1] - 2020-04-15
+
+* Remove deprecation warnings and create a note about it on README file.
+
+## [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
+
 ## [2.0.0] - 2019-10-07
 
 - Added calendars for `australia`, `austria`, `belgium`, `colombia`, `france`, `germany`,

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    spok (2.0.0)
-      activesupport (~> 5.1)
+    spok (2.1.3)
+      activesupport (>= 5.1, < 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.7.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       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.2)
+    rake (13.0.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -45,4 +47,4 @@ DEPENDENCIES
   spok!
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -25,22 +25,27 @@ 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:
+NOTE: All methods available on `Spok::Workday` now are available on `Spok` interface, `Spok::Workday` still works but we have plans to make `Spok:: Workday` a private resource, you should update your code to rely on `Spok` interface.
+
+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'
 
-Spok::Workday.workday?(Date.new(2012, 12, 24), calendar: :bovespa)
+Spok.workday?(Date.new(2012, 12, 24), calendar: :bovespa)
 # => false
 ```
 

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/config/bovespa.yml

@@ -383,7 +383,6 @@ bovespa:
 - 2020-09-07
 - 2020-10-12
 - 2020-11-02
-- 2020-11-20
 - 2020-12-24
 - 2020-12-25
 - 2020-12-31

data/lib/spok/config/united_states.yml

@@ -267,6 +267,7 @@ united_states:
 - 2020-01-01
 - 2020-01-20
 - 2020-02-17
+- 2020-04-10
 - 2020-05-25
 - 2020-07-03
 - 2020-09-07
@@ -277,6 +278,7 @@ united_states:
 - 2021-01-01
 - 2021-01-18
 - 2021-02-15
+- 2021-04-02
 - 2021-05-31
 - 2021-07-05
 - 2021-09-06
@@ -287,6 +289,7 @@ united_states:
 - 2021-12-31
 - 2022-01-17
 - 2022-02-21
+- 2022-04-15
 - 2022-05-30
 - 2022-07-04
 - 2022-09-05
@@ -297,6 +300,7 @@ united_states:
 - 2023-01-02
 - 2023-01-16
 - 2023-02-20
+- 2023-04-07
 - 2023-05-29
 - 2023-07-04
 - 2023-09-04
@@ -307,6 +311,7 @@ united_states:
 - 2024-01-01
 - 2024-01-15
 - 2024-02-19
+- 2024-03-29
 - 2024-05-27
 - 2024-07-04
 - 2024-09-02
@@ -317,6 +322,7 @@ united_states:
 - 2025-01-01
 - 2025-01-20
 - 2025-02-17
+- 2025-04-18
 - 2025-05-26
 - 2025-07-04
 - 2025-09-01
@@ -325,6 +331,7 @@ united_states:
 - 2025-11-27
 - 2025-12-25
 - 2026-01-01
+- 2026-04-03
 - 2026-01-19
 - 2026-02-16
 - 2026-05-25
@@ -451,4 +458,4 @@ united_states:
 - 2038-11-11
 - 2038-11-25
 - 2038-12-24
-- 2038-12-31
+- 2038-12-31

data/lib/spok/version.rb

@@ -1,3 +1,3 @@
 class Spok
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.3'.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.

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

data/spok.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'activesupport', '>= 5.1', '< 7.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: spok
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Magnetis Staff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +116,6 @@ files:
 - lib/spok/config/vietnam.yml
 - lib/spok/version.rb
 - lib/spok/workday.rb
-- pkg/spok-2.0.0.gem
 - spec/fixtures/custom-calendar.yml
 - spec/lib/spok/calendars_spec.rb
 - spec/lib/spok/workday_spec.rb
@@ -136,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A gem to work with periods of dates