class_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffc4cad3f8f4d70400fa68f8d4eef97a1a2ee4287bca220b7ea902f778185ec9
+  data.tar.gz: 255fac79049cdfc9fa3deec66df07ddf764514e821196b82752ba547e2f1e7e1
+SHA512:
+  metadata.gz: 9c47575057406c03c452d10010356f4ffd2eb13bf2e06c4c4c75a0bf2162b6305f83f4f9dd432abdbec41a20272ef9d5fbf31b3ee4ef8d6386d2f9b0a3514267
+  data.tar.gz: 025303bf83ab6f3f76942b5cdee572ed9fd517f22214e60a5c4a31494fcdb076a11af39ab9a48a66fe5c7455629376dce4c8fe106a8231f67e21b89e8aeb31f4

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - "bin/**/*"
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - "test/**/*"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-17
+
+- 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) 2025 drewthorp
+
+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,90 @@
+# ClassStore
+
+ClassStore provides a simple way to store data in arrays and hashes at a class level. Unlike class variables, changes made on a subclass are not replicated in their base class, and unlike class instance variables the contents of a base class are replicated in it's subclasses.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add class_store
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install class_store
+
+## Usage
+
+By default the data is stored in a Hash:
+
+```ruby
+class MyClass
+  include ClassStore
+
+  class_store :data
+end
+
+MyClass.data[:foo] = 'bar'
+MyClass.data[:foo] # => 'bar'
+```
+
+Alternatively, the data can be stored in an Array:
+
+```ruby
+class MyArrayStore
+  include ClassStore
+
+  class_store :data, inital_state: []
+end
+
+MyArrayStore.data << 'foo'
+MyArrayStore.data # => ['foo']
+```
+
+Derived classes inherit the data from their base class and can add there own. The data added in the derived class is not replicated in the base class:
+
+```ruby
+class MyClass
+  include ClassStore
+
+  class_store :data
+
+    def self.add_data(key, value)
+      data[key] = value
+    end
+
+    add_data(:foo, 'bar')
+end
+
+class MySubClass < MyClass
+  add_data(:baz, 'qux')
+end
+
+MyClass.data # => {:foo => 'bar'}
+MySubClass.data # => {:foo => 'bar', :baz => 'qux'}
+```
+
+Calls to a stores reset method will reset the data in that class alone. It will not alter the base class of a derived class, and, if called on a base class will not propagate to it's subclasses:
+
+```ruby
+MyClass.reset_data
+MyClass.data # => {}
+MySubClass.data # => {:baz => 'qux'}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/class_store. 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]/class_store/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 ClassStore project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/class_store/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/class_store/version.rb

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

data/lib/class_store.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative 'class_store/version'
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/object/deep_dup'
+
+# module ClassStorage
+#   extend ActiveSupport::Concern
+#
+#   included do
+#     class_attribute :_storage, instance_accessor: false, instance_predicate: false
+#     self._storage = {}
+#   end
+#
+#   class_methods do
+#     def inherited(subclass)
+#       super
+#       # Ensure each subclass starts with a copy of its parent's storage
+#       subclass._storage = _storage.deep_dup
+#     end
+#
+#     def set(key, value)
+#       _storage[key] = value
+#     end
+#
+#     def get(key)
+#       _storage[key]
+#     end
+#   end
+# end
+
+# def deep_dup_with_procs(obj)
+#   case obj
+#   when Hash
+#     obj.each_with_object({}) do |(k, v), new_hash|
+#       new_hash[deep_dup_with_procs(k)] = deep_dup_with_procs(v)
+#     end
+#   when Array
+#     obj.map { |e| deep_dup_with_procs(e) }
+#   else
+#     obj.duplicable? ? obj.dup : obj
+#   end
+# end
+
+module ClassStore
+  class DuplicateClassStoreError < StandardError; end
+  class IllegalStoreTyoeError < StandardError; end
+
+  # Class methods for registering, accessing and resetting class stores
+  module Registration
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_registered_class_stores, instance_writer: false
+      self._registered_class_stores = {}
+    end
+
+    class_methods do
+      # Register a class store on the class with the given name and options.
+      def class_store(name, **options)
+        raise ArgumentError, 'name is a required argument' if name.nil?
+        if _registered_class_stores.key?(name)
+          raise DuplicateClassStoreError, "Class store #{name} has already been registered"
+        end
+
+        inital_state = options.delete(:initial_state) || {}
+        unless inital_state.is_a?(Hash) || inital_state.is_a?(Array)
+          raise IllegalStoreTyoeError, 'initial_state must be a hash or array'
+        end
+
+        _registered_class_stores[name] = { initial_state: inital_state, options: options }
+        _create_class_store(name, inital_state, options)
+      end
+
+      def inherited(subclass)
+        super
+
+        # Clone the registered class stores on the subclass
+        subclass._registered_class_stores = _registered_class_stores.deep_dup
+
+        # Ensure each subclass starts with a copy of its parent's stores
+        subclass._registered_class_stores.each do |name, store_options|
+          subclass._create_class_store(name, store_options[:initial_state], store_options[:options])
+          subclass.send("_#{name}=", send("_#{name}").deep_dup)
+        end
+      end
+
+      def _create_class_store(name, initial_state, _options)
+        class_attribute :"_#{name}", instance_writer: false
+        send("_#{name}=", initial_state.deep_dup)
+        _generate_class_store_accessor(name)
+        _generate_class_store_resetter(name)
+      end
+
+      private
+
+      def _generate_class_store_accessor(name)
+        define_singleton_method(name) do
+          send("_#{name}")
+        end
+
+        define_singleton_method("#{name}=") do |value|
+          send("_#{name}")[value] = value
+        end
+
+        delegate name.to_sym, to: :class
+      end
+
+      def _generate_class_store_resetter(name)
+        resetter_name = "reset_#{name}"
+        define_singleton_method(resetter_name) do
+          send("_#{name}=", _registered_class_stores[name][:initial_state].dup)
+        end
+
+        delegate resetter_name.to_sym, to: :class
+      end
+    end
+  end
+end

data/sig/class_store.rbs

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: class_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- drewthorp
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Provides a class store for when writing APIs that need to persist data
+  against a class.
+email:
+- gems@fishfur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/class_store.rb
+- lib/class_store/version.rb
+- sig/class_store.rbs
+homepage: https://github.com/Fish-Fur/class_store
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Fish-Fur/class_store
+  source_code_uri: https://github.com/Fish-Fur/class_store
+  changelog_uri: https://github.com/Fish-Fur/class_store
+  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.5.11
+signing_key:
+specification_version: 4
+summary: Provides a class store for when writing APIs that need to persist data against
+  a class.
+test_files: []