attr_extras 3.2.0 → 4.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWFjODUyMWM5ZDQwYTllYzlkYWU4YjkwNzBkOWQ1YjY0NTE5MWY0ZQ==
+    YTEzMGU2ZTk5YTFhZTRkOGRjN2NjMDNkYTU4MDM4NTVkNDExNmVkOQ==
   data.tar.gz: !binary |-
-    NzI4N2YyZjcwN2ZkZDIzMmIyN2I2NmI3NDJjMGNlZTQyNjZkOGNmYw==
+    MDZkNDRkNzc2MDMyOGUwMzVjODE1YmE5NGNkODNhMjY4YTM5NzZjYw==
 SHA512:
   metadata.gz: !binary |-
-    NTUxMDVlN2I2NzI4NzY4MjBkMGM4OWQ0OGM5M2NjNGRkYzdiNzRiOWNiYzQ5
-    YTEyZTFhMjkxNjg3YTU2ZWJkMTgxNjU0OTU5NjcxNzY2YjYzODA0NTNlZmY4
-    MzYxZTc2ZTE5YzdiMjg1OTEzMmE1ODNmYzJjYmQ5OTkxMzZiODI=
+    MWNjNjMyYjQ3ZTMyMDE5MTQwYWIyY2NjYzQxMjJkNTNjNTQxOGZhMzY2NjAw
+    MmZkM2U3NzNiOTBjMWVmYzQyODA4MzBhMWU3ODIyYmZkNjFjODRhYTAzOTlm
+    MGY0NjEzYWIxZjU5MDhlNjRmNDkzYmZlMWVjMmY0ODQ5MWY0YWI=
   data.tar.gz: !binary |-
-    YmRlYTAwYWQzMmJiODA2ZTk5YzEyMDVkNGVmY2JiODI5MGUxYTAxNWQzNDIx
-    MjAyZWM3OTUwOWMzN2Y0NDkxZjhkOGYwYmM0ZmNjM2JhMTg0MDQ1ZGM3NGQw
-    ZmE2YzM1MGE2ODU2YTExZGZmNGM5NmZhYzI3YzgwMTFjODNjMzQ=
+    MWNiMmYwMDI5MDYzZjBjYWY2OGFhNTMyZWIyZjJjZDkzNDRlOWUxY2Q3NzNm
+    ZWJhYWViN2I5NmU1ZWY1OWFhODQ3NGEwOTY1YmE3MGZjNWY5YTU0NTY5YWU2
+    ODgwNjZmOGE2MjQzZmQ0MzE5ZDY5OTYyMzhjNjVlODk2NzMyMGQ=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2014 Barsoom AB (http://barsoom.se)
+
+MIT License
+
+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

@@ -83,18 +83,57 @@ attr_value :foo, :bar
 The `attr_initialize` notation for hash arguments is also supported: `vattr_initialize :foo, [:bar, :baz!]`
 
 
-### `method_object :fooable?, :foo`<br>
+### `static_facade :fooable?, :foo`<br>
 
-Defines a `.fooable?` class method that takes arguments (`foo`) and delegates to an instance method that can access those arguments as private readers.
+Defines a `.fooable?` class method that delegates to an instance method by the same name, having first provided `foo` as a private reader.
 
-This is useful for [method objects](http://refactoring.com/catalog/replaceMethodWithMethodObject.html):
+This is handy when a class-method API makes sense but you still want [the refactorability of instance methods](http://blog.codeclimate.com/blog/2012/11/14/why-ruby-class-methods-resist-refactoring/).
+
+``` ruby
+class PublishingPolicy
+  static_facade :allow?, :user
+  static_facade :disallow?, :user
+
+  def allow?
+    user.admin? && …
+  end
+
+  def disallow?
+    !allow?
+  end
+end
+
+PublishingPolicy.allow?(user)
+```
+
+`static_facade :fooable?, :foo` is a shortcut for
+
+``` ruby
+pattr_initialize :foo
+
+def self.fooable?(foo)
+  new(foo).fooable?
+end
+```
+
+The `attr_initialize` notation for hash arguments is also supported: `static_facade :fooable?, :foo, [:bar, :baz!]`
+
+You don't have to specify arguments/readers if you don't want them: just `static_facade :fooable?` is also valid.
+
+
+### `method_object :foo`
+
+*NOTE: v4.0.0 made a breaking change! `static_facade` does exactly what `method_object` used to do; the new `method_object` no longer accepts a method name argument.*
+
+Defines a `.call` class method that delegates to an instance method by the same name, having first provided `foo` as a private reader.
+
+This is a special case of `static_facade` for when you want a [Method Object](http://refactoring.com/catalog/replaceMethodWithMethodObject.html), and the class name itself will communicate the action it performs.
 
 ``` ruby
 class PriceCalculator
-  method_object :calculate,
-    :order
+  method_object :order
 
-  def calculate
+  def call
     total * factor
   end
 
@@ -111,27 +150,30 @@ end
 
 class Order
   def price
-    PriceCalculator.calculate(self)
+    PriceCalculator.call(self)
   end
-
-  # …
 end
 ```
 
-Shortcut for
+`method_object :foo` is a shortcut for
+
+``` ruby
+static_facade :call, :foo
+```
+
+which is a shortcut for
 
 ``` ruby
-attr_initialize :foo
-attr_private :foo
+pattr_initialize :foo
 
-def self.fooable?(foo)
-  new(foo).fooable?
+def self.call(foo)
+  new(foo).call
 end
 ```
 
-The `attr_initialize` notation for hash arguments is also supported: `method_object :fooable?, :foo, [:bar, :baz!]`
+The `attr_initialize` notation for hash arguments is also supported: `method_object :foo, [:bar, :baz!]`
 
-You don't have to specify readers if you don't want them: `method_object :fooable?` is also valid.
+You don't have to specify arguments/readers if you don't want them: just `method_object` is also valid.
 
 
 ### `attr_id_query :foo?, :bar?`<br>
@@ -151,6 +193,16 @@ Defines nullary (0-argument) methods `foo` and `bar` that raise e.g. `"Implement
 
 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).
 
+It's more or less a shortcut for
+
+``` ruby
+def my_method
+  raise "Implement me in a subclass!"
+end
+```
+
+though it is shorter, more declarative, gives you a clear message and handles edge cases you might not have thought about (see tests).
+
 
 ## Philosophy
 
@@ -211,25 +263,4 @@ Or to see warnings (try not to have any):
 
 ## License
 
-Copyright (c) 2012-2014 [Barsoom AB](http://barsoom.se)
-
-MIT License
-
-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.
+[MIT](LICENSE.txt)

data/lib/attr_extras.rb

@@ -46,7 +46,7 @@ module AttrExtras
       attr_value(*Utils.flat_names(names))
     end
 
-    def method_object(method_name, *names)
+    def static_facade(method_name, *names)
       define_singleton_method(method_name) do |*values|
         new(*values).public_send(method_name)
       end
@@ -54,6 +54,10 @@ module AttrExtras
       pattr_initialize(*names)
     end
 
+    def method_object(*names)
+      static_facade :call, *names
+    end
+
     def attr_query(*names)
       AttrQuery.define_with_suffix(self, "", *names)
     end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "3.2.0"
+  VERSION = "4.0.0"
 end

data/spec/attr_implement_spec.rb

@@ -38,9 +38,13 @@ describe Object, ".attr_implement" do
     subklass.new.foo.must_equal "bar"
   end
 
-  # E.g. Active Record defines column query methods like "admin?"
+  # E.g. when Active Record defines column query methods like "admin?"
   # higher up in the ancestor chain.
   it "does not raise if method is implemented in a superclass" do
+    foo_interface = Module.new do
+      attr_implement :foo
+    end
+
     superklass = Class.new do
       def foo
         "bar"
@@ -48,9 +52,17 @@ describe Object, ".attr_implement" do
     end
 
     klass = Class.new(superklass) do
-      attr_implement :foo
+      include foo_interface
     end
 
     klass.new.foo.must_equal "bar"
   end
+
+  it "does not mess up missing-method handling" do
+    klass = Class.new do
+      attr_implement :foo
+    end
+
+    lambda { klass.new.some_other_method }.must_raise NoMethodError
+  end
 end

data/spec/method_object_spec.rb

@@ -1,29 +1,28 @@
 require_relative "spec_helper"
 
 describe Object, ".method_object" do
-  it "creates a class method that instantiates and runs that instance method" do
+  it "creates a .call class method that instantiates and runs the #call instance method" do
     klass = Class.new do
-      method_object :fooable?,
-        :foo
+      method_object :foo
 
-      def fooable?
+      def call
         foo
       end
     end
 
-    assert klass.fooable?(true)
-    refute klass.fooable?(false)
+    assert klass.call(true)
+    refute klass.call(false)
   end
 
   it "doesn't require attributes" do
     klass = Class.new do
-      method_object :fooable?
+      method_object
 
-      def fooable?
+      def call
         true
       end
     end
 
-    assert klass.fooable?
+    assert klass.call
   end
 end

data/spec/static_facade_spec.rb

@@ -0,0 +1,29 @@
+require_relative "spec_helper"
+
+describe Object, ".static_facade" do
+  it "creates a class method that instantiates and runs that instance method" do
+    klass = Class.new do
+      static_facade :fooable?,
+        :foo
+
+      def fooable?
+        foo
+      end
+    end
+
+    assert klass.fooable?(true)
+    refute klass.fooable?(false)
+  end
+
+  it "doesn't require attributes" do
+    klass = Class.new do
+      static_facade :fooable?
+
+      def fooable?
+        true
+      end
+    end
+
+    assert klass.fooable?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,6 +37,7 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - attr_extras.gemspec
@@ -56,6 +57,7 @@ files:
 - spec/method_object_spec.rb
 - spec/pattr_initialize_spec.rb
 - spec/spec_helper.rb
+- spec/static_facade_spec.rb
 - spec/vattr_initialize_spec.rb
 homepage: https://github.com/barsoom/attr_extras
 licenses:
@@ -92,4 +94,5 @@ test_files:
 - spec/method_object_spec.rb
 - spec/pattr_initialize_spec.rb
 - spec/spec_helper.rb
+- spec/static_facade_spec.rb
 - spec/vattr_initialize_spec.rb