lazy_load_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad7ccf90af014e09150c0445aa798702fbdcff84203562aa2c7cd5fc960ed090
+  data.tar.gz: 3bd0d5a98e55beb2ef2c7c0e58c65b0be5ccff570ef262a43a134804566837c8
+SHA512:
+  metadata.gz: e0a48e5efc3240a93dc0624d572188b1ab88a02eb80b1e3ab7733d76c8a08e6eefbfd8034af8f11c0785255efbc6a900e68557c2f47480b9e304d2e244511fd5
+  data.tar.gz: 403da3d15930f376b7fef7965f37e5e57a99d322d45746f4729659cd161b12ba08fed34530e96c45783f67cbdf88d2346aac80e36e4cd35e9907ba342d4829d7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased Changes]
+
+## 0.1.0
+
+- initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 eizengan@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,119 @@
+# LazyLoadAttributes
+
+Simple "Ruby core"-inspired syntactic sugar for defining cached, lazy-loaded attributes which intuitively handle inheritence and attribute redefinition.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy_load_attributes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lazy_load_attributes
+
+## Usage
+
+The class-level `lazy_attr_reader` method defines a lazy-loaded attribute.
+
+A simple use-case:
+
+```ruby
+require "lazy_load_attributes"
+
+class Example
+  extend LazyLoadAttributes
+
+  lazy_attr_reader(:lazy_attr) { puts "loaded"; lazy_attr_method }
+
+  def lazy_attr_method
+    "lazy value"
+  end
+end
+
+example = Example.new
+example.lazy_attr
+# loaded
+# => "lazy value"
+example.lazy_attr
+# => "lazy value"
+```
+
+This illustrates four major powers of LazyLoadAttributes:
+
+- the attribute calls evaluate and return their definition's initializer
+- the initializer is not evaluated until the first attribute call
+- the initializer is evaluated in the context of the calling instance (i.e. `example` in the sample above), so its instance methods are available during evaluation as they would be within the body of a normal instance method
+- the initializer is evaluated only once; subsequent attribute calls are served from a cache
+
+Inheritence is handled transparently:
+
+```ruby
+class Superclass
+  extend LazyLoadAttributes
+
+  lazy_attr_reader(:super_attr) { super_attr_value }
+  lazy_attr_reader(:redefine_attr) { "redefine_attr from Superclass" }
+
+  def super_attr_value
+    "Superclass#super_attr_value"
+  end
+
+  def sub_attr_value
+    "Superclass#sub_attr_value"
+  end
+end
+
+class Subclass < Superclass
+  lazy_attr_reader(:redefine_attr) { "redefine_attr from Subclass" }
+  lazy_attr_reader(:sub_attr) { sub_attr_value }
+
+  def super_attr_value
+    "Subclass#super_attr_value"
+  end
+end
+
+super_instance = Superclass.new
+super_instance.super_attr
+# => "Superclass#super_attr_value"
+super_instance.redefine_attr
+# => "redefine_attr from Superclass"
+
+sub_instance = Subclass.new
+sub_instance.super_attr
+# => "Subclass#super_attr_value"
+sub_instance.sub_attr
+# => "Superclass#sub_attr_value"
+sub_instance.redefine_attr
+# => "redefine_attr from Subclass"
+```
+
+The call to `sub_instance.super_attr` shows that the instance methods used by an initializer respect inheritence even when the attribute itself is defined in the superclass
+
+The call to `sub_instance.sub_attr` shows that initializers used by definitions in a subclass have access to instance methods defined in a superclass
+
+The call to `sub_instance.redefine_attr` shows that an attribute redefined in a subclass will override its definition in the superclass
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/eizengan/lazy_load_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/eizengan/lazy_load_attributes/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 LazyLoadAttributes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eizengan/lazy_load_attributes/blob/main/CODE_OF_CONDUCT.md).

data/lazy_load_attributes.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/lazy_load_attributes/version"
+
+Gem::Specification.new do |spec|
+  raise "RubyGems 2.0 or newer is required to protect against public gem pushes." unless spec.respond_to?(:metadata)
+
+  spec.name = "lazy_load_attributes"
+  spec.version = LazyLoadAttributes::VERSION
+  spec.authors = ["Nate Eizenga"]
+  spec.email = ["eizengan@gmail.com"]
+
+  spec.summary = "Concise definition of lazy-loaded class attributes"
+  spec.description = <<~DESCRIPTION
+    Simple "Ruby core"-inspired syntactic sugar for defining cached, lazy-loaded attributes which intuitively handle
+    inheritence and attribute redefinition.
+  DESCRIPTION
+  spec.homepage = "https://github.com/eizengan/lazy_load_attributes"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = %w[
+    CHANGELOG.md
+    CODE_OF_CONDUCT.md
+    lazy_load_attributes.gemspec
+    README.md
+  ] + Dir["lib/**/*"]
+  spec.bindir = "bin"
+  spec.executables += spec.files.grep(%r{\A#{spec.bindir}/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = [">= 2.7", "< 4"]
+
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-performance", "~> 1.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.0"
+end

data/lib/lazy_load_attributes/version.rb

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

data/lib/lazy_load_attributes.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "set"
+require_relative "lazy_load_attributes/version"
+
+module LazyLoadAttributes
+  ATTR_NAME_REGEX = /\A[a-z0-9_]+\z/.freeze
+
+  def self.extended(base)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+  end
+
+  module ClassMethods
+    def lazy_attributes
+      @lazy_attributes ||= Set.new
+    end
+
+    def all_lazy_attributes
+      ancestors.select { |ancestor| ancestor.singleton_class.include?(::LazyLoadAttributes) }
+               .map(&:lazy_attributes)
+               .reduce(&:|)
+    end
+
+    def lazy_attr_reader(attribute, &initializer) # rubocop:disable Metrics/MethodLength
+      raise NameError, "bad attribute name '#{attribute}' (use a-z, 0-9, _)" unless attribute.match? ATTR_NAME_REGEX
+      raise ArgumentError, "no initializer block given in lazy-loaded attribute definition" if initializer.nil?
+
+      lazy_attributes.add(attribute)
+
+      define_method(attribute) do
+        instance_variable = :"@#{attribute}"
+        if instance_variable_defined?(instance_variable)
+          instance_variable_get(instance_variable)
+        else
+          instance_variable_set(instance_variable, instance_eval(&initializer))
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    def eager_load_attributes!
+      self.class.all_lazy_attributes.each { |attribute| send(attribute) }
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: lazy_load_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nate Eizenga
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Simple "Ruby core"-inspired syntactic sugar for defining cached, lazy-loaded attributes which intuitively handle
+  inheritence and attribute redefinition.
+email:
+- eizengan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- lazy_load_attributes.gemspec
+- lib/lazy_load_attributes.rb
+- lib/lazy_load_attributes/version.rb
+homepage: https://github.com/eizengan/lazy_load_attributes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eizengan/lazy_load_attributes
+  source_code_uri: https://github.com/eizengan/lazy_load_attributes
+  changelog_uri: https://github.com/eizengan/lazy_load_attributes/blob/main/CHANGELOG.md
+  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: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Concise definition of lazy-loaded class attributes
+test_files: []