session_attributes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: feb87cc568ea512e11a933810d21649fa427f90902d17006aa87d4a1ebd2f8ea
+  data.tar.gz: 81a4bf5a3604b4ef10a613ba5c69141d70193ec368b53c9126d39adce1b6b83c
+SHA512:
+  metadata.gz: da4f993c225cd016faeffd894a0c8bdc918eceae8d9431544c0608406985b50998d0b3b49ac2b5a27a9e100fd88568cb47e04254f42026ffe614375740066904
+  data.tar.gz: 110b9c7a5a5b5b84ecfde6a455df5b6676c795579098568bfa7b6e236b8d621fda15c8e53929fdaec1ec5a5a2311d572c1f14ac322576c5bbacec442c1e19668

data/README.md

@@ -0,0 +1,58 @@
+# SessionAttributes
+
+A modified `ActiveSupport::CurrentAttributes` designed to persist across sessions. Useful for creating fancy singletons for storing session attributes
+
+For more documentation, visit the `ActiveSupport::CurrentAttributes` docs [here](https://edgeapi.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html)
+
+## Usage
+
+Create a class inheriting from `SessionAttributes` in app/models:
+
+```
+class Journey < SessionAttributes
+  attribute :explorer, :basecamp
+end
+```
+
+Then utilize it in your controllers:
+
+```
+Journey.explorer = Member.find(params[:username])
+```
+
+
+```
+Journey.explorer.update!(name: "SessionAttributes Demo")
+```
+
+```
+Journey.reset
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "session_attributes"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install session_attributes
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/session_attributes.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "active_support/callbacks"
+require "active_support/core_ext/object/with"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/module/delegation"
+require "binding_of_caller"
+
+class SessionAttributes
+  include ActiveSupport::Callbacks
+  define_callbacks :reset
+
+  INVALID_ATTRIBUTE_NAMES = [:set, :reset, :resets, :instance, :before_reset, :after_reset, :reset_all, :clear_all] # :nodoc:
+
+  class << self
+    def instance
+      new
+    end
+
+    def attribute(*names, default: nil)
+      invalid_attribute_names = names.map(&:to_sym) & INVALID_ATTRIBUTE_NAMES
+      if invalid_attribute_names.any?
+        raise ArgumentError, "Restricted attribute names: #{invalid_attribute_names.join(", ")}"
+      end
+
+      ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
+        names.each do |name|
+          owner.define_cached_method(name, namespace: :session_attributes) do |batch|
+            batch <<
+              "def #{name}" <<
+              "attributes[:#{name}]" <<
+              "end"
+          end
+          owner.define_cached_method("#{name}=", namespace: :session_attributes) do |batch|
+            batch <<
+              "def #{name}=(value)" <<
+              "attributes[:#{name}] = value" <<
+              "end"
+          end
+        end
+      end
+
+      ActiveSupport::Delegation.generate(singleton_class, names, to: :instance, nilable: false, signature: "")
+      ActiveSupport::Delegation.generate(singleton_class, names.map { |n| "#{n}=" }, to: :instance, nilable: false, signature: "value")
+
+      self.defaults = defaults.merge(names.index_with { default })
+    end
+
+    def before_reset(*methods, &)
+      set_callback(:reset, :before, *methods, &)
+    end
+
+    def resets(*methods, &)
+      set_callback(:reset, :after, *methods, &)
+    end
+    alias_method :after_reset, :resets
+
+    delegate :set, :reset, to: :instance
+
+    def reset_all # :nodoc:
+      session_instances.each_value(&:reset)
+    end
+
+    def clear_all # :nodoc:
+      reset_all
+      session_instances.clear
+    end
+
+    def attributes=(attrs)
+      session_instances[session_instances_key] ||= {}
+      session_instances[session_instances_key][:attributes] = attrs
+    end
+
+    def attributes
+      session_instances[session_instances_key] ||= {}
+      session_instances[session_instances_key][:attributes] ||= {}
+    end
+
+    private
+
+    def session_instances
+      i = 1
+      while !binding.of_caller(i).eval("(session rescue nil).is_a? ActionDispatch::Request::Session") && i < 50
+        i += 1
+      end
+      binding.of_caller(i).eval("session[:session_attributes_instances] ||= {}")
+    end
+
+    def generated_attribute_methods
+      @generated_attribute_methods ||= Module.new.tap { |mod| include mod }
+    end
+
+    def session_instances_key
+      @session_instances_key ||= name.to_sym
+    end
+
+    def method_added(name)
+      return if name == :initialize
+      return unless public_method_defined?(name)
+      return if respond_to?(name, true)
+      ActiveSupport::Delegation.generate(singleton_class, [name], to: :instance, as: self, nilable: false)
+    end
+  end
+
+  delegate :attributes, :attributes=, to: :class
+
+  def resolve_defaults
+    defaults.transform_values do |value|
+      (Proc === value) ? value.call : value.dup
+    end
+  end
+
+  # :nodoc:
+  # I had to move this to a self. method because it was erroring out with stack level too deep
+  def self.respond_to_missing?(name, _)
+    instance.respond_to?(name)
+  end
+
+  class_attribute :defaults, instance_writer: false, default: {}.freeze
+
+  def initialize
+    @attributes = resolve_defaults
+  end
+
+  def set(attributes, &)
+    with(**attributes, &)
+  end
+
+  def reset
+    run_callbacks :reset do
+      self.attributes = resolve_defaults
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: session_attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Reese Armstrong
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Store attributes in handy singletons for Rails/ActionDispatch sessions
+email:
+- me@reeseric.ci
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/session_attributes.rb
+homepage: https://codeberg.org/reesericci/session_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://codeberg.org/reesericci/session_attributes
+  source_code_uri: https://codeberg.org/reesericci/session_attributes
+  changelog_uri: https://codeberg.org/reesericci/session_attributes/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: ActiveSupport::CurrentAttributes but for sessions
+test_files: []