rails_audit_log 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e3de1e31a64d33c94042ea45ff4eeb391d48cc65db934bf7b7256656326c480
-  data.tar.gz: e34d558b4687f61336af9a7f7e6ae3faebe6ea77533e7da8e360d27dbfc70060
+  metadata.gz: ee40b3b22f2f2a2b0b172ab8790f3f7e7a4317ba62e204149f9c676b51587cff
+  data.tar.gz: 4a2ff97b26eba46427a429ad833ef5083d1f733804f002a001df348617d5b51b
 SHA512:
-  metadata.gz: cd8d51146c5b915b5c00cc863f23cffc70066cf4cfaafc5e667e9b064b225168b71f45d5699199ba37de78f0089cebabb8a1707f6f837642c32b0fb73c290a6c
-  data.tar.gz: 3abf1d5c1894de5496a76b8827eb23f6f8b430e9a4a192505e1012a3be022cf01290b5ef38cc3d9b43e2e4dc5f46c2e2667fdd77015ce0dfb111fab6141530b5
+  metadata.gz: c175fe09de7e324232d55a083ac11db1dba88818779b18fe139c54d655b89bdf871caebdfc0b8161a9c730f2dc8246d886c7b280523532f300dccaf8d7025825
+  data.tar.gz: 36ef89be1868b069c8e3d46fa8d0759b0b2ba4fca231d928523cc9919f9c354637e34dc15dce2c6b2d72191e0d0a2f472c6e520bf7330dea35234c08f9a17ea2

data/README.md

@@ -909,20 +909,47 @@ article.paper_trail.version_at(1.week.ago) # reconstructed state at a point in t
 
 [↑ Table of contents](#table-of-contents)
 
-> Coming in the 1.x series
+Each companion gem declares `rails_audit_log` as a dependency so you only add what you use.
 
-| Gem | What it adds |
-|---|---|
-| `rails_audit_log-graphql` | Mountable GraphQL endpoint at `/audit/graphql` — queryable audit trail for API-first apps without forcing `graphql-ruby` on users who don't need it |
+### `rails_audit_log-graphql`
 
-Each companion gem declares `rails_audit_log` as a dependency so you only add what you use.
+[![Gem Version](https://img.shields.io/gem/v/rails_audit_log-graphql.svg)](https://rubygems.org/gems/rails_audit_log-graphql)
+
+A mountable GraphQL endpoint for API-first apps. Shipped as a separate gem so `graphql-ruby` is never a transitive dependency for users who don't need it.
+
+Add both gems to your `Gemfile`:
+
+```ruby
+gem "rails_audit_log"
+gem "rails_audit_log-graphql"
+```
+
+Mount the GraphQL engine alongside the main engine:
+
+```ruby
+# config/routes.rb
+mount RailsAuditLog::Engine,          at: "/audit"
+mount RailsAuditLog::GraphQL::Engine, at: "/audit/graphql"
+```
+
+Authentication re-uses `RailsAuditLog.authenticate` — nothing extra to configure.
+
+**Queries and subscriptions:**
+
+| Operation | Signature | Description |
+|---|---|---|
+| `Query.auditLogEntries` | `(event:, itemType:, itemId:, actorId:, since:, until:, page:)` | Filterable, paginated list |
+| `Query.auditLogEntry` | `(id:)` | Single entry lookup with full diff |
+| `Subscription.auditLogEntryCreated` | `(itemType:, itemId:)` | Real-time stream for a resource (requires Action Cable) |
+
+All fields on `AuditLogEntry` are exposed via `AuditLogEntryType`.
 
 ## Requirements
 
 [↑ Table of contents](#table-of-contents)
 
 - Ruby >= 3.3
-- Rails >= 7.2
+- Rails >= 8.0
 
 ## Performance
 

data/Rakefile

@@ -14,7 +14,12 @@ task :zeitwerk do
   sh({ "RAILS_ENV" => "test" }, "cd spec/dummy && bundle exec rails runner 'Rails.autoloaders.main.eager_load'")
 end
 
-task default: ["bundle:audit:update", "bundle:audit:check", :rubocop, :zeitwerk, :spec]
+desc "Run Brakeman static analysis on the engine (spec/ and the dummy app are excluded)"
+task :brakeman do
+  sh "bundle exec brakeman -q --no-pager --force-scan --skip-files spec/"
+end
+
+task default: ["bundle:audit:update", "bundle:audit:check", :brakeman, :rubocop, :zeitwerk, :spec]
 
 desc "Run the performance benchmark suite (requires dev:setup first)"
 task :benchmark do

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -142,9 +142,9 @@ module RailsAuditLog
     #   post.audit_log_entries.updated_events.touching(:published_at)
     scope :touching, ->(attribute) {
       if connection.adapter_name =~ /PostgreSQL/i
-        # :nocov:
+        # simplecov:disable
         where("object_changes->>? IS NOT NULL", attribute.to_s)
-        # :nocov:
+        # simplecov:enable
       else
         where("json_extract(object_changes, ?) IS NOT NULL", "$.#{attribute}")
       end

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement