accessor_hooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93a37b5efd529c2d7a04f33cc8c55446036e08bf7aa5e77649e1201f2796735a
+  data.tar.gz: 3a9cf292c31f18cbfe40605e66843ff04e6bb0da968f14fd523b8223fe17f7fb
+SHA512:
+  metadata.gz: 488dfa71bd9c58e48ee4a6e1e50ada205fd655ecf5a806c51cd3c3db929d415b56c2a4ce34defa821af3f05e9fc77479593567c847d02114b6c3fb6a53dd2be5
+  data.tar.gz: 512469d74a2ea13c441aa1660f81acfb450357eebd97df02a351b99294e7acc3bfd1e21e38ff5b695b8f02678c7269dad9b7e5fe5b2bf7fa182290ee0ea700d1

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Suban05
+
+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,154 @@
+# AccessorHooks
+
+`AccessorHooks` is a Ruby module that allows you to define hooks (`before_change` and `after_change`) on attribute writers. These hooks can be used to execute custom logic when an attribute is modified.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accessor_hooks'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it manually:
+
+```sh
+gem install accessor_hooks
+```
+
+## Usage
+
+Include `AccessorHooks` in your class and define hooks using `before_change` and `after_change`.
+
+### Basic Example
+
+```ruby
+class User
+  include AccessorHooks
+  
+  attr_reader :full_name
+  attr_accessor :first_name, :last_name
+
+  after_change :update_full_name, on: %i[first_name last_name]
+
+  private
+
+  def update_full_name
+    @full_name = [first_name, last_name].join(" ").strip
+  end
+end
+
+user = User.new
+user.first_name = "John"
+puts user.full_name # "John"
+
+user.last_name = "Doe"
+puts user.full_name # "John Doe"
+```
+
+### Using `before_change`
+
+`before_change` hooks run before the attribute value is updated.
+
+```ruby
+class Document
+  include AccessorHooks
+  
+  attr_reader :name
+  attr_accessor :title
+
+  before_change :clear_name, on: :title
+
+  private
+
+  def clear_name
+    @name = ""
+  end
+end
+
+doc = Document.new
+doc.title = "New Title"
+puts doc.name # ""
+```
+
+### Passing the New Attribute Value to the Hook
+
+The new value of the attribute can be passed to the hook method.
+
+```ruby
+class FileEntity
+  include AccessorHooks
+  
+  attr_reader :file_name
+  attr_accessor :name
+
+  after_change :update_file_name, on: :name
+
+  private
+
+  def update_file_name(name)
+    @file_name = "#{name}.pdf"
+  end
+end
+
+file = FileEntity.new
+file.name = "document"
+puts file.file_name # "document.pdf"
+```
+
+### Combining `before_change` and `after_change`
+
+```ruby
+class Record
+  include AccessorHooks
+  
+  attr_reader :ids
+  attr_accessor :id
+
+  before_change :validate_id, on: :id
+  after_change :store_id, on: :id
+
+  def initialize
+    @ids = []
+  end
+
+  private
+
+  def validate_id(value)
+    raise StandardError, "ID cannot be negative" if value < 0
+  end
+
+  def store_id
+    @ids << @id
+  end
+end
+
+record = Record.new
+record.id = 1
+puts record.ids.inspect # [1]
+
+begin
+  record.id = -1 # Raises StandardError
+rescue StandardError => e
+  puts e.message
+end
+```
+
+## Running Tests
+
+Run the test suite using RSpec:
+
+```sh
+bundle exec rspec
+```
+
+## License
+
+This project is licensed under the MIT License.
+

data/Rakefile

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

data/lib/accessor_hooks/version.rb

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

data/lib/accessor_hooks.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "accessor_hooks/version"
+
+module AccessorHooks
+  def self.included(base)
+    base.extend ClassMethods
+    base.instance_variable_set(:@event_hooks, {})
+  end
+
+  module ClassMethods
+    def before_change(hook, on:)
+      extend_writers(hook, :before_change, on)
+    end
+
+    def after_change(hook, on:)
+      extend_writers(hook, :after_change, on)
+    end
+
+    def event_hooks
+      @event_hooks
+    end
+
+    private
+
+    def extend_writers(hook, event, attributes)
+      Array(attributes).each do |attr|
+        @event_hooks[attr] ||= {}
+        if @event_hooks[attr].empty?
+          save_original_writer(attr)
+          extend_writer(attr)
+        end
+        @event_hooks[attr][event] = hook
+      end
+    end
+
+    def extend_writer(attr)
+      writer = writer_name(attr)
+      define_method(:"#{attr}=") do |value|
+        run_hook(attr, :before_change, value)
+        send(writer, value)
+        run_hook(attr, :after_change, value)
+      end
+    end
+
+    def save_original_writer(attr)
+      writer = writer_name(attr)
+      alias_method writer, :"#{attr}="
+      private writer
+    end
+
+    def writer_name(attr)
+      :"set_#{attr}"
+    end
+  end
+
+  def run_hook(attr, event, value)
+    hook = self.class.event_hooks.dig(attr, event)
+    return unless hook && respond_to?(hook, true)
+
+    args = method(hook).arity == 1 ? [value] : []
+    send(hook, *args)
+  end
+
+  private :run_hook
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: accessor_hooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anatoly Busygin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-05 00:00:00.000000000 Z
+dependencies: []
+description: Provides before and after hooks for attribute changes in Ruby classes,
+  allowing easy execution of custom logic when attributes are modified.
+email:
+- anatolyb94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/accessor_hooks.rb
+- lib/accessor_hooks/version.rb
+homepage: https://github.com/Suban05/accessor_hooks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Suban05/accessor_hooks
+  source_code_uri: https://github.com/Suban05/accessor_hooks
+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.5.22
+signing_key:
+specification_version: 4
+summary: Accessor hooks for Ruby attributes
+test_files: []