ez_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1a1656644b5f4125ced596740a565eb787d9c55d9a355cf819f6064707edd3d
+  data.tar.gz: f4ac601d6787ac40cee85efbc1fafe3f8664fbf5fbf90efc53ba0a92652bd30e
+SHA512:
+  metadata.gz: aedc2203f94400db3327994c3b568e3d2e419b61429dec040ccb4b7bf932ced79433e2c07db92ae2c75c223ac73198c8061e7da6754b91031cf45227a3ad864c
+  data.tar.gz: 81bc482c0f146b8e95a666e1bf2e4631eeaaa7b9ed18dd120b1a473ccf7796232ef24db28537b44c147ef1d27d97d3ff2ce3ba1bfc70c64b2607233398477521

data/.github/workflows/tests-and-linter.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+      - name: Rubocop Linter Action
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: true
+

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+<!-- ### Added -->
+<!-- ### Changed -->
+
+## <!-- ### Removed -->
+
+## [0.1.0] - 2020-11-24
+
+### Added
+
+- Basic module to define class initializers with keyword args.
+
+[unreleased]: https://github.com/MatheusRich/ez_attributes/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in f_service.gemspec
+gemspec
+
+gem 'rake', '~> 13.0.0'
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rspec', require: false
+gem 'solargraph'
+
+group :docs do
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    ez_attributes (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    backport (1.1.2)
+    benchmark (0.1.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    maruku (0.7.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (1.41.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    solargraph (0.39.17)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ez_attributes!
+  rake (~> 13.0.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+  solargraph
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matheus Richard
+
+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,73 @@
+<p align="center">
+  <h1 align="center">EzAttributes</h1>
+
+  <p align="center">
+    <i>Easily define initializers with keyword args</i>
+    <br>
+    <br>
+    <img src="https://img.shields.io/gem/v/ez_attributes">
+    <img src="https://img.shields.io/gem/dt/ez_attributes">
+    <img src="https://github.com/MatheusRich/ez_attributes/workflows/Ruby/badge.svg">
+    <a href="https://github.com/MatheusRich/ez_attributes/blob/master/LICENSE">
+      <img src="https://img.shields.io/github/license/MatheusRich/ez_attributes.svg" alt="License">
+    </a>
+  </p>
+</p>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ez_attributes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ez_attributes
+
+## Usage
+
+The first step is to extend EzAttributes in your class.
+
+```ruby
+class User
+  extend EzAttributes
+end
+```
+
+Then, add the required and optional fields
+
+```ruby
+class User
+  extend EzAttributes
+
+  # Here name and age are required, and email has a default value, so it is optional.
+  attributes :name, :age, email: 'guest@user.com'
+end
+
+User.new(name: 'Matz', age: 22)
+# => #<User:0x000055bac152f130 @name="Matz", @age=22, @email="guest@user.com">
+
+# EzAttributes will add getters for all fields too.
+User.name
+# => "Matz"
+```
+
+## 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 tags, 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/MatheusRich/ez_attributes.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ez_attributes'
+
+# 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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ez_attributes.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ez_attributes'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ez_attributes'
+  spec.version       = EzAttributes::VERSION
+  spec.authors       = ['Matheus Richard']
+  spec.email         = ['matheusrichardt@gmail.com']
+
+  spec.summary       = 'Easily define initializers with keyword args.'
+  spec.description   = 'Easily define initializers with keyword args. It supports required and optional args.'
+  spec.homepage      = 'https://github.com/MatheusRich/ez_attributes.git'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/MatheusRich/ez_attributes/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(File.expand_path(__dir__)) 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']
+end

data/lib/ez_attributes.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Easily define initializers with keyword args.
+# It supports required and optional args.
+#
+# @example
+#   class User
+#     extend EzAttributes
+#
+#     # Here name and age are required, and email has a default value, so it is optional.
+#     attributes :name, :age, email: 'guest@user.com'
+#   end
+#
+#   User.new(name: 'Matheus', age: 22)
+#   => #<User:0x000055bac152f130 @name="Matheus", @age=22, @email="guest@user.com">
+module EzAttributes
+  # Gem version
+  VERSION = '0.1.0'
+
+  # Defines multiple keyword arguments for a class initializer
+  def attributes(*args, **args_with_default)
+    required_args = args.map { |name| "#{name}:" }
+    optional_args = args_with_default.map { |name, _| "#{name}: __args_with_default[:#{name}]" }
+    init_args = (required_args + optional_args).join(', ')
+
+    define_method('__args_with_default', -> { args_with_default.dup })
+    private :__args_with_default
+
+    all_args = args + args_with_default.keys
+    attr_reader(*all_args)
+
+    class_eval <<~RUBY, __FILE__, __LINE__ + 1
+      def initialize(#{init_args})
+        #{all_args.map { |name| "@#{name} = #{name}" }.join('; ')}
+      end
+    RUBY
+  end
+
+  # Defines a single keyword argument for a class initializer
+  def attribute(name)
+    attributes(name)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ez_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matheus Richard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-25 00:00:00.000000000 Z
+dependencies: []
+description: Easily define initializers with keyword args. It supports required and
+  optional args.
+email:
+- matheusrichardt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests-and-linter.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ez_attributes.gemspec
+- lib/ez_attributes.rb
+homepage: https://github.com/MatheusRich/ez_attributes.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MatheusRich/ez_attributes.git
+  source_code_uri: https://github.com/MatheusRich/ez_attributes.git
+  changelog_uri: https://github.com/MatheusRich/ez_attributes/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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Easily define initializers with keyword args.
+test_files: []