spok 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81c3ccce2886f257f49bbb8ddd91d8758594cc799eefd975e34c563f958bed71
+  data.tar.gz: bfffef121638849c52dd3f25cb1712c1accc9bcf2288c2ad5077c3f9a2628045
+SHA512:
+  metadata.gz: f4c39525eb0c22b85cdd4906f34f290c802dc4a27afc9aaa0a6f61858c3f29a49baf007e6ede03e3eed0993a30cfa9e24e3295af437a7f570df26d822785b7fe
+  data.tar.gz: f39f10f38183cd427ddc579c09189daefdff7640cdd94e8796d5e2a9109fc2e7bbd2e66adf1762554a4e0fa03e148e779a555734d5fe3672fade587fa0e0a928

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0] - 2018-09-14
+- First public release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@magnetis.com.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+## 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).
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on [Issues](https://github.com/magnetis/spok/issues) page.
+
+* 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.
+
+#### **Do you have questions about the source code?**
+
+* You can contact us on dev@magnetis.com.br
+
+Thanks! :heart: :tada:
+
+Magnetis Team

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spok.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,203 @@
+Copyright 2014-2017 Magnetis http://www.magnetis.com.br
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,30 @@
+# Spok
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spok'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spok
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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
+See the [LICENSE](LICENSE.txt) file for license rights and limitations (Apache 2).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/spok.rb

@@ -0,0 +1,213 @@
+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'
+  attr_reader :start_date, :end_date
+
+  # Public: Parses a string into a Spok.
+  #
+  # dates_string - String containing the start and end dates for a period of
+  #                 days separated by a dash.
+  #
+  # Examples
+  #
+  #   Spok.parse('20120101-20120103')
+  #   # => #<Spok:0x00007f951e8a2ea0 ...>
+  #
+  #   Spok.parse('invalid string')
+  #   # => nil
+  #
+  # Returns a Spok or nil when the string does not contain two valid dates.
+  def self.parse(dates_string)
+    return nil unless dates_string
+
+    start_date, end_date = dates_string.split('-')
+
+    if start_date && end_date
+      Spok.new(::Date.parse(start_date), ::Date.parse(end_date))
+    else
+      nil
+    end
+  end
+
+  # Public: Initialize a Spok.
+  #
+  # start_date - Initial Date for the Spok.
+  # end_date - Final Date for Spok.
+  def initialize(start_date, end_date)
+    @start_date = start_date
+    @end_date = end_date
+    validate!
+  end
+
+  # Public: Returns the Spok start date as an Integer.
+  #
+  # Examples
+  #
+  #   spok.start_date_as_integer
+  #   # => 20120101
+  def start_date_as_integer
+    as_integer @start_date
+  end
+
+  # Public: Returns the Spok end date as an Integer.
+  #
+  # Examples
+  #
+  #   spok.end_date_as_integer
+  #   # => 20120103
+  def end_date_as_integer
+    as_integer @end_date
+  end
+
+  # Public: Returns the Spok start date as a String.
+  #
+  # Examples
+  #
+  #   spok.start_date_as_string
+  #   # => "20120101"
+  def start_date_as_string
+    as_string @start_date
+  end
+
+  # Public: Returns the Spok end date as a String.
+  #
+  # Examples
+  #
+  #   spok.end_date_as_string
+  #   # => "20120103"
+  def end_date_as_string
+    as_string @end_date
+  end
+
+  # Public: Returns an array containing all workdays on Spok.
+  #
+  # calendar - Symbol informing in which calendar to check for workdays
+  #            (default: :brasil).
+  #
+  # Examples
+  #
+  #   spok.workdays
+  #   # => [Mon, 02 Jan 2012, Tue, 03 Jan 2012]
+  def workdays(calendar = :brasil)
+    (@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).
+  #
+  # Examples
+  #
+  #   spok.to_calendar(:bovespa)
+  #   # => #<Spok:0x00007fbf122dba08 ...>
+  def to_calendar(calendar = :bovespa)
+    Spok.new(
+      Workday.last_workday(@start_date, calendar: calendar),
+      Workday.last_workday(@end_date, calendar: calendar)
+    )
+  end
+
+  # Public: Returns an array containing all Dates on Spok.
+  #
+  # Examples
+  #
+  #   spok.to_a
+  #   # => [Sun, 01 Jan 2012, Mon, 02 Jan 2012, Tue, 03 Jan 2012]
+  def to_a
+    (@start_date..@end_date).to_a
+  end
+
+  # Public: Returns a String containing the Spok start and end date separated
+  # by a dash.
+  #
+  # Examples
+  #
+  #   spok.to_s
+  #   # => "20120101-20120103"
+  def to_s
+    "#{start_date_as_string}-#{end_date_as_string}"
+  end
+
+  # Public: Informs whether the Spok has just one day or not.
+  #
+  # Examples
+  #
+  #   spok.one_day?
+  #   # => false
+  #
+  # Returns a boolean.
+  def one_day?
+    @start_date == @end_date
+  end
+
+  # Public: Returns an Integer with the number of days in the Spok.
+  #
+  # Examples
+  #
+  #   spok.days_count
+  #   # => 2
+  def days_count
+    (@end_date - @start_date).to_i
+  end
+
+  # Public: Returns a Float with the number of years in the Spok.
+  #
+  # Examples
+  #
+  #   spok.years_count
+  #   # => 1.6
+  def years_count
+    ((@end_date - @start_date).to_f / 365).to_f.round(1)
+  end
+
+  # Public: Compares the Spok with other Spok. Two spoks are considered
+  # equal when they are both instances of Spok, and have the same start and
+  # end dates.
+  #
+  # other_spok - Spok to be checked against.
+  #
+  # Examples
+  #
+  #   spok == other_spok
+  #   # => false
+  #
+  # Returns a boolean.
+  def ==(other_spok)
+    other_spok.class == self.class &&
+    other_spok.start_date == @start_date &&
+    other_spok.end_date == @end_date
+  end
+
+  # Public: Returns a range containing the Dates in the Spok.
+  #
+  # Examples
+  #
+  #   spok.to_range
+  #   # => Sun, 01 Jan 2012..Tue, 03 Jan 2012
+  def to_range
+    (@start_date..@end_date)
+  end
+
+  private
+
+  def as_string(date)
+    date.strftime(DATE_FORMAT)
+  end
+
+  def as_integer(date)
+    date.strftime(DATE_FORMAT).to_i
+  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
+    if @start_date > @end_date
+      raise ArgumentError.new("End date (#{@end_date}) must be greater or equal to start date (#{@start_date})")
+    end
+  end
+end