kwattr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3f52b74e112e1a8cd7ee56f91323339731eafd4
-  data.tar.gz: a763e6223e15158fe8062a801b2cfe78309adb54
+  metadata.gz: 7a5f6547c53d33b561a7706e2f35f265cdfc47b9
+  data.tar.gz: 519b1520e6d69054a81c8de80529982a0bc3c066
 SHA512:
-  metadata.gz: 2dc7f95df0dd1ef9dbe54f4d4900194ab11c85b6374811df4157c0a09aeb073a4a34409fcdf2ba4cfad48f373f916fb1cd608ab74ce4a157c0e276078b891251
-  data.tar.gz: d63c3abdfc609d1441847176aac5ee6ee0f8169fe741b68de74c10f2489657602f29d794f2968179c5914a2435ffa4be2614630130c9a3cec714776d7510676a
+  metadata.gz: 1c81b0f64cb6875c4dd96582199348b8580e490d2e77524640ec1b4b6e1dea265bb660387ed9389dfc09be630c68cce22f3616c2cc0512d19c698e54ad09a26c
+  data.tar.gz: 34975ee6fac582fc340b9d937ca432e8f35ac8d1d88b1996bf432370f9e6e814a1b31a501177a82e018e88b4a4cc47f1071cbf63b2b58be1d18342368d92450e

data/README.md

@@ -57,11 +57,15 @@ FooProtected.protected_instance_methods # => [:foo]
 ### subclass
 
 ```ruby
-class Bar < Foo
+class Foo
+  kwattr :foo
+end
+
+class FooWithBar < Foo
   kwattr :bar
 end
 
-Bar.new(bar: 42) # => #<Bar @foo=42, @bar=42>
+FooWithBar.new(foo: 42, bar: 21) # => #<FooWithBar @foo=42, @bar=21>
 ```
 
 ### include

data/Rakefile

@@ -13,4 +13,8 @@ task :examples do
   ruby "test.rb"
 end
 
-task :default => [:examples, :spec]
+task :benchmark do
+  ruby "benchmark.rb"
+end
+
+task :default => [:examples, :spec, :benchmark]

data/benchmark.rb

@@ -0,0 +1,124 @@
+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 = 0.1
+  b.time = 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/kwattr.gemspec

@@ -1,11 +1,9 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kwattr/version'
+require_relative 'lib/kwattr'
 
 Gem::Specification.new do |spec|
   spec.name          = "kwattr"
-  spec.version       = KWattr::VERSION
+  spec.version       = KWAttr::VERSION
   spec.authors       = ["Étienne Barrié"]
   spec.email         = ["etienne.barrie@gmail.com"]
 
@@ -19,4 +17,5 @@ Gem::Specification.new do |spec|
   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/lib/kwattr.rb

@@ -1,57 +1,57 @@
-require "kwattr/version"
+class KWAttr < Module
+  VERSION = "0.3.0"
 
-module KWAttr
+  attr_reader :required_attrs, :defaults
 
-  def kwattr(*attrs, **opts)
-    names = [*attrs, *opts.keys]
-    attr_reader(*names)
-    prepend Initializer
-    extend Heritable
-    required, defaults = kwattrs
-    attrs.each { |attr| required << attr unless required.include?(attr) }
-    defaults.merge!(opts)
-    names
+  def initialize
+    @required_attrs = []
+    @defaults = {}
   end
 
-  def kwattrs
-    @kwattrs ||= [[], {}]
-  end
-
-  module Heritable
-    def inherited(subclass)
-      required, defaults = kwattrs
-      subclass.kwattr(*required, **defaults)
-    end
-
-    alias_method :included, :inherited
-  end
+  def initializer(attrs, opts)
+    required_attrs = self.required_attrs
+    defaults = self.defaults
+    required_attrs.concat(attrs).uniq!
+    defaults.merge!(opts)
 
-  module Initializer
-    def initialize(*args, **kwargs)
-      required, defaults = self.class.kwattrs
-      required = required.dup
+    $VERBOSE = false
+    define_method :initialize do |*args, **kwargs|
+      required = required_attrs.dup
       defaults.merge(kwargs).each_pair do |key, value|
         next unless required.delete(key) || defaults.key?(key)
         kwargs.delete(key)
         instance_variable_set "@#{key}", value
       end
+
       unless required.empty?
+        method(:initialize).super_method.parameters.each do |type, name|
+          required << name if type == :keyreq && !kwargs.key?(name)
+        end
         raise ArgumentError,
           "missing keyword#{'s' if required.size > 1}: #{required.join(', ')}"
       end
-      if method(:initialize).super_method.arity == args.size && !kwargs.empty?
-        raise ArgumentError,
-          "unknown keyword#{'s' if kwargs.size > 1}: #{kwargs.keys.join(', ')}"
+      unless kwargs.empty?
+        arity = method(:initialize).super_method.arity
+        if arity != -1 && arity == args.size
+          raise ArgumentError,
+            "unknown keyword#{'s' if kwargs.size > 1}: #{kwargs.keys.join(', ')}"
+        end
+        args << kwargs
       end
-      args << kwargs unless kwargs.empty?
+
       super(*args)
     end
+    $VERBOSE = true
   end
 
 end
 
-public def kwattr(*args)
-  raise TypeError, "wrong type #{self.class} (expected Module)" unless Module === self
-  extend KWAttr
-  kwattr(*args)
+class Module
+  def kwattr(*attrs, **opts)
+    names = [*attrs, *opts.keys]
+    attr_reader(*names)
+    prepend @kwattrs ||= KWAttr.new
+    @kwattrs.initializer(attrs, opts)
+    names
+  end
 end

data/test.rb

@@ -15,8 +15,6 @@ rescue exception_class
   return p $!
 end
 
-fail unless raises?(TypeError) { kwattr }
-
 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) }
@@ -49,7 +47,6 @@ fail unless p(test.titi) == 1
 fail unless p(test.toto) == 2
 
 class TestDescendant < Test
-  kwattr :bar
   kwattr :baz
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kwattr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - "Étienne Barrié"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: ''
 email:
 - etienne.barrie@gmail.com
@@ -66,11 +80,11 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - kwattr.gemspec
 - lib/kwattr.rb
-- lib/kwattr/version.rb
 - test.rb
 homepage: https://github.com/etiennebarrie/kwattr
 licenses: []

data/lib/kwattr/version.rb

@@ -1,3 +0,0 @@
-module KWattr
-  VERSION = "0.2.0"
-end