bemi-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3333de9e0a741dd9ea055875b359e3cc5762e0cb8cda2ca7993fb013e761ad
-  data.tar.gz: 24080ca04dee07312adb7e41bf08286aae441ec404fc8bc1d06ed64693041c27
+  metadata.gz: a06ff1246ab3897a88169b8cad1bc69b1558bf6bb0d00d88408a88c6685fca3c
+  data.tar.gz: 52a82309d53e22acc15f374d152fbf473f4011a0d3c1a20d713e1060e418a470
 SHA512:
-  metadata.gz: d927d26dc83bdc1d1d0f44353506729c885b2de498f077fda655556f76ca14fb6dde5fb01f0c72e9f4a372e7970510bc9f16b4f60066539e0fe2bc3325259c77
-  data.tar.gz: ba9d3e21f4d365e4dc419a6444fe3fddfe8bd98e753eb08f24064be20d3883e864d514ab2cc89b050657410a835c4fdfebed82ac0cdaa44f7f154d3081eb7d35
+  metadata.gz: cd7cbe37593d41d81ddaa9e36eb36518ee0c431b96f8ecdadd4fe6ef1d13bb8eaacdd81762aa0d00b949183e215fdcc6cb2a1e8c9616e9d65d6ada156b1847ef
+  data.tar.gz: 79cbc5dcafbe7cc3c6d26e68551031a70a03e12cd636e02edb122014a0e3449c87a233f94fd653cdb4ff577b0ac33fd7bb37b24dc9e863cb507df29a1cb986e8

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+#### [v0.3.0](https://github.com/BemiHQ/bemi-rails/compare/v0.2.1...v0.3.0) - 2024-04-26
+
+- Allow querying changes by a record
+- Allow filtering changes by values and operations
+- Allow sorting changes by using new scopes
+- Allow diffing a change
+- Filter logs by using `Rails.application.config.filter_parameters`
+
+#### [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

data/lib/bemi/change_query_helpers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Bemi::ChangeQueryHelpers
+  extend ActiveSupport::Concern
+
+  included do
+    scope :before, ->(hash) { where('before @> ?', hash.to_json) }
+    scope :after, ->(hash) { where('after @> ?', hash.to_json) }
+    scope :context, ->(hash) { where('context @> ?', hash.to_json) }
+
+    scope :created, -> { where(operation: 'CREATE') }
+    scope :updated, -> { where(operation: 'UPDATE') }
+    scope :deleted, -> { where(operation: 'DELETE') }
+
+    scope :asc, -> { order(committed_at: :asc) }
+    scope :desc, -> { order(committed_at: :desc) }
+
+    self.filter_attributes = (Rails.respond_to?(:filter_parameters) ? Rails.configuration.filter_parameters : []).map do |filter|
+      if filter == :_key
+        /(?<!primary_)key/ # don't filter out primary_key
+      else
+        filter
+      end
+    end
+  end
+
+  def diff
+    result = {}
+
+    (before.keys | after.keys).each do |key|
+      next if before[key] == after[key]
+      result[key] = [before[key], after[key]]
+    end
+
+    result
+  end
+end

data/lib/bemi/context.rb

@@ -37,6 +37,9 @@ class Bemi
     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

data/lib/bemi/record_query_helpers.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module Bemi::RecordQueryHelpers
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Setter
+    def bemi_change_class(bemi_change_class_name)
+      @@bemi_change_class_name = bemi_change_class_name
+    end
+
+    # Getter
+    def __bemi_change_class
+      raise "Please set the change class name with `bemi_change_class 'BemiChange'`" if !@@bemi_change_class_name
+      @@__bemi_change_class ||= @@bemi_change_class_name.constantize
+    end
+  end
+
+  def bemi_changes
+    self.class.__bemi_change_class.where(table: self.class.table_name, primary_key: attributes[self.class.primary_key])
+  end
+end

data/lib/bemi/version.rb

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

data/lib/bemi.rb

@@ -3,7 +3,9 @@
 class Bemi
 end
 
+require_relative "./bemi/change_query_helpers"
 require_relative "./bemi/context"
 require_relative "./bemi/migration"
 require_relative "./bemi/migration_generator"
+require_relative "./bemi/record_query_helpers"
 require_relative "./bemi/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bemi-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - exAspArk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -53,9 +53,11 @@ files:
 - bemi-rails.gemspec
 - lib/bemi-rails.rb
 - lib/bemi.rb
+- lib/bemi/change_query_helpers.rb
 - lib/bemi/context.rb
 - lib/bemi/migration.rb
 - lib/bemi/migration_generator.rb
+- lib/bemi/record_query_helpers.rb
 - lib/bemi/templates/migration.rb.erb
 - lib/bemi/version.rb
 - sig/bemi-rails.rbs