business-period 0.0.2 → 0.0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba745e5aaff7be65b94b2261f57f3a1094820670
-  data.tar.gz: 138b3bbf4da2551a9a364358b0f204a3cc491396
+  metadata.gz: 3e02d1dcb164775cde27037f2e2df3787ce57e8a
+  data.tar.gz: 68d5ef403c026d8a3795080bae5e7b1b77bacb72
 SHA512:
-  metadata.gz: 5bbb30d5ca9837191212210128484a4e3b7245faa8532cb4ce553399e058ca9ee62fc178117a4cc745c1f03709ed6fcd71e61b85f8a78f7fd5df99c4a7cf1a34
-  data.tar.gz: 7a4536a9f4026ae039514d9bdf5519c5183af7a3d5e6378d15dda807420adc3bfaccc2618ece2ac76ca0714764f2f054e330a0c27b33c09edb5836151b199892
+  metadata.gz: 4e60a333ad85b06ed62a4456cb8dd318ec3ee4b0e0fdc1fcbab548d957700d2332651e46ba064bb93540bacca7df5b2ac0746b63789eb13a1b8d25517432cdac
+  data.tar.gz: 3e6b2e12660e5db681bc45ddbc4340eca8f7779c1a2349bd33ad276bc8f35665ac466b49fa03234fa9c3d9886a31a2d73c3e089434c1d88d10aa14fbaebc78d7

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.0
+defaults: &defaults
+  working_directory: ~/business-period
+  docker:
+    - image: circleci/ruby:2.4.2-jessie-node-browsers
+
+jobs:
+  backend-tests:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: 
+          name: Setup dependencies
+          command: |
+            bundle install --without production --path=${BUNDLE_PATH:-vendor/bundle}
+      - run: 
+          name: Run backend tests
+          command: |
+            bundle exec rake
+
+workflows:
+  version: 2
+
+  commit:
+    jobs:
+      - backend-tests

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+plugins:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/Documentation:
+        enabled: false
+  rubymotion:
+    enabled: true

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order rand
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+group :test, :development do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    business-period (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.1)
+    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.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  business-period!
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 matas
+
+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

@@ -0,0 +1,92 @@
+[![CircleCI](https://circleci.com/gh/matass/business-period.svg?style=svg&circle-token=4f56e9b7fe1047d59c9f74d518b9bf377fa04bf8)](https://github.com/matass/business-period)
+[![Maintainability](https://api.codeclimate.com/v1/badges/4a92970cba0ed7292720/maintainability)](https://codeclimate.com/github/matass/business-period/maintainability)
+
+# Business period
+
+**BusinessPeriod** is a ruby library that calculates business period by given array.
+This library was designed for lithuanian, latvian and estonian unemployment days.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'business-period'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install business-period
+
+## Quickstart
+
+##### Add an initializer file:
+
+```ruby
+# config/initializers/business_period.rb
+
+# set locale to get config file from config/holidays path
+# set work_days to define which days of week are work days
+
+BusinessPeriod.configure do |config|
+  config.locale = 'lt'
+  config.work_days = [1, 2, 3, 4, 5]
+end
+
+```
+
+## How it works
+
+1. Dynamically calculates how many days we have to add to period end (Saturdays/Sundays/Holidays)
+2. Generates new array
+2. Extracts weekends and holidays from newly generated array
+3. Generates result array
+
+## Usage
+
+```ruby
+# set period array
+# 2 is our start day and 4 is our end day
+period = [2, 4]
+
+# call BusinessPeriod::Days class to calculate period 
+BusinessPeriod::Days.call(period)
+```
+
+## Examples
+Let's say we have no holidays this month and today is Wednesday
+
+let `work_days = [1, 2, 3, 4, 5]` (all days except weekends)
+
+let `period = [2, 4]`
+
+* Begins to count period from the coming day
+* Tomorrow (Thursday) is the first valid day
+* The second valid day will be Fridary (first business day)
+* Fourth business day will be Tuesday (Saturday and Sunday are not in scope)
+
+```console
+irb(main):001:0> Time.current
+=> Wed, 12 Sep 2018 05:49:10 UTC +00:00
+irb(main):002:0> period = [2, 4]
+=> [2, 4]
+irb(main):003:0> BusinessPeriod::Days.call(period)
+=> [Fri, 14 Sep 2018, Tue, 18 Sep 2018]
+```
+
+## Todo
+- [ ] Add latvian config
+- [ ] Add estonian config 
+- [ ] Calculate Easter holidays 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/business-period.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'business_period/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'business-period'
+  spec.version       = BusinessPeriod::VERSION
+  spec.authors       = ['matas']
+  spec.email         = ['matas.simonaitis@ksdigital.lt']
+
+  spec.summary       = '📅 calculate business period'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/matass/business-period'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.platform = Gem::Platform::RUBY
+
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4.1'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/config/holidays/lt.yml

@@ -0,0 +1,33 @@
+months:
+  1:
+  - mday: 1
+    name: Naujieji metai
+  2:
+  - mday: 16
+    name: Valstybės atkūrimo diena
+  3:
+  - mday: 11
+    name: Nepriklausomybės atkūrimo diena
+  5:
+  - mday: 1
+    name: Darbininkų diena
+  6:
+  - mday: 24
+    name: Joninės
+  7:
+  - mday: 6
+    name: Valstybės diena
+  8:
+  - mday: 15
+    name: Žolinė
+  11:
+  - mday: 1
+    name: Visų šventųjų diena
+  12:
+  - mday: 24
+    name: Šv. Kūčios
+  - mday: 25
+    name: Šv. Kalėdos
+  - mday: 26
+    name: Antroji Kalėdų diena
+

data/lib/business_period/base.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BusinessPeriod
+  class Base
+    def config
+      @config ||= BusinessPeriod.configuration
+    end
+
+    # Returns range of days
+    # Plot is our given period. E.g. [2, 4]
+    def calculate_period(plot)
+      @calculate_period ||= begin
+        imaginable_last_day = calculate_days_to_add_to(plot)
+
+        # converts days to seconds
+        days_to_add = days_to_seconds(imaginable_last_day)
+
+        # Adds expected last day to current day
+        finish = Time.now + days_to_add
+
+        # Builds an array from current time to imaginable end time
+        Time.now.to_date..finish.to_date
+      end
+    end
+
+    # Sets holiday instance by given file location
+    def holidays
+      @holidays ||= YAML.load_file(File.join(holiday_config)).fetch('months')
+    end
+
+    # Dynamically calculates how many days we have add to plot end
+    def calculate_days_to_add_to(plot)
+      # Calculates subjective number
+      sum = (7 - config.work_days.size)
+
+      # sum cannot be zero.
+      # Relevant when when work_days array == [1, 2, 3, 4, 5, 6, 7]
+      sum = 1 if sum.zero?
+
+      # Some magic
+      (plot.last - plot.first) * 2 * sum + 7
+    end
+
+    private
+
+    # Gets path to config file by given locale
+    def holiday_config
+      [File.dirname(__FILE__), "../../config/holidays/#{config.locale}.yml"]
+    end
+
+    def days_to_seconds(days)
+      days * 60 * 60 * 24
+    end
+  end
+end

data/lib/business_period/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BusinessPeriod
+  attr_accessor :configuration
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :locale, :work_days
+  end
+end

data/lib/business_period/days.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BusinessPeriod
+  class Days < Base
+    def self.call(plot)
+      new.perform(plot)
+    end
+
+    def perform(plot)
+      @period = calculate_period(plot)
+      @days = business_days
+
+      check_holidays
+
+      # Selects business days from given plot.
+      # E.g plot = [2, 4], selects second and fourth elements
+      plot.map { |param| @days[param][:day] }
+    end
+
+    private
+
+    # Maps business days to array by given calculated period
+    def business_days
+      @business_days ||= @period.map do |day|
+        # checks if day is business day
+        if config.work_days.include?(day.wday)
+          { day: day, month: day.to_time.month }
+        end
+      end.compact
+    end
+
+    # Removes business days which are on holidays
+    def check_holidays
+      @days.each_with_index do |day, index|
+        # Skips if no holiday in the current month
+        next unless holidays[day[:month]]
+
+        extract_holidays(day, index)
+      end
+    end
+
+    def extract_holidays(day, index)
+      holidays[day[:month]].each do |holiday|
+        @days.delete_at(index) if holiday['mday'] == day[:day].mday
+      end
+    end
+  end
+end

data/lib/business_period/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BusinessPeriod
+  VERSION = '0.0.2.1'
+end

data/lib/business_period.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'business_period/configuration'
+require 'business_period/version'
+require 'business_period/base'
+require 'business_period/days'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: business-period
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.2.1
 platform: ruby
 authors:
 - matas
@@ -30,7 +30,24 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- business-period.gemspec
+- config/holidays/lt.yml
+- lib/business_period.rb
+- lib/business_period/base.rb
+- lib/business_period/configuration.rb
+- lib/business_period/days.rb
+- lib/business_period/version.rb
 homepage: https://github.com/matass/business-period
 licenses:
 - MIT