attr_extras 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a302397db869ccd71c2f96bed2c343468d4c1fb
-  data.tar.gz: 4753ba73b9809a4f4d24943058329bb491a796ee
+  metadata.gz: 3a8bcd34f935912a3cf97f5a31b39330e357aa61
+  data.tar.gz: f99cb0a632963344367f906285cc572b913932a1
 SHA512:
-  metadata.gz: dc2e5f3b692f3881884296fea5495bfd7da4986ff992552d4bb84eafd789495b2985c3dbac6f0f4bb0d232fdcd1333ad8540bb8c6d474a633aa110d8c13b65bc
-  data.tar.gz: 641b94a27502ff6263a13f5451970a92d5202897c4a3b8b2430e812db9e5403865396f3f6d51d2cf1729fce791e8693bf12371e9a90beb5b0e8e507eafaba74a
+  metadata.gz: 796bdd29576ca722747c2b2508571f6ab60197741e1dbf91532f4f6cdcbcfcc478e81d3ffb41e72345a22d5319eb9e066879144b6eaf7624bd0dd6765223d5aa
+  data.tar.gz: 5b0a456b2657f7a33823b98b864821ab8845296e63d459d661cce67d7d2b2a296208cb7097e34209bd4063510c79dc9f3906fbe8cd7ad7bce6265e1de7faca11

data/.travis.yml

@@ -2,5 +2,4 @@ language: ruby
 rvm:
   - 2.2.1
   - 2.0.0
-  - rbx-2.5.2
   - jruby-19mode

data/README.md

@@ -42,6 +42,7 @@ Also provides conveniences for creating value objects, method objects, query met
 * [`pattr_initialize`](#pattr_initialize) / [`attr_private_initialize`](#attr_private_initialize)
 * [`vattr_initialize`](#vattr_initialize) / [`attr_value_initialize`](#attr_value_initialize)
 * [`rattr_initialize`](#rattr_initialize) / [`attr_reader_initialize`](#attr_reader_initialize)
+* [`aattr_initialize`](#aattr_initialize) / [`attr_accessor_initialize`](#attr_accessor_initialize)
 * [`static_facade`](#static_facade)
 * [`method_object`](#method_object)
 * [`attr_implement`](#attr_implement)
@@ -57,7 +58,7 @@ Also provides conveniences for creating value objects, method objects, query met
 
 `attr_initialize [:bar, :baz!]` defines an initializer that takes one hash argument, assigning `@bar` (optional) and `@baz` (required).
 
-`attr_initialize` can also accept a block which will be invoked after initialization. This is useful for calling `super` appropriately in subclasses or initializing private data as necessary.
+`attr_initialize` can also accept a block which will be invoked after initialization. This is useful for e.g. initializing private data as necessary.
 
 
 ### `attr_private`
@@ -88,7 +89,7 @@ Example:
 
 ``` ruby
 class Item
-  pattr_initalize :name, :price
+  pattr_initialize :name, :price
 
   def price_with_vat
     price * 1.25
@@ -142,19 +143,47 @@ Example:
 
 ``` ruby
 class PublishBook
-  rattr_initalize :book_name, :publisher_backend
+  rattr_initialize :book_name, :publisher_backend
 
   def call
     publisher_backend.publish book_name
   end
 end
 
-service = PublishBook.new("A Novel")
+service = PublishBook.new("A Novel", publisher)
 service.book_name  # => "A Novel"
 ```
 
 [The `attr_initialize` notation](#attr_initialize) for hash arguments is also supported: `rattr_initialize :foo, [:bar, :baz!]`
 
+### `aattr_initialize`
+### `attr_accessor_initialize`
+
+`aattr_initialize :foo, :bar` defines an initializer, public readers, and public writers. It's a shortcut for:
+
+``` ruby
+attr_initialize :foo, :bar
+attr_accessor :foo, :bar
+```
+
+`aattr_initialize` is aliased as `attr_accessor_initialize`, if you prefer a longer but clearer name.
+
+Example:
+
+``` ruby
+class Client
+  aattr_initialize :username, :access_token
+end
+
+client = Client.new("barsoom", "SECRET")
+client.username # => "barsoom"
+
+client.access_token = "NEW_SECRET"
+client.access_token # => "NEW_SECRET"
+```
+
+[The `attr_initialize` notation](#attr_initialize) for hash arguments and blocks is also supported.
+
 ### `static_facade`
 
 `static_facade :allow?, :user` defines an `.allow?` class method that delegates to an instance method by the same name, having first provided `user` as a private reader.
@@ -275,6 +304,23 @@ end
 
 though it is shorter, more declarative, gives you a clear message and handles edge cases you might not have thought about (see tests).
 
+Note that you can also use this with modules, to effectively mix in interfaces:
+
+``` ruby
+module Bookable
+  attr_implement :book, [:bookable]
+  attr_implement :booked?
+end
+
+class Invoice
+  include Bookable
+end
+
+class Payment
+  include Bookable
+end
+```
+
 
 ### `attr_query`
 
@@ -294,7 +340,7 @@ This is not ideal if you're using attr\_extras in a library: those who depend on
 
 It's also not obvious where the methods come from. You can be more explicit about it, and restrict where the methods are added, like this:
 
-```
+``` ruby
 require "attr_extras/explicit"
 
 class MyLib
@@ -306,7 +352,7 @@ end
 
 Crucially, you need to `require "attr_extras/explicit"` *instead of* `require "attr_extras"`. Some frameworks, like Ruby on Rails, may automatically require everything in your `Gemfile`. You can avoid that with `gem "attr_extras", require: "attr_extras/explicit"`.
 
-In explicit mode, you need to call `extend AttrExtras.mixin` *in every class* that wants the attr\_extras methods.
+In explicit mode, you need to call `extend AttrExtras.mixin` *in every class or module* that wants the attr\_extras methods.
 
 
 ## Philosophy
@@ -330,6 +376,10 @@ Other than being more to type, declaring `attr_reader` after `private` will actu
 
 If you don't want the dependency on `attr_extras`, you can get rid of the warnings with `attr_reader :foo; private :foo`. Or just define a regular private method.
 
+### Can I use attr\_extras in `BasicObject`s?
+
+No, sorry. It depends on various methods that `BasicObject`s don't have. Use a regular `Object` or make do without attr\_extras.
+
 
 ## Installation
 
@@ -350,11 +400,15 @@ Or install it yourself as:
 
 Run them with:
 
-`rake`
+    rake
 
 Or to see warnings (try not to have any):
 
-`RUBYOPT=-w rake`
+    RUBYOPT=-w rake
+
+You can run an individual test using the [m](https://github.com/qrush/m) gem:
+
+    m spec/attr_extras/attr_initialize_spec.rb:48
 
 The tests are intentionally split into two test suites for reasons described in `Rakefile`.
 

data/attr_extras.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = AttrExtras::VERSION
 
   gem.add_development_dependency "minitest", ">= 5"
+  gem.add_development_dependency "m", "~> 1.3.1"  # Running individual tests.
 
   # For Travis CI.
   gem.add_development_dependency "rake"

data/lib/attr_extras/attr_implement.rb

@@ -0,0 +1,32 @@
+class AttrExtras::AttrImplement
+  def initialize(klass, names)
+    @klass, @names = klass, names.dup
+  end
+
+  def apply
+    arg_names = @names.last.is_a?(Array) ? @names.pop : []
+    expected_arity = arg_names.length
+
+    # Make available within the block.
+    names = @names
+
+    mod = Module.new do
+      define_method :method_missing do |name, *args|
+        if names.include?(name)
+          provided_arity = args.length
+
+          if provided_arity != expected_arity
+            raise ArgumentError, "wrong number of arguments (#{provided_arity} for #{expected_arity})"
+          end
+
+          raise AttrExtras::MethodNotImplementedError, "Implement a '#{name}(#{arg_names.join(", ")})' method"
+        else
+          super(name, *args)
+        end
+      end
+    end
+
+    # include is private in Ruby 2.0 and earlier.
+    @klass.send(:include, mod)
+  end
+end

data/lib/attr_extras/explicit.rb

@@ -2,6 +2,7 @@ require "attr_extras/version"
 require "attr_extras/attr_initialize"
 require "attr_extras/attr_value"
 require "attr_extras/attr_query"
+require "attr_extras/attr_implement"
 require "attr_extras/utils"
 
 module AttrExtras
@@ -9,12 +10,12 @@ module AttrExtras
   class MethodNotImplementedError < Exception; end
 
   def self.mixin
-    self::ModuleMethods
+    self::Mixin
   end
 
-  # Separate module for `include`ing so that mixing in the methods doesn't also mix in constants:
+  # Separate module so that mixing in the methods doesn't also mix in constants:
   # http://thepugautomatic.com/2014/02/private-api/
-  module ModuleMethods
+  module Mixin
     def attr_initialize(*names, &block)
       AttrInitialize.new(self, names, block).apply
     end
@@ -53,6 +54,13 @@ module AttrExtras
 
     alias_method :attr_reader_initialize, :rattr_initialize
 
+    def aattr_initialize(*names, &block)
+      attr_initialize(*names, &block)
+      attr_accessor(*Utils.flat_names(names))
+    end
+
+    alias_method :attr_accessor_initialize, :aattr_initialize
+
     def static_facade(method_name, *names)
       define_singleton_method(method_name) do |*values|
         new(*values).public_send(method_name)
@@ -74,26 +82,7 @@ module AttrExtras
     end
 
     def attr_implement(*names)
-      arg_names = names.last.is_a?(Array) ? names.pop : []
-      arity = arg_names.length
-
-      mod = Module.new do
-        define_method :method_missing do |name, *args|
-          if names.include?(name)
-            provided_arity = args.length
-
-            if provided_arity != arity
-              raise ArgumentError, "wrong number of arguments (#{provided_arity} for #{arity})"
-            end
-
-            raise MethodNotImplementedError, "Implement a '#{name}(#{arg_names.join(", ")})' method"
-          else
-            super(name, *args)
-          end
-        end
-      end
-
-      include mod
+      AttrImplement.new(self, names).apply
     end
   end
 end

data/lib/attr_extras/version.rb

@@ -1,3 +1,3 @@
 module AttrExtras
-  VERSION = "4.4.0"
+  VERSION = "4.5.0"
 end

data/script/test

@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-# Script used to have one way to run single tests in any project,
-# in this case we need to work around test unit a bit.
+# This script is per the Auctionet.com developer conventions for running tests in the same way in any project.
 
-# Test unit does not support line numbers :(
-file = ARGV.first.split(":").first
-system("bundle exec ruby #{file}") || exit(1)
+system("bundle exec m #{ARGV.first}") || exit(1)

data/spec/attr_extras/aattr_initialize_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Object, ".aattr_initialize" do
+  it "creates an initializer and public readers" do
+    klass = Class.new do
+      aattr_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+
+    example.foo.must_equal "Foo"
+  end
+
+  it "creates public writers" do
+    klass = Class.new do
+      aattr_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+    example.foo = "Baz"
+
+    example.foo.must_equal "Baz"
+  end
+
+  it "works with hash ivars" do
+    klass = Class.new do
+      aattr_initialize :foo, [:bar, :baz!]
+    end
+
+    example = klass.new("Foo", :bar => "Bar", :baz => "Baz")
+
+    example.baz.must_equal "Baz"
+  end
+
+  it "accepts a block for initialization" do
+    klass = Class.new do
+      aattr_initialize :value do
+        @copy = @value
+      end
+
+      attr_reader :copy
+    end
+
+    example = klass.new("expected")
+
+    example.copy.must_equal "expected"
+  end
+
+  it "accepts the alias attr_accessor_initialize" do
+    klass = Class.new do
+      attr_accessor_initialize :foo, :bar
+    end
+
+    example = klass.new("Foo", "Bar")
+
+    example.foo.must_equal "Foo"
+  end
+end

data/spec/attr_extras/pattr_initialize_spec.rb

@@ -33,7 +33,7 @@ describe Object, ".pattr_initialize" do
     example.copy.must_equal "expected"
   end
 
-  it "accepts the alias attr_private_initializer" do
+  it "accepts the alias attr_private_initialize" do
     klass = Class.new do
       attr_private_initialize :foo, :bar
     end

data/spec/attr_extras/rattr_initialize_spec.rb

@@ -19,7 +19,7 @@ describe Object, ".rattr_initialize" do
     example.public_send(:baz).must_equal "Baz"
   end
 
-  it "accepts the alias attr_reader_initializer" do
+  it "accepts the alias attr_reader_initialize" do
     klass = Class.new do
       attr_reader_initialize :foo, :bar
     end

data/spec/attr_extras/vattr_initialize_spec.rb

@@ -37,7 +37,7 @@ describe Object, ".vattr_initialize" do
     called.must_equal true
   end
 
-  it "accepts the alias attr_value_initializer" do
+  it "accepts the alias attr_value_initialize" do
     klass = Class.new do
       attr_value_initialize :foo, :bar
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +69,7 @@ files:
 - Rakefile
 - attr_extras.gemspec
 - lib/attr_extras.rb
+- lib/attr_extras/attr_implement.rb
 - lib/attr_extras/attr_initialize.rb
 - lib/attr_extras/attr_query.rb
 - lib/attr_extras/attr_value.rb
@@ -62,6 +77,7 @@ files:
 - lib/attr_extras/utils.rb
 - lib/attr_extras/version.rb
 - script/test
+- spec/attr_extras/aattr_initialize_spec.rb
 - spec/attr_extras/attr_id_query_spec.rb
 - spec/attr_extras/attr_implement_spec.rb
 - spec/attr_extras/attr_initialize_spec.rb
@@ -102,6 +118,7 @@ signing_key:
 specification_version: 4
 summary: Takes some boilerplate out of Ruby with methods like attr_initialize.
 test_files:
+- spec/attr_extras/aattr_initialize_spec.rb
 - spec/attr_extras/attr_id_query_spec.rb
 - spec/attr_extras/attr_implement_spec.rb
 - spec/attr_extras/attr_initialize_spec.rb