Merge pull request #148 from Bananapus/name/upcomingOf

rulesets.upcomingOf instead of rulesets.upcomingRulesetOf

src/JBController.sol

@@ -210,7 +210,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         override
         returns (JBRuleset memory ruleset, JBRulesetMetadata memory metadata)
     {
-        ruleset = RULESETS.upcomingRulesetOf(projectId);
+        ruleset = RULESETS.upcomingOf(projectId);
         metadata = ruleset.expandMetadata();
     }
 
@@ -664,7 +664,7 @@ contract JBController is JBPermissioned, ERC2771Context, IJBController, IJBMigra
         JBRuleset memory ruleset = RULESETS.currentOf(projectId);
 
         // If there's no current ruleset, get a reference to the upcoming one.
-        if (ruleset.id == 0) ruleset = RULESETS.upcomingRulesetOf(projectId);
+        if (ruleset.id == 0) ruleset = RULESETS.upcomingOf(projectId);
 
         // If owner minting is disabled for the ruleset, the owner cannot change the token.
         if (!ruleset.allowSetCustomToken()) revert RULESET_SET_TOKEN_DISABLED();

src/JBRulesets.sol

@@ -184,7 +184,7 @@ contract JBRulesets is JBControlled, IJBRulesets {
     /// @dev If an upcoming ruleset is not found for the project, returns an empty ruleset with all properties set to 0.
     /// @param projectId The ID of the project to get the upcoming ruleset of.
     /// @return ruleset The struct for the project's upcoming ruleset.
-    function upcomingRulesetOf(uint256 projectId) external view override returns (JBRuleset memory ruleset) {
+    function upcomingOf(uint256 projectId) external view override returns (JBRuleset memory ruleset) {
         // If the project does not have a latest ruleset, return an empty struct.
         // slither-disable-next-line incorrect-equality
         if (latestRulesetIdOf[projectId] == 0) return _getStructFor(0, 0);

src/interfaces/IJBRulesets.sol

@@ -38,7 +38,7 @@ interface IJBRulesets {
         view
         returns (JBRuleset[] memory rulesets);
 
-    function upcomingRulesetOf(uint256 projectId) external view returns (JBRuleset memory ruleset);
+    function upcomingOf(uint256 projectId) external view returns (JBRuleset memory ruleset);
 
     function currentOf(uint256 projectId) external view returns (JBRuleset memory ruleset);
 

test/TestRulesetQueueing.sol

@@ -241,7 +241,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         vm.warp(_ruleset.start + _ruleset.duration - 1);
 
         // Make sure the queued ruleset is the second one queued.
-        JBRuleset memory queuedRuleset = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory queuedRuleset = jbRulesets().upcomingOf(projectId);
         assertEq(queuedRuleset.cycleNumber, 3);
         assertEq(queuedRuleset.id, secondRulesetId);
         assertEq(queuedRuleset.weight, _weightSecondQueued);
@@ -277,7 +277,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         // Keep a reference to the initial, current, and queued rulesets.
         JBRuleset memory initialRuleset = jbRulesets().currentOf(projectId);
         JBRuleset memory currentRuleset = initialRuleset;
-        JBRuleset memory upcomingRuleset = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory upcomingRuleset = jbRulesets().upcomingOf(projectId);
 
         for (uint256 i = 0; i < _RULESET_DURATION_DAYS + 1; i++) {
             // If the deadline is less than the ruleset's duration, make sure the current ruleset's weight is linearly
@@ -303,7 +303,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
 
             // Get a reference to the current and upcoming rulesets.
             currentRuleset = jbRulesets().currentOf(projectId);
-            upcomingRuleset = jbRulesets().upcomingRulesetOf(projectId);
+            upcomingRuleset = jbRulesets().upcomingOf(projectId);
 
             // Get a list of queued rulesets
             JBRuleset[] memory rulesetsOf = jbRulesets().rulesetsOf(projectId, 0, 1);
@@ -328,7 +328,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
                 assertEq(currentRuleset.weight, _config[0].weight);
 
                 // Make the upcoming is the cycled over version of current.
-                upcomingRuleset = jbRulesets().upcomingRulesetOf(projectId);
+                upcomingRuleset = jbRulesets().upcomingOf(projectId);
                 assertEq(upcomingRuleset.weight, _config[0].weight);
             }
             // If the deadline duration is across many rulesets.
@@ -528,7 +528,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         _controller.queueRulesetsOf(projectId, _firstQueued, "");
 
         // Make sure the ruleset is queued.
-        JBRuleset memory _queued = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory _queued = jbRulesets().upcomingOf(projectId);
         assertEq(_queued.cycleNumber, 2);
         assertEq(_queued.id, _initialRulesetId + 1);
         assertEq(_queued.weight, _weightFirstQueued);
@@ -558,7 +558,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         _controller.queueRulesetsOf(projectId, _secondQueued, "");
 
         // Make sure this latest queued ruleset implies a cycled over ruleset from ruleset #1.
-        JBRuleset memory _requeued = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory _requeued = jbRulesets().upcomingOf(projectId);
         assertEq(_requeued.cycleNumber, 2);
         assertEq(_requeued.id, _initialRulesetId);
         assertEq(_requeued.weight, _weightInitial);
@@ -579,7 +579,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         assertEq(_initialIsCurrent.weight, _weightInitial);
 
         // Second queued ruleset that replaced our first queued ruleset.
-        JBRuleset memory _requeued2 = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory _requeued2 = jbRulesets().upcomingOf(projectId);
         assertEq(_requeued2.cycleNumber, 3);
         assertEq(_requeued2.id, _initialRulesetId + 2);
         assertEq(_requeued2.weight, _weightSecondQueued);
@@ -638,7 +638,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         _controller.queueRulesetsOf(projectId, _firstQueued, "");
 
         // Get a reference to the queued cycle.
-        JBRuleset memory queuedToOverwrite = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory queuedToOverwrite = jbRulesets().upcomingOf(projectId);
 
         assertEq(queuedToOverwrite.cycleNumber, 2);
         assertEq(queuedToOverwrite.id, _expectedRulesetId + 1);
@@ -661,7 +661,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         _controller.queueRulesetsOf(projectId, _secondQueued, "");
 
         // Make sure it's overwritten.
-        JBRuleset memory queued = jbRulesets().upcomingRulesetOf(projectId);
+        JBRuleset memory queued = jbRulesets().upcomingOf(projectId);
         assertEq(queued.cycleNumber, 2);
         assertEq(queued.id, _expectedRulesetId + 2);
         assertEq(queued.weight, _weightSecondQueued);
@@ -722,7 +722,7 @@ contract TestRulesetQueuing_Local is TestBaseWorkflow {
         assertEq(currentRuleset.weight, _weight);
 
         // get upcoming ruleset
-        JBRuleset memory upcomingRuleset = jbRulesets().upcomingRulesetOf(id);
+        JBRuleset memory upcomingRuleset = jbRulesets().upcomingOf(id);
 
         // check: upcoming ruleset should be 2nd queued
         assertEq(upcomingRuleset.weight, _weight + 100);

test/trees/JBRulesets/upcomingRulesetOf.tree

@@ -1,4 +1,4 @@
-TestUpcomingRulesetOf_Local
+TestUpcomingOf_Local
 ├── when latest ruleset Id EQ zero
 │   └── it will return an empty ruleset
 ├── when upcoming ruleset Id DNEQ zero

test/units/static/JBController/TestRulesetViews.sol

@@ -135,7 +135,7 @@ contract TestRulesetViews_Local is JBControllerSetup {
         assertEq(rulesetsArray[0].weight, queuedRulesets[0].ruleset.weight);
     }
 
-    function test_upcomingRulesetOf() external {
+    function test_upcomingOf() external {
         // setup: return data
         JBRuleset memory data = JBRuleset({
             cycleNumber: 1,
@@ -150,7 +150,7 @@ contract TestRulesetViews_Local is JBControllerSetup {
         });
 
         // setup: mock call
-        bytes memory _encodedCall = abi.encodeCall(IJBRulesets.upcomingRulesetOf, (1));
+        bytes memory _encodedCall = abi.encodeCall(IJBRulesets.upcomingOf, (1));
         bytes memory _willReturn = abi.encode(data, JBApprovalStatus.Empty);
 
         mockExpect(address(rulesets), _encodedCall, _willReturn);

test/units/static/JBController/TestSetTokenFor.sol

@@ -133,7 +133,7 @@ contract TestSetTokenFor_Local is JBControllerSetup {
         mockExpect(address(rulesets), _currentRulesetCall, abi.encode(ruleset));
 
         // Will check the upcoming ruleset
-        mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.upcomingRulesetOf, (1)), abi.encode(upcoming));
+        mockExpect(address(rulesets), abi.encodeCall(IJBRulesets.upcomingOf, (1)), abi.encode(upcoming));
 
         _controller.setTokenFor(_projectId, _token);
     }

test/units/static/JBRulesets/TestUpcomingRulesetOf.sol

@@ -4,7 +4,7 @@ pragma solidity 0.8.23;
 import /* {*} from */ "../../../helpers/TestBaseWorkflow.sol";
 import {JBRulesetsSetup} from "./JBRulesetsSetup.sol";
 
-contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
+contract TestUpcomingOf_Local is JBRulesetsSetup {
     // Necessary params
     JBRulesetMetadata private _metadata;
     JBRulesetMetadata private _metadataWithApprovalHook;
@@ -71,7 +71,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
     function test_WhenLatestRulesetIdEQZero() external {
         // it will return an empty ruleset
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, 0);
     }
 
@@ -162,7 +162,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             abi.encode(JBApprovalStatus.ApprovalExpected)
         );
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, block.timestamp + 1); // timestamp + 1 = second queued, since the preceeding ruleset is
             // in
     }
@@ -179,7 +179,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             abi.encode(JBApprovalStatus.Active)
         );
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, block.timestamp); // first queued, since the preceeding ruleset approval hook is still
             // "Active"
     }
@@ -230,7 +230,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             mustStartAtOrAfter: block.timestamp + 10 days
         });
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, block.timestamp);
     }
 
@@ -311,7 +311,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
 
         vm.warp(block.timestamp + 11 days);
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, 0);
     }
 
@@ -327,7 +327,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             abi.encode(JBApprovalStatus.Approved)
         );
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, block.timestamp + 1); // timestamp + 1 = second queued
     }
 
@@ -346,7 +346,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             abi.encode(JBApprovalStatus.Failed)
         );
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, block.timestamp); // first timestamp = first queued
     }
 
@@ -437,7 +437,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
 
         vm.warp(block.timestamp + 11 days);
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, 0);
     }
 
@@ -514,7 +514,7 @@ contract TestUpcomingRulesetOf_Local is JBRulesetsSetup {
             abi.encode(JBApprovalStatus.Failed)
         );
 
-        JBRuleset memory _upcoming = _rulesets.upcomingRulesetOf(_projectId);
+        JBRuleset memory _upcoming = _rulesets.upcomingOf(_projectId);
         assertEq(_upcoming.id, ogTimestamp); // original id
     }
 }