kwattr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 178bc67e1d1f7cdc032e4e1b55349992fb00869e
-  data.tar.gz: fd9698a022ccb2c69b6f63f239bc67dc4169b9cf
+  metadata.gz: f3f52b74e112e1a8cd7ee56f91323339731eafd4
+  data.tar.gz: a763e6223e15158fe8062a801b2cfe78309adb54
 SHA512:
-  metadata.gz: 52e4ef1bb5e95c1a9f5a3477cf3fc279cc4f53939c8e4204bd141a4bcb4294b1b017d06bc6b4db2e04a4b2f33fd6c91b4d53e61cf4d3c9d4da2bb8ec0f77a00e
-  data.tar.gz: c0f7229e9e29e9bf9ae82831cb6b3ce2300684fec79c9c0c2f43b4bbe9fe6d6e6396b1624cfbf23c22e7bbebee0268c148cd9797f8d768051b11f0201f4b02bc
+  metadata.gz: 2dc7f95df0dd1ef9dbe54f4d4900194ab11c85b6374811df4157c0a09aeb073a4a34409fcdf2ba4cfad48f373f916fb1cd608ab74ce4a157c0e276078b891251
+  data.tar.gz: d63c3abdfc609d1441847176aac5ee6ee0f8169fe741b68de74c10f2489657602f29d794f2968179c5914a2435ffa4be2614630130c9a3cec714776d7510676a

data/.rspec

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

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
+before_install:
+  - gem install bundler
 rvm:
-  - 2.2.0
+  - 2.2.1

data/README.md

@@ -1,14 +1,15 @@
 # KWattr
 
-Keyword arguments meet attribute definitions and initialize:
+Keyword arguments meet `attr_reader` and `initialize`:
 
 ```ruby
 class FooBar
-  kwattr :foo, :bar
+  kwattr :foo, bar: 21
 end
 
-FooBar.new foo: 42, bar: 21
-# => #<FooBar @foo=42, @bar=21>
+foobar = FooBar.new(foo: 42) # => #<FooBar @foo=42, @bar=21>
+foobar.foo # => 42
+foobar.bar # => 21
 ```
 
 instead of
@@ -17,58 +18,53 @@ instead of
 class FooBar
   attr_reader :foo, :bar
 
-  def initialize(foo:, bar:)
+  def initialize(foo:, bar: 21)
     @foo = foo
     @bar = bar
   end
 end
 ```
 
-### Default values
+### initialize
+
+The provided `initialize` is prepended so there's no need to call `super`, and
+attributes are already set when your code is reached.
 
 ```ruby
-class Foo
+class BarInitialize
   kwattr foo: 42
-end
 
-Foo.new
-# => #<Foo @foo=42>
+  def initialize(bar: 2)
+    @bar = foo / bar
+  end
+end
+BarInitialize.new # => #<BarInitialize @foo=42, @bar=21>
 ```
 
-### Overriding initialize
+### return value
 
-The default initialize is prepended so there's no need to call `super` in
-initialize, and attributes are already set.
+It returns the list of keyword attributes so you can combine with methods like
+`Module#protected`.
 
 ```ruby
-$over = []
-
-class Over
-  kwattr foo: 42
-
-  def initialize
-    $over << foo
-  end
+class FooProtected
+  protected *kwattr(foo: 42)
 end
-
-Over.new
-Over.new foo: 21
-$over
-# => [42, 21]
+FooProtected.new # => #<FooProtected @foo=42>
+FooProtected.protected_instance_methods # => [:foo]
 ```
 
-### Subclass
+### subclass
 
 ```ruby
 class Bar < Foo
   kwattr :bar
 end
 
-Bar.new bar: 42
-# => #<Bar @foo=42, @bar=42>
+Bar.new(bar: 42) # => #<Bar @foo=42, @bar=42>
 ```
 
-### Include
+### include
 
 ```ruby
 module Mod
@@ -79,9 +75,15 @@ class Inc
   include Mod
 end
 
-Inc.new mod: 42
+Inc.new(mod: 42)
 ```
 
+## See also
+
+* https://github.com/mbj/concord
+* https://github.com/ahoward/fattr
+* https://github.com/solnic/virtus
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

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

data/bin/console

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "kwattr"
+require_relative "../spec/examples"
 
 require "irb"
 IRB.start

data/kwattr.gemspec

@@ -18,4 +18,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"
 end

data/lib/kwattr/version.rb

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

data/lib/kwattr.rb

@@ -3,12 +3,14 @@ require "kwattr/version"
 module KWAttr
 
   def kwattr(*attrs, **opts)
-    attr_reader(*attrs, *opts.keys)
+    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
   end
 
   def kwattrs

data/test.rb

@@ -21,6 +21,24 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kwattr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - "Étienne Barrié"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: ''
 email:
 - etienne.barrie@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile