ifc_date 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89ca22bbc889e7505098ed029e28ddde175726a4405e656db1562efecd0fd1dc
-  data.tar.gz: 240078f8a04ed2f6c2ba24f5d61417435824443008ec40719a92e5ac186d5f5c
+  metadata.gz: 6979a62fb8321d9418b5789cc02303e536abcc042350412d538158b979370557
+  data.tar.gz: aa6d5344f97499fc6f173ba790a615e76507a092eec2b8b3d5af8b0f9af1cb05
 SHA512:
-  metadata.gz: ba2e63ce4cb6e4600069b57479d800b9b20368046c3d3535aece77e4559aeb6c278f2540e11bd7cb0646e34322b4acff6bc2260ad67c6349b48f3d3e74dd6296
-  data.tar.gz: f796584f34048013d885d9449a3411ace6c5790fa66d53530366f8fc2812e03ca1f5e56214c379674746ff2d465077f40d992589c26105428ec51c78b1bdd3c7
+  metadata.gz: 51e4513597bc76020664126c47fac826e56f048a16ec74897d4afe9f07d38f14b4c856567ebf5e2bc537ad1d8d0bed7f92d3d012473def43f2c0cd7973e0ef7f
+  data.tar.gz: 5ff49d42a1b8cb58e552617b2ecce0a85341490932e273a24b85a462368b5c3b4e3249c832a7f99307bf9b01daf2ac07d90ee4cc3fb9da21f750368739f31b0d

data/README.md

@@ -33,6 +33,55 @@ or from a standard `Date` object
   Date.today.ifc
 ```
 
+### Concepts
+It is really important to know how the indices of the different time units are:
+
+#### starday?
+```ruby
+  ifc_date.starday?
+```
+This is a concept introduced in this project. Since there is already a Moonday and a Sunday,
+The intermittant days, Year day and Leap day can be called Starday, it works in the code.
+
+#### day_of_year, yday
+```ruby
+  ifc_date.day_of_year # alias ifc_date.yday
+```
+This is the day of the year, ranges from 1-365 for non leap year, 1-366 for leap year.
+
+#### day_of_week, wday
+```ruby
+  ifc_date.day_of_week # alias ifc_date.wday
+```
+This is the day of the week. Ranges from 0-6, Indicating Sunday-Saturday.
+There is no days starting on Monday concept.
+When it is Starday a 7 will be returned.
+This will work in the `ifc_date.day_name` and `ifc_date.abbr_day_name` methods
+
+#### week_of_year, week
+```ruby
+  ifc_date.week_of_year # alias ifc_date.week
+```
+This returns the number of the week of the year. Ranges from 1-52. Note that the legacy date system
+can have week numbers 53 both in December and Januari, this will be the past.
+
+At the moment on a Starday the week number will return 0. Personally I might prefer to add the
+Starday week\_of\_year number to the week number that preceeds it. But I still have to
+investigate the validity of this one based on the specs.
+
+#### day_of_month, mday
+```ruby
+  ifc_date.day_of_month # alias ifc_date.mday
+```
+This returns the index of the day in the month. Ranges 1-28
+
+#### month_of_year, month
+```ruby
+  ifc_date.month_of_year # alias ifc_date.month
+```
+This returns the index of the month in the year. Ranges 1-13.
+The Starday days are added to the month number that preceeds those days as day number 29.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ifc_date/class_methods.rb

@@ -5,6 +5,8 @@ module IfcDateClassMethods
     (year % 400).zero?
   end
 
+  # Do not execute computational expensive operations more than once.
+  # 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}"

data/lib/ifc_date/version.rb

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

data/lib/ifc_date.rb

@@ -73,8 +73,6 @@ class IfcDate
 
   def day_of_month
     return 29 if starday?
-    #remainder = day_of_year_divmod_twenty_eight[1]
-    #remainder.zero? ? 28 : remainder
     day_of_year_divmod_twenty_eight[1] + 1
   end
   alias mday day_of_month

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ifc_date
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Benjamin ter Kuile