jpie 0.4.5 → 1.0.1

data/lib/rubocop/cop/custom/hash_value_omission.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Custom
+      # Enforces hash value omission syntax introduced in Ruby 3.1
+      # When a hash key and value have the same name, use the shorthand syntax.
+      #
+      # @example
+      #   # bad
+      #   { controller: controller }
+      #   { foo: foo, bar: bar }
+      #
+      #   # good
+      #   { controller: }
+      #   { foo:, bar: }
+      class HashValueOmission < Base
+        extend AutoCorrector
+
+        MSG = "Use hash value omission (`%<key>s:`) when the value is the same-named local variable."
+
+        def on_pair(node)
+          return unless valid_pair_for_omission?(node)
+
+          key_name = node.key.value.to_s
+          return if already_omitted?(node, key_name)
+          return unless same_name?(node, key_name)
+
+          add_offense(node, message: format(MSG, key: key_name)) do |corrector|
+            corrector.replace(node.source_range, "#{key_name}:")
+          end
+        end
+
+        def valid_pair_for_omission?(node)
+          key = node.key
+          value = node.value
+
+          key.sym_type? && value&.lvar_type?
+        end
+
+        def already_omitted?(node, key_name)
+          source = node.source.strip
+          source == "#{key_name}:"
+        end
+
+        def same_name?(node, key_name)
+          value_name = node.value.source
+          key_name == value_name
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Emil Kampp
 bindir: exe
 cert_chain: []
-date: 2025-05-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -49,183 +49,114 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 8.0.0
-- !ruby/object:Gem::Dependency
-  name: brakeman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.20'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.20'
-description: JPie provides a framework for developing JSON:API compliant servers with
-  Rails 8+. It focuses on clean architecture with strong separation of concerns.
+description: A Rails 8+ gem that provides jsonapi_resources routing DSL and generic
+  JSON:API controllers
 email:
-- emil@example.com
+- emil@kampp.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".cursor/rules/dependencies.mdc"
-- ".cursor/rules/examples.mdc"
-- ".cursor/rules/git.mdc"
-- ".cursor/rules/project_structure.mdc"
-- ".cursor/rules/publish_gem.mdc"
-- ".cursor/rules/security.mdc"
-- ".cursor/rules/style.mdc"
-- ".cursor/rules/testing.mdc"
-- ".overcommit.yml"
+- ".cursor/rules/release.mdc"
+- ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
-- LICENSE.txt
-- PUBLISHING.md
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
-- examples/basic_example.md
-- examples/including_related_resources.md
-- examples/pagination.md
-- examples/relationships.md
-- examples/resource_attribute_configuration.md
-- examples/resource_meta_configuration.md
-- examples/rspec_testing.md
-- examples/single_table_inheritance.md
+- bin/console
+- bin/setup
 - jpie.gemspec
+- kiln/app/resources/user_message_resource.rb
 - lib/jpie.rb
-- lib/jpie/configuration.rb
-- lib/jpie/controller.rb
-- lib/jpie/controller/crud_actions.rb
-- lib/jpie/controller/error_handling.rb
-- lib/jpie/controller/error_handling/handler_setup.rb
-- lib/jpie/controller/error_handling/handlers.rb
-- lib/jpie/controller/json_api_validation.rb
-- lib/jpie/controller/parameter_parsing.rb
-- lib/jpie/controller/related_actions.rb
-- lib/jpie/controller/relationship_actions.rb
-- lib/jpie/controller/relationship_validation.rb
-- lib/jpie/controller/rendering.rb
-- lib/jpie/deserializer.rb
-- lib/jpie/errors.rb
-- lib/jpie/generators/resource_generator.rb
-- lib/jpie/generators/templates/resource.rb.erb
-- lib/jpie/railtie.rb
-- lib/jpie/resource.rb
-- lib/jpie/resource/attributable.rb
-- lib/jpie/resource/inferrable.rb
-- lib/jpie/resource/sortable.rb
-- lib/jpie/routing.rb
-- lib/jpie/serializer.rb
-- lib/jpie/version.rb
-homepage: https://github.com/emk-klaay/jpie
+- lib/json_api.rb
+- lib/json_api/active_storage/deserialization.rb
+- lib/json_api/active_storage/detection.rb
+- lib/json_api/active_storage/serialization.rb
+- lib/json_api/configuration.rb
+- lib/json_api/controllers/base_controller.rb
+- lib/json_api/controllers/concerns/controller_helpers.rb
+- lib/json_api/controllers/concerns/controller_helpers/authorization.rb
+- lib/json_api/controllers/concerns/controller_helpers/document_meta.rb
+- lib/json_api/controllers/concerns/controller_helpers/error_rendering.rb
+- lib/json_api/controllers/concerns/controller_helpers/parsing.rb
+- lib/json_api/controllers/concerns/controller_helpers/resource_setup.rb
+- lib/json_api/controllers/concerns/relationships/active_storage_removal.rb
+- lib/json_api/controllers/concerns/relationships/events.rb
+- lib/json_api/controllers/concerns/relationships/removal.rb
+- lib/json_api/controllers/concerns/relationships/response_helpers.rb
+- lib/json_api/controllers/concerns/relationships/serialization.rb
+- lib/json_api/controllers/concerns/relationships/sorting.rb
+- lib/json_api/controllers/concerns/relationships/updating.rb
+- lib/json_api/controllers/concerns/relationships_controller/active_storage_removal.rb
+- lib/json_api/controllers/concerns/relationships_controller/events.rb
+- lib/json_api/controllers/concerns/relationships_controller/removal.rb
+- lib/json_api/controllers/concerns/relationships_controller/response_helpers.rb
+- lib/json_api/controllers/concerns/relationships_controller/serialization.rb
+- lib/json_api/controllers/concerns/relationships_controller/sorting.rb
+- lib/json_api/controllers/concerns/relationships_controller/updating.rb
+- lib/json_api/controllers/concerns/resource_actions.rb
+- lib/json_api/controllers/concerns/resource_actions/crud_helpers.rb
+- lib/json_api/controllers/concerns/resource_actions/field_validation.rb
+- lib/json_api/controllers/concerns/resource_actions/filter_validation.rb
+- lib/json_api/controllers/concerns/resource_actions/pagination.rb
+- lib/json_api/controllers/concerns/resource_actions/preloading.rb
+- lib/json_api/controllers/concerns/resource_actions/resource_loading.rb
+- lib/json_api/controllers/concerns/resource_actions/serialization.rb
+- lib/json_api/controllers/concerns/resource_actions/type_validation.rb
+- lib/json_api/controllers/relationships_controller.rb
+- lib/json_api/controllers/resources_controller.rb
+- lib/json_api/errors/parameter_not_allowed.rb
+- lib/json_api/railtie.rb
+- lib/json_api/resources/active_storage_blob_resource.rb
+- lib/json_api/resources/concerns/attributes_dsl.rb
+- lib/json_api/resources/concerns/filters_dsl.rb
+- lib/json_api/resources/concerns/meta_dsl.rb
+- lib/json_api/resources/concerns/model_class_helpers.rb
+- lib/json_api/resources/concerns/relationships_dsl.rb
+- lib/json_api/resources/concerns/sortable_fields_dsl.rb
+- lib/json_api/resources/resource.rb
+- lib/json_api/resources/resource_loader.rb
+- lib/json_api/routing.rb
+- lib/json_api/serialization/concerns/attributes_deserialization.rb
+- lib/json_api/serialization/concerns/attributes_serialization.rb
+- lib/json_api/serialization/concerns/deserialization_helpers.rb
+- lib/json_api/serialization/concerns/includes_serialization.rb
+- lib/json_api/serialization/concerns/links_serialization.rb
+- lib/json_api/serialization/concerns/meta_serialization.rb
+- lib/json_api/serialization/concerns/model_attributes_transformation.rb
+- lib/json_api/serialization/concerns/relationship_processing.rb
+- lib/json_api/serialization/concerns/relationships_deserialization.rb
+- lib/json_api/serialization/concerns/relationships_serialization.rb
+- lib/json_api/serialization/deserializer.rb
+- lib/json_api/serialization/serializer.rb
+- lib/json_api/support/active_storage_support.rb
+- lib/json_api/support/collection_query.rb
+- lib/json_api/support/concerns/condition_building.rb
+- lib/json_api/support/concerns/nested_filters.rb
+- lib/json_api/support/concerns/pagination.rb
+- lib/json_api/support/concerns/polymorphic_filters.rb
+- lib/json_api/support/concerns/regular_filters.rb
+- lib/json_api/support/concerns/sorting.rb
+- lib/json_api/support/instrumentation.rb
+- lib/json_api/support/param_helpers.rb
+- lib/json_api/support/relationship_guard.rb
+- lib/json_api/support/relationship_helpers.rb
+- lib/json_api/support/resource_identifier.rb
+- lib/json_api/support/responders.rb
+- lib/json_api/support/response_helpers.rb
+- lib/json_api/support/sort_parsing.rb
+- lib/json_api/support/type_conversion.rb
+- lib/json_api/testing.rb
+- lib/json_api/testing/test_helper.rb
+- lib/json_api/version.rb
+- lib/rubocop/cop/custom/hash_value_omission.rb
+homepage: https://github.com/klaay/json_api
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/emk-klaay/jpie
-  source_code_uri: https://github.com/emk-klaay/jpie.git
-  changelog_uri: https://github.com/emk-klaay/jpie/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -241,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
-summary: A resource-focused Rails library for developing JSON:API compliant servers
+summary: JSON:API compliant Rails gem for producing and consuming JSON:API resources
 test_files: []

data/.cursor/rules/dependencies.mdc

@@ -1,19 +0,0 @@
----
-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

@@ -1,16 +0,0 @@
----
-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

@@ -1,14 +0,0 @@
----
-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

@@ -1,30 +0,0 @@
----
-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/publish_gem.mdc

@@ -1,73 +0,0 @@
-# Publish JPie Gem
-
-This rule helps publish a new version of the JPie gem.
-
-## Requirements
-# Publish JPie Gem
-
-This rule helps publish a new version of the JPie gem.
-
-## Requirements
-
-1. You must have publishing rights on RubyGems.org
-2. You must have 2FA enabled on RubyGems.org
-3. The version must be updated in `lib/jpie/version.rb`
-4. The changelog must be updated in `CHANGELOG.md`
-
-## Steps
-
-1. First, ensure the version and changelog are updated and committed
-2. Build the gem
-3. Get OTP code from user
-4. Push to RubyGems with OTP
-5. Update bundle
-6. Tag the release
-7. Push tags
-
-## Example Chat
-
-Human: Publish new version of JPie gem
-
-Assistant: I will help you publish the gem. First, let me check if the version and changelog are updated.
-[Checks version and changelog]
-
-Now I will build the gem:
-> gem build jpie.gemspec
-
-The gem has been built. To publish it, I will need your OTP code from RubyGems.org.
-What is your OTP code?
-
-Human: 123456
-
-Assistant: Thanks! I will now push the gem with your OTP:
-> gem push jpie-x.y.z.gem --otp 123456
-
-Great! The gem has been published. Now I will:
-1. Update the bundle
-> bundle update jpie
-
-2. Tag the release
-> git tag -a vx.y.z -m "Version x.y.z"
-
-3. Push the tags
-> git push origin --tags
-
-The gem has been successfully published and all post-publish steps are complete!
-
-## Automation
-
-```bash
-# Build the gem
-gem build jpie.gemspec
-
-# Push to RubyGems (OTP will be requested via chat)
-gem push jpie-*.gem --otp ${OTP_CODE}
-
-# Update bundle
-bundle update jpie
-
-# Tag and push
-VERSION=$(ruby -r ./lib/jpie/version.rb -e "puts JPie::VERSION")
-git tag -a v${VERSION} -m "Version ${VERSION}"
-git push origin --tags
-```

data/.cursor/rules/security.mdc

@@ -1,14 +0,0 @@
----
-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

@@ -1,15 +0,0 @@
----
-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

@@ -1,16 +0,0 @@
----
-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/.overcommit.yml

@@ -1,35 +0,0 @@
-# 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']