Skip to content

Fix gemspec's files regexp to exclude Gemfile.lock #856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adrien-k wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix gemspec's files regexp to exclude Gemfile.lock #856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion shakapacker.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Gem::Specification.new do |s|
s.add_development_dependency "rubocop-performance"

s.files = `git ls-files -z`.split("\x0").reject { |f|
f.match(%r{^(test|spec|features|tmp|node_modules|packages|coverage|Gemfile.lock|rakelib)/})
f.match(%r{^(test|spec|features|tmp|node_modules|packages|coverage|Gemfile.lock|rakelib)($|/)})
} + Dir.glob("sig/**/*.rbs")
Comment on lines 31 to 33
Copy link

@coderabbitai coderabbitai bot Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify test and documentation changes for Gemfile.lock exclusion

# 1. Search for tests related to gemspec files exclusion
echo "=== Searching for gemspec-related tests ==="
find . -name "*.rb" -type f \( -path "*/spec/*" -o -path "*/test/*" \) 2>/dev/null | xargs grep -l "gemspec\|\.files\|Gemfile\.lock" 2>/dev/null | head -20

# 2. Check CHANGELOG for recent updates
echo -e "\n=== Checking CHANGELOG file ==="
if [ -f "CHANGELOG.md" ]; then
  head -50 CHANGELOG.md
elif [ -f "CHANGELOG" ]; then
  head -50 CHANGELOG
else
  echo "No CHANGELOG.md or CHANGELOG found"
fi

# 3. Check if Gemfile.lock is tracked by git
echo -e "\n=== Checking if Gemfile.lock is tracked by git ==="
git ls-files 2>/dev/null | grep "^Gemfile.lock$" && echo "Gemfile.lock is tracked" || echo "Gemfile.lock not tracked"

# 4. Check the actual shakapacker.gemspec file at lines 31-33
echo -e "\n=== Verifying shakapacker.gemspec lines 31-33 ==="
sed -n '31,33p' shakapacker.gemspec

Repository: shakacode/shakapacker

Length of output: 4822

🏁 Script executed:

#!/bin/bash
# More targeted search for Gemfile.lock in CHANGELOG and tests

echo "=== Searching CHANGELOG for Gemfile.lock entry ==="
grep -n "Gemfile.lock" CHANGELOG.md 2>/dev/null | head -20

echo -e "\n=== Searching spec files for Gemfile.lock related tests ==="
find ./spec -name "*.rb" -type f 2>/dev/null -exec grep -l "Gemfile.lock\|s\.files\|gemspec" {} \;

echo -e "\n=== Searching for files exclusion tests in detail ==="
find ./spec -name "*gemspec*" -o -name "*files*" 2>/dev/null | head -10

echo -e "\n=== Check git log for recent changes to shakapacker.gemspec ==="
git log --oneline -20 -- shakapacker.gemspec 2>/dev/null

Repository: shakacode/shakapacker

Length of output: 373

🏁 Script executed:

#!/bin/bash
# Check the specific commit that fixed the gemspec
echo "=== Details of commit 1fc855d ==="
git show --stat 1fc855d 2>/dev/null | head -30

echo -e "\n=== Check if CHANGELOG.md was mentioned in this commit ==="
git show 1fc855d 2>/dev/null | grep -i "changelog" || echo "No CHANGELOG mention in commit"

echo -e "\n=== List all files changed in commit 1fc855d ==="
git show --name-only --pretty=format: 1fc855d 2>/dev/null

Repository: shakacode/shakapacker

Length of output: 22275

🏁 Script executed:

#!/bin/bash
# Final verification: search entire CHANGELOG for Gemfile.lock entry
echo "=== Entire CHANGELOG search for Gemfile.lock ==="
grep -n "Gemfile.lock\|gemspec.*files\|files.*exclusion" CHANGELOG.md 2>/dev/null | head -20

echo -e "\n=== Count of lines in CHANGELOG.md ==="
wc -l CHANGELOG.md

echo -e "\n=== Search for any gemspec-related tests ==="
find ./spec -name "*.rb" -type f -exec grep -l "\.files\|gemspec\|exclude" {} \; 2>/dev/null

Repository: shakacode/shakapacker

Length of output: 271

Add test and CHANGELOG entry for Gemfile.lock exclusion.

The regex pattern correctly excludes Gemfile.lock. The ($|/) anchor ensures both exact filenames (via $) and directory paths (via /) are matched, preventing false positives like Gemfile.lock.bak.

However, add a test in the spec suite to verify that Gemfile.lock is excluded from s.files in the gemspec, and add a CHANGELOG entry documenting this change under the appropriate version section.

🤖 Prompt for AI Agents 
In shakapacker.gemspec around lines 31–33, the reviewer asks to add a spec test
that verifies Gemfile.lock is excluded from s.files and to add a CHANGELOG entry
documenting this behavior; write a unit test in the gem's spec suite that loads
or evaluates the gemspec, computes s.files (or invokes the same git/Dir logic),
and asserts that "Gemfile.lock" is not present, place the test alongside other
gemspec/specs, and update the CHANGELOG.md (or CHANGELOG) under the current
unreleased or appropriate version section with a short entry noting that
Gemfile.lock is excluded from s.files so the gem packaging will not include it.


s.test_files = `git ls-files -- test/*`.split("\n")
Expand Down
Loading