snapcher 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 494c49faf14017fbe5f13d5fd7f657a7b2fad2b78ac9264c83497217a70c7977
-  data.tar.gz: 6bc6340796e5344951ee7dbf02362978a512a5ca9230acb1d68c9e7293a7362d
+  metadata.gz: e451f8410d9ef2ca33254b255bdde727d2f9a3872f585adc858f60db6aa790d3
+  data.tar.gz: e65e54268eec21fd4319d70db673f92c79bda6236a034fc47d78dadbeb8ce3a3
 SHA512:
-  metadata.gz: 91d9af61604cd3a0693c832f32ccf7e92c963e913b9800cebf7a6a4094646edca7b559a61b207a5f10f0f1e2149e2e833e156d1d192ca67df6b32a08cb9fe737
-  data.tar.gz: 5e734b6997ef32f8f7fda3f2f23a9267ffa3ef01fa5268fe3303b222d9e20036f71925b2463ed526b62dd34a5fe5a89b74e57b000f07aaefa9c91b36ad51bae9
+  metadata.gz: 7467703fdd41b839c084d3cb3f0bdcb391c0bdb71bb998624bb15851a63182d25b606345466451854a55473c38b0cd6d9653fd457d027d3152a1b344962de25b
+  data.tar.gz: 0e94835a649439317cc0a0f2ffa0e0dceb8821f462f4707e6492ed9c3994532700dca74843e8327ea85e014dd16add2fc5f542ba1f22ad8aad8b2a46380e68ef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snapcher (0.1.5)
+    snapcher (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -13,6 +13,10 @@ When a change is made to a specific column, the difference between before and af
 
 To make it easier for analysts, save the table name, column name, and data before and after changes as separate columns.
 
+The name of this gem comes from one of Hideo Kojima's game works, ["Snatcher"](https://en.wikipedia.org/wiki/Snatcher_(video_game)).
+
+It was the first of his game works to introduce cinematic direction, and "Snapcher" is also the first of my gem works.
+
 ## Supported
 
 ### Snapcher supports Ruby versions:
@@ -76,3 +80,11 @@ snapcher.action # => "update"
 snapcher.before_params # => "Gillian Seed"
 snapcher.after_params # => "Mika Slayton"
 ```
+If the "Snatcher" column you want to capture is not user_id, you can specify this.
+
+```ruby
+class User < ActiveRecord::Base
+  scanning column_name: "name", change_user_column: "id"
+end
+```
+

data/lib/snapcher/junker.rb

@@ -32,7 +32,7 @@ module Snapcher
         run_scanning(action: "create",
                      column_name: snapcher_options[:column_name],
                      after_params: snapcher_attributes[snapcher_options[:column_name]],
-                     user_id: snapcher_attributes["user_id"],
+                     user_id: snatch,
                      table_name: self.class.table_name)
       end
 
@@ -42,7 +42,7 @@ module Snapcher
         run_scanning(action: "update",
                      column_name: snapcher_options[:column_name],
                      table_name: self.class.table_name,
-                     user_id: snapcher_attributes["user_id"],
+                     user_id: snatch,
                      before_params: snapcher_changes[:before_params],
                      after_params: snapcher_changes[:after_params])
       end
@@ -53,7 +53,7 @@ module Snapcher
         run_scanning(action: "destroy",
                      column_name: snapcher_options[:column_name],
                      table_name: self.class.table_name,
-                     user_id: snapcher_attributes["user_id"])
+                     user_id: snatch)
       end
 
       # List of attributes that are snapcher.
@@ -62,6 +62,10 @@ module Snapcher
         normalize_enum_changes(snapcher_attributes)
       end
 
+      def snatch
+        snapcher_attributes[snapcher_options[:change_user_column]] || snapcher_attributes["user_id"]
+      end
+
       def scanning_change_values
         all_changes = if respond_to?(:changes_to_save)
                         changes_to_save
@@ -75,9 +79,10 @@ module Snapcher
       end
 
       def snapcher_changes
+        snapcher_attributes = filter_encrypted_attrs(attributes)
         filtered_changes = scanning_change_values
-
         monitoring_column_name = snapcher_options[:column_name]
+        change_user_column = snapcher_options[:change_user_column]
 
         return if filtered_changes[monitoring_column_name.to_s].nil?
 

data/lib/snapcher/version.rb

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

data/lib/snapcher.rb

@@ -12,6 +12,7 @@ module Snapcher
 
   class << self
     attr_accessor :column_name, :current_user
+    attr_accessor :change_user_column
     attr_writer :scanning_class
 
     def scanning_class

data/sample-app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    snapcher (0.2.0)
+    snapcher (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/sample-app/app/models/gift.rb

@@ -0,0 +1,3 @@
+class Gift < ApplicationRecord
+  scanning column_name: "name", change_user_column: "from_user_id"
+end

data/sample-app/app/models/user.rb

@@ -1,5 +1,5 @@
 class User < ApplicationRecord
-  scanning column_name: "role"
+  scanning column_name: "role", change_user_column: "id"
 
   enum :role, { normal: 0, admin: 1 }
 end

data/sample-app/db/migrate/20240625084542_create_gifts.rb

@@ -0,0 +1,11 @@
+class CreateGifts < ActiveRecord::Migration[7.1]
+  def change
+    create_table :gifts do |t|
+      t.integer :from_user_id
+      t.integer :to_user_id
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/sample-app/db/schema.rb

@@ -10,7 +10,24 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2024_05_09_025320) do
+ActiveRecord::Schema[7.1].define(version: 2024_06_25_084542) do
+  create_table "gifts", force: :cascade do |t|
+    t.integer "from_user_id"
+    t.integer "to_user_id"
+    t.string "name"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "posts", force: :cascade do |t|
+    t.string "title"
+    t.text "body"
+    t.integer "user_id", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["user_id"], name: "index_posts_on_user_id"
+  end
+
   create_table "scannings", force: :cascade do |t|
     t.integer "scannable_id"
     t.string "scannable_type"
@@ -36,4 +53,5 @@ ActiveRecord::Schema[7.1].define(version: 2024_05_09_025320) do
     t.datetime "updated_at", null: false
   end
 
+  add_foreign_key "posts", "users"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapcher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ryosk7
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   Snapcher is an ORM extension that logs changes to specific columns to your model.
@@ -43,7 +43,6 @@ files:
 - lib/snapcher/scanning.rb
 - lib/snapcher/sweeper.rb
 - lib/snapcher/version.rb
-- logo/snapcher_logo.png
 - sample-app/.dockerignore
 - sample-app/.gitattributes
 - sample-app/.gitignore
@@ -62,6 +61,7 @@ files:
 - sample-app/app/jobs/application_job.rb
 - sample-app/app/models/application_record.rb
 - sample-app/app/models/concerns/.keep
+- sample-app/app/models/gift.rb
 - sample-app/app/models/post.rb
 - sample-app/app/models/user.rb
 - sample-app/app/views/layouts/application.html.erb
@@ -91,6 +91,7 @@ files:
 - sample-app/db/migrate/20231019151334_install_snapcher.rb
 - sample-app/db/migrate/20240509025320_add_user_id_to_scannings.rb
 - sample-app/db/migrate/20240509080448_create_posts.rb
+- sample-app/db/migrate/20240625084542_create_gifts.rb
 - sample-app/db/schema.rb
 - sample-app/db/seeds.rb
 - sample-app/lib/assets/.keep