bemi-rails 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0601f1bb209e0d1d0e0b08f7e9f6ed1b32575b5bb6b3dfd1c6262a249afaec
-  data.tar.gz: ea404c16b60f45fedfef06dfbd017aaba63649d99a4fc0e001bf015ede6c42c5
+  metadata.gz: f19aaf859eda061205bee3a1a49aa3985982a80ebb90b94fb44160431753f058
+  data.tar.gz: 947da8058a12c7171e312dc8a2069e6b303b16af670247c287830336def82dad
 SHA512:
-  metadata.gz: 78e7ab750b1adcab1bb9675fdb5425ed9404f01fb920b1ed5c9712ce94c6f1a8972add88d94e0d6b3d977ff9835c14eff9bec78c346e80c73e934f959825e1b5
-  data.tar.gz: 1bc3a6fb17ad990a96eb92f05f2d85f813c3580f343715a64d45df25da2aa5d0451911df681210fe9c100acc9cc43ac6b52d39e6e302009cc4cb27334b32a01d
+  metadata.gz: fe752060e2291a4e39cf126a5984a4453db821055e49a80d81e4efd4dfc0d96717d4a6ebdf18cc3800869409438e81bac1b291292497c0c8412d4eb5df9417a6
+  data.tar.gz: 238dfc3d2ed1ce9a0aa6fbdcbf0697009dcd1a29b6858aa01b7518751d3ac0da36e84637b6945c22ca63e6eaf0971aaa1e52981dbb8b8a479d0bf6b8b0800cd4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+#### [v0.2.1](https://github.com/BemiHQ/bemi-rails/compare/v0.2.0...v0.2.1) - 2024-04-16
+
+- Validate context type to make sure it's a hash or hash-like object
+
+#### [v0.2.0](https://github.com/BemiHQ/bemi-rails/compare/v0.1.0...v0.2.0) - 2024-04-16
+
+- Fix compatibility with ActiveRecord versions prior to 7.1
+- Validate context size to keep it under 1MB
+
 #### v0.1.0 - 2024-03-08
 
 - Create the gem

data/README.md

@@ -24,7 +24,7 @@
 
 # Bemi Rails
 
-[Bemi](https://bemi.io) plugs into [Ruby on Rails](https://github.com/rails/rails) with Active Record and PostgreSQL to track database changes automatically. It unlocks robust context-aware audit trails and time travel querying inside your application.
+[Bemi](https://bemi.io) plugs into [Ruby on Rails](https://github.com/rails/rails) with Active Record and your existing PostgreSQL database to track data changes automatically. It unlocks robust context-aware audit trails and time travel querying inside your application.
 
 Designed with simplicity and non-invasiveness in mind, Bemi doesn't require any alterations to your existing database structure. It operates in the background, empowering you with data change tracking features.
 

data/lib/bemi/context.rb

@@ -3,22 +3,46 @@
 require 'active_record'
 
 class Bemi
-  def self.set_context(context)
-    Thread.current[:bemi_context] = context
-  end
+  READ_QUERY = ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp(
+    :close, :declare, :fetch, :move, :set, :show
+  )
 
-  def self.context
-    Thread.current[:bemi_context]
-  end
+  MAX_CONTEXT_SIZE = 1_000_000 # ~1MB
+
+  class << self
+    def set_context(ctx)
+      Thread.current[:bemi_context] = ctx
+    end
+
+    def context
+      Thread.current[:bemi_context]
+    end
 
-  def self.append_context
-    ->(sql, adapter) do
-      if adapter.write_query?(sql)
-        "#{sql} /*Bemi #{Bemi.context.to_json} Bemi*/"
-      else
-        sql
+    def append_context
+      Proc.new do |sql, adapter = nil| # Adapter is automatically passed only with Rails v7.1+
+        if (adapter ? adapter.write_query?(sql) : write_query?(sql)) && ctx = serialized_context
+          "#{sql} /*Bemi #{ctx} Bemi*/"
+        else
+          sql
+        end
       end
     end
+
+    private
+
+    def write_query?(sql)
+      !READ_QUERY.match?(sql)
+    rescue ArgumentError
+      !READ_QUERY.match?(sql.b)
+    end
+
+    def serialized_context
+      return if context.nil?
+      return if !context.is_a?(Hash) && !context.respond_to?(:has_key?)
+
+      result = context.to_json
+      result if result.size <= MAX_CONTEXT_SIZE
+    end
   end
 end
 

data/lib/bemi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Bemi
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bemi-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - exAspArk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties