snapcher 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae931c7528d7bffe91dec097d6ead260efd735ab12382162b4e8882b7d8e8c4
-  data.tar.gz: 9d53f6a77bfef51b30fff83a3f462534a8f3fea9832af6c1bb4eb4e56baaf5f8
+  metadata.gz: e451f8410d9ef2ca33254b255bdde727d2f9a3872f585adc858f60db6aa790d3
+  data.tar.gz: e65e54268eec21fd4319d70db673f92c79bda6236a034fc47d78dadbeb8ce3a3
 SHA512:
-  metadata.gz: 37f7bf0ef0bbef1bf9a9891586305680f3af12041511c9ab019fa7950eb0a0ef26751200514823bc3f2b3eb735521c5f8f3b95ef307630f99776509da0c70aff
-  data.tar.gz: e92d5dffce405f03d8b832ad8dc32fcd18ece0bb6e2dc99379509cfe7b46c15978fa61fb379463786e78a4a6c01312efa3946a287cda030606d909487fa19d23
+  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/generators/snapcher/migration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Snapcher
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) # :nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if timestamped_migrations?
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      private
+
+      def timestamped_migrations?
+        (Rails.gem_version >= Gem::Version.new("7.0")) ?
+          ::ActiveRecord.timestamped_migrations :
+          ::ActiveRecord::Base.timestamped_migrations
+      end
+    end
+  end
+end

data/lib/generators/snapcher/migration_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Snapcher
+  module Generators
+    module MigrationHelper
+      def migration_parent
+        "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/snapcher/templates/add_user_id_to_scannings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < <%= migration_parent %>
+  def self.up
+    add_column :scannings, :user_id, :<%= options[:snapcher_user_id_column_type] %>, after: :action
+
+    add_index :scannings, [:user_id], name: index_name
+  end
+
+  def self.down
+    remove_column :scannings, :user_id
+    remove_index :scannings, name: index_name
+  end
+
+  private
+
+  def index_name
+    'snapcher_user_index'
+  end
+end

data/lib/generators/snapcher/upgrade_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+require "generators/snapcher/migration"
+require "generators/snapcher/migration_helper"
+
+module Snapcher
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Snapcher::Generators::MigrationHelper
+      extend Snapcher::Generators::Migration
+
+      class_option :snapcher_user_id_column_type, type: :string, default: "integer", required: false
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_templates
+        migration_template "add_user_id_to_scannings.rb", "db/migrate/add_user_id_to_scannings.rb"
+      end
+    end
+  end
+end

data/lib/snapcher/junker.rb

@@ -32,6 +32,7 @@ module Snapcher
         run_scanning(action: "create",
                      column_name: snapcher_options[:column_name],
                      after_params: snapcher_attributes[snapcher_options[:column_name]],
+                     user_id: snatch,
                      table_name: self.class.table_name)
       end
 
@@ -41,6 +42,7 @@ module Snapcher
         run_scanning(action: "update",
                      column_name: snapcher_options[:column_name],
                      table_name: self.class.table_name,
+                     user_id: snatch,
                      before_params: snapcher_changes[:before_params],
                      after_params: snapcher_changes[:after_params])
       end
@@ -48,8 +50,10 @@ module Snapcher
       def scanning_destroy
         return if new_record?
 
-        run_scanning(action: "destroy", column_name: snapcher_options[:column_name],
-                     table_name: self.class.table_name)
+        run_scanning(action: "destroy",
+                     column_name: snapcher_options[:column_name],
+                     table_name: self.class.table_name,
+                     user_id: snatch)
       end
 
       # List of attributes that are snapcher.
@@ -58,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
@@ -71,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.1.5"
+  VERSION = "0.3.0"
 end

data/lib/snapcher.rb

@@ -6,8 +6,13 @@ module Snapcher
   class Error < StandardError; end
   # Your code goes here...
 
+  class RequestStore < ActiveSupport::CurrentAttributes
+    attribute :snapcher_store
+  end
+
   class << self
-    attr_accessor :column_name
+    attr_accessor :column_name, :current_user
+    attr_accessor :change_user_column
     attr_writer :scanning_class
 
     def scanning_class
@@ -17,7 +22,13 @@ module Snapcher
       @scanning_class = @scanning_class.safe_constantize if @scanning_class.is_a?(String)
       @scanning_class ||= Snapcher::Scanning
     end
+
+    def store
+      RequestStore.snapcher_store ||= {}
+    end
   end
+
+  @current_user_method = :current_user
 end
 
 require "snapcher/junker"

data/sample-app/Gemfile.lock

@@ -1,75 +1,76 @@
 PATH
   remote: ..
   specs:
-    snapcher (0.1.0)
+    snapcher (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.1.1)
-      actionpack (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.2)
-    actionpack (7.1.1)
-      actionview (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       nokogiri (>= 1.8.5)
+      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.1)
-      actionpack (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.1.1)
-      activesupport (= 7.1.1)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.1.1)
-      activesupport (= 7.1.1)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
       globalid (>= 0.3.6)
-    activemodel (7.1.1)
-      activesupport (= 7.1.1)
-    activerecord (7.1.1)
-      activemodel (= 7.1.1)
-      activesupport (= 7.1.1)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       timeout (>= 0.4.0)
-    activestorage (7.1.1)
-      actionpack (= 7.1.1)
-      activejob (= 7.1.1)
-      activerecord (= 7.1.1)
-      activesupport (= 7.1.1)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       marcel (~> 1.0)
-    activesupport (7.1.1)
+    activesupport (7.1.3.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -79,34 +80,33 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     bindex (0.8.1)
-    bootsnap (1.16.0)
+    bootsnap (1.18.3)
       msgpack (~> 1.2)
     builder (3.2.4)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crass (1.0.6)
-    date (3.3.3)
-    debug (1.8.0)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    drb (2.1.1)
-      ruby2_keywords
+    date (3.3.4)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.1)
     erubi (1.12.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.8.3)
-      rdoc
-      reline (>= 0.3.8)
-    jbuilder (2.11.5)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jbuilder (2.12.0)
       actionview (>= 5.0.0)
       activesupport (>= 5.0.0)
-    loofah (2.21.4)
+    loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     mail (2.8.1)
@@ -114,33 +114,33 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.2)
+    marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.20.0)
+    minitest (5.22.3)
     msgpack (1.7.2)
-    mutex_m (0.1.2)
-    net-imap (0.4.1)
+    mutex_m (0.2.0)
+    net-imap (0.4.11)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.2.1)
+    net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4-aarch64-linux)
+    nio4r (2.7.3)
+    nokogiri (1.16.4-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.15.4-arm64-darwin)
+    nokogiri (1.16.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.16.4-x86_64-linux)
       racc (~> 1.4)
-    psych (5.1.1.1)
+    psych (5.1.2)
       stringio
-    puma (6.4.0)
+    puma (6.4.2)
       nio4r (~> 2.0)
-    racc (1.7.1)
-    rack (3.0.8)
+    racc (1.7.3)
+    rack (3.0.10)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -148,20 +148,20 @@ GEM
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
-    rails (7.1.1)
-      actioncable (= 7.1.1)
-      actionmailbox (= 7.1.1)
-      actionmailer (= 7.1.1)
-      actionpack (= 7.1.1)
-      actiontext (= 7.1.1)
-      actionview (= 7.1.1)
-      activejob (= 7.1.1)
-      activemodel (= 7.1.1)
-      activerecord (= 7.1.1)
-      activestorage (= 7.1.1)
-      activesupport (= 7.1.1)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       bundler (>= 1.15.0)
-      railties (= 7.1.1)
+      railties (= 7.1.3.2)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -169,20 +169,19 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
-    rake (13.0.6)
-    rdoc (6.5.0)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    reline (0.3.9)
+    reline (0.5.5)
       io-console (~> 0.5)
-    ruby2_keywords (0.0.5)
     sprockets (4.2.1)
       concurrent-ruby (~> 1.0)
       rack (>= 2.2.4, < 4)
@@ -190,12 +189,12 @@ GEM
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    sqlite3 (1.6.7-aarch64-linux)
-    sqlite3 (1.6.7-arm64-darwin)
-    sqlite3 (1.6.7-x86_64-linux)
-    stringio (3.0.8)
-    thor (1.3.0)
-    timeout (0.4.0)
+    sqlite3 (1.7.3-aarch64-linux)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    stringio (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     web-console (4.2.1)
@@ -207,7 +206,7 @@ GEM
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   aarch64-linux

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/post.rb

@@ -0,0 +1,5 @@
+class Post < ApplicationRecord
+  scanning column_name: "title"
+
+  belongs_to :user
+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/20240509025320_add_user_id_to_scannings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class AddUserIdToScannings < ActiveRecord::Migration[7.1]
+  def self.up
+    add_column :scannings, :user_id, :integer
+
+    add_index :scannings, [:user_id], name: index_name
+  end
+
+  def self.down
+    remove_column :scannings, :user_id
+    remove_index :scannings, name: index_name
+  end
+
+  private
+
+  def index_name
+    'user_index'
+  end
+end

data/sample-app/db/migrate/20240509080448_create_posts.rb

@@ -0,0 +1,11 @@
+class CreatePosts < ActiveRecord::Migration[7.1]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.references :user, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+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: 2023_10_19_151334) 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"
@@ -20,6 +37,8 @@ ActiveRecord::Schema[7.1].define(version: 2023_10_19_151334) do
     t.string "after_params"
     t.string "action"
     t.datetime "created_at"
+    t.integer "user_id"
+    t.index ["user_id"], name: "user_index"
   end
 
   create_table "users", force: :cascade do |t|
@@ -33,4 +52,6 @@ ActiveRecord::Schema[7.1].define(version: 2023_10_19_151334) do
     t.datetime "created_at", null: false
     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.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - ryosk7
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-27 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.
@@ -31,15 +31,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/snapcher/install/install_generator.rb
+- lib/generators/snapcher/install_generator.rb
+- lib/generators/snapcher/migration.rb
+- lib/generators/snapcher/migration_helper.rb
+- lib/generators/snapcher/templates/add_user_id_to_scannings.rb
 - lib/generators/snapcher/templates/install.rb
+- lib/generators/snapcher/upgrade_generator.rb
 - lib/snapcher.rb
 - lib/snapcher/junker.rb
 - lib/snapcher/railtie.rb
 - 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
@@ -58,6 +61,8 @@ 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
 - sample-app/bin/bundle
@@ -84,6 +89,9 @@ files:
 - sample-app/config/routes.rb
 - sample-app/db/migrate/20231019150803_create_users.rb
 - 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