kwattr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 178bc67e1d1f7cdc032e4e1b55349992fb00869e
+  data.tar.gz: fd9698a022ccb2c69b6f63f239bc67dc4169b9cf
+SHA512:
+  metadata.gz: 52e4ef1bb5e95c1a9f5a3477cf3fc279cc4f53939c8e4204bd141a4bcb4294b1b017d06bc6b4db2e04a4b2f33fd6c91b4d53e61cf4d3c9d4da2bb8ec0f77a00e
+  data.tar.gz: c0f7229e9e29e9bf9ae82831cb6b3ce2300684fec79c9c0c2f43b4bbe9fe6d6e6396b1624cfbf23c22e7bbebee0268c148cd9797f8d768051b11f0201f4b02bc

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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

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

data/README.md

@@ -0,0 +1,112 @@
+# KWattr
+
+Keyword arguments meet attribute definitions and initialize:
+
+```ruby
+class FooBar
+  kwattr :foo, :bar
+end
+
+FooBar.new foo: 42, bar: 21
+# => #<FooBar @foo=42, @bar=21>
+```
+
+instead of
+
+```ruby
+class FooBar
+  attr_reader :foo, :bar
+
+  def initialize(foo:, bar:)
+    @foo = foo
+    @bar = bar
+  end
+end
+```
+
+### Default values
+
+```ruby
+class Foo
+  kwattr foo: 42
+end
+
+Foo.new
+# => #<Foo @foo=42>
+```
+
+### Overriding initialize
+
+The default initialize is prepended so there's no need to call `super` in
+initialize, and attributes are already set.
+
+```ruby
+$over = []
+
+class Over
+  kwattr foo: 42
+
+  def initialize
+    $over << foo
+  end
+end
+
+Over.new
+Over.new foo: 21
+$over
+# => [42, 21]
+```
+
+### Subclass
+
+```ruby
+class Bar < Foo
+  kwattr :bar
+end
+
+Bar.new bar: 42
+# => #<Bar @foo=42, @bar=42>
+```
+
+### Include
+
+```ruby
+module Mod
+  kwattr :mod
+end
+
+class Inc
+  include Mod
+end
+
+Inc.new mod: 42
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kwattr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kwattr
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+## 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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :default do
+  ruby "test.rb"
+end

data/bin/console

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

data/bin/setup

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

data/kwattr.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kwattr/version'
+
+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"
+end

data/lib/kwattr/version.rb

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

data/lib/kwattr.rb

@@ -0,0 +1,55 @@
+require "kwattr/version"
+
+module KWAttr
+
+  def kwattr(*attrs, **opts)
+    attr_reader(*attrs, *opts.keys)
+    prepend Initializer
+    extend Heritable
+    required, defaults = kwattrs
+    attrs.each { |attr| required << attr unless required.include?(attr) }
+    defaults.merge!(opts)
+  end
+
+  def kwattrs
+    @kwattrs ||= [[], {}]
+  end
+
+  module Heritable
+    def inherited(subclass)
+      required, defaults = kwattrs
+      subclass.kwattr(*required, **defaults)
+    end
+
+    alias_method :included, :inherited
+  end
+
+  module Initializer
+    def initialize(*args, **kwargs)
+      required, defaults = self.class.kwattrs
+      required = required.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?
+        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(', ')}"
+      end
+      args << kwargs unless kwargs.empty?
+      super(*args)
+    end
+  end
+
+end
+
+public def kwattr(*args)
+  raise TypeError, "wrong type #{self.class} (expected Module)" unless Module === self
+  extend KWAttr
+  kwattr(*args)
+end

data/test.rb

@@ -0,0 +1,200 @@
+require 'kwattr'
+
+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?(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) }
+
+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 :bar
+  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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: kwattr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "Étienne Barrié"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- etienne.barrie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kwattr.gemspec
+- lib/kwattr.rb
+- lib/kwattr/version.rb
+- test.rb
+homepage: https://github.com/etiennebarrie/kwattr
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: attr_reader + initialize with keyword arguments
+test_files: []