spok 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c3ccce2886f257f49bbb8ddd91d8758594cc799eefd975e34c563f958bed71
-  data.tar.gz: bfffef121638849c52dd3f25cb1712c1accc9bcf2288c2ad5077c3f9a2628045
+  metadata.gz: a19af02d276f5c0ac98d97658ebe07421f5fbacfd012fb74536af5b39547cc8f
+  data.tar.gz: 811ccc44e1dcf14ff6a8f7cb2fe1cf49b8a64d205c4c6a511a1f3a6054436713
 SHA512:
-  metadata.gz: f4c39525eb0c22b85cdd4906f34f290c802dc4a27afc9aaa0a6f61858c3f29a49baf007e6ede03e3eed0993a30cfa9e24e3295af437a7f570df26d822785b7fe
-  data.tar.gz: f39f10f38183cd427ddc579c09189daefdff7640cdd94e8796d5e2a9109fc2e7bbd2e66adf1762554a4e0fa03e148e779a555734d5fe3672fade587fa0e0a928
+  metadata.gz: 451e183abf5655749b8f6f6b317842e864484eec03a11b754682bcac96293c31e7b6c2f434b0feb297760fde31cd473269f5721b9d5dfce75c0310da421c1ef8
+  data.tar.gz: 9d558e1edbf7c05db5a5ff2f86f943af0983201b9a157977e67e9f9da0cd96064768cb64977dc3811ca47c89950d2a11de67ee35e91ca6971dccae8d19178870

data/CHANGELOG.md

@@ -3,5 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2018-10-02
+- Add calendars for Canada, Costa Rica, Indonesia, Mexico, Netherlands, Poland, Portugal, Spain and Vietnam.
+- Create configuration for defining a default calendar.
+
 ## [1.0.0] - 2018-09-14
 - First public release.

data/CONTRIBUTING.md

@@ -1,6 +1,27 @@
 ## Contributing to Spok
 
-Before contributing, please read our [Code of Conduct](https://github.com/magnetis/spok/blob/master/CODE_OF_CONDUCT.md) and [License](https://github.com/magnetis/spok/blob/master/LICENSE.txt).
+Thank you for your interest in contributing to Spok! We want to encourage you
+to contribute with documentation, bug reports, code and ideas.
+
+Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md) and [License](LICENSE.txt).
+
+### Table of Contents
+
+* [Documentation](#documentation)
+* [Did you find a bug?](#did-you-find-a-bug)
+* [Contributing with code](#contributing-with-code)
+* [Contributing with ideas](#contributing-with-ideas)
+* [Do you have questions about the source code?](#do-you-have-questions-about-the-source-code)
+
+
+#### **Documentation**
+
+The project uses the [RDoc tool](https://ruby.github.io/rdoc/) to generate documentation.
+Spok uses the [TomDoc](http://tomdoc.org/) style for writing docs. You can read
+the [existing docs](https://www.rubydoc.info/gems/spok/) for more information.
+
+Documentation is a very important portion of software. We want to always improve
+our communication using it.
 
 #### **Did you find a bug?**
 
@@ -8,6 +29,28 @@ Before contributing, please read our [Code of Conduct](https://github.com/magnet
 
 * If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/magnetis/spok/issues/new). Please, be sure to include a **title and clear description**, as much relevant information as possible.
 
+#### **Contributing with code**
+
+To contribute with code you should follow these steps:
+
+1. Fork the project;
+2. Clone your fork using the project URL (git or https);
+3. Create a new branch to implement your functionality or code. This can be done with the command: `git checkout -b your-branch-name-here`;
+4. Make your changes and add a new commit with a clear message saying why this change is being made;
+5. Make sure the tests are passing. To run the tests use the command: `rake spec`;
+5. Push your code with the command: `git push -u origin your-branch-name-here`;
+6. Go to your fork page at Github;
+7. Open a new Pull request.
+
+If you want ideas on what you can do, check the
+[open issues](https://github.com/magnetis/spok/issues).
+
+#### **Contributing with ideas**
+
+To contribute with ideas you can
+[open a new issue](https://github.com/magnetis/spok/issues/new). Please write a
+clear description of your suggestion, along with motivations and examples.
+
 #### **Do you have questions about the source code?**
 
 * You can contact us on dev@magnetis.com.br

data/README.md

@@ -1,6 +1,11 @@
 # Spok
 
-TODO: Write a gem description
+By [Magnetis](https://magnetis.com.br)
+
+[![Build Status](https://travis-ci.org/magnetis/spok.svg?branch=master)](https://travis-ci.org/magnetis/spok)
+
+Spok is a tool for dealing with workdays and restdays in an easy way.
+It also provides functionalities for working with periods of dates.
 
 ## Installation
 
@@ -18,7 +23,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Dealing with workdays
+
+You can use the `Spok::Workday` module to check if a date is either a restday or a workday:
+
+```ruby
+require 'spok'
+
+Spok::Workday.workday?(Date.new(2012, 12, 24))
+# => true
+```
+
+Spok also supports different calendars for checking if a date is a workday or a
+restday
+
+```ruby
+require 'spok'
+
+Spok::Workday.workday?(Date.new(2012, 12, 24), calendar: :bovespa)
+# => false
+```
+
+If `calendar` is not informed, it will default to the `:brasil` calendar.
+
+The available calendars are defined with `.yml` files [here](lib/spok/config/).
+
+### Working with periods of dates
+
+Objects from the `Spok` class can be used to work with periods of dates. You can
+initialize a new object passing the start and end date for your period to the
+`new` method:
+
+```ruby
+require 'spok'
+
+period = Spok.new(Date.new(2018, 9, 14), Date.new(2018, 10, 14))
+another_period = Spok.new(Date.today, Date.today + 10.days)
+```
+
+You can also use the `Spok.parse` method to initialize a new object using a string:
+
+```ruby
+require 'spok'
+
+parsed_period = Spok.parse('20180901-20180903')
+```
+
+With the object, you can check for all the workdays in that period of dates:
+
+```ruby
+require 'spok'
+
+period = Spok.new(Date.new(2018, 10, 10), Date.new(2018, 10, 14))
+period.workdays
+# => [Wed, 10 Oct 2018, Thu, 11 Oct 2018]
+```
+
+### Set default calendar
+```ruby
+Spok.default_calendar = :bovespa
+```
+
+## Documentation
+
+The complete documentation in the RDoc format is available here:
+
+https://www.rubydoc.info/gems/spok
 
 ## Contributing
 
@@ -26,5 +96,5 @@ Please read our [Contributing](CONTRIBUTING.md) guide for more information.
 
 ## License
 
-This project is licensed under the terms of the Apache 2. Copyright 2014-2017 Magnetis http://www.magnetis.com.br
+This project is licensed under the terms of the Apache 2. Copyright 2014-2018 Magnetis http://www.magnetis.com.br
 See the [LICENSE](LICENSE.txt) file for license rights and limitations (Apache 2).

data/lib/spok.rb

@@ -1,13 +1,18 @@
-require "spok/version"
+require 'spok/version'
 require 'spok/workday'
 
 # Public: Class responsible for dealing with periods of Dates, considering
 # workdays and restdays.
 class Spok
   # Internal: String specifying format for dates in the period.
-  DATE_FORMAT = '%Y%m%d'
+  DATE_FORMAT = '%Y%m%d'.freeze
+
   attr_reader :start_date, :end_date
 
+  mattr_reader :default_calendar
+
+  @@default_calendar = :brasil
+
   # Public: Parses a string into a Spok.
   #
   # dates_string - String containing the start and end dates for a period of
@@ -28,10 +33,10 @@ class Spok
     start_date, end_date = dates_string.split('-')
 
     if start_date && end_date
-      Spok.new(::Date.parse(start_date), ::Date.parse(end_date))
-    else
-      nil
+      return Spok.new(::Date.parse(start_date), ::Date.parse(end_date))
     end
+
+    nil
   end
 
   # Public: Initialize a Spok.
@@ -93,19 +98,19 @@ class Spok
   #
   #   spok.workdays
   #   # => [Mon, 02 Jan 2012, Tue, 03 Jan 2012]
-  def workdays(calendar = :brasil)
+  def workdays(calendar = Spok.default_calendar)
     (@start_date..@end_date).to_a.delete_if{ |date| Workday.restday?(date, calendar: calendar) }
   end
 
   # Public: Returns a Spok containing the same dates in a different calendar.
   #
-  # calendar - Symbol informing calendar for new Spok (default: :bovespa).
+  # calendar - Symbol informing calendar for new Spok (default: :brasil).
   #
   # Examples
   #
-  #   spok.to_calendar(:bovespa)
+  #   spok.to_calendar(:brasil)
   #   # => #<Spok:0x00007fbf122dba08 ...>
-  def to_calendar(calendar = :bovespa)
+  def to_calendar(calendar = Spok.default_calendar)
     Spok.new(
       Workday.last_workday(@start_date, calendar: calendar),
       Workday.last_workday(@end_date, calendar: calendar)
@@ -169,18 +174,18 @@ class Spok
   # equal when they are both instances of Spok, and have the same start and
   # end dates.
   #
-  # other_spok - Spok to be checked against.
+  # other - Spok to be checked against.
   #
   # Examples
   #
-  #   spok == other_spok
+  #   spok == other
   #   # => false
   #
   # Returns a boolean.
-  def ==(other_spok)
-    other_spok.class == self.class &&
-    other_spok.start_date == @start_date &&
-    other_spok.end_date == @end_date
+  def ==(other)
+    other.class == self.class &&
+      other.start_date == @start_date &&
+      other.end_date == @end_date
   end
 
   # Public: Returns a range containing the Dates in the Spok.
@@ -193,6 +198,12 @@ class Spok
     (@start_date..@end_date)
   end
 
+  class << self
+    def default_calendar=(calendar)
+      class_variable_set(:@@default_calendar, calendar)
+    end
+  end
+
   private
 
   def as_string(date)
@@ -204,10 +215,11 @@ class Spok
   end
 
   def validate!
-    raise ArgumentError.new("Start date must be present.") unless @start_date
-    raise ArgumentError.new("End date must be present.") unless @end_date
+    raise ArgumentError, 'Start date must be present.' unless @start_date
+    raise ArgumentError, 'End date must be present.' unless @end_date
+
     if @start_date > @end_date
-      raise ArgumentError.new("End date (#{@end_date}) must be greater or equal to start date (#{@start_date})")
+      raise ArgumentError, "End date (#{@end_date}) must be greater or equal to start date (#{@start_date})"
     end
   end
 end

data/lib/spok/config/canada.yml

@@ -0,0 +1,246 @@
+---
+canada:
+- 1993-01-01
+- 1993-04-09
+- 1993-05-24
+- 1993-07-01
+- 1993-09-06
+- 1993-10-11
+- 1993-11-11
+- 1993-12-24
+- 1993-12-25
+- 1994-01-01
+- 1994-01-03
+- 1994-04-01
+- 1994-05-23
+- 1994-07-01
+- 1994-10-10
+- 1994-11-11
+- 1994-12-25
+- 1994-12-26
+- 1995-01-01
+- 1995-01-02
+- 1995-04-14
+- 1995-05-22
+- 1995-07-01
+- 1995-09-04
+- 1995-10-09
+- 1995-11-11
+- 1995-12-25
+- 1996-01-01
+- 1996-04-05
+- 1996-05-20
+- 1996-07-01
+- 1996-09-02
+- 1996-10-14
+- 1996-11-11
+- 1996-12-25
+- 1997-01-01
+- 1997-03-28
+- 1997-05-19
+- 1997-07-01
+- 1997-09-01
+- 1997-10-13
+- 1997-11-11
+- 1997-12-25
+- 1998-01-01
+- 1998-04-10
+- 1998-05-18
+- 1998-07-01
+- 1998-09-07
+- 1998-10-12
+- 1998-11-11
+- 1998-12-25
+- 1999-01-01
+- 1999-04-02
+- 1999-05-24
+- 1999-07-01
+- 1999-09-06
+- 1999-10-11
+- 1999-11-11
+- 1999-12-24
+- 1999-12-25
+- 2000-01-01
+- 2000-03-03
+- 2000-04-21
+- 2000-05-22
+- 2000-07-01
+- 2000-09-04
+- 2000-10-09
+- 2000-11-11
+- 2000-12-25
+- 2001-01-01
+- 2001-04-13
+- 2001-05-21
+- 2001-07-01
+- 2001-07-02
+- 2001-09-03
+- 2001-10-08
+- 2001-11-11
+- 2001-11-12
+- 2001-12-25
+- 2002-01-01
+- 2002-03-29
+- 2002-05-20
+- 2002-07-01
+- 2002-09-02
+- 2002-10-14
+- 2002-11-11
+- 2002-12-25
+- 2003-01-01
+- 2003-04-18
+- 2003-05-19
+- 2003-07-01
+- 2003-09-01
+- 2003-10-13
+- 2003-11-11
+- 2003-12-25
+- 2004-01-01
+- 2004-04-09
+- 2004-05-24
+- 2004-07-01
+- 2004-10-11
+- 2004-11-11
+- 2004-12-24
+- 2004-12-25
+- 2005-01-01
+- 2005-01-03
+- 2005-03-25
+- 2005-05-23
+- 2005-07-01
+- 2005-09-05
+- 2005-10-10
+- 2005-11-11
+- 2005-12-25
+- 2006-01-01
+- 2006-01-02
+- 2006-04-14
+- 2006-05-22
+- 2006-07-01
+- 2006-09-04
+- 2006-10-09
+- 2006-11-11
+- 2006-12-12
+- 2007-01-01
+- 2007-04-06
+- 2007-05-21
+- 2007-07-01
+- 2007-07-02
+- 2007-09-03
+- 2007-10-08
+- 2007-11-11
+- 2007-11-12
+- 2007-12-25
+- 2008-01-01
+- 2008-03-21
+- 2008-05-19
+- 2008-07-01
+- 2008-09-01
+- 2008-10-13
+- 2008-11-11
+- 2008-12-25
+- 2009-01-01
+- 2009-04-10
+- 2009-05-18
+- 2009-07-01
+- 2009-09-07
+- 2009-10-12
+- 2009-11-11
+- 2009-12-25
+- 2010-01-01
+- 2010-04-02
+- 2010-05-24
+- 2010-07-01
+- 2010-09-06
+- 2010-10-11
+- 2010-11-11
+- 2010-12-24
+- 2010-12-25
+- 2011-01-01
+- 2011-01-03
+- 2011-04-22
+- 2011-05-23
+- 2011-07-01
+- 2011-09-05
+- 2011-10-10
+- 2011-11-11
+- 2011-12-25
+- 2011-12-26
+- 2012-01-01
+- 2012-01-02
+- 2012-04-06
+- 2012-05-21
+- 2012-07-01
+- 2012-07-02
+- 2012-09-03
+- 2012-10-08
+- 2012-11-11
+- 2012-11-12
+- 2012-12-25
+- 2013-01-01
+- 2013-03-29
+- 2013-05-20
+- 2013-07-01
+- 2013-09-02
+- 2013-10-14
+- 2013-11-11
+- 2013-12-25
+- 2014-01-01
+- 2014-04-18
+- 2014-05-19
+- 2014-07-01
+- 2014-09-01
+- 2014-10-13
+- 2014-11-11
+- 2014-12-25
+- 2015-01-01
+- 2015-04-03
+- 2015-05-18
+- 2015-07-01
+- 2015-09-07
+- 2015-10-12
+- 2015-11-11
+- 2015-12-25
+- 2016-01-01
+- 2016-03-25
+- 2016-05-23
+- 2016-07-01
+- 2016-09-05
+- 2016-10-10
+- 2016-11-11
+- 2016-12-25
+- 2016-12-26
+- 2017-01-01
+- 2017-01-02
+- 2017-04-14
+- 2017-05-22
+- 2017-07-01
+- 2017-09-04
+- 2017-10-09
+- 2017-11-11
+- 2017-12-25
+- 2018-01-01
+- 2018-03-30
+- 2018-05-21
+- 2018-07-01
+- 2018-07-02
+- 2018-03-09
+- 2018-10-08
+- 2018-11-11
+- 2018-11-12
+- 2018-12-25
+- 2019-01-01
+- 2019-04-19
+- 2019-05-20
+- 2019-07-01
+- 2019-09-02
+- 2019-10-14
+- 2019-11-11
+- 2019-12-25
+- 2020-01-01
+- 2020-04-10
+- 2020-05-18
+- 2020-07-01
+- 2020-10-12
+- 2020-11-11
+- 2020-12-25