has_private_attributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c360b8d110bb4512877816d8a03059bddbb14c76a87d0f9c5c2effebb462b60
+  data.tar.gz: ff7cd5c56a2bfc5079c31d87323e88144ef1fe6e41f747943c0a7bf25c39aad0
+SHA512:
+  metadata.gz: 8836b85d765c234ef8a8b896b3686359623de3a3b62d61476c4d1145ce8febcab93cc732f721c645fcaccdb31aeb11962b24f0d160a61ce697da6e417d540c13
+  data.tar.gz: d8459b3b2aa3ee9a061ff658e452d64078a04732d290e3d00dc01b1011a5a4575882a29b78499c0312f7419f034e40fda95f3ebabb523e47573b59cf7daacf7e

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-16
+
+- 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 sebi
+
+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,163 @@
+# HasPrivateAttributes 🔒
+
+This Ruby gem provides a simple and elegant way to define private attributes in your classes. It allows you to create static, lazy-evaluated, and argument-based private attributes with automatic caching and freezing of the returned values, all in a thread-safe manner.
+
+## Features 🌟
+
+- **Static Attributes**: Define private attributes with a fixed, immutable value.
+- **Lazy Attributes**: Define private attributes that are lazily evaluated and cached.
+- **Argument-based Attributes**: Define private attributes that depend on arguments and cache the results.
+- **Inheritance**: Private attributes can be inherited from parent classes.
+- **Freezing**: All returned values are automatically deep-frozen to prevent modification.
+- **Thread Safety**: All operations are thread-safe, allowing for use in multi-threaded environments.
+
+## Installation 📥
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_private_attributes'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage 🚀
+
+Here's a simple example of how to use the `HasPrivateAttributes` gem:
+
+```ruby
+class MyClass
+  include HasPrivateAttributes
+
+  # definition of private attributes
+
+  private_attribute :static_servers, [
+    { ip: '1.1.1.1', location: 'US' },
+    { ip: '8.8.8.8', location: 'US' }
+  ]
+
+  private_attribute :lazy_servers do
+    [
+      { ip: '2.2.2.2', location: 'EU' },
+      { ip: '3.3.3.3', location: 'EU' }
+    ]
+  end
+
+  private_attribute :servers_by_region do |region|
+    case region
+    when 'us'
+      [
+        { ip: '1.1.1.1', location: 'US' },
+        { ip: '8.8.8.8', location: 'US' }
+      ]
+    when 'eu'
+      [
+        { ip: '2.2.2.2', location: 'EU' }
+      ]
+    end
+  end
+
+  # usage of private attributes
+
+  def get_static_servers
+    static_servers
+  end
+
+  def get_lazy_servers
+    lazy_servers
+  end
+
+  def get_servers_by_region(region)
+    servers_by_region(region)
+  end
+end
+
+instance = MyClass.new
+
+puts instance.get_static_servers
+# Output:
+# [
+#   { ip: '1.1.1.1', location: 'US' },
+#   { ip: '8.8.8.8', location: 'US' }
+# ]
+
+puts instance.get_lazy_servers
+# Output:
+# [
+#   { ip: '2.2.2.2', location: 'EU' },
+#   { ip: '3.3.3.3', location: 'EU' }
+# ]
+
+puts instance.get_servers_by_region('us')
+# Output:
+# [
+#   { ip: '1.1.1.1', location: 'US' },
+#   { ip: '8.8.8.8', location: 'US' }
+# ]
+
+puts instance.get_servers_by_region('eu')
+# Output:
+# [
+#   { ip: '2.2.2.2', location: 'EU' }
+# ]
+```
+
+## Examples 💡
+
+Here are some more examples of using the `HasPrivateAttributes` gem:
+
+### Static Attributes 🗄️
+
+```ruby
+instance.static_servers # => [{ ip: '1.1.1.1', location: 'US' }, { ip: '8.8.8.8', location: 'US' }]
+instance.static_servers.frozen? # => true
+```
+
+### Lazy Attributes 🐢
+
+```ruby
+instance.lazy_servers # => [{ ip: '2.2.2.2', location: 'EU' }, { ip: '3.3.3.3', location: 'EU' }]
+instance.lazy_servers.object_id # => 12345678
+instance.lazy_servers.object_id # => 12345678 (same object)
+```
+
+### Argument-based Attributes 🔍
+
+```ruby
+instance.servers_by_region('us') # => [{ ip: '1.1.1.1', location: 'US' }, { ip: '8.8.8.8', location: 'US' }]
+instance.servers_by_region('eu') # => [{ ip: '2.2.2.2', location: 'EU' }]
+```
+
+## Thread Safety 🔒
+
+All operations in HasPrivateAttributes are thread-safe. This means you can safely use private attributes in multi-threaded environments without worrying about race conditions or data inconsistencies. The gem uses Ruby's `Monitor` and `Mutex` classes to ensure proper synchronization.
+
+For example, you can safely access private attributes from multiple threads:
+
+```ruby
+threads = []
+10.times do
+  threads << Thread.new do
+    puts instance.get_lazy_servers
+  end
+end
+threads.each(&:join)
+```
+
+This will safely initialize and return the lazy servers, even if multiple threads try to access it simultaneously.
+
+## Contributing 🤝
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/has_private_attributes. 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/sebyx07/has_private_attributes/blob/master/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 HasPrivateAttributes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/has_private_attributes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lefthook.yml

@@ -0,0 +1,8 @@
+pre-commit:
+  commands:
+    rubocop:
+      run: bundle exec rubocop -A
+      skip:
+        - merge
+        - rebase
+      stage_fixed: true

data/lib/has_private_attributes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasPrivateAttributes
+  VERSION = '1.0.0'
+end

data/lib/has_private_attributes.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require_relative 'has_private_attributes/version'
+require 'monitor'
+
+module HasPrivateAttributes
+  # @!macro [attach] included
+  #   @!extend ClassMethods
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Provides class-level methods for defining private attributes.
+  module ClassMethods
+    # @!macro [new] private_attribute
+    #   @!method $1(*args)
+    #   Returns the value of the private attribute '$1'.
+    #   @return [Object] The value of the private attribute.
+    #   @!visibility private
+    #   @note This method is thread-safe.
+    #
+    #   @!method self.$1(*args)
+    #   Returns the class-level value of the private attribute '$1'.
+    #   @return [Object] The class-level value of the private attribute.
+    #   @!visibility private
+    #   @note This method is thread-safe.
+
+    # Defines a private attribute with the given name, value, and optional block.
+    #
+    # @param name [Symbol] The name of the private attribute.
+    # @param value [Object, Proc] The value of the private attribute, or a Proc that will be used to lazily evaluate the value.
+    # @yield [*args] An optional block that will be used to lazily evaluate the value of the private attribute.
+    # @return [void]
+    # @!macro private_attribute
+    def private_attribute(name, value = nil, &block)
+      ivar_name = "@#{name}"
+
+      define_method(name) do |*args|
+        _pa_synchronize do
+          if instance_variable_defined?(ivar_name) && args.empty?
+            instance_variable_get(ivar_name)
+          else
+            result = if block_given?
+              if block.arity.zero?
+                instance_exec(&block)
+              else
+                HasPrivateAttributes.memoize(self, name) do |*memoized_args|
+                  instance_exec(*memoized_args, &block)
+                end.call(*args)
+              end
+            elsif value.respond_to?(:call)
+              instance_exec(&value)
+            else
+              value
+            end
+            result = HasPrivateAttributes._pa_deep_freeze(result)
+            instance_variable_set(ivar_name, result) if args.empty?
+            result
+          end
+        end
+      end
+
+      private name
+
+      singleton_class.define_method(name) do |*args|
+        @singleton_monitor ||= Monitor.new
+        @singleton_monitor.synchronize do
+          @singleton_values ||= {}
+          return @singleton_values[name] if @singleton_values.key?(name) && args.empty?
+
+          result = if block_given?
+            if block.arity.zero?
+              class_exec(&block)
+            else
+              HasPrivateAttributes.memoize(self, name) do |*memoized_args|
+                class_exec(*memoized_args, &block)
+              end.call(*args)
+            end
+          elsif value.respond_to?(:call)
+            class_exec(&value)
+          else
+            value
+          end
+
+          result = HasPrivateAttributes._pa_deep_freeze(result)
+          @singleton_values[name] = result if args.empty?
+          result
+        end
+      end
+
+      private_class_method name
+    end
+  end
+
+  # @!macro [new] utility_method
+  #   @!visibility private
+
+  # Deeply freezes the given object, recursively freezing any nested data structures.
+  #
+  # @param obj [Object] The object to be deeply frozen.
+  # @return [Object] The deeply frozen object.
+  # @!macro utility_method
+  def self._pa_deep_freeze(obj)
+    case obj
+    when Hash
+      obj.each_with_object({}) { |(k, v), memo| memo[_pa_deep_freeze(k)] = _pa_deep_freeze(v) }.freeze
+    when Array
+      obj.map { |v| _pa_deep_freeze(v) }.freeze
+    when String, Numeric, TrueClass, FalseClass, NilClass
+      obj
+    else
+      obj.clone.freeze
+    end
+  end
+
+  # Memoizes the result of the given block, keyed by the arguments passed to the block.
+  #
+  # @param target [Object] The object on which to memoize the result.
+  # @param name [Symbol] The name of the memoized value.
+  # @yield [*args] The block whose result should be memoized.
+  # @return [Proc] A lambda that will return the memoized result.
+  # @!macro utility_method
+  def self.memoize(target, name)
+    target.instance_variable_set("@#{name}_memo", {})
+    target.instance_variable_set("@#{name}_memo_mutex", Mutex.new)
+    memo = target.instance_variable_get("@#{name}_memo")
+    mutex = target.instance_variable_get("@#{name}_memo_mutex")
+    lambda do |*args|
+      key = args.hash
+      mutex.synchronize do
+        memo[key] = yield(*args) unless memo.key?(key)
+        memo[key]
+      end
+    end
+  end
+
+  # Synchronizes access to instance variables
+  #
+  # @yield The block to be executed in a synchronized manner
+  # @return [Object] The result of the block
+  # @!macro utility_method
+  def _pa_synchronize(&block)
+    @monitor ||= Monitor.new
+    @monitor.synchronize(&block)
+  end
+end

data/sig/has_private_attributes.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: has_private_attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-16 00:00:00.000000000 Z
+dependencies: []
+description: Support for private attributes in classes in Ruby
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lefthook.yml
+- lib/has_private_attributes.rb
+- lib/has_private_attributes/version.rb
+- sig/has_private_attributes.rbs
+homepage: https://github.com/sebyx07/has_private_attributes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sebyx07/has_private_attributes
+  source_code_uri: https://github.com/sebyx07/has_private_attributes
+  changelog_uri: https://github.com/sebyx07/has_private_attributes
+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.11
+signing_key: 
+specification_version: 4
+summary: Support for private attributes in classes in Ruby
+test_files: []