declarative_initialization 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2def6406dabc72b117248ec302ac3fbb6b69dc2a67721abd229a1f5787ae50ce
+  data.tar.gz: 1bfa5430363018213e882a330e5ee83267b65a282a7cfb4f3439243a70e79887
+SHA512:
+  metadata.gz: 150ee62b3d7034af1b9d171bbfe6f472914439c1b9af558b78f34c4e4e66a6fdf28f870af998d00fc0d73f2ef699f76cfe3443a675cdff047668d66f15179e87
+  data.tar.gz: 84dabfae84540cd6d7e0fe130e33edd1eb4126fc5a8e32d83fea676c2401c297ae70fe6de6b6c4210228ea86d7789b90be5c17311af5880e320a701b405aa3b9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+# Here down -- just getting our core level to pass
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  AllowedMethods: [initialize, initialize_with]
+
+Metrics/AbcSize:
+  Max: 42
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 13
+
+Gemspec/RequireMFA:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-05
+
+- Initial release

data/CODEOWNERS

@@ -0,0 +1 @@
+* @teamshares/platform

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 kali@teamshares.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,106 @@
+# DeclarativeInitialization
+
+Boilerplate slows down devs and irritates everyone, plus the added cruft makes it harder to scan for the actual logic in a given file.
+
+This is a small layer to support declarative initialization _specifically for simple keyword-based classes_.
+
+## Usage
+
+Given a standard ruby class like so:
+
+```ruby
+class SomeObject
+  def initialize(foo:, bar:, baz: "default value")
+    @foo = foo
+    @bar = bar
+    @baz = baz
+  end
+
+  attr_reader :foo, :bar, :baz
+end
+```
+
+With this library it can be simplified to:
+
+```ruby
+class SomeObject
+  include DeclarativeInitialization
+
+  initialize_with :foo, :bar, baz: "default value"
+end
+```
+## Quick note on naming
+
+The gem name is `declarative_initialization` because there's already a very outdated gem claiming the `initialize_with` name.
+
+We've set up an alias, however, so you can do either `include DeclarativeInitialization` _or_ `include InitializeWith`.
+
+FWIW in practice at Teamshares we just `include DeclarativeInitialization` in the base class for all our View Components.
+
+### Custom logic
+
+Sometimes the existing `initialize` method also does other work, for instance setting initial values for additional instance variables that aren't passed in directly.
+
+We support that by passing an optional block to `initialize_with` -- for instance, in the example above if the original version also set `@bang = foo * bar`, we could support that by changing the updated version to:
+
+  ```ruby
+  initialize_with :foo, :bar, baz: "default value" do
+    @bang = @foo * @bar
+  end
+  ```
+
+### Edge cases
+
+* Accepting a block: this is handled automatically -- if a block was provided to the Foo.new call, it'll be made available as `@block`/`attr_reader :block`
+
+* If a method with same name already exists, we log a warning and do not create the `attr_reader`.  In that case you'll need to reference the instance variable directly.
+
+  * Because of this, best practice when referencing variables in the post-initialize block is use `@foo` rather than relying on the `foo` attr_reader
+
+* Due to ruby syntax limitations, we do not support referencing other fields directly in the declaration:
+
+  * Does _not_ work:
+    ```ruby
+    initialize_with :user, company: user.employer
+    ```
+  * Workaround:
+    ```ruby
+    initialize_with :user, company: nil do
+      @company ||= @user.employer
+    end
+    ```
+
+* If using `initialize_with` on a subclass where the superclass defines `initialize`, we will _not_ automatically call `super`, because if we do we get this `RuntimeError`:
+  > implicit argument passing of super from method defined by define_method() is not supported. Specify all arguments explicitly.
+
+* If you need to call `super` from the block passed into `initialize_with` (unusual edge case, subclass requires different arguments than parent):
+
+  * Does _not_ work (due to `instance_exec` changing execution context but _not_ the method lookup chain):
+    ```ruby
+    initialize_with :foo do
+      super(bar: 123)
+    end
+    ```
+  * Workaround _possible_ (but really, probably more understandable to just fall back to manually writing `def initialize`):
+    ```ruby
+    initialize_with :foo do
+      parent_initialize = method(:initialize).super_method
+      parent_initialize.call(bar: 123)
+    end
+    ```
+
+* If you find yourself backed into a weird corner, just use a plain ole `def initialize`!  This library is meant to make the easy cases less work, but there's no requirement that you must use it for every super complex case you run into. :)
+
+## 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/teamshares/declarative_initialization. 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/teamshares/declarative_initialization/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the DeclarativeInitialization project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/teamshares/declarative_initialization/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/declarative_initialization/version.rb

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

data/lib/declarative_initialization.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "declarative_initialization/version"
+require "logger"
+
+module DeclarativeInitialization
+  def self.included(base)
+    base.class_eval do
+      include InstanceMethods
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def initialize_with(*args, **kwargs, &post_initialize_block)
+      declared = args + kwargs.keys
+      raise ArgumentError, "initialize_with expects to receive symbols" unless declared.all? { |arg| arg.is_a?(Symbol) }
+
+      defaults = kwargs
+
+      define_method(:initialize) do |*given_args, **given_kwargs, &block|
+        class_name = self.class.name || "Anonymous Class"
+        raise ArgumentError, "[#{class_name}] Only accepts keyword arguments" unless given_args.empty?
+
+        missing = declared - given_kwargs.keys - defaults.keys
+        extra = given_kwargs.keys - declared
+
+        raise ArgumentError, "[#{class_name}] Missing keyword arguments: #{missing.join(", ")}" unless missing.empty?
+        raise ArgumentError, "[#{class_name}] Unknown keyword arguments: #{extra.join(", ")}" unless extra.empty?
+
+        declared.each do |key|
+          instance_variable_set(:"@#{key}", given_kwargs.fetch(key, defaults[key]))
+          if respond_to?(key, true)
+            __logger.warn "Method ##{key} already exists on #{self.class.name}. Skipping attr_reader generation."
+          else
+            self.class.send(:attr_reader, key)
+          end
+        end
+
+        if block # Automatically record any block passed to .new as an instance variable
+          instance_variable_set(:@block, block)
+          self.class.send(:attr_reader, :block) unless respond_to?(:block)
+        end
+
+        instance_exec(&post_initialize_block) if post_initialize_block
+      end
+    end
+  end
+
+  module InstanceMethods
+    def __logger
+      @__logger ||= begin
+        Rails.logger
+      rescue NameError
+        Logger.new($stdout)
+      end
+    end
+  end
+end
+
+# Set up an alias so you can also do `include InitializeWith`
+module InitializeWith
+  def self.included(base)
+    base.class_eval do
+      include DeclarativeInitialization
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: declarative_initialization
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kali Donovan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-07 00:00:00.000000000 Z
+dependencies: []
+description: A declarative replacement for `def initialize` in keyword-argument-based
+  POROs.
+email:
+- kali@teamshares.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/declarative_initialization.rb
+- lib/declarative_initialization/version.rb
+homepage: https://github.com/teamshares/declarative_initialization
+licenses: []
+metadata:
+  homepage_uri: https://github.com/teamshares/declarative_initialization
+  source_code_uri: https://github.com/teamshares/declarative_initialization
+  changelog_uri: https://github.com/teamshares/declarative_initialization/blob/main/CHANGELOG.md
+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.4.10
+signing_key:
+specification_version: 4
+summary: Reduce initialization boilerplate for Ruby classes
+test_files: []