ifc_date 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6979a62fb8321d9418b5789cc02303e536abcc042350412d538158b979370557
-  data.tar.gz: aa6d5344f97499fc6f173ba790a615e76507a092eec2b8b3d5af8b0f9af1cb05
+  metadata.gz: 8ad433793e0ad036ce9c1ec24d911e51bb6c2bedd3de4bc803e80f45c6fa0816
+  data.tar.gz: 8b035067f852ec5af13aa02d7743e3ca4659ed0dcbfe2ba99165de1a8baac1e4
 SHA512:
-  metadata.gz: 51e4513597bc76020664126c47fac826e56f048a16ec74897d4afe9f07d38f14b4c856567ebf5e2bc537ad1d8d0bed7f92d3d012473def43f2c0cd7973e0ef7f
-  data.tar.gz: 5ff49d42a1b8cb58e552617b2ecce0a85341490932e273a24b85a462368b5c3b4e3249c832a7f99307bf9b01daf2ac07d90ee4cc3fb9da21f750368739f31b0d
+  metadata.gz: 901f390a464a7d8af4f38874943a25bcae0e7c3eb0ab91ee673e851296e0a9eef5f7bf8853d6e91a54301eded36f887fbd0c3c641a52a9d7fa2a4efc22f4c3e0
+  data.tar.gz: 0c945503fff33804c196b06d69fca51cf6a8756c5edfa7bbd5b96da7f71752ea4f5b93b8624f578ebe41a3e75f4a954898ddfb73efd663bc2fe6f01363bf344f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-07-xx
+* Add `to_s` and `inspect` method to return ISO8601 style representation
+* Attach the starday to the week it attaches instead of using zero.
+  So  '2022-12-31'.to\_date.ifc.week will be 52 instead of 0
+  and '2020-06-17'.to\_date.ifc.week will be 24 instead of 0
+* more consistent implementation using the cleaned divmod structure
+
 ## [0.1.0] - 2022-06-08
 
 - Initial release
+
+
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ifc_date (0.1.0)
+    ifc_date (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/ifc_date/class_methods.rb

@@ -9,13 +9,14 @@ module IfcDateClassMethods
   # NOTE: only use for explicitly non nil return methods, false is fine
   def memoize(method_name)
     unmemoized_name = "_unmemoized_#{method_name}"
-    instance_var_name = method_name.end_with?('?') ? "@is_#{method_name[0..-2]}" : "@#{method_name}"
+    cache_key = method_name.end_with?('?') ? "is_#{method_name[0..-2]}" : "#{method_name}"
     alias_method unmemoized_name, method_name
     define_method method_name do |*args, &block|
-      instance_var = instance_variable_get instance_var_name
-      return instance_var unless instance_var.nil?
+      @_memoized_methods ||= {}
+      return @_memoized_methods[cache_key] if @_memoized_methods.has_key?(cache_key)
       evaluated_result = send(unmemoized_name, *args, &block)
-      instance_variable_set instance_var_name, evaluated_result
+      @_memoized_methods[cache_key] = evaluated_result
     end
   end
+
 end

data/lib/ifc_date/instance_methods.rb

@@ -0,0 +1,11 @@
+module IfcDateInstanceMethods
+  # In case a crucial element of the object itself changes the memoization should be cleared.
+  # Note that this is not expected since the current way of reasoning assumes new object creation.
+  # Maybe something of the future could be:
+  #   date = Date.today.ifc
+  #   date.move_forward 3.days
+  # But this is for later consideration
+  def clear_memoization_results
+    @_memoized_methods.clear
+  end
+end

data/lib/ifc_date/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class IfcDate
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/ifc_date.rb

@@ -4,12 +4,16 @@ require 'date'
 require_relative 'ifc_date/version'
 require_relative 'ifc_date/ext/to_ifc'
 require_relative 'ifc_date/class_methods'
+require_relative 'ifc_date/instance_methods.rb'
 
 class IfcDate
   class Error < StandardError; end
   extend IfcDateClassMethods
+  include IfcDateInstanceMethods
+
   attr_reader :day_of_year, :year
   alias yday day_of_year
+
   DAYNAMES = Date::DAYNAMES + ['Starday']
   ABBR_DAYNAMES = Date::ABBR_DAYNAMES + ['Sta']
   MONTHNAMES = Date::MONTHNAMES.dup.insert(6, 'Sol')
@@ -32,18 +36,26 @@ class IfcDate
     self.class.is_leap_year?(year)
   end
 
+  # This method caches the divmod result of the:
+  # zero based (working number starts with 1) day of the year
+  # where Leap day is removed. By applying the divmod on the
+  # 'cleaner' representation of the day of the year, other parts
+  # of the code become easier to reason about.
   memoize def day_of_year_divmod_seven
-    if leap_year? && day_of_year > 169
+    if leap_year? && day_of_year > 168
       (day_of_year - 2).divmod(7)
     else
       (day_of_year - 1).divmod(7)
     end
   end
 
-  # day_of_year starts from 1,
-  # divmod should be zero based
+  # This method caches the divmod result of the:
+  # zero based (working number starts with 1) day of the year
+  # where Leap day is removed. By applying the divmod on the
+  # 'cleaner' representation of the day of the year, other parts
+  # of the code become easier to reason about.
   memoize def day_of_year_divmod_twenty_eight
-    if leap_year? && day_of_year > 169
+    if leap_year? && day_of_year > 168
       (day_of_year - 2).divmod(28)
     else
       (day_of_year - 1).divmod(28)
@@ -60,8 +72,8 @@ class IfcDate
   end
 
   memoize def week_of_year
-    return 0 if starday?
-    day_of_year_divmod_seven[0] + 1
+    # The min operation if for the year day, which would be 53, but is appended to week 52
+    [day_of_year_divmod_seven[0] + 1, 52].min
   end
   alias week week_of_year
 
@@ -78,11 +90,10 @@ class IfcDate
   alias mday day_of_month
 
   # Return the month in index of the year.
-  # NOTE Januari will be 1, so different indexing thant the wday
+  # NOTE January will be 1, so different indexing thant the wday
   def month_of_year
-    return 13 if day_of_year > 364 # prevent 14
-    return 6 if leap_year? && day_of_year == 169
-    day_of_year_divmod_twenty_eight[0] + 1
+    # The min operation if for the year day, which would be 14, but is appended to month 13
+    [day_of_year_divmod_twenty_eight[0] + 1, 13].min
   end
   alias month month_of_year
 
@@ -101,4 +112,9 @@ class IfcDate
   def abbr_month_name
     ABBR_MONTHNAMES[month_of_year]
   end
+
+  def inspect
+    "#{year.to_s}-#{month_of_year.to_s.rjust(2, '0')}-#{day_of_month.to_s}"
+  end
+  alias to_s inspect
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ifc_date
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin ter Kuile
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-07-02 00:00:00.000000000 Z
 dependencies: []
 description: Ruby implementation of the International Fixed Calendar system. Other
   name references are Cotsworth and Eastman
@@ -28,6 +28,7 @@ files:
 - lib/ifc_date.rb
 - lib/ifc_date/class_methods.rb
 - lib/ifc_date/ext/to_ifc.rb
+- lib/ifc_date/instance_methods.rb
 - lib/ifc_date/version.rb
 - sig/ifc_date.rbs
 homepage: https://gitlab.com/benja-2/ifc_date