jpie 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17c72f6974e3f671d772c5acec6ccd40541e06c36797603b4e0625b2235834f2
-  data.tar.gz: 6e13c925f6c6605278a0f3544165c8c3f7c9c6feaf3f97c54265c033f0a498e5
+  metadata.gz: 8d3cbfd72c12a023879f10c3314c321bf0210c861cffd838dc860d0497b53ae5
+  data.tar.gz: c8caf96a60fe557f7f07ce74e9cb725370b2d410856e33c2138f0bef7f1ba141
 SHA512:
-  metadata.gz: 8a9d2f4a6505c5bd7e94798fd63c382150b4170f8cd610548439161bec82dc9bfc07807468e32cc50d980018e7bc5625724db509742a97281e32dfb069acbe47
-  data.tar.gz: 8e1eb70f4967a8d83c25583b234172a6fd9e9767ef1ea816a2fe5b6dc447f7bd11a68e67cab7e27851eee342395e616249d32033680cdc83050d896bd5726ec9
+  metadata.gz: dd2a288d7526fd45c3f2a30881019656a0772942d83f208e9a031d976223a8497ea29f00295d37d2c045805dae791a79f2d6d6be5c1835007dfd9ba1b6b8b4c2
+  data.tar.gz: 99a5f5e5fb484a394ce36c6ac9f5635c2f06c820dc6c41f16d89903e7135fde2b1e32d6a1a7df5277ee3ee3f248b15651a1353fb83315e96c9525a47b8638221

data/.cursor/rules/dependencies.mdc

@@ -0,0 +1,19 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Dependency Management
+
+## Requirements
+- 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
+
+## Compatibility Requirements
+- Maintain Ruby 3.4+ compatibility
+- Support Rails 8+ integration
+- Follow JSON:API specification strictly

data/.cursor/rules/examples.mdc

@@ -0,0 +1,16 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Example Guidelines
+
+- Examples must only include required code
+- Examples must not include any unrelated or superfluous code
+- Examples must be a single markdown file
+- Examples must use the `http` code blocks for examples
+- Examples must only include the minimum 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/.cursor/rules/git.mdc

@@ -0,0 +1,14 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Git Commit Guidelines
+
+- Write clear, descriptive commit messages
+- Keep commits focused and atomic
+- 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
+- Update tests in the same commit as code changes

data/.cursor/rules/project_structure.mdc

@@ -0,0 +1,30 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Project Information
+- Project Name: jpie
+- Description: Ruby gem for JSON:API implementation
+
+# Project Structure
+
+## Core Structure
+- Keep core functionality in lib/jpie/
+- Place tests in spec/jpie/
+- Use proper namespacing (JPie module)
+- Follow Ruby gem best practices
+
+## Protected Files
+- Do not update spec/jpie/database.rb unless absolutely necessary
+- Do not update spec/jpie/resources.rb unless absolutely necessary
+
+## Documentation
+- Keep README.md up to date with installation and usage instructions
+- Include example usage in documentation
+
+## Development Process
+- Always read the .aiconfig file
+- Always implement code slowly and methodically
+- Always test as you go
+- Always make sure rubocop passes

data/.cursor/rules/security.mdc

@@ -0,0 +1,14 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# 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

data/.cursor/rules/style.mdc

@@ -0,0 +1,15 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# Style Guidelines
+
+## Ruby Style
+- 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 absolutely necessary
+- Keep any code comments short and concise
+- Don't update .rubocop.yml unless absolutely necessary

data/.cursor/rules/testing.mdc

@@ -0,0 +1,16 @@
+---
+description: 
+globs: 
+alwaysApply: false
+---
+# 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)
+- Only care about coverage reduction when running all specs
+- Do not add any functionality for new features to existing tests unless absolutely necessary

data/lib/jpie/rspec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+module JPie
+  # RSpec matchers and helpers for testing JPie resources
+  module RSpec
+    # Configure RSpec with JPie helpers and matchers
+    def self.configure!
+      ::RSpec.configure do |config|
+        config.include JPie::RSpec::Matchers
+        config.include JPie::RSpec::Helpers
+      end
+    end
+
+    # Custom matchers for JPie resources
+    module Matchers
+      extend ::RSpec::Matchers::DSL
+
+      matcher :have_attribute do |attribute_name|
+        match do |actual|
+          actual.respond_to?(attribute_name) &&
+            actual.attributes.key?(attribute_name.to_s)
+        end
+
+        failure_message do |actual|
+          "expected #{actual.inspect} to have attribute '#{attribute_name}'"
+        end
+      end
+
+      matcher :have_relationship do |relationship_name|
+        match do |actual|
+          actual.respond_to?(relationship_name) &&
+            actual.relationships.key?(relationship_name.to_s)
+        end
+
+        failure_message do |actual|
+          "expected #{actual.inspect} to have relationship '#{relationship_name}'"
+        end
+      end
+    end
+
+    # Helper methods for testing JPie resources
+    module Helpers
+      # Build a JPie resource without saving it
+      def build_jpie_resource(type, attributes = {}, relationships = {})
+        JPie::Resource.new(
+          type: type,
+          attributes: attributes,
+          relationships: relationships
+        )
+      end
+
+      # Create a JPie resource and save it
+      def create_jpie_resource(type, attributes = {}, relationships = {})
+        resource = build_jpie_resource(type, attributes, relationships)
+        resource.save
+        resource
+      end
+
+      # Clean up test data after specs
+      def cleanup_jpie_resources(resources)
+        Array(resources).each do |resource|
+          resource.destroy if resource.persisted?
+        rescue StandardError => e
+          warn "Failed to cleanup resource #{resource.inspect}: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/jpie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JPie
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
 end

data/lib/jpie.rb

@@ -3,14 +3,18 @@
 require 'active_support'
 require 'active_support/core_ext'
 require 'jpie/version'
+require_relative 'jpie/resource'
+require_relative 'jpie/client'
+require_relative 'jpie/errors'
+
+# Load RSpec support if RSpec is defined
+require_relative 'jpie/rspec' if defined?(RSpec)
 
 module JPie
-  autoload :Resource, 'jpie/resource'
   autoload :Serializer, 'jpie/serializer'
   autoload :Deserializer, 'jpie/deserializer'
   autoload :Controller, 'jpie/controller'
   autoload :Configuration, 'jpie/configuration'
-  autoload :Errors, 'jpie/errors'
   autoload :Routing, 'jpie/routing'
 
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Emil Kampp
@@ -169,7 +169,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".cursorrules"
+- ".cursor/rules/dependencies.mdc"
+- ".cursor/rules/examples.mdc"
+- ".cursor/rules/git.mdc"
+- ".cursor/rules/project_structure.mdc"
+- ".cursor/rules/security.mdc"
+- ".cursor/rules/style.mdc"
+- ".cursor/rules/testing.mdc"
 - ".overcommit.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -207,6 +213,7 @@ files:
 - lib/jpie/resource/inferrable.rb
 - lib/jpie/resource/sortable.rb
 - lib/jpie/routing.rb
+- lib/jpie/rspec.rb
 - lib/jpie/serializer.rb
 - lib/jpie/version.rb
 homepage: https://github.com/emk-klaay/jpie

data/.cursorrules

@@ -1,82 +0,0 @@
-# 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
-- 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
-- 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)
-- Only care about coverge reduction when running all specs
-
-# Git commit guidelines
-- Write clear, descriptive commit messages
-- Keep commits focused and atomic
-- 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
-- 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
-- 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
-- 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
-
-# When implementing new features or refactoring
-- Always read the .aiconfig file 
-- Always implement code slowly and methodically 
-- 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