initialize-with 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c234fd115bbc996ec62a1ddbfa3bf60a57893bf2a2de4c281f0f81fbacc33354
+  data.tar.gz: 8b55ca2fd5e8a2373941ac8211f3e9ee3c3849f5ec9e869ae5b0bee84726c9ec
+SHA512:
+  metadata.gz: 4d00e4fa7569aed8c9e6173424eaed3f054814bcf7338c9730bdca039fd6c05bfa8b0c53e17c7364f9b2a0784e00835947d52ddceefeac8ddac5f077402d5b31
+  data.tar.gz: 90753b26df54c571535d6ab99c30ccae6c41ad1cf5dc66c389b3a2f264d59182e097c03d7d5466b34fd6285450488b7ce6d8cbb4182c2107759cd6e901714839

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Test & lint
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '20'
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+
+      - run: bundle install
+
+      - name: RSpec
+        run: bundle exec rspec
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+
+      - run: bundle install
+
+      - name: Run linter
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+*.gem
+

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.4

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nicktbarone@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in initialize_with.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nicholas Barone
+
+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,98 @@
+# InitializeWith
+
+![ci](https://github.com/rangerscience/initialize_with/actions/workflows/ci.yml/badge.svg)
+[![code-climate](https://codeclimate.com/github/rangerscience/initialize_with.svg)](https://codeclimate.com/github/rangerscience/initialize_with)
+
+Utility gem to ease Ruby code development by replacing the common boiler plate:
+
+```ruby
+class MyClass
+  def initialize param
+    @param = param
+  end
+end
+```
+
+with
+
+```ruby
+class MyClass
+  include InitializeWith
+  initialize_with :param
+end
+```
+
+## Installation
+
+```gemfile
+gem 'initialize-with'
+```
+```ruby
+require "initialize_with"
+```
+
+Note that there is a very stale gem `initialize_with` (underscore instead of dash) and I am not creative with this naming!
+
+## Usage
+The aim is function "as you expect", and otherwise, see the rspec tests for more involved examples.
+
+If you were writing:
+```ruby
+class MyClass
+  def initialize foo, bar: 42
+    @foo = foo
+    @bar = bar
+    call_some_function
+  end
+end
+```
+
+you can now write:
+```ruby
+class MyClass
+  include InitializeWith
+  initialize_with :foo, bar: 42 do
+    call_some_function
+  end
+end
+```
+
+Additionally, it's safe to invoke multiple times:
+```ruby
+class MyClass
+  include InitializeWith
+  initialize_with :foo
+  initialize_with bar: 42
+end
+```
+
+### Inheritance
+Simple inheritance works just fine:
+
+```ruby
+class Parent
+  include InitializeWith
+end
+
+class MyClass
+  initialize_with :foo, bar: 42
+end
+```
+
+But note that there isn't a way to replicate something like `super` - you'll have to do things by hand (see the test suite for more).
+
+## Development
+
+`bundle install` to get started, `rspec` for tests, `bin/console` for an IRB that's already `reqiured` the library.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rangerscience/initialize_with. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 InitializeWith project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rangerscience/initialize_with/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "initialize_with"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/initialize_with.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "initialize_with/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "initialize-with"
+  spec.version       = InitializeWith::VERSION
+  spec.authors       = [ "Nicholas Barone" ]
+  spec.email         = [ "nicktbarone@gmail.com" ]
+
+  spec.summary       = %q(Sugar to skip the usual @param = param boilerplate in Ruby)
+  spec.description   = %q(Adds some utility class methods to simplify some common Ruby patterns)
+  spec.homepage      = "https://github.com/rangerscience/initialize_with"
+  spec.license       = "MIT"
+
+  # 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         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = [ "lib" ]
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "debug", "~> 1.6"
+  spec.add_development_dependency "rubocop", "~> 1.6"
+  spec.add_development_dependency "rubocop-rails-omakase", "~> 1.0"
+end

data/lib/initialize_with/version.rb

@@ -0,0 +1,3 @@
+module InitializeWith
+  VERSION = "0.1.0"
+end

data/lib/initialize_with.rb

@@ -0,0 +1,56 @@
+require "initialize_with/version"
+
+module InitializeWith
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def initialize(...)
+    self.class._validate_initialization_parameters!(...)
+    self.class._apply_initialization_parameters(self, ...)
+    self.class.instance_variable_get(:@_initialize_with_blocks)&.each { |blk| self.instance_exec(&blk) }
+  end
+
+  module ClassMethods
+    def initialize_with *args, **kwargs, &blk
+      @_initialize_with ||= []
+      @_initialize_with += args
+      args.each { |name| attr_reader name }
+
+      @_initialize_with_splat = kwargs.delete(:splat)
+      attr_reader @_initialize_with_splat if @_initialize_with_splat
+
+      @_initialize_with_optional ||= {}
+      @_initialize_with_optional.merge! kwargs
+      kwargs.each { |name, _default| attr_reader name }
+
+      @_initialize_with_blocks ||= []
+      @_initialize_with_blocks << blk if blk
+    end
+
+    def _validate_initialization_parameters! *args
+      @_initialize_with ||= []
+      @_initialize_with_optional ||= {}
+
+      max_args = @_initialize_with.size + @_initialize_with_optional.size
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected #{@_initialize_with.size})" unless args.size >= @_initialize_with.size
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected #{@_initialize_with.size..(max_args)})" if @_initialize_with_splat.nil? && args.size > max_args
+    end
+
+    def _apply_initialization_parameters instance, *args
+      # [1, 2, 3   ]
+      # [      4, 5] =>
+      # [1, 2, 3, 5]
+      names = @_initialize_with + @_initialize_with_optional.keys
+      values = args + @_initialize_with_optional.values.drop(args.size - @_initialize_with.size)
+
+      names.zip(values).each do |name, val|
+        instance.instance_variable_set("@#{name}", val)
+      end
+
+      if @_initialize_with_splat
+        instance.instance_variable_set("@#{@_initialize_with_splat}", args[names.size..-1])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: initialize-with
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Barone
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  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'
+description: Adds some utility class methods to simplify some common Ruby patterns
+email:
+- nicktbarone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- initialize_with.gemspec
+- lib/initialize_with.rb
+- lib/initialize_with/version.rb
+homepage: https://github.com/rangerscience/initialize_with
+licenses:
+- MIT
+metadata: {}
+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.16
+signing_key:
+specification_version: 4
+summary: Sugar to skip the usual @param = param boilerplate in Ruby
+test_files: []