fat_period 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875ad1917477c27f17278fb0d5aad18423f4dcf52f32c9957651c829a1164f4b
-  data.tar.gz: 1495e04adb60e49dfc26f1b94c9699a129f30b7a15c36e9fa82d0e68d87ed183
+  metadata.gz: 0e3eda6535209cd894a7d4dae2e4185e6a7ca7890bedca9662e5a017b38fa6cc
+  data.tar.gz: c7d3a27c9ea484f3ba68988627e84b42c9fa1916cc496a823afcdf8321be3084
 SHA512:
-  metadata.gz: f7e5ece151032b3ce11aad94225ef649c9e217a2d9239406f3ef030b335169cc33a130ff860b11b65a2e9d90ab4d9f900eb6df713f904beb9d841a7068ebcb96
-  data.tar.gz: 91a94d16666150d0eba4cd4bd5cb24813150d714f2e534a15746bd70119e87996d39940d8da40c5ab7589707975fe53f60a53cd4ae7d9bd58254b710d7d3c4ee
+  metadata.gz: 58a7f0386cc6b84ca713bc4ff1775af9c08e5b0fe95b3125d2cd9ff2ea2495e9440ad845d37517822b07e4eebdb813a44979522b58f146997aab40665051c46e
+  data.tar.gz: 937c97b9d3c3a359854f85d3ba611882d86f1fb4f7d27213820b53a4f93e82edad05cf1385a33da28d3fcfbf6a34cc86ee7a19f6139c5141e25197ff4970fffe

data/.envrc

@@ -1,5 +1,4 @@
 PATH_add .bundle/bin
-PATH_add ./scripts
 # Ensure that we use the development DB when in the src dir.
 export DB=development
 export COMPOSE_FILE=.devcontainer/docker-compose.yml

data/.github/workflows/ruby.yml

@@ -0,0 +1,57 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby CI (setup-ruby)
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        # Supported stable series; setup-ruby selects the latest patch release.
+        # https://www.ruby-lang.org/en/downloads/branches/
+        ruby: ['3.3', '3.4', '4.0']
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v7
+
+      - name: Install build dependencies (needed if Ruby must be compiled)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            build-essential autoconf bison libssl-dev libreadline-dev \
+            zlib1g-dev libyaml-dev libffi-dev libgdbm-dev libncurses5-dev \
+            libgmp-dev pkg-config
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Verify Ruby
+        run: |
+          ruby -v
+          gem -v
+        shell: bash
+
+      - name: Install gems
+        run: |
+          gem install bundler --conservative
+          # optional: use vendor/bundle to keep gems within repo workspace
+          bundle config set --local path 'vendor/bundle' || true
+          bundle install --jobs 4 --retry 3
+        shell: bash
+
+      - name: Run tests
+        run: bundle exec rake
+        shell: bash

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+/.yardopts

data/.rubocop.yml

@@ -0,0 +1,3 @@
+# Inherit the shared config from the rubocop-ddoherty gem (git-hosted on GitHub)
+inherit_gem:
+  rubocop-ddoherty: 'config/default.yml'

data/CHANGELOG.org

@@ -0,0 +1,43 @@
+* Version 3.1.0
+- Add ~Period#year_fraction~ to calculate a ~BigDecimal~ interest-accrual
+  factor from the period's start to a payment or settlement date. Support
+  twelve day-count conventions: four 30/360 variants, Actual/Actual ICMA,
+  Actual/Actual ISDA, Actual/365 Fixed, Actual/360, Actual/364, Actual/365L,
+  Actual/Actual AFB, and 1/1. Default to 30/360 US (~convention: 1~).
+- Support optional February end-of-month adjustments for 30/360 US and a
+  maturity-date exception for 30E/360 ISDA. Require settlement to fall
+  within the period; ICMA supports regular coupon periods only.
+- Add ~Period#freq_per_year~ to infer payment frequency from period length.
+- Document the conventions and examples in ~README.org~, with references
+  to Wikipedia and Section 4.16 of the /2006 ISDA Definitions/. Add specs
+  covering month ends, leap years, maturity dates, and frequency boundaries.
+
+* Version 3.0.0
+- Use the newly-spun-out fat_date library in place of fat_core/date, which no
+  longer exists starting with fat_core version 6.0.0.
+- The fat_date library uses ~Date.spec~ instead of ~Date.parse_spec~, which is
+  just cleaner to type.
+- The new ~fat_date~ libraries come with some notable enhancements to date
+  specs, including:
+  1. Skip modifiers, which allow the spec to "skip" from its usual target date
+     to the nearest day-of-week, either before or after the target date, and
+     either including or not including the target date as a candidate.
+  2. Changes the semimonth specifier from uppercase roman to A or B, so
+     2025-10-A (rather than 2025-I) is now the first semimonth for October,
+     2025, and 2025-10-B (rather than 2025-II) is now the second semimonth.
+     This allows week-of-month specs to be case insensitive, so 2025-10-i,
+     2025-10-ii, 2025-10-iii, 2025-10-iv, and 2025-10-v, can represent the
+     first through fifth week of October, 2025, as well as 2025-10-I,
+     2025-10-II, 2025-10-III, 2025-10-IV, and 2025-10-V.
+  3. In general, all the spec involving letters should now be case insensitive.
+- Some other code cleanup with no impact on the API.
+
+* Version 2.1.0
+- When the first date is later than the second in ~Period.new~, raise
+  ~ArgumentError~ exception instead of returning nil.
+- Allow ~Period.parse_phrase~ to parse a 'per' clause and return an Array of
+  Periods that are sub-periods of the period given by the from- and
+  to-clauses.
+- Add ~Period.ensure(arg)~ to try to return a ~Period~ from a string that can
+  be parsed as a ~Period~, an object that has a ~to_period~ method, or return
+  the ~arg~ if its already a ~Period~.

data/Gemfile

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fat_period.gemspec
 gemspec
 
-gem 'bundler'
-gem 'debug'
-gem 'pry'
-gem 'pry-doc'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
-gem 'rubocop-rspec'
-gem 'rubocop-performance'
-gem 'rubocop-rake'
-gem 'rubocop-shopify'
+group :development do
+  gem 'bundler'
+  gem 'debug'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', require: false
+  gem 'rubocop-ddoherty', git: 'https://github.com/ddoherty03/rubocop-ddoherty.git', branch: 'master', require: false
+  gem 'gem_docs', '>=0.2.0'
+end