fat_date 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e319d0c13b150c6d36c003eae0a64a38bc0f1c5b37321d934d7b40641655cf95
-  data.tar.gz: d1c54d5d42a15b54e27801f0a68daf7a688c0925e87502947fddebcc0b2efba2
+  metadata.gz: 452b9656245ca0f24843e11235d7dd515d3d2e45c3900997770cc5ebaca634f8
+  data.tar.gz: 0b4cb43b3a743b1086f51002caa6264a980e6dc08d8c0154d39a16514ed60a27
 SHA512:
-  metadata.gz: 986a61f5d321817430db1b26b1c8ac009137e13043d766376d958b9375850772441ee61c0227138e3a869b917ec2d38d4dcbf1ca228981a0b26cb4cf90796110
-  data.tar.gz: ff2b2d927d576bc626408a577adec18d55d0501844af140096d60b19513f244239454b31f6a98cb2c27c3aa4bbc8d2cfd371a6f483a2b3c6db7773a5a46454af
+  metadata.gz: 81ad8559c9c4663fa7c65fa0d27bc649a48cb9083f3c50517cc01e55e1ee765fd5b47a7125736a85fc396c1cf38016a1c528873dabab713a94dd67417fde2945
+  data.tar.gz: b4de5c7866c14cb16d8b5d5bd8f4ee80d0e8f37c6b059666766a3c9916b2d2394d6fd38e332c3dd78c99e907501a2407f4fd2a9d7c20b27c8d86d673fc5f1484

data/.rubocop.yml

@@ -1,9 +1,3 @@
-inherit_from:
-  - ~/.rubocop.yml
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-Style/BitwisePredicate:
-   Enabled: false
+# Inherit the shared config from the rubocop-ddoherty gem (git-hosted on GitHub)
+inherit_gem:
+  rubocop-ddoherty: 'config/default.yml'

data/CHANGELOG.org

@@ -1,5 +1,7 @@
-## [Unreleased]
 
-## [0.1.0] - 2025-10-13
+* Version 0.1.4
+- Add DateTime.iso to print time/zone components.
 
-- Initial release
+* [0.1.3] - 2025-10-13
+- Initial release splitting the Date methods out of fat_core into this
+  separate gem.

data/README.org

@@ -1,45 +1,105 @@
 #+TITLE: FatDate Guide
 #+OPTIONS: toc:5
-#+PROPERTY: header-args:ruby :colnames no :hlines yes :exports both :wrap example :ruby ruby
+#+PROPERTY: header-args:ruby :colnames no :session fatdate :hlines yes :exports both :wrap example :ruby "bundle exec irb --prompt=simple"
 #+PROPERTY: header-args:sh :exports code
 
-[[https://travis-ci.org/ddoherty03/fat_core.svg?branch=master]]
 
-* README Setup Do First for Code Blocks                            :noexport:
+[[https://github.com/ddoherty03/fat_date/actions/workflows/ruby.yml][https://github.com/ddoherty03/fat_date/actions/workflows/ruby.yml/badge.svg?branch=master]]
+
+,#+BEGIN_COMMENT
+
+* Setup for Code Blocks                            :noexport:
 Run this block before all others to ensure that we are reading the libraries
 from the source directory.
 
 #+begin_src ruby :results output :export no
   puts "Current directory: #{Dir.pwd}"
   puts "Ruby LOADPATH:"
-  $:.unshift("./lib") unless $:[0] == './lib'
+  $LOAD_PATH.unshift(File.expand_path("lib", Dir.pwd)) unless $:[0].match?(%r{src/fat_date/lib})
   $:[0..10].each { |d| puts d }
   puts "..."
-  require 'fat_date'  # => true
+  require 'fat_date'
 #+end_src
 
 #+RESULTS:
 #+begin_example
 Current directory: /home/ded/src/fat_date
 Ruby LOADPATH:
-./lib
+/home/ded/src/fat_date/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/bundler-2.6.7/lib
 /home/ded/.rbenv/rbenv.d/exec/gem-rehash
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/site_ruby/3.4.0
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/site_ruby/3.4.0/x86_64-linux
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/site_ruby
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/vendor_ruby/3.4.0
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/vendor_ruby/3.4.0/x86_64-linux
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/vendor_ruby
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/3.4.0
-/home/ded/.rbenv/versions/3.4.1/lib/ruby/3.4.0/x86_64-linux
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/simplecov-0.22.0/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/simplecov_json_formatter-0.1.4/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/simplecov-html-0.13.2/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/bundler/gems/rubocop-ddoherty-6b28e9614f18/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/rubocop-shopify-2.17.1/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/rubocop-rspec-3.7.0/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/rubocop-rake-0.7.1/lib
+/home/ded/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/rubocop-performance-1.26.1/lib
 ...
 #+end_example
 
+,#+END_COMMENT
+
+* Table of Contents                                                     :toc:
+- [[#fatdate][FatDate]]
+- [[#version][Version]]
+- [[#installation][Installation]]
+- [[#usage][Usage]]
+    - [[#constants][Constants]]
+    - [[#ensure][Ensure]]
+    - [[#formatting][Formatting]]
+    - [[#chunks][Chunks]]
+    - [[#parsing-american-dates][Parsing American Dates]]
+    - [[#holidays-and-workdays][Holidays and Workdays]]
+      - [[#federal][Federal]]
+      - [[#nyse][NYSE]]
+    - [[#ordinal-weekdays-in-month][Ordinal Weekdays in Month]]
+    - [[#easter][Easter]]
+    - [[#date-specs][Date Specs]]
+      - [[#given-day][Given Day]]
+      - [[#day-of-year][Day-of-Year]]
+      - [[#month][Month]]
+      - [[#year][Year]]
+      - [[#commercial-weeks-of-year][Commercial Weeks-of-Year]]
+      - [[#halves][Halves]]
+      - [[#quarters][Quarters]]
+      - [[#semi-months][Semi-Months]]
+      - [[#week-of-month][Week-of-Month]]
+      - [[#day-of-week][Day-of-Week]]
+      - [[#easter-based][Easter Based]]
+      - [[#relative-dates][Relative Dates]]
+      - [[#extremes][Extremes]]
+      - [[#skip-modifiers][Skip Modifiers]]
+      - [[#conventions][Conventions]]
+      - [[#examples][Examples]]
+- [[#contributing][Contributing]]
 
 * FatDate
+~fat_date~ collects core extensions for the Date class to make it more useful
+in financial applications, including:
+
+- determining when a =Date= is a federal or NYSE holiday with Presidential
+  decrees included,
+- determining when a =Date= is part of a larger calendar-related "chunk," such
+  as a year, half, quarter, bimonth, month, semimonth, or week,
+- calculating Easter for a =Date's= year, a date on which some "movable
+  feasts" depend, and
+- parsing so-called "specs" that allow the beginning or ending =Date= of a
+  larger period of time to be returned, a facility put to good use in the
+  [[https://github.com/ddoherty03/fat_period][FatPeriod]] gem.
+
+
+* Version
+
+#+begin_src ruby :results output
+  puts "#{FatDate::VERSION}"
+#+end_src
+
+#+begin_example
+0.1.3
+#+end_example
 
-~fat_date~ is a simple gem to collect core extensions for the Date class to
-make it more useful in financial applications.
 
 * Installation
 
@@ -58,7 +118,7 @@ And then execute:
 Or install it yourself as:
 
 #+begin_src shell
-  $ gem install fat_core
+  $ gem install fat_date
 #+end_src
 
 * Usage
@@ -87,9 +147,7 @@ a date argument but want the caller to be able to supply anything that can
 reasonably be converted to a ~Date~:
 
 #+begin_src ruby :results output
-  $:.unshift("~/src/fat_core/lib")
-  require 'fat_core/date'  # => true
-
+  # require 'fat_date'
   def tomorow_tomorrow(arg)
     from = Date.ensure(arg)  # => ArgumentError: cannot convert class 'Array' to a Date or DateTime
     from + 2.days            # => Mon, 03 Jun 2024, Wed, 16 Oct 2024 05:47:30 -0500, Sun, 03 Mar 2024
@@ -104,7 +162,7 @@ reasonably be converted to a ~Date~:
 
 #+begin_example
 2025-06-03
-2025-10-18T04:54:44-05:00
+2025-10-26T15:42:14-05:00
 2025-03-03
 #+end_example
 
@@ -113,7 +171,6 @@ reasonably be converted to a ~Date~:
 that are often useful:
 
 #+begin_SRC ruby :results output
-  require_relative './lib/fat_date'
   d = Date.parse('1957-09-22')
   puts "ISO: #{d.iso}"
   puts "All Numbers: #{d.num}"
@@ -134,6 +191,7 @@ English: September 22, 1957
 American: 9/22/1957
 #+end_example
 
+
 Most of these are self-explanatory, but a couple are not.  The
 ~Date.org(active: false)~ method formats a date as an Emacs org-mode
 timestamp, by default an inactive timestamp that does not show up in the org
@@ -163,8 +221,6 @@ as "chunks", and they are the following:
 or end of each of these chunks:
 
 #+begin_SRC ruby :results value
-  require_relative './lib/fat_date'
-
   tab = []
   tab << ['Subject Date', 'Method', 'Result']
   tab << nil
@@ -203,8 +259,6 @@ It also provides corresponding methods that return the date at the beginning
 or end of the calendar chunk, starting at the given date:
 
 #+begin_SRC ruby
-  require './lib/fat_date'
-
   tab = []
   tab << ['Subject Date', 'Method', 'Result']
   tab << nil
@@ -239,11 +293,10 @@ or end of the calendar chunk, starting at the given date:
 | 2017-04-21   | d.end_of_week            | 2017-04-23 |
 #+end_example
 
+
 You can query which numerical half, quarter, etc. that a given date falls in:
 
 #+begin_SRC ruby
-  require './lib/fat_date'
-
   tab = []
   tab << ['Subject Date', 'Method', 'Result']
   tab << nil
@@ -258,14 +311,14 @@ You can query which numerical half, quarter, etc. that a given date falls in:
 #+begin_example
 | Subject Date | Method      | Result                 |
 |--------------+-------------+------------------------|
-| 2017-07-26   | d.year      | in year number 2017    |
-| 2017-06-01   | d.half      | in half number 1       |
-| 2017-07-08   | d.quarter   | in quarter number 3    |
-| 2017-04-30   | d.bimonth   | in bimonth number 2    |
-| 2017-05-01   | d.month     | in month number 5      |
-| 2017-05-18   | d.semimonth | in semimonth number 10 |
-| 2017-05-21   | d.biweek    | in biweek number 10    |
-| 2017-07-01   | d.week      | in week number 26      |
+| 2017-07-29   | d.year      | in year number 2017    |
+| 2017-06-10   | d.half      | in half number 1       |
+| 2017-07-17   | d.quarter   | in quarter number 3    |
+| 2017-06-03   | d.bimonth   | in bimonth number 3    |
+| 2017-06-28   | d.month     | in month number 6      |
+| 2017-06-18   | d.semimonth | in semimonth number 12 |
+| 2017-05-17   | d.biweek    | in biweek number 10    |
+| 2017-07-08   | d.week      | in week number 27      |
 #+end_example
 
 *** Parsing American Dates
@@ -275,8 +328,6 @@ will parse such a string as d/M/Y, often resulting in invalid date errors.
 such strings.
 
 #+begin_SRC ruby :results output
-  require './lib/fat_date'
-
   begin
     ss = '9/22/1957'
     Date.parse(ss)
@@ -320,9 +371,6 @@ Methods concerning Federal holidays:
   we hit a Federal workday
 
 #+begin_SRC ruby
-  require './lib/fat_date'
-
-
   result = []
   result << ['Date', 'Federal Holiday?', 'Comment']
   result << nil
@@ -356,8 +404,6 @@ And we have similar methods for "holidays" or non-trading days on the NYSE:
 Likewise, days on which the NYSE is closed can be gotten with:
 
 #+begin_SRC ruby :results output
-  require './lib/fat_date'
-
   puts Date.parse('2014-04-18').nyse_holiday?
 #+end_SRC
 
@@ -366,8 +412,6 @@ true
 #+end_example
 
 #+begin_SRC ruby :results value
-  require './lib/fat_date'
-
   date_comments = [
     ['2014-04-18', 'Good Friday'],
     ['2014-05-18', 'Weekend'],
@@ -400,8 +444,6 @@ wday, year, month)~ to return such dates.  The first parameter can be
 negative, which will count from the end of the month.
 
 #+begin_src ruby
-  require './lib/fat_date'
-
   results = []
   results << ['n', 'Year', 'Month', 'nth Thursday']
   results << nil
@@ -448,8 +490,6 @@ the reform happened after Easter in 1752.
 - Date#easter? :: return whether the subject Date is Easter.
 
 #+begin_src ruby
-  require './lib/fat_date'
-
   yrs = [800, 1000, 1200, 1400, 1500, 1600, 1800, 2000]
   result = []
   result << ['Year', 'Easter Date']
@@ -473,7 +513,6 @@ the reform happened after Easter in 1752.
 | 2000 | [2000-04-23 Sun] |
 #+end_example
 
-
 *** Date Specs
 It is often desirable to get the first or last date of a specified time
 period.  For this ~FatDate~ provides the ~spec~ method that takes a string and
@@ -636,10 +675,9 @@ Some things to note with respect to ~Date.spec~:
 6. 'fortnight' is a synonym for a biweek.
 
 **** Examples
+The following examples demonstrate all of the date specs available.
 
 #+begin_src ruby results :value
-  require './lib/fat_date'
-
   strs = ['today', '2024-07-04', '2024-05', '2024', '2024-333',
          '08', '08-12', '2024-W36', '2024-36W', 'W36', '36W',
          '2024-1H', '2024-2H', '1H', '2H',
@@ -665,7 +703,7 @@ Some things to note with respect to ~Date.spec~:
 #+begin_example
 | Spec            | From             | To               |
 |-----------------+------------------+------------------|
-| 'today'         | [2025-10-16 Thu] | [2025-10-16 Thu] |
+| 'today'         | [2025-10-24 Fri] | [2025-10-24 Fri] |
 | '2024-07-04'    | [2024-07-04 Thu] | [2024-07-04 Thu] |
 | '2024-05'       | [2024-05-01 Wed] | [2024-05-31 Fri] |
 | '2024'          | [2024-01-01 Mon] | [2024-12-31 Tue] |
@@ -711,9 +749,10 @@ Some things to note with respect to ~Date.spec~:
 | '2025-E+50>=Su' | [2025-06-15 Sun] | [2025-06-15 Sun] |
 #+end_example
 
+
 * Contributing
 
-1. Fork it ([[http://github.com/ddoherty03/fat_core/fork]]  )
+1. Fork it ([[http://github.com/ddoherty03/fat_date/fork]]  )
 2. Create your feature branch (~git checkout -b my-new-feature~)
 3. Commit your changes (~git commit -am 'Add some feature'~)
 4. Push to the branch (~git push origin my-new-feature~)

data/Rakefile

@@ -5,8 +5,22 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+########################################################################
+# Rubocop tasks
+########################################################################
+# Option A (recommended): Keep using Bundler and run rubocop via `bundle exec`.
+# This wrapper task ensures the rubocop run uses the gems from your Gemfile,
+# even when you invoke `rake rubocop` (no need to remember `bundle exec rake`).
+#
+# You can pass extra RuboCop CLI flags with the RUBOCOP_OPTS environment variable:
+#   RUBOCOP_OPTS="--format simple" rake rubocop
 
-RuboCop::RakeTask.new
+desc "Run rubocop under `bundle exec`"
+task :rubocop do
+  opts = (ENV['RUBOCOP_OPTS'] || '').split
+  Bundler.with_unbundled_env do
+    sh 'bundle', 'exec', 'rubocop', *opts
+  end
+end
 
-task default: %i[spec rubocop]
+task :default => [:spec, :rubocop]

data/lib/fat_date/date.rb

@@ -2011,7 +2011,7 @@ module FatDate
       #
       # @param dat [String, Date, Time] the object to be converted to Date
       # @return [Date, DateTime]
-      def ensure_date(dat)
+      def ensure(dat)
         if dat.is_a?(Date) || dat.is_a?(DateTime)
           dat
         elsif dat.is_a?(Time)
@@ -2030,22 +2030,19 @@ module FatDate
           raise ArgumentError, "cannot convert class '#{dat.class}' to a Date or DateTime"
         end
       end
+
+      alias_method :ensure_date, :ensure
     end
 
+    # Extend the Date class methods with the FatDate::ClassMethods methods
+    # when this module is included.
     def self.included(base)
       base.extend(ClassMethods)
     end
   end
 end
 
-# Include the FatDate methods in Date and extend the Date class methods with
-# the FatDate::ClassMethods methods.
+# Include the FatDate methods in Date.
 class Date
   include FatDate::Date
-
-  def self.ensure(dat)
-    ensure_date(dat)
-  end
-  # @!parse include FatDate::Date
-  # @!parse extend FatDate::Date::ClassMethods
 end

data/lib/fat_date/datetime.rb

@@ -0,0 +1,15 @@
+module FatDate
+  module DateTime
+    # Format as an ISO string of the form `YYYY-MM-DD`.
+    # @return [String]
+    def iso
+      strftime('%Y-%m-%dT%H:%M:%S.%3N%:%z')
+    end
+  end
+end
+
+# Include the FatDate methods in Date and extend the Date class methods with
+# the FatDate::ClassMethods methods.
+class DateTime
+  include FatDate::DateTime
+end

data/lib/fat_date/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FatDate
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/fat_date.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'active_support'
-# require 'active_support/core_ext/object/blank'
-# require 'active_support/core_ext/object/deep_dup'
 require "active_support/isolated_execution_state"
 require "active_support/core_ext/date"
 require "active_support/core_ext/time"
@@ -14,5 +12,4 @@ require 'fat_core/string'
 require_relative "fat_date/version"
 require_relative "fat_date/patches"
 require_relative "fat_date/date"
-
-require 'debug'
+require_relative "fat_date/datetime"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fat_date
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel E. Doherty
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fat_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   FatDate provides useful extensions to the Date class including a way to
   specify dates via a number of rich 'specs', strings that allow specifying
@@ -44,6 +58,7 @@ files:
 - Rakefile
 - lib/fat_date.rb
 - lib/fat_date/date.rb
+- lib/fat_date/datetime.rb
 - lib/fat_date/patches.rb
 - lib/fat_date/version.rb
 - sig/fat_date.rbs
@@ -67,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Useful extensions to the Date class.
 test_files: []