jpie 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 815bcf1e307d5c5195cf35302381f44f073638c784e6628f893c1eb9e3cb1762
-  data.tar.gz: 0dd7be88db93f112400c8b1750814f875b79c383e19610622f983e6d7b911793
+  metadata.gz: f0e1d1634f188bca4057e3550479af557bd00ba0d262c919ba221aa99997490e
+  data.tar.gz: 89db580da555f310a1b840daad204e2315fcb8b7828278b328271412d3bc321d
 SHA512:
-  metadata.gz: 2fdbec7a1d41afda8bfce7eb92f7d27feb4a8b73e32ea28a034dc8e1d8a96a8ba5fa7b9ab4396295f669c9a65df46b8f2334c0d1f9cfc93fddffc0085af250cb
-  data.tar.gz: 701c7e2a064ceecb89820ffcba6241e9c6daf774b422ced235fe173340403f78229c9385a9560e4a52dae7c2226bf8cad31d54e0068acab1480a787e7dbe12e9
+  metadata.gz: d2ced2be2db661db82e08200be2e5df033c072dcbf249565719336d3b08532d2cb01c4bbcec78cfb5e14fbbbadddb0c127292b70a9b970da3ecc20891bc8c8ab
+  data.tar.gz: 5d1ac4453eb74ba6a8ea04036f00065e26a54c2ff85a603525dd90106bd4f82a839ed3985083c5ff60d087b6bb1239c7a618a7a024e7e3fa1955c82d863aefa8

data/{.aiconfig → .cursorrules}

@@ -5,6 +5,10 @@
 - Follow Ruby style guide and RuboCop rules defined in .rubocop.yml
 - Prefer rubocop autocorrect 
 - Always pass rubocop before committing to git
+- Use `{data:}` rather than `{data: data}`
+- Only use code comments when abasolutely necessary
+- Keep any code comments short and concise
+- Don't update the .rubocop.yml unless it's absolutely necessarry
 
 # Documentation requirements
 - Keep README.md up to date with installation and usage instructions
@@ -22,7 +26,7 @@
 # Git commit guidelines
 - Write clear, descriptive commit messages
 - Keep commits focused and atomic
-- Run tests before committing
+- Run and pass tests before committing
 - Update documentation in the same commit as code changes
 - Ignore spec/examples.txt and other files listed in .gitignore
 - Include Ruby/Rails version requirements in relevant commits
@@ -33,6 +37,8 @@
 - Place tests in spec/jpie/
 - Use proper namespacing (JPie module)
 - Follow Ruby gem best practices
+- Do not update the spec/jpie/database.rb unless it's absolutely necessarry
+- Do not update the spec/jpie/resources.rb unless it's absolutely necessarry
 
 # Dependency management
 - Keep dependencies minimal and justified
@@ -56,10 +62,20 @@
 - Support Rails 8+ integration
 - Follow JSON:API specification strictly
 
-# Styleguide
-- Use `{data:}` rather than `{data: data}`
-
 # When implementing new features or refactoring
 - Always read the .aiconfig file 
 - Always implement code slowly and methodically 
-- Always test as you go
+- Always test as you go
+- Always make sure rubocop passes
+- Do not add any functionality for the new feature to existing tests unless absolutely necessarry.
+
+# Examples
+- The examples must _only_ include _required_ code
+- The examples must not include any unrelated or supurflous code
+- Examples must be a single markdown file
+- Examples must use the `http` code blocks for its exampels
+- Examples must only include the minium number of examples
+- Examples must never include migrations.
+- Examples must not include a features section or similar
+- Examples must include an introduction to the example
+- Examples live in /examples/*.md

data/.overcommit.yml

@@ -0,0 +1,35 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+
+# Global settings
+verify_signatures: false
+
+PreCommit:
+  ALL:
+    problem_on_unmodified_line: ignore
+    requires_files: true
+    quiet: false
+
+  # Run RuboCop on Ruby files before commit
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop']
+    flags: ['--force-exclusion']
+    on_warn: fail
+
+  # Check for trailing whitespace
+  TrailingWhitespace:
+    enabled: true
+    exclude:
+      - '**/*.md'
+
+  # Check for merge conflicts
+  MergeConflicts:
+    enabled: true
+
+PrePush:
+  # Run RSpec tests before push
+  RSpec:
+    enabled: true
+    command: ['bundle', 'exec', 'rspec']

data/CHANGELOG.md

@@ -7,6 +7,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.2] - 2025-01-25
+
+### Added
+- **Pagination Example**: Comprehensive pagination example demonstrating both simple and JSON:API standard pagination formats
+  - Simple pagination parameters (`page`, `per_page`)
+  - JSON:API standard pagination format (`page[number]`, `page[size]`)
+  - Pagination combined with sorting functionality
+  - Edge cases including last page and empty results
+  - Complete HTTP request/response examples following project format
+
+### Enhanced
+- **Documentation**: Improved example coverage with detailed pagination use cases
+- **Developer Experience**: Clear examples for implementing pagination in JPie applications
+
+## [0.4.1] - 2025-01-25
+
+### Fixed
+- **Test Suite Stability**: Fixed require statements in spec files that were incorrectly requiring `rails_helper` instead of `spec_helper`
+  - Fixed `spec/jpie/automatic_crud_spec.rb`
+  - Fixed `spec/jpie/polymorphic_crud_spec.rb` 
+  - Fixed `spec/jpie/through_associations_crud_spec.rb`
+- **Code Quality**: Addressed RuboCop warnings and improved code style compliance
+- **Error Handling**: Improved error message consistency for unsupported sort fields and include parameters
+
+### Enhanced
+- **Test Coverage**: Maintained high test coverage (93.39%) with improved test reliability
+- **Documentation**: Updated gem publishing workflow and development guidelines
+
+### Technical Details
+- All spec files now correctly use `spec_helper` for consistent test environment setup
+- Improved gem build process with proper dependency management
+- Enhanced RuboCop configuration for better code quality enforcement
+
 ## [0.4.0] - 2025-01-25
 
 ### Added