holidays_from_google_calendar 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea98c95ad38a12d3c95ae95bce204eb9922fe556
-  data.tar.gz: e04b7ada90c239f80455c9db4d2b81decc2ba8da
+  metadata.gz: e141f7e77b5d28a0f6286c5ce57a9e3140459d8e
+  data.tar.gz: c49f47556e87dc460485d09689637dbbb3cc0413
 SHA512:
-  metadata.gz: d73607ef9df0b677747b7adae6a13efb66f3f31a4468a5c38d48cfa7af19f72694dbcd44ab2e3fd306f7c6150d722b621871eaf82d178ed8f631935f8de75b16
-  data.tar.gz: 3db9c1c44dcf6b6f76df199c0527fc24e4099a21f11a07b41607085f469ecef86994874ff624ae1b77c2b84dd9b9c9e57d73ca577888342fe82469bc739fcbf4
+  metadata.gz: 18ca26424001c47596268618ab2816980f76ab07a8d4d89f86806eda50453a0df748a1567e62f63d07f5b88969f9bef9a11b762c65381a39d00e1c79f620ace9
+  data.tar.gz: a2769dc98cf24f2f85072e06a5e88f7e5eef5f802c39414ec671d3d51822c8fb250c3b065d7b1a7d716e07e72455686b95bf60a15a0d62cd26c95bad4bac4dd0

data/lib/holidays_from_google_calendar/cache.rb

@@ -0,0 +1,71 @@
+module HolidaysFromGoogleCalendar
+  class Cache
+    attr_reader :size
+
+    def initialize(enable: nil, max_size: nil)
+      @enable = enable
+      @max_size = max_size
+      @container = []
+      calculate_size
+    end
+
+    def enabled?
+      @enable
+    end
+
+    def cache(holidays, date_min, date_max)
+      pack_container(CacheUnit.new(holidays.dup, date_min, date_max))
+      page_out if calculate_size > @max_size
+    end
+
+    def retrieve(date_min, date_max)
+      unit = @container.find { |e| e.include?(date_min, date_max) }
+      return nil if unit.nil?
+
+      # For LRU (Least Recently Used)
+      @container.delete(unit)
+      @container.push(unit)
+
+      unit.retrieve(date_min, date_max)
+    end
+
+    private
+
+    def calculate_size
+      @size = unit_count + holidays_count
+    end
+
+    def unit_count
+      @container.size
+    end
+
+    def holidays_count
+      @container.map(&:size).sum
+    end
+
+    def pack_container(new_unit)
+      unnecessary_units = @container.reduce([]) do |array, unit|
+        # If there are overlapped units, combine them into the new unit
+        if new_unit.include?(unit.date_min, unit.date_max)
+          array.push(unit)
+        elsif new_unit.overlapped?(unit)
+          new_unit.combine(unit)
+          array.push(unit)
+        else
+          array # Do nothing
+        end
+      end
+      @container -= unnecessary_units
+      @container.push(new_unit)
+    end
+
+    def page_out
+      deleted_size = 0
+      while (@size - deleted_size) > @max_size
+        unit = @container.shift
+        deleted_size += (1 + unit.size) # Size is unit count plus holiday count
+      end
+      @size -= deleted_size
+    end
+  end
+end

data/lib/holidays_from_google_calendar/cache_unit.rb

@@ -0,0 +1,40 @@
+module HolidaysFromGoogleCalendar
+  class CacheUnit
+    attr_reader :holidays, :date_min, :date_max
+
+    def initialize(holidays, date_min, date_max)
+      @holidays = holidays
+      @date_min = date_min
+      @date_max = date_max
+    end
+
+    def size
+      @holidays.size
+    end
+
+    def include?(date_min, date_max)
+      [date_min, date_max].all? { |e| @date_min <= e && e <= @date_max }
+    end
+
+    def retrieve(date_min, date_max)
+      @holidays.select { |e| date_min <= e.date && e.date <= date_max }
+    end
+
+    def overlapped?(other)
+      (date_min <= other.date_max && other.date_min <= date_max) ||
+        (other.date_min <= date_max && date_min <= other.date_max)
+    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
+      @holidays =
+        @holidays.concat(other.holidays).uniq.sort { |a, b| a.date <=> b.date }
+    end
+  end
+end

data/lib/holidays_from_google_calendar/client.rb

@@ -4,9 +4,26 @@ module HolidaysFromGoogleCalendar
       @nation = configuration.calendar[:nation]
       @language = configuration.calendar[:language]
       @api_key = configuration.credential[:api_key]
+      @cache = Cache.new(configuration.cache)
+
+      return unless configuration.preload[:enable]
+      preload(configuration.preload[:date_range])
     end
 
-    def retrieve_from_google_calendar(date_min: nil, date_max: nil)
+    def retrieve(date_min: nil, date_max: nil)
+      if @cache.enabled?
+        cached_holidays = @cache.retrieve(date_min, date_max)
+        return cached_holidays if cached_holidays
+      end
+
+      retrieve_from_google_calendar(date_min, date_max).tap do |holidays|
+        @cache.cache(holidays, date_min, date_max) if @cache.enabled?
+      end
+    end
+
+    private
+
+    def retrieve_from_google_calendar(date_min, date_max)
       service = Google::Apis::CalendarV3::CalendarService.new
       service.key = @api_key
 
@@ -20,8 +37,6 @@ module HolidaysFromGoogleCalendar
       pack_response_in_object(response)
     end
 
-    private
-
     def calendar_id
       "#{@language}.#{@nation}#holiday@group.v.calendar.google.com"
     end
@@ -39,5 +54,12 @@ module HolidaysFromGoogleCalendar
         array.push(holiday)
       end
     end
+
+    def preload(date_range)
+      retrieve(
+        date_min: Date.current - date_range,
+        date_max: Date.current + date_range
+      )
+    end
   end
 end

data/lib/holidays_from_google_calendar/configuration.rb

@@ -1,15 +1,24 @@
 module HolidaysFromGoogleCalendar
   class Configuration
-    CALENDAR_ATTRIBUTES = %i(nation language).freeze
-    CREDENTIAL_ATTRIBUTES = %i(api_key).freeze
+    DEFAULT_CACHE_SIZE = 1_000
 
-    attr_accessor :calendar, :credential
+    attr_accessor :calendar, :credential, :cache, :preload
 
     def initialize
       @calendar = {
         nation: "japanese",
         language: "ja"
       }
+
+      @cache = {
+        enable: true,
+        max_size: DEFAULT_CACHE_SIZE
+      }
+
+      @preload = {
+        enable: true, # Require cache enabled
+        date_range: 1.year
+      }
     end
   end
 end

data/lib/holidays_from_google_calendar/version.rb

@@ -1,3 +1,3 @@
 module HolidaysFromGoogleCalendar
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/holidays_from_google_calendar.rb

@@ -1,12 +1,13 @@
-require "holidays_from_google_calendar/version"
-require "holidays_from_google_calendar/configuration"
-require "holidays_from_google_calendar/client"
-require "holidays_from_google_calendar/holiday"
-
-require "google/apis/calendar_v3"
-
 require "active_support"
 require "active_support/core_ext"
+require "google/apis/calendar_v3"
+
+require "holidays_from_google_calendar/cache"
+require "holidays_from_google_calendar/cache_unit"
+require "holidays_from_google_calendar/client"
+require "holidays_from_google_calendar/configuration"
+require "holidays_from_google_calendar/holiday"
+require "holidays_from_google_calendar/version"
 
 module HolidaysFromGoogleCalendar
   class Holidays
@@ -17,14 +18,14 @@ module HolidaysFromGoogleCalendar
     end
 
     def in_year(date)
-      @client.retrieve_from_google_calendar(
+      @client.retrieve(
         date_min: date.beginning_of_year,
         date_max: date.end_of_year + 1.day
       )
     end
 
     def in_month(date)
-       @client.retrieve_from_google_calendar(
+      @client.retrieve(
         date_min: date.beginning_of_month,
         date_max: date.end_of_month + 1.day
       )
@@ -32,8 +33,7 @@ module HolidaysFromGoogleCalendar
 
     def holiday?(date)
       return true if date.wday.in?([0, 6]) # If Sunday or Saturday
-      response = @client.retrieve_from_google_calendar(date_min: date, date_max: date + 1.day)
-      response.items.size > 0
+      @client.retrieve(date_min: date, date_max: date + 1.day).size > 0
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: holidays_from_google_calendar
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - necojackarc
@@ -100,6 +100,8 @@ files:
 - bin/setup
 - holidays_from_google_calendar.gemspec
 - lib/holidays_from_google_calendar.rb
+- lib/holidays_from_google_calendar/cache.rb
+- lib/holidays_from_google_calendar/cache_unit.rb
 - lib/holidays_from_google_calendar/client.rb
 - lib/holidays_from_google_calendar/configuration.rb
 - lib/holidays_from_google_calendar/holiday.rb