active_force 0.28.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c240b297b231441f1e118382265406f86080553212533be3016f5c3c747ddfe6
-  data.tar.gz: fa0162bee251048885d820b01c458da369ea4ca902657b097d73a8a5760429fa
+  metadata.gz: 9282bb2814d5d90acdad820f72977aee58dfa17af2feff228e05a68c77b1cece
+  data.tar.gz: 34e234b1cf52121f65853f9fea12c438b344a800f5d3623931b2d5b45230dd43
 SHA512:
-  metadata.gz: 1d7ff886ce3c59348c158ce8c9927ca0a6893a72921fab8dd32fced0d153c91c23114ed71a50747f0747a93dd0b80cdd2cc30f82d03680ed9de6ba9a6d34ab0e
-  data.tar.gz: 16a6a89dd42bad672ec1702a16560f032df1537834d309b7cd56b57ccc70b554b9f506530ee86caf25ef15a45f6dfc26e5a26ee6d9d8fbcc1d31dd5a4c3ccf6b
+  metadata.gz: e056683a3151f3528e3ee1d5bae676ae6f0366ce4fdf4af718b28366c8fbd2114401860fe781fddff0722b40db97ca16f1560eac34e5bb9b5f9cad72a74311e3
+  data.tar.gz: ca35e7aacf091512287c65e4a7e816f0fe1eb027716dd67d498b6fe4c9c8d6a4156b2b54898e9c1b90d48b7b8e8abb095eecaa4f140b6777a0905ad88093b9fc

data/.claude/skills/release/SKILL.md

@@ -0,0 +1,91 @@
+---
+name: release
+description: Release a new version of the active_force gem. Use when asked to cut, prepare, or publish a release. Phase 1 (default) prepares the release PR; phase 2 (`publish`, after the PR is merged) builds and pushes the gem and creates the GitHub release.
+argument-hint: "[version|publish] [--dry-run]"
+---
+
+# Releasing active_force
+
+Two phases, split by the release PR being reviewed and merged. The argument is either a version or `publish`, never both.
+
+- A version (`0.28.0`, no `v`) runs phase 1 with that version.
+- No argument runs phase 1 and follows "Choosing the version" below.
+- `publish` runs phase 2. It takes no version: it reads `VERSION` from `lib/active_force/version.rb` on an up-to-date `main`, which is the merged release.
+
+`--dry-run` can be added to either form. See "Dry run" below.
+
+## Dry run
+
+With `--dry-run`, work through the phase as written but change nothing: describe what each step would do, with the real values filled in, and stop at the end. Print the plan as a numbered list in the same order as the steps, marking each as `would do`, `would skip (already done)` or `blocked (reason)`.
+
+Only these commands are allowed:
+- Read-only git: `git status`, `git fetch`, `git log`, `git diff`, `git show origin/main:<path>`, `git ls-remote --tags origin <tag>`. Do not switch branches or pull; read `main` through `origin/main` instead.
+- Read-only GitHub: `gh pr list`, `gh pr view`, `gh release list`, `gh release view`, and the `generate-notes` API call (it only returns text).
+- `gem list -r`.
+
+Do not run `git switch`, `git pull`, `git commit`, `git push`, `gem build`, `gem push`, `gh pr create`, `gh release create`, or edit any file. If no version was given, still propose one and ask for it: the plan depends on it. Do not ask for the confirmations that precede `gem push` or `gh release create`; show what you would ask instead.
+
+What to show:
+- **Phase 1:** the chosen version, the branch name, the PR title, the exact `CHANGELOG.md` diff and `version.rb` change as they would be written, any `TBD` links, and the result of the already-released check.
+- **Phase 2:** the version read from `origin/main`, whether the release PR is merged (and its number), the already-done check for rubygems, the GitHub release and the tag, the commands that would build and push, and the **final release notes** with the release PR's bullet removed.
+
+End by saying nothing was changed, and that running the same command without `--dry-run` would do it for real.
+
+## Choosing the version
+
+Read the `## Not released` section of `CHANGELOG.md` and the current `ActiveForce::VERSION` in `lib/active_force/version.rb`.
+
+- If there are no entries under `Not released`, stop and say there is nothing to release.
+- Otherwise propose a bump (new feature or behavior change = minor, fixes only = patch, breaking change = major; this gem is 0.x so breaking changes are also a minor bump) with a one-line reason, and **ask the user to confirm or give a different version**. Never pick one silently.
+
+## Phase 1: prepare the release PR
+
+1. Require no modified or staged tracked files (`git status --untracked-files=no` is empty); untracked files don't matter. `git switch main && git pull`.
+2. Check the `Not released` entries for placeholder links (`pull/TBD`). If any are found, list them and ask the user before continuing.
+3. Refuse if `{version}` is already released: a git tag `{version}` exists, or `gem list -r -e active_force --all` includes it. `{version}` must also be greater than the current `VERSION`.
+4. `git switch -c release_{version}`.
+5. Set `VERSION = '{version}'` in `lib/active_force/version.rb`.
+6. In `CHANGELOG.md`, insert a new `## {version}` heading directly under `## Not released`, so the existing entries fall under it, and leave `## Not released` at the top, empty. Result:
+
+   ```
+   # Changelog
+
+   ## Not released
+
+   ## {version}
+   - ...entries...
+   ```
+7. Do not touch `Gemfile.lock` (gitignored) and never `git add` `*.gem` files. Stage only `version.rb` and `CHANGELOG.md`.
+8. Commit as `Release {version}`, push, and open a PR titled `Release {version}`. **Do not use the Linear `KEY-N | TYPE | title` format for release PRs.** The body can be the changelog entries being released.
+9. Report the PR URL and stop. Someone else approves and merges it. Do not merge it.
+
+## Phase 2: publish (only after the release PR is merged)
+
+Naming, matching past releases: the git tag is `{version}` (no `v`) and the GitHub release title is `v{version}`.
+
+1. `git switch main && git pull`. Read `{version}` from `version.rb`.
+2. Confirm the release PR is merged: `gh pr list --head release_{version} --state merged --json number,title`. If it isn't, stop and say so. This works after the branch is deleted. Keep the PR number for step 6.
+3. **Check what is already done**, so a rerun resumes instead of failing partway. Report the result to the user, skip the steps that are done, and continue with the rest:
+   - On rubygems: `gem list -r -e active_force --all` includes `{version}` -> skip build and push (steps 4-5).
+   - GitHub release: `gh release view {version}` succeeds -> skip notes and release (steps 6-7). If it succeeds, tell the user the release already exists and give the link.
+   - A tag `{version}` exists (`git ls-remote --tags origin {version}`) with no GitHub release: stop and ask the user. The tag may point at the wrong commit, so don't create a release on it unprompted.
+   - If everything is done, say so and stop.
+4. `gem build active_force.gemspec`.
+5. **Ask for explicit confirmation, then** `gem push active_force-{version}.gem`. A push cannot be undone. If rubygems needs an MFA code, ask the user to run it themselves with `! gem push active_force-{version}.gem`.
+6. Generate release notes and drop the release PR's own entry:
+
+   ```
+   gh api repos/{owner}/{repo}/releases/generate-notes \
+     -f tag_name={version} -f previous_tag_name={previous_tag} -f target_commitish=main \
+     --jq .body
+   ```
+
+   `{previous_tag}` is `gh release list --limit 1 --json tagName --jq '.[0].tagName'`. Remove the bullet that links to the release PR's number (from step 2); do not match on its title. Keep everything else, including the "Full Changelog" line.
+7. Show the user the final notes and ask to confirm. Then:
+
+   ```
+   gh release create {version} --target main --title "v{version}" --notes-file <file>
+   ```
+
+   This creates the tag.
+8. Report the rubygems and GitHub release links. Leave the built `.gem` file alone (gitignored).

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Not released
 
+## 0.28.1
+- `modified_attributes` computes the changed attribute names once instead of once per attribute, making it linear in the number of fields. The result is unchanged. (https://github.com/Beyond-Finance/active_force/pull/126)
+
 ## 0.28.0
 - Add `delete` / `delete_all` (class, relation and instance) using the Composite sObject Collections API. Ids are deleted in chunks of 200, each chunk all-or-none, and the first failing chunk raises `ActiveForce::DeleteFailed` with the Salesforce `errors` and the `deleted_count` from earlier chunks, which stay deleted. Nothing is retried, and ids that are already deleted or never existed are errors like any other. (https://github.com/Beyond-Finance/active_force/pull/119)
 - `delete` raises `ArgumentError` before sending any request when an id's key prefix belongs to another object, so `Account.delete(a_contact_id)` no longer deletes the Contact. The prefix comes from `Model.key_prefix`, read from describe once per class and cached. Objects with no key prefix are not checked, and objects that share a prefix (`ContentDocument` and `ContentNote`) can still be mixed up. (https://github.com/Beyond-Finance/active_force/pull/122)

data/lib/active_force/sobject.rb

@@ -233,7 +233,7 @@ module ActiveForce
     end
 
     def modified_attributes
-      attributes.select{ |attr, key| changed.include? attr.to_s }
+      attributes.slice(*changed)
     end
 
     def reload

data/lib/active_force/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveForce
-  VERSION = '0.28.0'
+  VERSION = '0.28.1'
 end

data/spec/active_force/sobject_spec.rb

@@ -547,6 +547,116 @@ describe ActiveForce::SObject do
     end
   end
 
+  describe '#modified_attributes' do
+    context 'with a new instance' do
+      it 'returns an empty hash when nothing has been assigned' do
+        expect(Whizbang.new.modified_attributes).to eq({})
+      end
+
+      it 'returns only the assigned attributes' do
+        instance = Whizbang.new(text: 'some text', boolean: false)
+
+        expect(instance.modified_attributes).to eq('text' => 'some text', 'boolean' => false)
+      end
+
+      it 'returns the cast values of the assigned attributes' do
+        instance = Whizbang.new(date: '2010-01-01', percent: '21')
+
+        expect(instance.modified_attributes).to eq('date' => Date.new(2010, 1, 1), 'percent' => 21.0)
+      end
+    end
+
+    context 'with a built instance' do
+      let(:instance) { Whizbang.build sobject_hash }
+
+      it 'returns an empty hash when nothing has changed' do
+        expect(instance.modified_attributes).to eq({})
+      end
+
+      it 'returns only the changed attributes with their new values' do
+        instance.text = 'changed text'
+        instance.checkbox = true
+
+        expect(instance.modified_attributes).to eq('checkbox' => true, 'text' => 'changed text')
+      end
+
+      it 'excludes attributes assigned their current value' do
+        instance.text = 'Hi there!'
+        instance.percent = 21
+
+        expect(instance.modified_attributes).to eq({})
+      end
+
+      it 'excludes attributes changed and then restored to their original value' do
+        instance.text = 'changed text'
+        instance.text = 'Hi there!'
+
+        expect(instance.modified_attributes).to eq({})
+      end
+
+      it 'includes attributes changed to nil' do
+        instance.text = nil
+
+        expect(instance.modified_attributes).to eq('text' => nil)
+      end
+
+      it 'includes attributes mutated in place' do
+        instance.text << ' Bye!'
+
+        expect(instance.modified_attributes).to eq('text' => 'Hi there! Bye!')
+      end
+
+      it 'excludes attributes that were not selected' do
+        expect(Whizbang.attribute_names).to include('estimated_close_date', 'updated_from')
+        expect(instance.modified_attributes.keys).not_to include('estimated_close_date', 'updated_from')
+      end
+
+      it 'includes an unselected attribute once it is assigned' do
+        instance.updated_from = 'Rails'
+
+        expect(instance.modified_attributes).to eq('updated_from' => 'Rails')
+      end
+
+      it 'returns string keys in attribute declaration order' do
+        instance.percent = 42
+        instance.text = 'changed text'
+        instance.checkbox = true
+
+        expect(instance.modified_attributes.keys).to eq(%w[checkbox text percent])
+      end
+    end
+
+    context 'after persisting changes' do
+      let(:instance) { Territory.new(id: '1') }
+
+      it 'returns an empty hash after create' do
+        new_instance = Territory.new(name: 'Walter')
+        allow(client).to receive(:create!).and_return('1')
+
+        new_instance.create!
+
+        expect(new_instance.modified_attributes).to eq({})
+      end
+
+      it 'returns an empty hash after update' do
+        allow(client).to receive(:update!).and_return(true)
+
+        instance.update!(name: 'Walter')
+
+        expect(instance.modified_attributes).to eq({})
+      end
+
+      it 'returns an empty hash after reload' do
+        allow(client).to receive(:query).and_return([Restforce::Mash.new(Id: '1', Name: 'Jeff')])
+        instance.name = 'Walter'
+
+        instance.reload
+
+        expect(instance.modified_attributes).to eq({})
+      end
+    end
+  end
+
   describe 'logger output' do
     let(:instance){ Whizbang.new }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Eloy Espinaco
@@ -159,6 +159,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".claude/skills/release/SKILL.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"