Merge pull request #13 from tithely/mv/IN-2466/add-fund-methods-that-we-need

feat: [IN-2466] add status? and active? to funds

Author: Tjaay

.rubocop.yml

@@ -65,6 +65,8 @@ Layout/EmptyLinesAroundModuleBody:
 # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
 Style/HashSyntax:
   Enabled: true
+  EnforcedStyle: ruby19
+  EnforcedShorthandSyntax: never # Ruby 3.1 allows omission of value name, but we want to support prior Ruby versions
 
 Layout/FirstArgumentIndentation:
   Enabled: true

.tool-versions

@@ -1 +1,2 @@
-ruby 3.0.6
+ruby 3.3.5
+

CHANGELOG.md

@@ -7,6 +7,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+1. Adds `Entity::Fund` `active?` and `default?` interrogatives
+
+## [4.0.1] - 2024-09-13
+
+This version adds support for Ruby 3.3.5. No real changes were required. We just needed to add some gems to the gemspec
+to silence deprecation warnings.
+
+### Added
+
+1. Add dependencies which will be removed from a future version of Ruby. (IN-2512)
+
+## [4.0.0] - 2024-09-11
+
+### Changed
+
+1. Update ActiveSupport Version to support Rails 7. (IN-2109)
+
 ## [3.0.1] - 2024-09-09
 
 ### Changed

Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    faithteams-api (3.0.1)
-      activesupport (>= 6.1.7)
+    faithteams-api (4.1.1)
+      activesupport (>= 7.0.8, <= 7.1.5.1)
       http (~> 5.1)
+      logger (~> 1.6.1)
+      ostruct (~> 0.6.0)
       rexml (~> 3.3.6)
 
 GEM
@@ -87,6 +89,7 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    ostruct (0.6.1)
     parallel (1.26.3)
     parser (3.3.6.0)
       ast (~> 2.4.1)
@@ -136,7 +139,7 @@ GEM
     rubocop-rspec (1.42.0)
       rubocop (>= 0.87.0)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.2)
+    securerandom (0.4.1)
     shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)

faithteams-api.gemspec

@@ -32,8 +32,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 6.1.7"
+  spec.add_dependency "activesupport", ">= 7.0.8", "<= 7.1.5.1"
   spec.add_dependency "http", "~> 5.1"
+  spec.add_dependency "logger", "~> 1.6.1"
+  spec.add_dependency "ostruct", "~> 0.6.0"
   spec.add_dependency "rexml", "~> 3.3.6" # only needs to be specified to address security warning
 
   spec.add_development_dependency "byebug", "~> 11.1"

lib/faithteams/api/v2/entity/fund.rb

@@ -11,6 +11,11 @@ def default
             read_attribute(:isDefault).presence
           end
 
+          # @return [Boolean]
+          def default?
+            default == "Y"
+          end
+
           # @return [String, nil]
           def description
             read_attribute(:description).presence
@@ -41,6 +46,11 @@ def status
             read_attribute(:status).presence
           end
 
+          # @return [Boolean]
+          def active?
+            status == "A"
+          end
+
           # @return [String, nil] "T" for true?, "Y" for yes?
           def tax_deductible
             read_attribute(:taxDeductible).presence

lib/faithteams/version.rb

@@ -2,5 +2,5 @@
 
 module FaithTeams
   # Current version number.
-  VERSION = "3.0.1"
+  VERSION = "4.1.1"
 end

spec/faithteams/api/v2/entity/fund_spec.rb

@@ -22,6 +22,21 @@
     end
   end
 
+  describe "#default?" do
+    context "when default is 'Y'" do
+      it "returns true" do
+        fund = described_class.new(attributes: { "isDefault" => "Y" })
+        expect(fund).to be_default
+      end
+    end
+
+    context "when default isn't 'Y'" do
+      it "returns false" do
+        expect(fund).not_to be_default
+      end
+    end
+  end
+
   describe "description" do
     it "is a String" do
       expect(fund.description).to be_instance_of(String)
@@ -64,6 +79,21 @@
     end
   end
 
+  describe "#active?" do
+    context "when status is 'A'" do
+      it "returns true" do
+        expect(fund).to be_active
+      end
+    end
+
+    context "when status isn't 'A'" do
+      it "returns false" do
+        fund = described_class.new(attributes: { "status" => "I" })
+        expect(fund).not_to be_active
+      end
+    end
+  end
+
   describe "tax_deductible" do
     it "is a String" do
       expect(fund.tax_deductible).to be_instance_of(String)