kwattr 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61721e21a4931b993ff18921d3b9394e0fbcd4bb
-  data.tar.gz: acb2bf765ffafe8a6a6f4e6a46ede82d506f1dff
+  metadata.gz: a9ced9e0ee4d57097a23c8e2a32b6844e590031a
+  data.tar.gz: 3aba633d536806dfb842125e8a41b29c12d16844
 SHA512:
-  metadata.gz: 025b7eb42a06621e0999d1840ccb4b9455ec83989388986a09079b0437a580b36f3aed0b6d2aa511af7766d98f06afdd297fbbfa7ed334fa0508dc290ab9517e
-  data.tar.gz: 8c76eb114593e993dd020657a55b8e6f1d64d7fa0b10534f797c8529d9837e74b7188e9d9604295423e4f944ae3bc8cd676de109871b0bb3b42ff88c40ebf656
+  metadata.gz: 23bdd697aa7329a1b0dcad3352fc5ef0946634d204f0d4e35a131a9732ae15d6047a7efb37deb1f292478021ae35486e6cd0abcac854e6fff95dbbdf220c24e6
+  data.tar.gz: d1d49b97510a5751992cdf0441eaa1edc112d8f0fe108f1611d476f10d5098a846d81d877d1124e0d4027a2324634e22a72b5cd8c8bfb0698204c9ab48f4d3df

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Étienne Barrié
+
+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

@@ -36,11 +36,21 @@ class BarInitialize
 
   def initialize(bar: 2)
     @bar = foo / bar
+    yield @bar if block_given?
   end
 end
 BarInitialize.new # => #<BarInitialize @foo=42, @bar=21>
 ```
 
+The prepended `initialize` passes on any block it receives, so you can yield
+from your `initialize` as usual.
+
+```ruby
+default_bar = nil
+BarInitialize.new { |bar| default_bar = bar }
+default_bar # => 21
+```
+
 ### return value
 
 It returns the list of keyword attributes so you can combine with methods like
@@ -67,22 +77,17 @@ class FooBar2
   end
 end
 FooBar2.new
-# Ruby 2.2 and later:    ArgumentError: missing keywords: bar, foo
-# Ruby 2.1 and Rubinius: ArgumentError: missing keyword: foo
+# Ruby 2.2 and later: ArgumentError: missing keywords: bar, foo
+# Rubinius:           ArgumentError: missing keyword: foo
 ```
 
 ## compatibility
 
-* **Ruby 2.3**, **Ruby 2.2** and **JRuby 9000** are fully supported.
-
-* **Ruby 2.1** is supported, but exceptions don't include keywords from `super`.
+* **Ruby 2.5**, **Ruby 2.4**,**Ruby 2.3**, **Ruby 2.2** and **JRuby 9000** are
+  fully supported.
 
-* **Ruby 2.0**: kwattr brings fake required keyword arguments to Ruby 2.0: it
-  gives you the feel of required keyword arguments without needing the syntax
-  that came in 2.1.
-
-* **Rubinius** is supported, starting at least version 2.5.8, possibly before.
-  A similar but not exactly the same limitation as 2.1 applies to exceptions.
+* **Rubinius** is supported, but exceptions don't include keywords from
+  `super`.
 
 ## free features
 
@@ -146,8 +151,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-1. Fork it ( https://github.com/etiennebarrie/kwattr/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/etiennebarrie/kwattr. 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 KWattr project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/etiennebarrie/kwattr/blob/master/CODE_OF_CONDUCT.md).

data/lib/kwattr.rb

@@ -1,5 +1,5 @@
 class KWAttr < Module
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
   def initialize
     @required = []
@@ -10,12 +10,11 @@ class KWAttr < Module
     required_attrs = @required
     defaults = @defaults
     required_attrs.concat(attrs).uniq!
-    super_method = Method.instance_methods.include? :super_method
     defaults.merge!(opts)
     iv_cache = Hash.new { |h, k| h[k] = :"@#{k}" }
 
     verbose, $VERBOSE = $VERBOSE, false
-    define_method :initialize do |*args, **kwargs|
+    define_method :initialize do |*args, **kwargs, &block|
       required = required_attrs.dup
 
       defaults.merge(kwargs).each_pair do |key, value|
@@ -29,7 +28,7 @@ class KWAttr < Module
         initialize = method(:initialize)
         initialize.super_method.parameters.each do |type, name|
           super_required << name if type == :keyreq && !kwargs.key?(name)
-        end if super_method
+        end
         required.unshift(*super_required)
         raise ArgumentError,
           "missing keyword#{'s' if required.size > 1}: #{required.join(', ')}"
@@ -39,10 +38,11 @@ class KWAttr < Module
 
       begin
 
-        super(*args)
+
+        super(*args, &block)
 
       rescue ArgumentError
-        arity = super_method ? method(:initialize).super_method.arity : -1
+        arity = method(:initialize).super_method.arity
         if !kwargs.empty? && arity != -1 && arity == args.size - 1
           raise ArgumentError,
             "unknown keyword#{'s' if kwargs.size > 1}: #{kwargs.keys.join(', ')}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kwattr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Étienne Barrié
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-12 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,21 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
+- LICENSE.txt
 - README.md
-- Rakefile
-- benchmark.rb
-- bin/console
-- bin/rake
-- bin/rspec
-- bin/setup
-- kwattr.gemspec
 - lib/kwattr.rb
-- test.rb
 homepage: https://github.com/etiennebarrie/kwattr
 licenses: []
 metadata: {}
@@ -107,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: attr_reader + initialize with keyword arguments

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - rbx-3
-  - jruby-9.1.5.0
-matrix:
-  allow_failures:
-  - rvm: rbx-3

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in kwattr.gemspec
-gemspec

data/Rakefile

@@ -1,20 +0,0 @@
-begin
-  require "bundler/gem_tasks"
-rescue LoadError
-end
-
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
-task :examples do
-  ruby "test.rb"
-end
-
-task :benchmark do
-  ruby "benchmark.rb"
-end
-
-task :default => [:examples, :spec, :benchmark]

data/benchmark.rb

@@ -1,124 +0,0 @@
-require 'benchmark/ips'
-require 'kwattr'
-require_relative 'spec/examples'
-
-class ROneAttr
-  attr_reader :foo
-
-  def initialize(foo:)
-    @foo = foo
-  end
-end
-
-class ROneAttrDefault
-  DEFAULT_FOO = 42
-
-  attr_reader :foo
-
-  def initialize(foo: DEFAULT_FOO)
-    @foo = foo
-  end
-end
-
-class ROneAttrOnePositional
-  attr_reader :foo, :bar
-
-  def initialize(bar, foo:)
-    @foo = foo
-    @bar = bar
-  end
-end
-
-class RTwoAttrs
-  attr_reader :foo, :bar
-
-  def initialize(foo:, bar:)
-    @foo = foo
-    @bar = bar
-  end
-end
-
-class RTwoAttrsDefaults
-  DEFAULT_FOO = 42
-  DEFAULT_BAR = 21
-
-  attr_reader :foo, :bar
-
-  def initialize(foo: DEFAULT_FOO, bar: DEFAULT_BAR)
-    @foo = foo
-    @bar = bar
-  end
-end
-
-class RTwoAttrsOneDefault
-  DEFAULT_BAR = 21
-
-  attr_reader :foo, :bar
-
-  def initialize(foo:, bar: DEFAULT_BAR)
-    @foo = foo
-    @bar = bar
-  end
-end
-
-class RTwoAttrsOnePos
-  attr_reader :foo, :bar, :baz
-
-  def initialize(baz, foo:, bar:)
-    @foo = foo
-    @bar = bar
-    @baz = baz
-  end
-end
-
-class RTwoAttrsInheritsOneAttr < ROneAttr
-  attr_reader :bar
-
-  def initialize(foo:, bar:)
-    super(foo: foo)
-    @bar = bar
-  end
-end
-
-module ROneAttrModule
-  attr_reader :foo
-
-  def initialize(foo:)
-    @foo = foo
-  end
-end
-
-class ROneAttrViaModule
-  include ROneAttrModule
-end
-
-Benchmark.ips do |b|
-  b.warmup = ENV['CONTINUOUS_INTEGRATION'] ? 1 : 0.1
-  b.time = ENV['CONTINUOUS_INTEGRATION'] ? 5 : 1
-
-  b.report "KWAttr classes" do
-    OneAttr.new foo: 42
-    OneAttrDefault.new
-    OneAttrOnePositional.new 42, foo: 21
-    TwoAttrs.new foo: 42, bar: 21
-    TwoAttrsDefaults.new
-    TwoAttrsOneDefault.new foo: 42
-    TwoAttrsOnePos.new 42, foo: 21, bar: 14
-    TwoAttrsInheritsOneAttr.new foo: 42, bar: 21
-    OneAttrViaModule.new foo: 42
-  end
-
-  b.report "Plain classes" do
-    ROneAttr.new foo: 42
-    ROneAttrDefault.new
-    ROneAttrOnePositional.new 42, foo: 21
-    RTwoAttrs.new foo: 42, bar: 21
-    RTwoAttrsDefaults.new
-    RTwoAttrsOneDefault.new foo: 42
-    RTwoAttrsOnePos.new 42, foo: 21, bar: 14
-    RTwoAttrsInheritsOneAttr.new foo: 42, bar: 21
-    ROneAttrViaModule.new foo: 42
-  end
-
-  b.compare!
-end

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "kwattr"
-require_relative "../spec/examples"
-
-require "irb"
-IRB.start

data/bin/rake

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -1,5 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install

data/kwattr.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kwattr'
-
-Gem::Specification.new do |spec|
-  spec.name          = "kwattr"
-  spec.version       = KWAttr::VERSION
-  spec.authors       = ["Étienne Barrié"]
-  spec.email         = ["etienne.barrie@gmail.com"]
-
-  spec.summary       = %q{attr_reader + initialize with keyword arguments}
-  spec.description   = %q{}
-  spec.homepage      = "https://github.com/etiennebarrie/kwattr"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "benchmark-ips", "~> 2.2"
-end

data/test.rb

@@ -1,221 +0,0 @@
-require 'kwattr'
-puts "kwattr v#{KWAttr::VERSION}"
-
-def p(value)
-  super if $DEBUG
-  value
-end
-
-class Test
-  kwattr :foo, :bar
-end
-
-test = Test.new(foo: 42, bar: 21)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-
-def raises?(exception_class)
-  yield
-  return
-rescue exception_class
-  return p $!
-end
-
-fail unless raises?(ArgumentError) { Test.new }
-fail unless raises?(ArgumentError) { Test.new(foo: 42) }
-fail unless raises?(ArgumentError) { Test.new(foo: 42, bar: 21, baz: 43) }
-
-class Discrete
-  protected *kwattr(:foo, bar: 21)
-
-  def pfoo
-    foo
-  end
-
-  def pbar
-    bar
-  end
-end
-
-test = Discrete.new(foo: 42)
-fail unless p(test.pfoo) == 42
-fail unless p(test.pbar) == 21
-fail unless raises?(NoMethodError) { test.foo }
-fail unless raises?(NoMethodError) { test.bar }
-
-class Test2
-  kwattr :titi
-  kwattr :toto
-end
-
-test = Test2.new(titi: 1, toto: 2)
-fail unless p(test.titi) == 1
-fail unless p(test.toto) == 2
-
-class TestDescendant < Test
-  kwattr :baz
-end
-
-test = TestDescendant.new(foo: 42, bar: 21, baz: 14)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-fail unless p(test.baz) == 14
-
-class TestInitialize
-  kwattr :foo, :bar
-  attr :baz
-
-  def initialize(baz: 42)
-    @baz = baz / 3
-  end
-end
-
-test = TestInitialize.new(foo: 42, bar: 21)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-fail unless p(test.baz) == 14
-test = TestInitialize.new(foo: 42, bar: 21, baz: 21)
-fail unless p(test.baz) == 7
-
-class TestPositional
-  kwattr :foo, :bar
-  attr :x, :y
-
-  def initialize(x, y)
-    @x = x
-    @y = y
-  end
-end
-
-test = TestPositional.new(1, 2, foo: 42, bar: 21)
-fail unless p(test.x) == 1
-fail unless p(test.y) == 2
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-
-class TestOptionalKeyword
-  kwattr foo: 42
-  kwattr :bar
-end
-
-test = TestOptionalKeyword.new(bar: 21)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-test = TestOptionalKeyword.new(foo: 21, bar: 42)
-fail unless p(test.foo) == 21
-
-class TestPositionalDescendant < TestPositional
-  kwattr baz: 14
-end
-
-test = TestPositionalDescendant.new(1, 2, foo: 42, bar: 21)
-fail unless p(test.x) == 1
-fail unless p(test.y) == 2
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-fail unless p(test.baz) == 14
-
-class TestPositionalDescendantMore < TestPositionalDescendant
-  attr :z
-
-  def initialize(x, y, z, **options)
-    super(x, y, **options)
-    @z = z
-  end
-end
-
-test = TestPositionalDescendantMore.new(1, 2, 3, foo: 42, bar: 21)
-fail unless p(test.x) == 1
-fail unless p(test.y) == 2
-fail unless p(test.z) == 3
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-fail unless p(test.baz) == 14
-
-class TestPositionalDescendantFull < TestPositionalDescendant
-  attr :z
-  kwattr opt: 42
-  kwattr :req
-
-  def initialize(x, y, z, **options)
-    super(x, y, **options)
-    @z = z
-  end
-end
-
-test = TestPositionalDescendantFull.new(1, 2, 3, foo: 42, bar: 21, opt: 7, req: 6)
-fail unless p(test.x) == 1
-fail unless p(test.y) == 2
-fail unless p(test.z) == 3
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-fail unless p(test.baz) == 14
-fail unless p(test.opt) == 7
-fail unless p(test.req) == 6
-
-class TestDefaults
-  kwattr foo: 42, bar: 21
-end
-
-test = TestDefaults.new
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21
-
-class TestKeywordArgs
-  kwattr foo: 42
-  attr :bar
-
-  def initialize(bar: 21)
-    @bar = bar * 3
-  end
-end
-
-test = TestKeywordArgs.new(foo: 42, bar: 14)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 42
-
-class TestInit
-  kwattr foo: 42, bar: 21
-
-  def initialize
-    @inits ||= []
-    @inits << 1
-  end
-end
-
-class TestInitDescendant < TestInit
-  kwattr baz: 14
-  attr :inits
-
-  def initialize(*)
-    super
-    @inits << 2
-  end
-end
-
-test = TestInit.new(bar: 42)
-test = TestInitDescendant.new(baz: 7)
-fail unless p(test.inits) == [1, 2]
-
-module Foo
-  kwattr :foo
-end
-
-class TestModule
-  include Foo
-end
-
-test = TestModule.new(foo: 42)
-fail unless p(test.foo) == 42
-
-module Bar
-  kwattr :bar
-end
-
-class TestModules
-  include Foo, Bar
-end
-
-test = TestModules.new(foo: 42, bar: 21)
-fail unless p(test.foo) == 42
-fail unless p(test.bar) == 21