holidays_from_google_calendar 0.4.3 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2ae6b02cc84e33b45e895f23533e6c3bf660a64
-  data.tar.gz: 4ae41a072da7685c8c30afe4a6d7c8f9a346fec6
+SHA256:
+  metadata.gz: d580e1150fd1410a754c1704caf0a2bd8961b45c4e19eb14298fd8a0fd754de1
+  data.tar.gz: 0d924ba7e83d1b72db38e2ac1eb210edaa941511098eafd5a7bcb661917204a1
 SHA512:
-  metadata.gz: 200ebd890eddc0d45a9aa72e93101ec4ac128b4d15fd9e186735ea7247907f3a06f3bdb398eca8616ace16e6062bbf828f54e866f444f2a3cb6b6b8813fe17e8
-  data.tar.gz: c2894111a48fcb745adc21805631d98a1266063d4b675c14742aa8d47c2c9889c1f4a454d57cb47f54c0c34cdfff2f2de331de781ecd583e4c887046d142c018
+  metadata.gz: f5c0261d1d967e2178e52de58b8b3031eb5d8a7740b9044e9136ce0b21b20d46d244244d96b75a5ccc330b6cce8999ead598547afd9420bd4a64b00002440e57
+  data.tar.gz: bcdf1eafebd441cb953430e2d286a42b411a213aef1f4035188869cf10eefafd8fc67b1899a2b733d07f490cb2e496a8caf64a8cd767a0702367efbcb8421f2f

data/.rubocop.yml

@@ -37,14 +37,6 @@ Style/BlockDelimiters:
 FormatString:
   EnforcedStyle: sprintf
 
-# Maximum line length
-LineLength:
-  Max: 100
-
-# Whatever we should use "postfix if/unless"
-IfUnlessModifier:
-  MaxLineLength: 100
-
 # Maximum method length
 MethodLength:
   Max: 20

data/.travis.yml

@@ -1,6 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a5c4305696a06c12d5071d9c5bbda7d604be0495ad47c6199389f633fcbdaf86
 language: ruby
 rvm:
   - 2.0
   - 2.1
   - 2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3
+  - 2.4
+  - 2.5
+before_install:
+  - gem update --system --no-document
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email: false

data/README.md

@@ -1,5 +1,30 @@
-# HolidaysFromGoogleCalendar [![Build Status](https://travis-ci.org/necojackarc/holidays_from_google_calendar.svg?branch=master)](https://travis-ci.org/necojackarc/holidays_from_google_calendar) [![Code Climate](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/gpa.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar) [![Test Coverage](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/coverage.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/coverage)
-Under construction.
+# HolidaysFromGoogleCalendar 
+
+[![Build Status](https://travis-ci.org/necojackarc/holidays_from_google_calendar.svg?branch=master)](https://travis-ci.org/necojackarc/holidays_from_google_calendar)
+[![Code Climate](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/gpa.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar)
+[![Test Coverage](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/badges/coverage.svg)](https://codeclimate.com/github/necojackarc/holidays_from_google_calendar/coverage)
+
+HolidaysFromGoogleCalendar can retrieve national holidays from Google Calendar with very simple interface.
+
+The results is going to be cached and you can preload holidays with your favorite range at initialization if you want.
+These features help you to reduce access times to Google Calendar API.
+
+I am sure that you only need to access the API a very few times if you preload holidays with proper range.
+
+Using Google Calendar, available nations are same as Google Calendar.
+
+Note that you can only retrieve holidays which Google Calendar has.
+Google Calendar appears not to have all holidays, so you cannot retrieve very old ones and far future's.
+
+## Features
+### Main
+* List holidays of a particular nation in a particular year
+* List holidays of a particular nation in a particular month
+* Check a date whether it is a holiday or not in a particular nation
+
+### Others
+* Cacheing results using LRU algorithm
+* Preload holidays at initialization
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,7 +46,54 @@ $ gem install holidays_from_google_calendar
 ```
 
 ## Usage
+### Configuration
+All parameters you can pass are below:
+
+```ruby
+usa_holidays = HolidaysFromGoogleCalendar::Holidays.new do |config|
+  config.credential = {
+    api_key: "YOUR OWN GOOGLE API KEY"
+  }
+
+  config.calendar = {
+    nation: "usa",
+    language: "en"
+  }
 
+  config.cache = {
+    enable: true,
+    max_size: 1000 # DEFAULT_CACHE_SIZE is 1000
+  }
+
+  config.preload = {
+    enable: true, # Require cache enabled
+    date_range: 1.year # Retrive holidays from "this day last year" to "this day next year"
+  }
+end
+```
+
+Default parameters of `cache` and `preload` are same as above.
+
+### List holidays of a particular nation in a particular year
+Returns a array of holidays in a particular year.
+
+```ruby
+usa_holidays.in_year(Date.current)
+```
+
+### List holidays of a particular nation in a particular month
+Returns a array of holidays in a particular month.
+
+```ruby
+usa_holidays.in_month(Date.current)
+```
+
+### Check a date whether it is a holiday or not in a particular nation
+Returns `true` when the day is holiday, Saturday or Sunday.
+
+```ruby
+usa_holidays.holiday?(Date.current)
+```
 
 ### Sample code
 ```ruby
@@ -69,7 +141,7 @@ usa_holidays.in_month(Date.parse("3rd March 2016")) # Retrieve holidays of March
 usa_holidays.holiday?(Date.parse("Oct 31 2016")) # Halloween
 => true
 
-usa_holidays.holiday?(Date.parse("April 16th 2016")) # Satruday
+usa_holidays.holiday?(Date.parse("April 16th 2016")) # Saturday
 => true
 
 usa_holidays.holiday?(Date.parse("April 17th 2016")) # Sunday
@@ -80,7 +152,7 @@ usa_holidays.holiday?(Date.parse("Aug 2 2016")) # Weekday (Tuesday)
 ```
 
 ## Development
-Need to set the following environment variable to run rspec.
+Need to set the following environment variable to run rspec:
 
 ```bash
 GOOGLE_API_KEY="YOUR OWN GOOGLE API KEY"

data/bin/console

@@ -6,9 +6,5 @@ require "holidays_from_google_calendar"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/holidays_from_google_calendar.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/holidays_from_google_calendar.rb

@@ -17,13 +17,6 @@ module HolidaysFromGoogleCalendar
       @client = Client.new(@configuration)
     end
 
-    def on_date(date)
-      @client.retrieve(
-        date_min: date,
-        date_max: date
-      )
-    end
-
     def in_year(date)
       @client.retrieve(
         date_min: date.beginning_of_year,

data/lib/holidays_from_google_calendar/cache.rb

@@ -31,6 +31,7 @@ module HolidaysFromGoogleCalendar
 
     private
 
+    # The size of cache is sum of unit count and the number of holidays
     def calculate_size
       @size = unit_count + holidays_count
     end

data/lib/holidays_from_google_calendar/cache_unit.rb

@@ -21,18 +21,14 @@ module HolidaysFromGoogleCalendar
     end
 
     def overlapped?(other)
-      (date_min <= other.date_max && other.date_min <= date_max) ||
-        (other.date_min <= date_max && date_min <= other.date_max)
+      (@date_min <= other.date_max && other.date_min <= @date_max + 1.day) ||
+        (other.date_min <= @date_max && @date_min <= other.date_max + 1.day)
     end
 
     def combine(other)
       return unless overlapped?(other)
-
-      if date_min <= other.date_max
-        date_min = other.date_min # rubocop:disable Lint/UselessAssignment
-      elsif other.date_min <= date_max
-        date_max = other.date_max # rubocop:disable Lint/UselessAssignment
-      end
+      @date_min = [@date_min, other.date_min].min
+      @date_max = [@date_max, other.date_max].max
       @holidays =
         @holidays.concat(other.holidays).uniq.sort { |a, b| a.date <=> b.date }
     end

data/lib/holidays_from_google_calendar/client.rb

@@ -50,9 +50,11 @@ module HolidaysFromGoogleCalendar
 
     def pack_response_in_object(response, date_min, date_max)
       response.items.reduce([]) do |array, item|
+        date = item.start.date
+
         holiday = Holiday.new(
           name: item.summary,
-          date: Date.parse(item.start.date)
+          date: date.is_a?(Date) ? date : Date.parse(date)
         )
 
         if date_min <= holiday.date && holiday.date <= date_max

data/lib/holidays_from_google_calendar/version.rb

@@ -1,3 +1,3 @@
 module HolidaysFromGoogleCalendar
-  VERSION = "0.4.3"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: holidays_from_google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.7
 platform: ruby
 authors:
 - necojackarc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Holidays from Google Calendar.