jpie 0.4.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47016b3f031cd5322fecf012737f1aaace980414f3ed27dd18f54e21e5c5b76b
-  data.tar.gz: 7f8164b1e49018f93838740dcf64d79c331608095e1aa6c58e6c3fbf756ce1b8
+  metadata.gz: a8d19fff52264fdefbdba8d63bae64a532cbd2daddfdcfbfaa9ffd205d028822
+  data.tar.gz: c10827822e1638a8e0690a8432709a0cfc7d3fc5d82a845e276d74c66f8761c3
 SHA512:
-  metadata.gz: 81b14fd2264f3a2b930deec1f9328fea96c6b89e8fd0a2ef60379ec245789503304f013c442ff6e23b1eee304a8e3d34c064b8535a51edcbcf505b108f63acff
-  data.tar.gz: aad90976a22a42d6dcc038edfb0a28ef5f2a4923cf7a8d5083ad6d9c55198c93c59aab7b94cce408057597219f50f4f8ecad18651f7a774821d5906601be55e9
+  metadata.gz: 7693f48c7c20c4879478a72e233c092dd4e0a90e1ca038129b3c3d2821d2d07d0cfa50bd73b166c2c5235e2e580869b989fce91928916b2df671e397811002d7
+  data.tar.gz: 859af674c3a0eca429e86ed566df855141806b1d26d15f7dacfa2fad5ab93699957a9c30e218199bb04152b6ab865e690c0ed1cf54296ebc9fe58de0fd967dc2

data/.cursor/rules/release.mdc

@@ -0,0 +1,62 @@
+---
+description: Rules for releasing the jpie gem to RubyGems
+alwaysApply: true
+---
+
+# Gem Release Rules
+
+## Core Principles
+
+- **OTP Authentication Required**: RubyGems release requires OTP (One-Time Password) codes for authentication
+- **Interactive Release Flow**: The `rake release` command will prompt for an OTP code during push to RubyGems
+- **Cannot be fully automated**: Due to OTP requirements, gem releases require human interaction
+- **Tests and Linting Must Pass**: Both `rspec` and `rubocop` must pass before releasing
+
+## Release Process
+
+### Steps
+
+1. Bump the version in `lib/json_api/version.rb`
+2. Run tests to ensure everything passes: `bundle exec rspec`
+3. Run linting to ensure code quality: `bundle exec rubocop`
+4. Commit the version bump (include `Gemfile.lock` changes)
+5. Run `bundle exec rake release` which will:
+   - Build the gem
+   - Create a git tag
+   - Push the tag to the remote
+   - Push the gem to RubyGems (requires OTP code entry)
+
+### OTP Code Entry
+
+When running `rake release`, you will be prompted:
+
+```
+Enter OTP code:
+```
+
+Enter your RubyGems authenticator OTP code to complete the release.
+
+## Implementation Guidelines
+
+### Version Bump
+
+```ruby
+# lib/json_api/version.rb
+module JSONAPI
+  VERSION = "x.y.z"  # Update patch/minor/major as needed
+end
+```
+
+### Release Command
+
+```bash
+bundle exec rake release
+```
+
+## Best Practices
+
+- Always run the full test suite (`bundle exec rspec`) before releasing - it must pass
+- Always run linting (`bundle exec rubocop`) before releasing - it must pass
+- Ensure `Gemfile.lock` is committed with version changes
+- Have your authenticator app ready for the OTP prompt
+- Verify the release on rubygems.org after completion

data/.gitignore

@@ -0,0 +1,26 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Gem builds
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+# test log files
+spec/dummy/log/*.log
+spec/dummy/log/*.log.*
+
+# dummy app tmp directory
+spec/dummy/tmp/
+
+# SQLite test databases
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-shm
+spec/dummy/db/*.sqlite3-wal

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,140 +1,109 @@
-# frozen_string_literal: true
-
-require:
-  - rubocop-performance
-  - rubocop-rails
+plugins:
   - rubocop-rspec
+  - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 3.4
-  TargetRailsVersion: 8.0
   NewCops: enable
+  TargetRubyVersion: 3.4
+  SuggestExtensions: false
   Exclude:
-    - 'vendor/**/*'
-    - 'bin/**/*'
-    - 'db/schema.rb'
-    - 'tmp/**/*'
-    - 'spec/examples.txt'
+    - "bin/**/*"
+    - "pkg/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - "spec/dummy/db/schema.rb"
+    - "spec/dummy/db/migrate/**/*"
+    - "spec/dummy/tmp/**/*"
+    - "spec/dummy/log/**/*"
+
+# Gem-specific: ensure dev dependencies are in gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+  EnforcedStyle: gemspec
 
+# Layout
 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
+  AllowedPatterns:
+    - "^\\s*#" # Allow long comments
+  Exclude:
+    - "spec/**/*"
 
-Metrics/ClassLength:
-  Max: 150
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
 
-Metrics/ModuleLength:
-  Max: 150
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
 
-Metrics/MethodLength:
-  Max: 20
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 
+# Metrics - exclude spec and gemspec blocks only
 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
+    - "spec/**/*"
+    - "*.gemspec"
+    - "Rakefile"
 
-Rails/ApplicationRecord:
-  Enabled: false
+Metrics/ParameterLists:
+  CountKeywordArgs: false
 
-# Gemspec cops that are acceptable for gems
-Gemspec/DevelopmentDependencies:
+# Naming - allow DSL methods
+Naming/PredicatePrefix:
+  AllowedMethods:
+    - is_a?
+    - has_key?
+    - has_value?
+    - has_one
+    - has_many
+    - has_setter?
+    - has_id?
+    - has_type?
+
+# Style
+Style/Documentation:
   Enabled: false
 
-# Capybara cops that are causing issues (rubocop bug)
-Capybara/RSpec/PredicateMatcher:
+Style/DocumentationMethod:
   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
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
 
-RSpec/FilePath:
-  Enabled: false
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
 
-RSpec/SpecFilePathFormat:
-  Enabled: false
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
 
-RSpec/MultipleDescribes:
-  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 
-RSpec/LeakyConstantDeclaration:
-  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 
-RSpec/VerifiedDoubles:
-  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
 
-RSpec/MessageSpies:
-  Enabled: false
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
 
-# Style cops that are acceptable for test code
-Style/OpenStructUse:
+# Lint - file-specific exclusions
+Lint/UnusedBlockArgument:
   Exclude:
-    - 'spec/**/*'
+    - "spec/jsonapi/authorization_spec.rb"
 
-# Lint cops that are acceptable for test initialization methods
-Lint/MissingSuper:
+# RSpec - file-specific exclusions
+RSpec/DescribedClass:
   Exclude:
-    - 'spec/**/*'
+    - "spec/jsonapi/base_controller_spec.rb"
 
-Lint/ConstantDefinitionInBlock:
+# Allow deeper nesting in complex integration specs
+RSpec/NestedGroups:
+  Max: 4
   Exclude:
-    - 'spec/**/*'
+    - "spec/jsonapi_spec/active_storage_spec.rb"
 
-# Rails cops that we can ignore in test support files
-Rails/SkipsModelValidations:
-  Exclude:
-    - 'spec/**/*' 
+# Allow more memoized helpers in complex specs
+RSpec/MultipleMemoizedHelpers:
+  Max: 8

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_api.gemspec
+gemspec
+
+group :development, :test do
+  gem "appraisal", "~> 2.4"
+  gem "bundler", "~> 2.0"
+  gem "json_schemer", "~> 2.4"
+  gem "pundit", "~> 2.3"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.12"
+  gem "rspec-rails", "~> 6.0"
+  gem "rubocop", "~> 1.0"
+  gem "rubocop-performance", "~> 1.0"
+  gem "rubocop-rails", "~> 2.0"
+  gem "rubocop-rspec", "~> 3.0"
+  gem "sqlite3", ">= 2.1"
+end

data/Gemfile.lock

@@ -0,0 +1,321 @@
+PATH
+  remote: .
+  specs:
+    jpie (1.0.1)
+      actionpack (~> 8.0, >= 8.0.0)
+      rails (~> 8.0, >= 8.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    action_text-trix (2.1.15)
+      railties
+    actioncable (8.1.1)
+      actionpack (= 8.1.1)
+      activesupport (= 8.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.1.1)
+      actionpack (= 8.1.1)
+      activejob (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      mail (>= 2.8.0)
+    actionmailer (8.1.1)
+      actionpack (= 8.1.1)
+      actionview (= 8.1.1)
+      activejob (= 8.1.1)
+      activesupport (= 8.1.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.1.1)
+      actionview (= 8.1.1)
+      activesupport (= 8.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.1.1)
+      action_text-trix (~> 2.1.15)
+      actionpack (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.1.1)
+      activesupport (= 8.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.1.1)
+      activesupport (= 8.1.1)
+      globalid (>= 0.3.6)
+    activemodel (8.1.1)
+      activesupport (= 8.1.1)
+    activerecord (8.1.1)
+      activemodel (= 8.1.1)
+      activesupport (= 8.1.1)
+      timeout (>= 0.4.0)
+    activestorage (8.1.1)
+      actionpack (= 8.1.1)
+      activejob (= 8.1.1)
+      activerecord (= 8.1.1)
+      activesupport (= 8.1.1)
+      marcel (~> 1.0)
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crass (1.0.6)
+    date (3.5.0)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (6.0.0)
+    erubi (1.13.1)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    hana (1.3.7)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.3)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.16.0)
+    json_schemer (2.4.0)
+      bigdecimal
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      simpleidn (~> 0.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.9.0)
+      logger
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.26.2)
+    net-imap (0.5.12)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.5)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.6.0)
+    psych (5.2.6)
+      date
+      stringio
+    pundit (2.5.2)
+      activesupport (>= 3.0.0)
+    racc (1.8.1)
+    rack (3.2.4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.1.1)
+      actioncable (= 8.1.1)
+      actionmailbox (= 8.1.1)
+      actionmailer (= 8.1.1)
+      actionpack (= 8.1.1)
+      actiontext (= 8.1.1)
+      actionview (= 8.1.1)
+      activejob (= 8.1.1)
+      activemodel (= 8.1.1)
+      activerecord (= 8.1.1)
+      activestorage (= 8.1.1)
+      activesupport (= 8.1.1)
+      bundler (>= 1.15.0)
+      railties (= 8.1.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.1)
+      actionpack (= 8.1.1)
+      activesupport (= 8.1.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rdoc (6.15.1)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.5)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.6)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.0)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rspec (3.8.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    simpleidn (0.2.3)
+    sqlite3 (2.8.0-aarch64-linux-gnu)
+    sqlite3 (2.8.0-aarch64-linux-musl)
+    sqlite3 (2.8.0-arm-linux-gnu)
+    sqlite3 (2.8.0-arm-linux-musl)
+    sqlite3 (2.8.0-arm64-darwin)
+    sqlite3 (2.8.0-x86_64-darwin)
+    sqlite3 (2.8.0-x86_64-linux-gnu)
+    sqlite3 (2.8.0-x86_64-linux-musl)
+    stringio (3.1.8)
+    thor (1.4.0)
+    timeout (0.4.4)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal (~> 2.4)
+  bundler (~> 2.0)
+  jpie!
+  json_schemer (~> 2.4)
+  pundit (~> 2.3)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rspec-rails (~> 6.0)
+  rubocop (~> 1.0)
+  rubocop-performance (~> 1.0)
+  rubocop-rails (~> 2.0)
+  rubocop-rspec (~> 3.0)
+  sqlite3 (>= 2.1)
+
+BUNDLED WITH
+   2.7.2