jpie 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f594e2f3e5123f2663c45f616ecd71ecfd3536dfa18584a717fc1dd009725ea
+  data.tar.gz: 1f58bb161f508a317eba59075067f8b11ee8d0c9c2f06bdbf1db97ec954c436b
+SHA512:
+  metadata.gz: f1a6e30858f39970bcd27e6b32fef2bdcf8b988fe9feb1cf69d5edb146ccebbe4bf0f01f68b75129916678f4431ba02e95b126086cd08f7966e2f4974778f8e7
+  data.tar.gz: bfc7c45df14267309e08f05d1ec66134d5a64ba19da1492eb04f04ae6cce19455ba4ca3d7c53aa209b723d7208d42f8df38a65a139e69520a570b37e93b4f634

data/.aiconfig

@@ -0,0 +1,65 @@
+# AI Assistant Configuration
+# This file contains rules and guidelines for AI assistants working on the jpie project
+
+# Follow these code style guidelines
+- Follow Ruby style guide and RuboCop rules defined in .rubocop.yml
+- Prefer rubocop autocorrect 
+- Always pass rubocop before committing to git
+
+# Documentation requirements
+- Keep README.md up to date with installation and usage instructions
+- Include example usage in documentation
+
+# Testing guidelines
+- Write RSpec tests for all new features
+- Maintain test coverage for all public methods
+- Use meaningful test descriptions
+- Follow the existing test structure in spec/
+- Test both success and error cases
+- Use modern RSpec features and syntax
+- Don't reduce test coverage (line, file, branch, or other)
+
+# Git commit guidelines
+- Write clear, descriptive commit messages
+- Keep commits focused and atomic
+- Run 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
+- Update tests in the same commit as code changes
+
+# Maintain the following project structure
+- Keep core functionality in lib/jpie/
+- Place tests in spec/jpie/
+- Use proper namespacing (JPie module)
+- Follow Ruby gem best practices
+
+# Dependency management
+- Keep dependencies minimal and justified
+- Document new dependencies in README.md
+- Keep development dependencies in Gemfile
+- Ensure compatibility with Ruby 3.4+
+- Only support Rails 8+ features
+- Use modern gem versions
+
+# Security guidelines
+- Never commit sensitive data or credentials
+- Use environment variables for configuration
+- Follow secure coding practices
+- Keep dependencies up to date
+- Follow Rails 8+ security best practices
+- Use Ruby 3.4+ security features
+- Implement proper input validation
+
+# Compatibility requirements
+- Maintain Ruby 3.4+ compatibility
+- 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

data/.rubocop.yml

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.4
+  TargetRailsVersion: 8.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'db/schema.rb'
+    - 'tmp/**/*'
+    - 'spec/examples.txt'
+
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns: ['\A\s*#']
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+# Naming cops
+Naming/PredicateName:
+  AllowedMethods:
+    - has_many     # DSL method for defining relationships
+    - has_one      # DSL method for defining relationships
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'lib/jpie/resource/**/*'  # Resource modules have large class_methods blocks for DSL methods
+    - 'lib/jpie/controller/**/*'  # Controller modules have large class_methods blocks for DSL methods
+
+# Rails cops that don't apply to our gem
+Rails/TimeZone:
+  Enabled: false
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+# Gemspec cops that are acceptable for gems
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Capybara cops that are causing issues (rubocop bug)
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+# RSpec cops that are acceptable for our test style
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 8  # Allow more expectations for complex integration tests
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 20  # Allow more helpers for complex test scenarios
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/**/*_integration_spec.rb'
+    - 'spec/**/*_spec.rb'  # Allow integration and feature tests without class specification
+
+RSpec/ContextWording:
+  Enabled: false  # Allow flexible context descriptions for better readability
+
+RSpec/IndexedLet:
+  Enabled: false  # Allow indexed let statements for test data setup
+
+RSpec/LetSetup:
+  Enabled: false  # Allow let! for test data setup
+
+RSpec/StubbedMock:
+  Enabled: false  # Allow expect().to receive for test clarity
+
+RSpec/IteratedExpectation:
+  Enabled: false  # Allow iteration over arrays in tests
+
+RSpec/InstanceVariable:
+  Enabled: false  # Allow instance variables in tests for setup
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+# Style cops that are acceptable for test code
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/**/*'
+
+# Lint cops that are acceptable for test initialization methods
+Lint/MissingSuper:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*'
+
+# Rails cops that we can ignore in test support files
+Rails/SkipsModelValidations:
+  Exclude:
+    - 'spec/**/*' 

data/CHANGELOG.md

@@ -0,0 +1,93 @@
+# Changelog
+
+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]
+
+## [0.3.0] - 2025-01-24
+
+### Added
+- **Modern DSL Aliases**: Introduced concise aliases following Rails conventions
+  - `render_jsonapi` - Single method for rendering both resources and collections
+  - `resource` - Concise alias for `jsonapi_resource` in controllers
+  - `meta` and `metas` - Short aliases for `meta_attribute` and `meta_attributes`
+  - `sortable` - Concise alias for `sortable_by` in resources
+- **Method Override Support**: Custom attribute methods can now be defined directly on resource classes
+  - Support for both public and private method definitions
+  - Access to `object` and `context` within custom methods
+  - Method precedence: blocks → options blocks → custom methods → model attributes
+- **Enhanced Documentation**: Comprehensive README updates with Key Features section and modern DSL examples
+
+### Enhanced
+- **Controller DSL**: Simplified rendering with intelligent `render_jsonapi` method that handles both single resources and collections automatically
+- **Resource DSL**: More intuitive and concise method names aligned with modern Rails patterns
+- **Backward Compatibility**: All original method names preserved via aliases - no breaking changes
+- **Code Quality**: 100% test coverage maintained with 363 passing tests and full RuboCop compliance
+
+### Improved
+- **Developer Experience**: Cleaner, more intuitive API that follows Rails conventions
+- **IDE Support**: Better support for custom attribute methods with proper method definitions
+- **Testing**: Easier testing of individual custom methods vs block-based approaches
+- **Performance**: Method-based attributes avoid block overhead for simple transformations
+
+### Technical Details
+- Custom methods support both public and private visibility
+- Intelligent method detection prevents overriding existing custom implementations
+- All render methods consolidated into single polymorphic `render_jsonapi` method
+- Full backward compatibility ensures seamless upgrades
+
+## [0.2.0] - 2025-01-24
+
+### Added
+- **Single Table Inheritance (STI) Support**: Comprehensive support for Rails STI models with automatic type inference, resource inheritance, and polymorphic serialization
+- **Custom Meta Method**: Resources can now define a `meta` method to provide dynamic meta data alongside the existing `meta_attributes` macro, with access to `object`, `context`, and ability to call `super`
+- **Enhanced Test Coverage**: Added comprehensive test suites for STI and meta method functionality with 95.13% line coverage
+- **RuboCop Configuration**: Improved RuboCop configuration for test files, reducing offenses from 247 to 0 while maintaining code quality
+
+### Enhanced
+- **STI Models**: Automatic JSON:API type inference from STI model classes (e.g., `Car` model → `"cars"` type)
+- **STI Resources**: Seamless resource inheritance matching model inheritance patterns  
+- **STI Serialization**: Each STI model serializes with correct type and specific attributes
+- **STI Controllers**: Automatic scoping to specific STI types while supporting polymorphic queries
+- **Meta Method Features**: Dynamic meta data generation with context access and inheritance support
+- **Documentation**: Comprehensive README updates with STI examples and meta method usage
+
+### Improved
+- **Test Suite**: 343 tests covering all functionality including complex STI scenarios
+- **Code Quality**: Zero RuboCop offenses with reasonable configuration for comprehensive test suites
+- **Error Handling**: Proper validation for meta method return types with helpful error messages
+
+### Technical Details
+- STI models automatically infer correct resource classes for polymorphic serialization
+- Meta methods can access `object`, `context`, and call `super` for attribute merging
+- RuboCop configuration optimized for integration tests without compromising production code standards
+- Comprehensive test coverage for edge cases and complex scenarios
+
+## [0.1.0] - 2024-01-01
+
+### Added
+- Initial release with core functionality
+- JSON:API compliant serialization and deserialization
+- Resource definition with attributes
+- Controller integration module
+- Rails generator for creating resources
+- Comprehensive error handling
+- Configuration system for key formats
+- Full test suite with RSpec
+
+### Features
+- `JPie::Resource` - Base class for defining API resources
+- `JPie::Serializer` - Converts Ruby objects to JSON:API format
+- `JPie::Deserializer` - Converts JSON:API format to Ruby hashes
+- `JPie::Controller` - Rails integration module
+- `JPie::Configuration` - Gem-wide configuration management
+- `JPie::Errors` - JSON:API compliant error classes
+- Rails generator: `rails generate jpie:resource`
+
+### Dependencies
+- Ruby >= 3.4.0
+- Rails >= 8.0.0
+- ActiveSupport >= 8.0.0 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Emil Kampp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.