swedish_holidays 1.1.0 → 2.0.1

data/data/2043

@@ -1,103 +1,103 @@
 ---
-- :date: '2018-01-01'
+- :date: '2043-01-01'
   :name: Nyårsdagen
   :week: 1
-  :weekday: Måndag
+  :weekday: Torsdag
   :yday: 1
   :real_holiday: true
-- :date: '2018-01-06'
+- :date: '2043-01-06'
   :name: Trettondedag jul
-  :week: 1
-  :weekday: Lördag
+  :week: 2
+  :weekday: Tisdag
   :yday: 6
   :real_holiday: true
-- :date: '2018-03-30'
+- :date: '2043-03-27'
   :name: Långfredagen
   :week: 13
   :weekday: Fredag
-  :yday: 89
+  :yday: 86
   :real_holiday: true
-- :date: '2018-03-31'
+- :date: '2043-03-28'
   :name: Påskafton
   :week: 13
   :weekday: Lördag
-  :yday: 90
+  :yday: 87
   :real_holiday: false
-- :date: '2018-04-01'
+- :date: '2043-03-29'
   :name: Påskdagen
   :week: 13
   :weekday: Söndag
-  :yday: 91
+  :yday: 88
   :real_holiday: true
-- :date: '2018-04-02'
+- :date: '2043-03-30'
   :name: Annandag påsk
   :week: 14
   :weekday: Måndag
-  :yday: 92
+  :yday: 89
   :real_holiday: true
-- :date: '2018-05-01'
+- :date: '2043-05-01'
   :name: Första maj
   :week: 18
-  :weekday: Tisdag
+  :weekday: Fredag
   :yday: 121
   :real_holiday: true
-- :date: '2018-05-10'
+- :date: '2043-05-07'
   :name: Kristi himmelfärdsdag
   :week: 19
   :weekday: Torsdag
-  :yday: 130
+  :yday: 127
   :real_holiday: true
-- :date: '2018-05-20'
+- :date: '2043-05-17'
   :name: Pingstdagen
   :week: 20
   :weekday: Söndag
-  :yday: 140
+  :yday: 137
   :real_holiday: true
-- :date: '2018-06-06'
+- :date: '2043-06-06'
   :name: Sveriges nationaldag
   :week: 23
-  :weekday: Onsdag
+  :weekday: Lördag
   :yday: 157
   :real_holiday: true
-- :date: '2018-06-22'
+- :date: '2043-06-19'
   :name: Midsommarafton
   :week: 25
   :weekday: Fredag
-  :yday: 173
+  :yday: 170
   :real_holiday: false
-- :date: '2018-06-23'
+- :date: '2043-06-20'
   :name: Midsommardagen
   :week: 25
   :weekday: Lördag
-  :yday: 174
+  :yday: 171
   :real_holiday: true
-- :date: '2018-11-03'
+- :date: '2043-10-31'
   :name: Alla helgons dag
   :week: 44
   :weekday: Lördag
-  :yday: 307
+  :yday: 304
   :real_holiday: true
-- :date: '2018-12-24'
+- :date: '2043-12-24'
   :name: Julafton
   :week: 52
-  :weekday: Måndag
+  :weekday: Torsdag
   :yday: 358
   :real_holiday: false
-- :date: '2018-12-25'
+- :date: '2043-12-25'
   :name: Juldagen
   :week: 52
-  :weekday: Tisdag
+  :weekday: Fredag
   :yday: 359
   :real_holiday: true
-- :date: '2018-12-26'
+- :date: '2043-12-26'
   :name: Annandag jul
   :week: 52
-  :weekday: Onsdag
+  :weekday: Lördag
   :yday: 360
   :real_holiday: true
-- :date: '2018-12-31'
+- :date: '2043-12-31'
   :name: Nyårsafton
-  :week: 1
-  :weekday: Måndag
+  :week: 53
+  :weekday: Torsdag
   :yday: 365
   :real_holiday: false

data/data/2044

@@ -1,103 +1,103 @@
 ---
-- :date: '2018-01-01'
+- :date: '2044-01-01'
   :name: Nyårsdagen
-  :week: 1
-  :weekday: Måndag
+  :week: 53
+  :weekday: Fredag
   :yday: 1
   :real_holiday: true
-- :date: '2018-01-06'
+- :date: '2044-01-06'
   :name: Trettondedag jul
   :week: 1
-  :weekday: Lördag
+  :weekday: Onsdag
   :yday: 6
   :real_holiday: true
-- :date: '2018-03-30'
+- :date: '2044-04-15'
   :name: Långfredagen
-  :week: 13
+  :week: 15
   :weekday: Fredag
-  :yday: 89
+  :yday: 106
   :real_holiday: true
-- :date: '2018-03-31'
+- :date: '2044-04-16'
   :name: Påskafton
-  :week: 13
+  :week: 15
   :weekday: Lördag
-  :yday: 90
+  :yday: 107
   :real_holiday: false
-- :date: '2018-04-01'
+- :date: '2044-04-17'
   :name: Påskdagen
-  :week: 13
+  :week: 15
   :weekday: Söndag
-  :yday: 91
+  :yday: 108
   :real_holiday: true
-- :date: '2018-04-02'
+- :date: '2044-04-18'
   :name: Annandag påsk
-  :week: 14
+  :week: 16
   :weekday: Måndag
-  :yday: 92
+  :yday: 109
   :real_holiday: true
-- :date: '2018-05-01'
+- :date: '2044-05-01'
   :name: Första maj
-  :week: 18
-  :weekday: Tisdag
-  :yday: 121
+  :week: 17
+  :weekday: Söndag
+  :yday: 122
   :real_holiday: true
-- :date: '2018-05-10'
+- :date: '2044-05-26'
   :name: Kristi himmelfärdsdag
-  :week: 19
+  :week: 21
   :weekday: Torsdag
-  :yday: 130
+  :yday: 147
   :real_holiday: true
-- :date: '2018-05-20'
+- :date: '2044-06-05'
   :name: Pingstdagen
-  :week: 20
+  :week: 22
   :weekday: Söndag
-  :yday: 140
+  :yday: 157
   :real_holiday: true
-- :date: '2018-06-06'
+- :date: '2044-06-06'
   :name: Sveriges nationaldag
   :week: 23
-  :weekday: Onsdag
-  :yday: 157
+  :weekday: Måndag
+  :yday: 158
   :real_holiday: true
-- :date: '2018-06-22'
+- :date: '2044-06-24'
   :name: Midsommarafton
   :week: 25
   :weekday: Fredag
-  :yday: 173
+  :yday: 176
   :real_holiday: false
-- :date: '2018-06-23'
+- :date: '2044-06-25'
   :name: Midsommardagen
   :week: 25
   :weekday: Lördag
-  :yday: 174
+  :yday: 177
   :real_holiday: true
-- :date: '2018-11-03'
+- :date: '2044-11-05'
   :name: Alla helgons dag
   :week: 44
   :weekday: Lördag
-  :yday: 307
+  :yday: 310
   :real_holiday: true
-- :date: '2018-12-24'
+- :date: '2044-12-24'
   :name: Julafton
-  :week: 52
-  :weekday: Måndag
-  :yday: 358
+  :week: 51
+  :weekday: Lördag
+  :yday: 359
   :real_holiday: false
-- :date: '2018-12-25'
+- :date: '2044-12-25'
   :name: Juldagen
-  :week: 52
-  :weekday: Tisdag
-  :yday: 359
+  :week: 51
+  :weekday: Söndag
+  :yday: 360
   :real_holiday: true
-- :date: '2018-12-26'
+- :date: '2044-12-26'
   :name: Annandag jul
   :week: 52
-  :weekday: Onsdag
-  :yday: 360
+  :weekday: Måndag
+  :yday: 361
   :real_holiday: true
-- :date: '2018-12-31'
+- :date: '2044-12-31'
   :name: Nyårsafton
-  :week: 1
-  :weekday: Måndag
-  :yday: 365
+  :week: 52
+  :weekday: Lördag
+  :yday: 366
   :real_holiday: false

data/lib/swedish_holidays.rb

@@ -6,19 +6,33 @@ module SwedishHolidays
 
   class Error < StandardError; end
 
-  def self.[](date, real: true)
-    return Holiday.find(Utils.to_date(date), real: real) unless date.is_a? Range
-    range = Utils.to_date_range(date)
-    each(start: range.first, real: real).take_while { |h| range.include? h.date }
-  end
+  class << self
+    def [](date, real: no_arg, include_informal: no_arg)
+      informal = Utils.include_informal?(real, include_informal)
+      return Holiday.find(Utils.to_date(date), include_informal: informal) unless date.is_a? Range
 
-  def self.holiday?(date = nil, real: true)
-    Holiday.holiday?(Utils.to_date(date), real: real)
-  end
+      range = Utils.to_date_range(date)
+      each(start: range.first, include_informal: informal).take_while { |h| range.include? h.date }
+    end
+
+    def holiday?(date = nil, real: no_arg, include_informal: no_arg)
+      informal = Utils.include_informal?(real, include_informal)
+      date = Utils.to_date(date)
+      Holiday.holiday?(date, include_informal: informal)
+    end
+
+    def each(start: nil, real: no_arg, include_informal: no_arg, &block)
+      informal = Utils.include_informal?(real, include_informal)
+      enumerator = Utils.enumerator(start, informal)
+      return enumerator.lazy unless block_given?
+
+      enumerator.each(&block)
+    end
+
+    private
 
-  def self.each(start: nil, real: true)
-    enumerator = Utils.enumerator(start, real)
-    return enumerator.lazy unless block_given?
-    enumerator.each { |holiday| yield holiday }
+    def no_arg
+      Utils::VALUE_NOT_GIVEN
+    end
   end
 end

data/lib/swedish_holidays/holiday.rb

@@ -12,28 +12,36 @@ module SwedishHolidays
     attr_reader :date, :name
 
     class << self
-      def holiday?(date, real: true)
-        !find(date, real: real).nil?
+      def holiday?(date, real: no_arg, include_informal: no_arg)
+        informal = Utils.include_informal?(real, include_informal)
+        !find(date, include_informal: informal).nil?
       end
 
-      def find(date, real: true)
+      def find(date, real: no_arg, include_informal: no_arg)
+        informal = Utils.include_informal?(real, include_informal)
         year = date.year
         load(year)
         holiday = loaded[year][date.yday]
-        return holiday unless real
-        holiday&.real? ? holiday : nil
+        return holiday if informal
+        return holiday if holiday&.real?
       end
 
-      def each(year = Date.today.year, real: true)
+      def each(year = Date.today.year, real: no_arg, include_informal: no_arg, &block)
+        informal = Utils.include_informal?(real, include_informal)
         load(year)
         holidays = loaded[year.to_i].values
-        holidays.delete_if { |holiday| real && !holiday.real? }
-        return holidays.each unless block_given?
-        holidays.each { |holiday| yield holiday }
+        holidays.delete_if { |holiday| !informal && holiday.informal? }
+        return holidays.each(&block) if block
+
+        holidays.each
       end
 
       private
 
+      def no_arg
+        Utils::VALUE_NOT_GIVEN
+      end
+
       def file(year)
         File.join(DATA_DIR, year.to_s)
       end
@@ -61,7 +69,7 @@ module SwedishHolidays
     def initialize(attr)
       @date = Date.parse(attr[:date])
       @name = attr[:name]
-      @real = attr[:real_holiday]
+      @informal = attr.fetch(:informal_holiday) { !attr[:real_holiday] }
     end
 
     delegate [:wday, :yday] => :date
@@ -75,7 +83,11 @@ module SwedishHolidays
     end
 
     def real?
-      @real
+      !informal?
+    end
+
+    def informal?
+      @informal
     end
   end
 end

data/lib/swedish_holidays/utils.rb

@@ -3,11 +3,16 @@ require 'swedish_holidays/holiday'
 
 module SwedishHolidays
   module Utils
+    puts "loading Utils.."
+    VALUE_NOT_GIVEN = Object.new
+
     class << self
       def to_date(arg = nil)
         case arg
         when NilClass
           Date.today
+        when /\d{4}\Z/
+          Date.parse("#{date}-01-01")
         when /\d{4}-\d{2}-\d{2}/
           Date.parse(arg)
         when Date
@@ -25,17 +30,32 @@ module SwedishHolidays
         end
       end
 
-      def enumerator(start, real)
+      def enumerator(start, include_informal)
         start_date = to_date(start)
-        Enumerator.new { |yielder| iterate(yielder, start_date, real) }
+        Enumerator.new { |yielder| iterate(yielder, start_date, include_informal) }
+      end
+
+      def include_informal?(real, include_informal)
+        warn <<~DEPRECATION if real != VALUE_NOT_GIVEN
+          warn 'Keyword `:real` is deprecated!
+          Use `:include_informal` instead (Note: that the value is inverted)'
+        DEPRECATION
+
+        if include_informal != VALUE_NOT_GIVEN
+          include_informal
+        elsif real != VALUE_NOT_GIVEN
+          !real
+        else
+          false
+        end
       end
 
       private
 
-      def iterate(yielder, start_date, real)
+      def iterate(yielder, start_date, include_informal)
         year = start_date.year
         loop do
-          Holiday.each(year, real: real) do |holiday|
+          Holiday.each(year, include_informal: include_informal) do |holiday|
             next if holiday.date < start_date
             yielder << holiday
           end