save_chain_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb5b157973994040b28e5a9a9db7fae7fba7ce8ca5e5c13a7c5dbc9dc13165d8
+  data.tar.gz: e88c0bd09a45fce934dedb1af3580e6e0220690e09c865ea142a237a7896834f
+SHA512:
+  metadata.gz: aa60bbc1f71bfb213f32992030b8d80d57aac2c8797ef57eb4e421de9d3b219403c7d9944344e620b972afcf3e6ad8af9453a817adef765b4f2f7f26e45477c0
+  data.tar.gz: eeeb8944be49e80994d87042daa5da60eee32b886e63311f43c95c6185d575268417db34c193db552c9930c36d9d2de0fe76f22c09bbf93be2ed117f2f4a846e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
+Layout/LineLength:
+  Exclude:
+    - save_chain_inspector.gemspec
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'Gemfile'
+    - '*.gemspec'
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Shinichi Maeshima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# SaveChainInspector
+
+When you execute save on a model in Active Record, the saves of related models with pre-set hooks are also executed. SaveChainInspector provides a way to know which models and which hooks have been executed specifically.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add save_chain_inspector --group=development,test
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install save_chain_inspector
+
+## Usage
+
+`SaveChainInspector.start` takes a block. It outputs the execution order of the save chain to the standard output.
+
+```ruby      
+SaveChainInspector.start do
+  post = Post.new
+  post.comments.build
+  post.save
+end
+```
+
+```
+Post#save start
+ Post#autosave_associated_records_for_comments start
+   Comment#save start
+     Comment#before_save start
+       Comment#autosave_associated_records_for_post start
+       Comment#autosave_associated_records_for_post end
+     Comment#before_save end
+     Comment#after_create start
+     Comment#after_create end
+   Comment#save end
+ Post#autosave_associated_records_for_comments end
+Post#save end
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/willnet/save_chain_inspector. 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/willnet/save_chain_inspector/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SaveChainInspector project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/willnet/save_chain_inspector/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/save_chain_inspector/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SaveChainInspector
+  VERSION = '0.1.0'
+end

data/lib/save_chain_inspector.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative 'save_chain_inspector/version'
+
+class SaveChainInspector # rubocop:disable Metrics/ClassLength, Style/Documentation
+  class << self
+    attr_accessor :indent, :enable
+  end
+
+  self.indent = 0
+  self.enable = false
+  def self.start(&block)
+    self.indent = 0
+    self.enable = true
+    new.call(&block)
+  ensure
+    self.enable = false
+  end
+
+  def initialize
+    ActiveRecord::Base.descendants.each do |klass|
+      next if klass.abstract_class
+      next if @save_chain_inspector_initialized
+
+      @save_chain_inspector_initialized = true
+      add_hooks(klass)
+    end
+  end
+
+  attr_accessor :last_call_method, :last_call_class, :last_return_method, :last_return_class
+
+  def add_hooks(klass) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    klass.before_save(prepend: true) do |model|
+      next unless SaveChainInspector.enable
+
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#before_save start"
+      SaveChainInspector.indent += 1
+    end
+    klass.before_save do |model|
+      next unless SaveChainInspector.enable
+
+      SaveChainInspector.indent -= 1
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#before_save end"
+    end
+    klass.set_callback(:create, :after) do |model|
+      next unless SaveChainInspector.enable
+
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#after_create start"
+      SaveChainInspector.indent += 1
+    end
+    klass.after_create do |model|
+      next unless SaveChainInspector.enable
+
+      SaveChainInspector.indent -= 1
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#after_create end"
+    end
+    klass.set_callback(:update, :after) do |model|
+      next unless SaveChainInspector.enable
+
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#after_update start"
+      SaveChainInspector.indent += 1
+    end
+    klass.after_update do |model|
+      next unless SaveChainInspector.enable
+
+      SaveChainInspector.indent -= 1
+      puts "#{' ' * (SaveChainInspector.indent * 2)}#{model.class}#after_update end"
+    end
+  end
+
+  def autosave_method?(trace_point)
+    trace_point.method_id.match?(/autosave_associated_records_for_/)
+  end
+
+  def save_method?(trace_point)
+    trace_point.method_id == :save || trace_point.method_id == :save!
+  end
+
+  def duplicate_save_method_call?(trace_point)
+    last_call_method == trace_point.method_id && last_call_class == trace_point.self.class
+  end
+
+  def duplicate_save_method_return?(trace_point)
+    last_return_method == trace_point.method_id && last_return_class == trace_point.self.class
+  end
+
+  def autosave_to_save?(trace_point)
+    (trace_point.method_id == :save || trace_point.method_id == :save!) &&
+      last_call_method&.match?(/autosave_associated_records_for_/)
+  end
+
+  def update_last_call(trace_point)
+    self.last_call_class = trace_point.self.class
+    self.last_call_method = trace_point.method_id
+  end
+
+  def update_last_return(trace_point)
+    self.last_return_class = trace_point.self.class
+    self.last_return_method = trace_point.method_id
+  end
+
+  def call(&block)
+    trace.enable
+    block.yield
+  ensure
+    trace.disable
+  end
+
+  def trace # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    @trace ||= TracePoint.new(:call, :return) do |trace_point|
+      if trace_point.event == :call
+        if autosave_method?(trace_point) || (save_method?(trace_point) && !duplicate_save_method_call?(trace_point))
+          update_last_call(trace_point)
+          puts "#{' ' * (self.class.indent * 2)}#{trace_point.self.class.name}##{trace_point.method_id} start"
+          self.class.indent += 1
+        end
+      else # :return
+        if save_method?(trace_point) && !duplicate_save_method_return?(trace_point)
+          self.class.indent -= 1
+          update_last_return(trace_point)
+          puts "#{' ' * (self.class.indent * 2)}#{trace_point.self.class.name}##{trace_point.method_id} end"
+        end
+
+        if autosave_method?(trace_point)
+          self.class.indent -= 1
+          puts "#{' ' * (self.class.indent * 2)}#{trace_point.self.class.name}##{trace_point.method_id} end"
+        end
+      end
+    end
+  end
+end

data/sig/save_chain_inspector.rbs

@@ -0,0 +1,4 @@
+module SaveChainInspector
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: save_chain_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shinichi Maeshima
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: When you execute save on a model in Active Record, the saves of related
+  models with pre-set hooks are also executed. SaveChainInspector provides a way to
+  know which models and which hooks have been executed specifically.
+email:
+- netwillnet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/save_chain_inspector.rb
+- lib/save_chain_inspector/version.rb
+- sig/save_chain_inspector.rbs
+homepage: https://github.com/willnet/save_chain_inspector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/willnet/save_chain_inspector
+  source_code_uri: https://github.com/willnet/save_chain_inspector
+  changelog_uri: https://github.com/willnet/save_chain_inspector/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: A tool to investigate the order in which the saves of related models are
+  executed.
+test_files: []