ez_attributes 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a1656644b5f4125ced596740a565eb787d9c55d9a355cf819f6064707edd3d
-  data.tar.gz: f4ac601d6787ac40cee85efbc1fafe3f8664fbf5fbf90efc53ba0a92652bd30e
+  metadata.gz: 4d004aaed015e6616f82058b5eb28d543be87d27a489ce9736bb558273405a4f
+  data.tar.gz: 5cda1cf13ae92c1b390987d5b92bd1f2c3cd5f72aab9380d206198d20cf137d1
 SHA512:
-  metadata.gz: aedc2203f94400db3327994c3b568e3d2e419b61429dec040ccb4b7bf932ced79433e2c07db92ae2c75c223ac73198c8061e7da6754b91031cf45227a3ad864c
-  data.tar.gz: 81bc482c0f146b8e95a666e1bf2e4631eeaaa7b9ed18dd120b1a473ccf7796232ef24db28537b44c147ef1d27d97d3ff2ce3ba1bfc70c64b2607233398477521
+  metadata.gz: ce17bb4e9bfc325c49af790b476e77110c42a1f67cefe663ac80c44cb4dd0e2e30f407292fb7c446b259fa46e89f836682ec39f1eafe8c3c9550b6f443fc28ec
+  data.tar.gz: 84e2e39b8c054f2a1dccfbfa0160c2f83786f1bf91b73784e065c00338887913e07aa59a934ce3f6c29e36d7cc640a5fee128c1f7cdb850edf71717ccb27370d

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

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7]
+        ruby: [2.5, 2.6, 2.7, '3.0']
 
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - name: Build and test with Rake
@@ -24,5 +24,5 @@ jobs:
           gem install bundler
           bundle install --jobs 4 --retry 3
           bundle exec rake
-      - name: Rubocop Linter Action
-        run: bundle exec rubocop --parallel
+      - name: Linter Action
+        run: bundle exec standardrb

data/.standard.yml

@@ -0,0 +1 @@
+format: progress

data/CHANGELOG.md

@@ -7,10 +7,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2021-10-25
+
 <!-- ### Added -->
-<!-- ### Changed -->
 
-## <!-- ### Removed -->
+### Changed
+
+- Allow configuring EzAttributes (PR #3)
+
+```ruby
+class User
+  extend EzAttributes.configure(getters: false)
+
+  attributes :name, :age, email: 'guest@user.com'
+end
+
+User.new(name: 'Matz', age: 22).name
+# NoMethodError (undefined method `name' for #<User:0x000055bac152f130>)
+```
+
+- Replace Rubocop with StandardRB
+
+<!-- ### Removed -->
+
+## [0.2.2] - 2021-04-30
+
+### Changed
+
+- Fix shared state between class instances. (Commit 759abc7cb971e6a30448f5e9557be4542128d7cf)
+
+## [0.2.1] - 2021-01-20
+
+### Changed
+
+- Do not generate getter for attribute named `class`. This prevents overriding the `Object#class` method.
+
+## [0.2.0] - 2021-01-19
+
+### Added
+
+- Allow using reserved words as attributes.
+
+```ruby
+Class.new do
+  extend EzAttributes
+
+  # This would break in 0.1.0.
+  # Now it works.
+  attributes :class, :if
+end
+```
 
 ## [0.1.0] - 2020-11-24
 
@@ -18,5 +64,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - 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
+[unreleased]: https://github.com/MatheusRich/ez_attributes/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.3.0
+[0.2.2]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.2.2
+[0.2.1]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.2.1
+[0.2.0]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.2.0
+[0.1.0]: https://github.com/MatheusRich/ez_attributes/releases/tag/v0.2.0

data/Gemfile

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+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'
+gem "rake", "~> 13.0.0"
+gem "standard"
+gem "solargraph"
 
 group :docs do
-  gem 'yard'
+  gem "yard"
 end
 
 group :test do
-  gem 'rspec', '~> 3.0'
-  gem 'simplecov', require: false
+  gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    ez_attributes (0.1.0)
+    ez_attributes (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     backport (1.1.2)
     benchmark (0.1.0)
     diff-lcs (1.4.4)
@@ -17,14 +17,15 @@ GEM
     mini_portile2 (2.4.0)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (2.1.1)
     reverse_markdown (2.0.0)
       nokogiri
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -38,19 +39,21 @@ GEM
       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)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.5.0)
       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)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
     simplecov (0.19.1)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -69,9 +72,12 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
+    standard (0.7)
+      rubocop (= 0.92)
+      rubocop-performance (= 1.8.1)
     thor (1.0.1)
     tilt (2.0.10)
-    unicode-display_width (1.7.0)
+    unicode-display_width (1.8.0)
     yard (0.9.25)
 
 PLATFORMS
@@ -81,12 +87,10 @@ DEPENDENCIES
   ez_attributes!
   rake (~> 13.0.0)
   rspec (~> 3.0)
-  rubocop
-  rubocop-performance
-  rubocop-rspec
   simplecov
   solargraph
+  standard
   yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.29

data/README.md

@@ -50,24 +50,51 @@ class User
   attributes :name, :age, email: 'guest@user.com'
 end
 
-User.new(name: 'Matz', age: 22)
+user = 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
+user.name
 # => "Matz"
 ```
 
+### Configuration
+
+You can disable getters:
+
+```ruby
+class User
+  extend EzAttributes.configure(getters: false)
+
+  attributes :name, :age, email: 'guest@user.com'
+end
+
+u = User.new(name: 'Matz', age: 22)
+# => #<User:0x000055bac152f130 @name="Matz", @age=22, @email="guest@user.com">
+
+u.name
+# NoMethodError (undefined method `name' for #<User:0x000055bac152f130>)
+
+```
+
 ## 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.
+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).
+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.
+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).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/ez_attributes.gemspec

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-require_relative 'lib/ez_attributes'
+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.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.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'
+  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']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 end

data/lib/ez_attributes.rb

@@ -15,29 +15,44 @@
 #   => #<User:0x000055bac152f130 @name="Matheus", @age=22, @email="guest@user.com">
 module EzAttributes
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = "0.3.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(', ')
+  # Attributes that won't have a getter to prevent conflicts with default methods
+  EXCEPTIONS = [:class].freeze
 
-    define_method('__args_with_default', -> { args_with_default.dup })
-    private :__args_with_default
+  def self.extended(other)
+    other.extend configure
+  end
+
+  def self.configure(getters: true)
+    mod = Module.new
+
+    mod.module_eval do
+      # Defines multiple keyword arguments for a class initializer
+      define_method :attributes do |*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", -> { Marshal.load(Marshal.dump(args_with_default)) })
+        private :__args_with_default
 
-    all_args = args + args_with_default.keys
-    attr_reader(*all_args)
+        all_args = args + args_with_default.keys
+        attr_reader(*(all_args - EXCEPTIONS)) if getters
 
-    class_eval <<~RUBY, __FILE__, __LINE__ + 1
-      def initialize(#{init_args})
-        #{all_args.map { |name| "@#{name} = #{name}" }.join('; ')}
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def initialize(#{init_args})
+            #{all_args.map { |name| "@#{name} = binding.local_variable_get(:#{name})" }.join("; ")}
+          end
+        RUBY
       end
-    RUBY
-  end
 
-  # Defines a single keyword argument for a class initializer
-  def attribute(name)
-    attributes(name)
+      # Defines a single keyword argument for a class initializer
+      define_method :attribute do |name|
+        attributes(name)
+      end
+    end
+
+    mod
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ez_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matheus Richard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Easily define initializers with keyword args. It supports required and
   optional args.
@@ -21,8 +21,8 @@ files:
 - ".github/workflows/tests-and-linter.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".ruby-version"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -40,7 +40,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -55,9 +55,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.25
+signing_key:
 specification_version: 4
 summary: Easily define initializers with keyword args.
 test_files: []

data/.rubocop.yml

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