struct-initializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7fe016ff5c10888c244f9619fcb1df0db9d88b0bd86d8b8bc040568d9e4d457
+  data.tar.gz: a143951c7a8b13c25863cb1258c7907f5af20c90bc57a90c6208929463884efd
+SHA512:
+  metadata.gz: 85b7019e5a8e0fb88422e7c3bcb67d7f5788f7ae2d403e1c2d7bf30d3d920c973d368e7d1e46e8cd5f1959f2da233b256a73c9fe34cd0d418b2604e1f077d8c4
+  data.tar.gz: 1429200eb55a06eda679dd7c00fc27d045ddedcb16deda9aba5d50ab3dfcb10152559c7aaa37920275f9211ca4cabae2ef7a87502721fed2a348015127f4db08

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-core_ext-struct.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    struct-initializer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.15.0)
+    minitest-sprint (1.2.1)
+      path_expander (~> 1.1)
+    path_expander (1.1.0)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-sprint
+  rake (~> 13.0)
+  struct-initializer!
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kasper Timm Hansen
+
+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,64 @@
+# Struct::Initializer
+
+Reuse Struct.new's attr_reader and initialize generation in any class.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add struct-initializer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install struct-initializer
+
+## Usage
+
+Ruby's `Struct` class allows auto-generating public `attr_reader`'s and an `initialize` method based on the passed attributes, like so:
+
+```ruby
+class Greeter < Struct.new(:name, :greeting)
+end
+```
+
+But this only works with inheritance, so there's certain simple initializers that still have to be written manually. `Struct::Initializer` lifts the concept out of needing inheritance:
+
+```ruby
+class Greeter
+  extend Struct::Initializer
+  struct :name, :greeting
+end
+```
+
+Another benefit, you can also have the `attr_reader`'s be marked private, even with keyword arguments:
+
+```ruby
+class Greeter
+  extend Struct::Initializer
+  private struct :name, :greeting, keyword_init: true
+end
+```
+
+### Auto-include
+
+If you want `struct` available on any object automatically, change the require to:
+
+```ruby
+gem "struct-initializer", require: "struct/initializer/autoinclude"
+```
+
+This extends `Object` with the `struct` macro, so it's automatically available on any object and `extend Struct::Initializer` from above isn't needed.
+
+## 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/kaspth/struct-initializer.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/struct/initializer/autoinclude.rb

@@ -0,0 +1,3 @@
+require_relative "../initializer"
+
+Object.include Struct::Initializer

data/lib/struct/initializer/version.rb

@@ -0,0 +1,3 @@
+module Struct::Initializer
+  VERSION = "0.1.0"
+end

data/lib/struct/initializer.rb

@@ -0,0 +1,19 @@
+module Struct::Initializer
+  def struct(*names, keyword_init: false)
+    include Definition.new(names, keyword_init: keyword_init)
+    names
+  end
+
+  class Definition < Module
+    def initialize(names, keyword_init: false)
+      attr_reader(*names)
+      arguments = names.map { "#{_1}#{":" if keyword_init}" }.join(", ")
+
+      class_eval <<~RUBY, __FILE__, __LINE__ + 1
+        def initialize(#{arguments})
+          #{names.map { "@#{_1} = #{_1}" }.join("\n")}
+        end
+      RUBY
+    end
+  end
+end

data/struct-initializer.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/struct/initializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "struct-initializer"
+  spec.version = Struct::Initializer::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email   = ["hey@kaspth.com"]
+
+  spec.summary  = "Reuse Struct.new's attr_reader and initialize generation in any class."
+  spec.homepage = "https://github.com/kaspth/struct-initializer"
+  spec.license  = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "minitest-sprint"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: struct-initializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-sprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- hey@kaspth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/struct/initializer.rb
+- lib/struct/initializer/autoinclude.rb
+- lib/struct/initializer/version.rb
+- struct-initializer.gemspec
+homepage: https://github.com/kaspth/struct-initializer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/struct-initializer
+  source_code_uri: https://github.com/kaspth/struct-initializer
+  changelog_uri: https://github.com/kaspth/struct-initializer/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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.30
+signing_key:
+specification_version: 4
+summary: Reuse Struct.new's attr_reader and initialize generation in any class.
+test_files: []