business-period 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d341e7c30a7da55a96ae31a6312dc3aa0d8870a8
-  data.tar.gz: 5fdc3d52b49f83cbb6b2857b4b92fca1785e0984
+  metadata.gz: 6910f7cb08ae02406dab9a48a5be8a9fa13fa4db
+  data.tar.gz: f29b0758ddc9d9f4736a8b3fa1c0fb1ce44e07b9
 SHA512:
-  metadata.gz: dfbce184b7c997dfb249523dd9444b84fc27954dbd37ac77bd4e11099c91827801561473c161cbf1202dd98f54d848ab77d48d363aaacf7e03e186f892fbed12
-  data.tar.gz: 14c41468341715c5e9162f017eb0bc548b782081f51fd54545e58e57b1cc9b166ea6b2f992346c145afc78f912a04c421b585eebb25512cee4881a50fe57e00e
+  metadata.gz: 6a1ad16665a792b9cba88b700b2486cc162feb1b846246ce0cfa28fbed780ec6aaccfcbd0f4fcfa70268ed3cb651c7c98a13009c65d1eeeecbef654db4f9977e
+  data.tar.gz: 0b4cce9bd863d542a032c7be80e28e7cc5a8393f2eeab27c8e2072d0e12d9e4099e188ee54df394bdbe2e79c235e5374c4914f9a0ceeefca8a88d2aed563b11d

data/.codeclimate.yml

@@ -4,3 +4,5 @@ plugins:
     checks:
       Rubocop/Style/Documentation:
         enabled: false
+      Rubocop/Metrics/LineLength:
+        enabled: false

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/business-period.svg)](https://badge.fury.io/rb/business-period)
 # Business period
 
-**BusinessPeriod** is a ruby library that calculates business period by given array.
+**BusinessPeriod** is a ruby library that calculates business period by given hash.
 This library was designed for lithuanian, latvian and estonian unemployment days.
 
 ## Installation
@@ -26,7 +26,7 @@ Or install it yourself as:
 
 There are two ways to initialize:
 
-##### Add an initializer file:
+##### Default initialization:
 
 ```ruby
 # config/initializers/business_period.rb
@@ -37,19 +37,18 @@ There are two ways to initialize:
 locale = 'lt'
 work_days = [1, 2, 3, 4, 5]
 
-BusinessPeriod.configure do |config|
-  config.locale = locale
-  config.work_days = work_days
-end
+BusinessPeriod::Config.locale = locale
+BusinessPeriod::Config.work_days = work_days
 ```
 
-##### Initialize through params:
+##### Initialization with Proc:
 
 ```ruby
 locale = 'lt'
 work_days = [1, 2, 3, 4, 5]
 
-BusinessPeriod::Days.new(locale, work_days)
+BusinessPeriod::Config.locale = -> { locale }
+BusinessPeriod::Config.work_days = -> { work_days }
 ```
 
 ## How it works
@@ -62,9 +61,8 @@ BusinessPeriod::Days.new(locale, work_days)
 ## Usage
 
 ```ruby
-# set period array
-# 2 is our start day and 4 is our end day
-period = [2, 4]
+# set period hash
+period = { from_date: 2, to_date: 4 }
 
 # call BusinessPeriod::Days class to calculate period 
 BusinessPeriod::Days.call(period)
@@ -75,7 +73,7 @@ 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]`
+let `period = { from_date: 2, to_date: 4 }`
 
 * Begins to count period from the coming day
 * Tomorrow (Thursday) is the first valid day
@@ -85,13 +83,14 @@ let `period = [2, 4]`
 ```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):002:0> period = { from_date: 2, to_date: 4 }
+=> {:from_date=>2, :to_date=>4}
 irb(main):003:0> BusinessPeriod::Days.call(period)
-=> [Fri, 14 Sep 2018, Tue, 18 Sep 2018]
+=> {:from_date=>Fri, 14 Sep 2018, :to_date=>Tue, 18 Sep 2018]
 ```
 
 ## Todo
+- [ ] improve specs
 - [ ] Add latvian config
 - [ ] Add estonian config
 

data/lib/business_period/base.rb

@@ -7,10 +7,9 @@ module BusinessPeriod
     end
 
     # Returns range of days
-    # Plot is our given period. E.g. [2, 4]
-    def calculate_period(plot)
+    def calculate_period(from_date, to_date)
       @calculate_period ||= begin
-        imaginable_last_day = calculate_days_to_add_to(plot)
+        imaginable_last_day = calculate_days_to_add_to(from_date, to_date)
 
         # converts days to seconds
         days_to_add = days_to_seconds(imaginable_last_day)
@@ -28,8 +27,8 @@ module BusinessPeriod
       @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)
+    # Dynamically calculates how many days we have add to `to_date` end
+    def calculate_days_to_add_to(from_date, to_date)
       # Calculates subjective number
       sum = (7 - config.work_days.size)
 
@@ -38,7 +37,7 @@ module BusinessPeriod
       sum = 1 if sum.zero?
 
       # Some magic
-      (plot.last - plot.first) * 2 * sum + 7
+      (to_date - from_date) * 2 * sum + 7
     end
 
     private

data/lib/business_period/days.rb

@@ -2,19 +2,23 @@
 
 module BusinessPeriod
   class Days < Base
-    def self.call(plot)
-      new.perform(plot)
+    def self.call(from_date:, to_date:)
+      new.perform(from_date, to_date)
     end
 
-    def perform(plot)
-      @period = calculate_period(plot)
+    def perform(from_date, to_date)
+      @period = calculate_period(from_date, to_date)
       @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] }
+      # Selects business days from given from_date and to_date values.
+      # E.g from_date = 2, to_date = 4
+      # selects second and fourth elements
+      {
+        from_date: @days[from_date][:day],
+        to_date: @days[to_date][:day]
+      }
     end
 
     private

data/lib/business_period/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: business-period
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - matas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec