attr_extras 1.4.0 → 1.5.0

data/README.md

@@ -22,6 +22,9 @@ Defines a `.fooable?` class method that delegates to an instance method.
 `attr_id_query :foo?, :bar?`<br>
 Defines query methods like `foo?`, which is true iff `foo_id` is truthy. Goes well with Active Record.
 
+`attr_query :foo?, :bar?`<br>
+Defines query methods like `foo?`, which is true iff `foo` is truthy.
+
 Findability has been a central consideration.
 Hence the long name `attr_initialize`, so you see it when scanning for the initializer;
 and the enforced questionmarks with `attr_id_query :foo?`, so you can search for that method.
@@ -34,6 +37,7 @@ class MyClass
   attr_initialize :foo, :bar
   attr_private :foo
   attr_id_query :item?
+  attr_query :oof?
 
   def oof
     foo.reverse
@@ -48,6 +52,7 @@ x = MyClass.new("Foo!", "Bar!")
 x.oof    # => "!ooF"
 x.foo    # NoMethodError: private method `foo' called.
 x.item?  # => true
+x.oof?   # => true
 
 class MyMethodObject
   method_object :fooable?,
@@ -70,6 +75,45 @@ x = MyHashyObject.new("Foo!", bar: "Bar!", baz: "Baz!")
 x.bar  # => "Bar!"
 ```
 
+## Why not use `Struct`?
+
+`Struct` has some behavior you may not expect. Say you have this:
+
+``` ruby
+class Greeter < Struct.new(:user)
+  def greet
+    puts "Hello #{user.name}!"
+  end
+end
+```
+
+The `Struct` won't actually require you to provide any arguments. You could do this and it won't complain until `nil.name` explodes on you:
+
+``` ruby
+Greeter.new.greet
+```
+
+Also, the Greeter will have a public `user` accessor even if you only need it internally, so your public interface is unnecessarily large.
+
+Further, inheriting from `Struct` arguably suggests that you have a mere data structure, not a full-blown class with rich behavior.
+
+With `attr_extras`, you have none of these issues:
+
+``` ruby
+class Greeter
+  pattr_initialize :user
+
+  def greet
+    puts "Hello #{user.name}!"
+  end
+end
+```
+
+## Why not use `private; attr_reader :foo`?
+
+Instead of `attr_private :foo`, you could do `private; attr_reader :foo`.
+
+Other than being more to type, declaring `attr_reader` after `private` will actually give you a warning (deserved or not) if you run Ruby with warnings turned on.
 
 ## Installation
 
@@ -85,7 +129,6 @@ Or install it yourself as:
 
     gem install attr_extras
 
-
 ## License
 
 Copyright (c) 2012 [Barsoom AB](http://barsoom.se)

data/lib/attr_extras.rb

@@ -39,15 +39,25 @@ module AttrExtras
       pattr_initialize *names
     end
 
+    def attr_query(*names)
+      attr_query_with_suffix(*names, "")
+    end
+
     def attr_id_query(*names)
+      attr_query_with_suffix(*names, "_id")
+    end
+
+    private
+
+    def attr_query_with_suffix(*names, suffix)
       names.each do |name|
         name = name.to_s
 
         raise "#{__method__} wants `#{name}?`, not `#{name}`." unless name.end_with?("?")
 
-        define_method(name) do       # def foo?
-          !!send("#{name.chop}_id")  #   !!send("foo_id")
-        end                          # end
+        define_method(name) do             # def foo?
+          !!send("#{name.chop}#{suffix}")  #   !!send("foo_id")
+        end                                # end
       end
     end
   end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/spec/attr_extras_spec.rb

@@ -13,7 +13,8 @@ end
 
 class QueryExample
   attr_id_query :baz?, :boink?
-  attr_accessor :baz_id
+  attr_query :flurp?
+  attr_accessor :baz_id, :flurp
 end
 
 class MethodObjectExample
@@ -88,3 +89,16 @@ describe Object, ".attr_id_query" do
     lambda { Object.attr_id_query(:foo) }.must_raise RuntimeError
   end
 end
+
+describe Object, ".attr_query" do
+  it "creates attribute query methods" do
+    example = QueryExample.new
+    refute example.flurp?
+    example.flurp = "!"
+    assert example.flurp?
+  end
+
+  it "requires a trailing questionmark" do
+    lambda { Object.attr_query(:foo) }.must_raise RuntimeError
+  end
+end

metadata

@@ -1,60 +1,34 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: attr_extras
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 1.5.0
   prerelease: 
-  segments: 
-  - 1
-  - 4
-  - 0
-  version: 1.4.0
 platform: ruby
-authors: 
+authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70260295305400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
+  version_requirements: *70260295305400
 description: 
-email: 
+email:
 - henrik@nyh.se
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - .travis.yml
@@ -67,36 +41,33 @@ files:
 - spec/attr_extras_spec.rb
 homepage: https://github.com/barsoom/attr_extras
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1437049872274333765
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1437049872274333765
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Takes some boilerplate out of Ruby with methods like attr_initialize.
-test_files: 
+test_files:
 - spec/attr_extras_spec.rb