attr_extras 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfeb7ee3f02c3e7a249a3a76041fa4faf1604b36
-  data.tar.gz: f976af63159f1beaa0f951652a8ea15220c9b650
+  metadata.gz: 984c86a8a64ba56792a8e78ce89452ca66c32b55
+  data.tar.gz: 3957fdf50be3ffee0ffec904176d6e3918676294
 SHA512:
-  metadata.gz: 49df99f90b8667b4926a30af53e23e50a2327e0305cbf0c81956fba1223773c46e3714e3c29e70cf8a049c21398edd6adb18abe562048346e72baa1a3c7eb7e9
-  data.tar.gz: c3875dd5d15e08ebaca8941a7624839dca8fcbb4c0acaf607108aae231303204c17d076b9ff0bf2beb12477d78fc0cb30b81e70820723211d3f61e8ac2915b7b
+  metadata.gz: 1857358b5507acbbbd0aefe5266f1b0e5626ecb5415ffd5070a7f4bd327fcdf4e615917df393cbefe58b6b34d6c9ae869a32751549d119e1d2fc37aa8a4f2e46
+  data.tar.gz: 2f7c2155bfd5a96f9b31f88bf2153ef11048ce1117c03b402cb5ac90249bfe66240177e741ce4544c88e3933566ad6abafb7fe80082c6344172159c05bafff9e

data/README.md

@@ -143,7 +143,11 @@ Defines query methods like `foo?`, which is true if (and only if) `foo` is truth
 
 ### `attr_implement :foo, :bar`<br>
 
-Defines methods `foo` and `bar` that raise e.g. `"Implement a 'foo' method"`, suitable for abstract base classes.
+Defines nullary (0-argument) methods `foo` and `bar` that raise e.g. `"Implement a 'foo()' method"`.
+
+`attr_implement :foo, [:name, :age]` will define a binary (2-argument) method `foo` that raises `"Implement a 'foo(name, age)' method"`.
+
+This is suitable for [abstract methods](http://en.wikipedia.org/wiki/Abstract_method#Abstract_methods) in base classes, e.g. when using the [template method pattern](http://en.wikipedia.org/wiki/Template_method_pattern).
 
 
 ## Philosophy

data/lib/attr_extras.rb

@@ -63,9 +63,18 @@ module AttrExtras
     end
 
     def attr_implement(*names)
+      arg_names = names.last.is_a?(Array) ? names.pop : []
+      arity = arg_names.length
+
       names.each do |name|
-        define_method(name) do |*_|
-          raise "Implement a '#{name}' method"
+        define_method(name) do |*args|
+          provided_arity = args.length
+
+          if provided_arity != arity
+            raise ArgumentError, "wrong number of arguments (#{provided_arity} for #{arity})"
+          end
+
+          raise "Implement a '#{name}(#{arg_names.join(", ")})' method"
         end
       end
     end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "2.3.0"
+  VERSION = "3.0.0"
 end

data/spec/attr_implement_spec.rb

@@ -1,23 +1,26 @@
 require_relative "spec_helper"
 
 describe Object, ".attr_implement" do
-  it "creates methods that raise" do
+  it "creates 0-argument methods that raise" do
     klass = Class.new do
       attr_implement :foo, :bar
     end
 
     example = klass.new
     exception = lambda { example.foo }.must_raise RuntimeError
-    exception.message.must_equal "Implement a 'foo' method"
+    exception.message.must_equal "Implement a 'foo()' method"
   end
 
-  it "accepts any number of arguments" do
+  it "allows specifying arity and argument names" do
     klass = Class.new do
-      attr_implement :foo
+      attr_implement :foo, [:name, :age]
     end
 
     example = klass.new
-    exception = lambda { example.foo(1, 2, 3) }.must_raise RuntimeError
-    exception.message.must_equal "Implement a 'foo' method"
+
+    exception = lambda { example.foo(1, 2) }.must_raise RuntimeError
+    exception.message.must_equal "Implement a 'foo(name, age)' method"
+
+    lambda { example.foo }.must_raise ArgumentError
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Henrik Nyh