with_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cd2b0040307ecf193dd4aeaa8e964a52676f1511b0fae3afe4452eaa27a9eb3
+  data.tar.gz: 645c20b445e473ae0063b434140fb8a0de5ae42c0d9b4be5512b71d7cfcb18d8
+SHA512:
+  metadata.gz: 3b60ed7e8a7916f117077c4a1bf45cb19ce5760ffe4ebc969eb438ed8454cb721261ca0ccffaa69b145ff21dad9c4555628b27c0363d446b4108d6acad5095a5
+  data.tar.gz: 2c0c15826a68fac8af53c54eeca2c4203f3e24f17fccc8979bb915b7f52c81880cba280dfdb2954e094741156cc0dda19ab20ea244b53e050046416f04190380

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Javier Aranda
+
+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,201 @@
+# WithAttributes
+
+[![Testing](https://github.com/javierav/with_attributes/actions/workflows/testing.yml/badge.svg)](https://github.com/javierav/with_attributes/actions/workflows/testing.yml)
+
+Temporarily enabling or disabling boolean attributes on classes and instances using `with` and `without` dynamic methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "with_attributes"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+```ruby
+class User
+  extend WithAttributes
+
+  with_attribute :notifications, default: false
+end
+```
+
+This add the following methods:
+
+* `User.with_notifications` for enable notifications in class-level during block execution.
+
+* `User.without_notifications` for disable notifications in class-level during block execution.
+
+* `User.enable_notifications`for enable notifications in class-level permanently.
+
+* `User.disable_notifications`for disable notifications in class-level permanently.
+
+* `User.notifications?`for check current status of notifications in class-level, using default value if not inside `with_notifications` or `without_notifications` modifiers.
+
+* `user.with_notifications` for enable notifications in instance-level during block execution.
+
+* `user.without_notifications` for disable notifications in instance-level during block execution.
+
+* `user.enable_notifications`for enable notifications in instance-level permanently.
+- `user.disable_notifications`for disable notifications in instance-level permanently.
+
+- `user.notifications?`for check current status of notifications in instance-level, using class-level value if not inside `with_notifications` or `without_notifications` modifiers.
+
+Example using class-level methods:
+
+```ruby
+# using default value
+User.notifications? # => false
+
+User.with_notifications do
+  User.notifications? # => true
+
+  User.without_notifications do
+    User.notifications? # => false
+  end
+
+  User.notifications? # => true
+end
+
+User.notifications? # => false
+```
+
+Example using instance level methods:
+
+```ruby
+user = User.new
+
+# if notifications is not changed in this instance, using value of class or default if class value is also not changed
+user.notifications? # => false
+
+# changing value in class-level
+User.with_notifications do
+  user.notifications? # => true
+end
+
+# changing value in instance-level
+user.with_notifications do
+  user.notifications? # => true
+end
+
+# using nested
+User.with_notifications do
+  user.without_notifications do
+    user.notifications? # => false
+  end
+end
+```
+
+## Real world example
+
+```ruby
+module Trackable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    include WithAttributes
+  end
+
+  included do
+    with_attribute :tracking, default: true
+
+    with_options if: :tracking? do
+      after_create  { ... }
+      after_update  { ... }
+      after_destroy { ... }
+    end
+  end
+end
+
+class User
+  include Trackable
+end
+
+User.without_tracking do
+  User.create(...)
+end
+
+User.find(...).tap do |user|
+  user.without_tracking do
+    user.update(...)
+  end
+end
+```
+
+
+
+## Thread safety
+
+Thread safety is guaranteed using class-level methods. Instance-level methods only are thread safe if each thread not share the same instance with others.
+
+```ruby
+# thread safe example
+
+t1 = Thread.new do
+  User.without_notifications do
+    User.create(...) # user created without notifications
+  end
+end
+
+t2 = Thread.new do
+  User.with_notifications do
+    User.create(...) # user created with notifications
+  end
+end
+
+[t1, t2].map(&:join)
+```
+
+```ruby
+# thread safe example
+
+t1 = Thread.new do
+  user = User.find(...)
+
+  user.without_notifications do
+    user.update(...) # user updated without notifications
+  end
+end
+
+t2 = Thread.new do
+  user = User.find(...)
+
+  user.with_notifications do
+    user.update(...) # user updated with notifications
+  end
+end
+
+[t1, t2].map(&:join)
+```
+
+```ruby
+# thread unsafe example
+
+user = User.new
+
+t1 = Thread.new do
+  user.without_notifications do
+    user.update(...) # unexpected behaviour, can be created with or without notifications
+  end
+end
+
+t2 = Thread.new do
+  user.with_notifications do
+    user.update(...) # unexpected behaviour, can be created with or without notifications
+  end
+end
+
+[t1, t2].map(&:join)
+```
+
+## Licence
+
+Copyright © 2024 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/lib/with_attributes/version.rb

@@ -0,0 +1,3 @@
+module WithAttributes
+  VERSION = "0.1.0".freeze
+end

data/lib/with_attributes.rb

@@ -0,0 +1,79 @@
+require_relative "with_attributes/version"
+
+module WithAttributes
+  def with_attribute(*attrs, default: true)
+    raise ArgumentError, "invalid with_attribute default option" unless [true, false].include?(default)
+
+    attrs.each do |attr|
+      raise NameError, "invalid with_attribute name: #{attr}" unless /^[_A-Za-z]\w*$/.match?(attr)
+
+      class_eval(<<~CODE, __FILE__, __LINE__ + 1)
+        def self.#{attr}?
+          value = Thread.current["with_attribute_#{attr}_\#{object_id}"]
+
+          if value.nil?
+            if superclass.respond_to?(:#{attr}?)
+              superclass.#{attr}?
+            else
+              #{default}
+            end
+          else
+            value
+          end
+        end
+
+        def self.with_#{attr}
+          current = Thread.current["with_attribute_#{attr}_\#{object_id}"]
+          enable_#{attr}
+          yield if block_given?
+        ensure
+          Thread.current["with_attribute_#{attr}_\#{object_id}"] = current
+        end
+
+        def self.without_#{attr}
+          current = Thread.current["with_attribute_#{attr}_\#{object_id}"]
+          disable_#{attr}
+          yield if block_given?
+        ensure
+          Thread.current["with_attribute_#{attr}_\#{object_id}"] = current
+        end
+
+        def self.enable_#{attr}
+          Thread.current["with_attribute_#{attr}_\#{object_id}"] = true
+        end
+
+        def self.disable_#{attr}
+          Thread.current["with_attribute_#{attr}_\#{object_id}"] = false
+        end
+
+        def #{attr}?
+          @#{attr}.nil? ? self.class.#{attr}? : @#{attr}
+        end
+
+        def with_#{attr}
+          current = @#{attr}
+          enable_#{attr}
+          yield if block_given?
+        ensure
+          @#{attr} = current
+        end
+
+        def without_#{attr}
+          current = @#{attr}
+          disable_#{attr}
+          yield if block_given?
+        ensure
+          @#{attr} = current
+        end
+
+        def enable_#{attr}
+          @#{attr} = true
+        end
+
+        def disable_#{attr}
+          @#{attr} = false
+        end
+      CODE
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: with_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javier Aranda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-08 00:00:00.000000000 Z
+dependencies: []
+description:
+email: javier@aranda.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/with_attributes.rb
+- lib/with_attributes/version.rb
+homepage: https://github.com/javierav/with_attributes
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/javierav/with_attributes/releases
+  homepage_uri: https://github.com/javierav/with_attributes
+  source_code_uri: https://github.com/javierav/with_attributes/tree/v0.1.0
+  bug_tracker_uri: https://github.com/javierav/with_attributes/issues
+  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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: temporarily enabling or disabling boolean attributes on classes and instances
+test_files: []