snapcher 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d135b4fe2eb8e197ce54999308444dff97dcce48be81085900c3ab0f31630a01
-  data.tar.gz: 39561cc6337d078b96c55bf8eb01bb3682f9691e32d9c899f14d5efd7fc19a7d
+  metadata.gz: cf06ee5a1a0a2a88b36aaf158a7968e6e43e076d48c5109312f299b00dd84f75
+  data.tar.gz: 0005bf88e3a4e16762aec1ba059a327bdb2c5e01e97f9727a5a4ac60db1abf42
 SHA512:
-  metadata.gz: 862907d00cd9ced9f372a6ea76816ee05b43ed2d5689edc5b6886232697c4e5c9dea0f55671547a6c703f356cebf2aeccc795da3fb49ebabedd243c8989ef30a
-  data.tar.gz: 191d10f000330f07fda6c60fe54747f413149063182edd59808e289eb60e3073e14368dbdd1070d6a8fd57b6624d29af984ead148aebdfd5e11ab75c747fa793
+  metadata.gz: b9377f8a832c2ca08c13b9cdeb05651be64672d7058a96e8bf36ca82fb5b2142e8cc3f48c15f2555011dca32ab409ab20119c07e1822ca6b12e77f3efc30257b
+  data.tar.gz: e7c95f86a999f0000686f5a9f4afc55af69b0fc3cd451e8a9cf1d1970f1c06d50a14cefdfe72a9c0e057f1e012c0c1f1fd9240562446ee1141ee0298023e103e

data/.rubocop.yml

@@ -1,5 +1,14 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  rubocop-discourse: default.yml
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
+  NewCops: disable
+  Exclude:
+    - lib/generators/snapcher/templates/install.rb
+    - sample-app/bin/bundle
 
 Style/StringLiterals:
   Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,78 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 999999`
+# on 2023-10-23 18:48:06 UTC using RuboCop version 1.57.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Discourse/NoChdir:
+  Exclude:
+    - 'spec/**/*'
+    - 'plugins/*/spec/**/*'
+    - 'snapcher.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith, Severity.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/snapcher/junker.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, AllowedPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/snapcher/junker.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'sample-app/config/environments/production.rb'
+
+# Offense count: 34
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/generators/snapcher/install/install_generator.rb'
+    - 'sample-app/Gemfile'
+    - 'sample-app/Rakefile'
+    - 'sample-app/app/controllers/application_controller.rb'
+    - 'sample-app/app/helpers/application_helper.rb'
+    - 'sample-app/app/jobs/application_job.rb'
+    - 'sample-app/app/models/application_record.rb'
+    - 'sample-app/app/models/user.rb'
+    - 'sample-app/bin/rails'
+    - 'sample-app/bin/rake'
+    - 'sample-app/bin/setup'
+    - 'sample-app/config.ru'
+    - 'sample-app/config/application.rb'
+    - 'sample-app/config/boot.rb'
+    - 'sample-app/config/environment.rb'
+    - 'sample-app/config/environments/development.rb'
+    - 'sample-app/config/environments/production.rb'
+    - 'sample-app/config/environments/test.rb'
+    - 'sample-app/config/initializers/assets.rb'
+    - 'sample-app/config/initializers/content_security_policy.rb'
+    - 'sample-app/config/initializers/filter_parameter_logging.rb'
+    - 'sample-app/config/initializers/inflections.rb'
+    - 'sample-app/config/initializers/permissions_policy.rb'
+    - 'sample-app/config/puma.rb'
+    - 'sample-app/config/routes.rb'
+    - 'sample-app/db/migrate/20231019150803_create_users.rb'
+    - 'sample-app/db/schema.rb'
+    - 'sample-app/db/seeds.rb'
+    - 'spec/rails_app/config/application.rb'
+    - 'spec/rails_app/config/environment.rb'
+    - 'spec/rails_app/config/environments/test.rb'
+    - 'spec/rails_app/config/routes.rb'
+    - 'spec/support/active_record/models.rb'
+    - 'spec/support/active_record/schema.rb'

data/Gemfile

@@ -3,10 +3,14 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in snapcher.gemspec
-gemspec
+gemspec name: "snapcher"
 
+gem "debug", ">= 1.8.0"
+gem "rails", ">= 7.0.0", "< 7.1"
+gem "railties", require: false
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
+gem "rspec-rails", "~> 6.0.0"
+gem "rubocop-discourse", "~> 3.4.0"
 gem "rubocop", "~> 1.21"
+gem "sqlite3", ">= 1.4"

data/Gemfile.lock

@@ -1,24 +1,168 @@
 PATH
   remote: .
   specs:
-    snapcher (0.1.0)
+    snapcher (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.8)
+      actionpack (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activesupport (= 7.0.8)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.8)
+      actionview (= 7.0.8)
+      activesupport (= 7.0.8)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.8)
+      actionpack (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.8)
+      activesupport (= 7.0.8)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.8)
+      activesupport (= 7.0.8)
+      globalid (>= 0.3.6)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activerecord (7.0.8)
+      activemodel (= 7.0.8)
+      activesupport (= 7.0.8)
+    activestorage (7.0.8)
+      actionpack (= 7.0.8)
+      activejob (= 7.0.8)
+      activerecord (= 7.0.8)
+      activesupport (= 7.0.8)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.1.1)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
     diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    net-imap (0.4.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
+    psych (5.1.1.1)
+      stringio
     racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.8)
+      actioncable (= 7.0.8)
+      actionmailbox (= 7.0.8)
+      actionmailer (= 7.0.8)
+      actionpack (= 7.0.8)
+      actiontext (= 7.0.8)
+      actionview (= 7.0.8)
+      activejob (= 7.0.8)
+      activemodel (= 7.0.8)
+      activerecord (= 7.0.8)
+      activestorage (= 7.0.8)
+      activesupport (= 7.0.8)
+      bundler (>= 1.15.0)
+      railties (= 7.0.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.8)
+      actionpack (= 7.0.8)
+      activesupport (= 7.0.8)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
     regexp_parser (2.8.2)
+    reline (0.3.9)
+      io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -32,6 +176,14 @@ GEM
     rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
+    rspec-rails (6.0.3)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
     rspec-support (3.12.1)
     rubocop (1.57.1)
       base64 (~> 0.1.1)
@@ -47,17 +199,46 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-discourse (3.4.0)
+      rubocop (>= 1.1.0)
+      rubocop-rspec (>= 2.0.0)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    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)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
+  debug (>= 1.8.0)
+  rails (>= 7.0.0, < 7.1)
+  railties
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-rails (~> 6.0.0)
   rubocop (~> 1.21)
+  rubocop-discourse (~> 3.4.0)
   snapcher!
+  sqlite3 (>= 1.4)
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -1,39 +1,78 @@
+![snapcher_logo](https://github.com/ryosk7/snapcher/blob/0-1-2/logo/snapcher_logo.png?raw=true)
+
+----------
+
 # Snapcher
+[![Gem Version](https://img.shields.io/gem/v/snapcher.svg)](http://rubygems.org/gems/snapcher)
+![GitHub](https://img.shields.io/github/license/ryosk7/snapcher)
+=======
 
-TODO: Delete this and the text below, and describe your gem
+**Snapcher** is an ORM extension that logs changes to specific columns to your model.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/snapcher`. To experiment with that code, run `bin/console` for an interactive prompt.
+When a change is made to a specific column, the difference between before and after the change is obtained and saved.
 
-## Installation
+To make it easier for analysts, save the table name, column name, and data before and after changes as separate columns.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Supported
 
-Install the gem and add to the application's Gemfile by executing:
+### Snapcher supports Ruby versions:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+* 3.1
+* 3.2
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Snapcher supports Rails versions:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+* 7.0
+* 7.1
 
-## Usage
+## Supported ORMs
+
+Snapcher is currently ActiveRecord-only.
 
-TODO: Write usage instructions here
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "snapcher"
+```
 
-## Development
+Then, from your Rails app directory, create the `scannings` table:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+$ rails generate snapcher:install
+$ rails db:migrate
+```
+
+## Usage
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Simply call `scanning` on your models.
 
-## Contributing
+Use `column_name:` to select the column you want to log.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snapcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/snapcher/blob/main/CODE_OF_CONDUCT.md).
+```ruby
+class User < ActiveRecord::Base
+  scanning column_name: "name"
+end
+```
 
-## License
+By default, whenever a user is created, updated or destroyed, a new scanning is created.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+user = User.create!(name: "Gillian Seed")
+user.scannings.count # => 1
+user.update!(name: "Mika Slayton")
+user.scannings.count # => 2
+user.destroy
+user.scannings.count # => 3
+```
 
-## Code of Conduct
+Scanning contain information regarding what action was taken on the model and what changes were made.
 
-Everyone interacting in the Snapcher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snapcher/blob/main/CODE_OF_CONDUCT.md).
+```ruby
+user.update!(name: "Mika Slayton")
+snapcher = user.scannings.last
+snapcher.action # => "update"
+snapcher.before_params # => "Gillian Seed"
+snapcher.after_params # => "Mika Slayton"
+```

data/Rakefile

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require "bundler/gem_helper"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
+Bundler::GemHelper.install_tasks(name: "snapcher")
+
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"

data/lib/generators/snapcher/install/install_generator.rb

@@ -7,7 +7,7 @@ module Snapcher
   class InstallGenerator < ::Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path("../../templates", __FILE__)
+    source_root File.expand_path("../templates", __dir__)
 
     def copy_migration
       migration_template "install.rb", "db/migrate/install_snapcher.rb"
@@ -24,13 +24,15 @@ module Snapcher
     end
 
     def self.timestamped_migrations?
-      (Rails.version >= "7.0") ?
-        ::ActiveRecord.timestamped_migrations :
+      if Rails.version >= "7.0"
+        ::ActiveRecord.timestamped_migrations
+      else
         ::ActiveRecord::Base.timestamped_migrations
+      end
     end
 
     def migration_parent
       "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
     end
   end
-end
+end

data/lib/snapcher/junker.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require "debug"
+
 module Snapcher
   module Junker
     extend ActiveSupport::Concern
 
-    CALLBACKS = [:scanning_create, :scanning_update, :scanning_destroy]
+    CALLBACKS = %i[scanning_create scanning_update scanning_destroy]
 
     module ClassMethods
       def scanning(options = {})
@@ -15,7 +17,9 @@ module Snapcher
 
         self.snapcher_options = options
 
-        has_many :scannings, -> { order(version: :asc) }, as: :scannable, class_name: "Snapcher::Scanning", inverse_of: :scannable
+        has_many :scannings, lambda {
+                               order(id: :asc)
+                             }, as: :scannable, class_name: "Snapcher::Scanning", inverse_of: :scannable
 
         after_create :scanning_create
         before_update :scanning_update
@@ -27,19 +31,27 @@ module Snapcher
 
     module ScanningInstanceMethods
       def scanning_create
-        run_scanning(action: "create", column_name: self.snapcher_options[:column_name], after_params: snapcher_attributes[self.snapcher_options[:column_name]], table_name: self.class.table_name)
+        run_scanning(action: "create",
+                     column_name: snapcher_options[:column_name],
+                     after_params: snapcher_attributes[snapcher_options[:column_name]],
+                     table_name: self.class.table_name)
       end
 
       def scanning_update
-        if (changes = snapcher_changes).present?
-          run_scanning(action: "update", column_name: self.snapcher_options[:column_name], table_name: self.class.table_name, before_params: snapcher_changes[:before_params], after_params: snapcher_changes[:after_params])
-        end
+        return unless (changes = snapcher_changes).present?
+
+        run_scanning(action: "update",
+                     column_name: snapcher_options[:column_name],
+                     table_name: self.class.table_name,
+                     before_params: snapcher_changes[:before_params],
+                     after_params: snapcher_changes[:after_params])
       end
 
       def scanning_destroy
-        unless new_record?
-          run_scanning(action: "destroy", column_name: self.snapcher_options[:column_name], table_name: self.class.table_name)
-        end
+        return if new_record?
+
+        run_scanning(action: "destroy", column_name: snapcher_options[:column_name],
+                     table_name: self.class.table_name)
       end
 
       # List of attributes that are snapcher.
@@ -50,10 +62,10 @@ module Snapcher
 
       def scanning_change_values
         all_changes = if respond_to?(:changes_to_save)
-          changes_to_save
-        else
-          changes
-        end
+                        changes_to_save
+                      else
+                        changes
+                      end
 
         filtered_changes = filter_encrypted_attrs(all_changes)
         filtered_changes = normalize_enum_changes(filtered_changes)
@@ -63,20 +75,20 @@ module Snapcher
       def snapcher_changes
         filtered_changes = scanning_change_values
 
-        monitoring_column_name = self.snapcher_options[:column_name]
+        monitoring_column_name = snapcher_options[:column_name]
 
         return if filtered_changes[monitoring_column_name.to_s].nil?
 
         before_params = filtered_changes[monitoring_column_name.to_s][0]
         after_params = filtered_changes[monitoring_column_name.to_s][1]
-        {before_params: before_params, after_params: after_params}
+        { before_params:, after_params: }
       end
 
       def run_scanning(attrs)
-        run_callbacks(:scanning) {
+        run_callbacks(:scanning) do
           scanning = scannings.create(attrs)
           scanning
-        }
+        end
       end
 
       def filter_encrypted_attrs(filtered_changes)

data/lib/snapcher/railtie.rb

@@ -4,12 +4,8 @@ module Snapcher
   class Railtie < Rails::Railtie
     initializer "snapcher.sweeper" do
       ActiveSupport.on_load(:action_controller) do
-        if defined?(ActionController::Base)
-          ActionController::Base.around_action Snapcher::Sweeper.new
-        end
-        if defined?(ActionController::API)
-          ActionController::API.around_action Snapcher::Sweeper.new
-        end
+        ActionController::Base.around_action Snapcher::Sweeper.new if defined?(ActionController::Base)
+        ActionController::API.around_action Snapcher::Sweeper.new if defined?(ActionController::API)
       end
     end
   end

data/lib/snapcher/scanning.rb

@@ -6,6 +6,8 @@ module Snapcher
 
     cattr_accessor :snapcher_class_names
 
-    scope :scannable_finder, ->(scannable_id, scannable_type) { where(scannable_id: scannable_id, scannable_type: scannable_type) }
+    scope :scannable_finder, lambda { |scannable_id, scannable_type|
+                               where(scannable_id:, scannable_type:)
+                             }
   end
 end

data/lib/snapcher/sweeper.rb

@@ -20,7 +20,9 @@ module Snapcher
     end
 
     def current_user
-      lambda { controller.send(Snapcher.current_user_method) if controller.respond_to?(Snapcher.current_user_method, true) }
+      lambda {
+        controller.send(Snapcher.current_user_method) if controller.respond_to?(Snapcher.current_user_method, true)
+      }
     end
 
     def remote_ip

data/lib/snapcher/version.rb

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

data/lib/snapcher.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_record"
-require_relative "snapcher/version"
 
 module Snapcher
   class Error < StandardError; end
@@ -12,7 +11,8 @@ module Snapcher
     attr_writer :scanning_class
 
     def scanning_class
-      # The scanning_class is set as String in the initializer. It can not be constantized during initialization and must
+      # The scanning_class is set as String in the initializer.
+      # It can not be constantized during initialization and must
       # be constantized at runtime.
       @scanning_class = @scanning_class.safe_constantize if @scanning_class.is_a?(String)
       @scanning_class ||= Snapcher::Scanning
@@ -27,4 +27,6 @@ ActiveSupport.on_load :active_record do
   include Snapcher::Junker
 end
 
-require "snapcher/railtie"
+require "snapcher/sweeper"
+require_relative "snapcher/railtie" if defined?(Rails::Railtie)
+# require "snapcher/railtie"

data/sample-app/Gemfile

@@ -2,22 +2,21 @@ source "https://rubygems.org"
 
 ruby "3.2.2"
 
+gem "jbuilder"
+gem "puma", ">= 5.0"
 gem "rails", "~> 7.1.1"
 gem "sprockets-rails"
 gem "sqlite3", "~> 1.4"
-gem "puma", ">= 5.0"
-gem "jbuilder"
 
 gem "snapcher", path: "../"
 
-gem "tzinfo-data", platforms: %i[ windows jruby ]
 gem "bootsnap", require: false
+gem "tzinfo-data", platforms: %i[windows jruby]
 
 group :development, :test do
-  gem "debug", platforms: %i[ mri windows ]
+  gem "debug", platforms: %i[mri windows]
 end
 
 group :development do
   gem "web-console"
 end
-

data/sample-app/bin/bundle

@@ -24,14 +24,14 @@ m = Module.new do
   def cli_arg_version
     return unless invoked_as_script? # don't want to hijack other binstubs
     return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+
     bundler_version = nil
     update_index = nil
     ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
-        bundler_version = a
-      end
+      bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
       next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1
+
+      bundler_version = Regexp.last_match(1)
       update_index = i
     end
     bundler_version
@@ -55,8 +55,10 @@ m = Module.new do
 
   def lockfile_version
     return unless File.file?(lockfile)
+
     lockfile_contents = File.read(lockfile)
     return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+
     Regexp.last_match(1)
   end
 
@@ -86,10 +88,14 @@ m = Module.new do
       gem "bundler", bundler_requirement
     end
     return if gem_error.nil?
+
     require_error = activation_error_handling do
       require "bundler/version"
     end
-    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+      return
+    end
+
     warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
     exit 42
   end
@@ -104,6 +110,4 @@ end
 
 m.load_bundler!
 
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end
+load Gem.bin_path("bundler", "bundle") if m.invoked_as_script?

data/sample-app/config/application.rb

@@ -26,7 +26,7 @@ module SampleApp
     # Please, add to the `ignore` list any other `lib` subdirectories that do
     # not contain `.rb` files, or that should not be reloaded or eager loaded.
     # Common ones are `templates`, `generators`, or `middleware`, for example.
-    config.autoload_lib(ignore: %w(assets tasks))
+    config.autoload_lib(ignore: %w[assets tasks])
 
     # Configuration for the application, engines, and railties goes here.
     #

data/sample-app/config/environments/production.rb

@@ -45,11 +45,11 @@ Rails.application.configure do
 
   # Log to STDOUT by default
   config.logger = ActiveSupport::Logger.new(STDOUT)
-    .tap  { |logger| logger.formatter = ::Logger::Formatter.new }
-    .then { |logger| ActiveSupport::TaggedLogging.new(logger) }
+                                       .tap  { |logger| logger.formatter = ::Logger::Formatter.new }
+                                       .then { |logger| ActiveSupport::TaggedLogging.new(logger) }
 
   # Prepend all log lines with the following tags.
-  config.log_tags = [ :request_id ]
+  config.log_tags = [:request_id]
 
   # Info include generic and useful information about system operation, but avoids logging too much
   # information to avoid inadvertent exposure of personally identifiable information (PII). If you

data/sample-app/config/initializers/filter_parameter_logging.rb

@@ -3,6 +3,6 @@
 # Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file.
 # Use this to limit dissemination of sensitive information.
 # See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors.
-Rails.application.config.filter_parameters += [
-  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+Rails.application.config.filter_parameters += %i[
+  passw secret token _key crypt salt certificate otp ssn
 ]

data/sample-app/db/migrate/20231019151334_install_snapcher.rb

@@ -2,7 +2,7 @@
 
 class InstallSnapcher < ActiveRecord::Migration[7.1]
   def self.up
-    create_table :scannings, :force => true do |t|
+    create_table :scannings, force: true do |t|
       t.column :scannable_id, :integer
       t.column :scannable_type, :string
       t.column :table_name, :string

data/sample-app/db/schema.rb

@@ -33,5 +33,4 @@ ActiveRecord::Schema[7.1].define(version: 2023_10_19_151334) do
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end
-
 end

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: snapcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ryosk7
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies: []
-description: Save snapshot of DB columns.
+description: |
+  Snapcher is an ORM extension that logs changes to specific columns to your model.
+  When a change is made to a specific column, the difference between before and after the change is obtained and saved.
+  To make it easier for analysts, save the table name, column name, and data before and after changes as separate columns.
 email:
 - uchiryo7@gmail.com
 executables: []
@@ -19,6 +22,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -35,6 +39,7 @@ 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
@@ -111,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -121,5 +126,6 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Save snapshot of DB columns.
+summary: Snapcher is an ORM extension that logs changes to specific columns to your
+  model.
 test_files: []