attr_extras 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a2e11ff4aab1d128893a0145fb72ebc026ac4b5
-  data.tar.gz: 2bf233446caf0aefb3f7e16db7e388bc216cde34
+  metadata.gz: 9a302397db869ccd71c2f96bed2c343468d4c1fb
+  data.tar.gz: 4753ba73b9809a4f4d24943058329bb491a796ee
 SHA512:
-  metadata.gz: 2d61715715969959cf37ee1e7c6ba1a553675e14bd516cfddd76ea5c0758cb7518af05e3a437407392152e7960c5b3e389350a52c57f3b4297caa29b4c9a36c6
-  data.tar.gz: ac7e05c8f8cb05e554b59b644e5d0115f195b0bb9555e06d5918c1c0f46995c2c96224b94ccb52b203410df7696a04ec931fe2c5622f4b5a5d228ba0e558f664
+  metadata.gz: dc2e5f3b692f3881884296fea5495bfd7da4986ff992552d4bb84eafd789495b2985c3dbac6f0f4bb0d232fdcd1333ad8540bb8c6d474a633aa110d8c13b65bc
+  data.tar.gz: 641b94a27502ff6263a13f5451970a92d5202897c4a3b8b2430e812db9e5403865396f3f6d51d2cf1729fce791e8693bf12371e9a90beb5b0e8e507eafaba74a

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.2
-  - 1.9.3
+  - 2.2.1
+  - 2.0.0
+  - rbx-2.5.2
   - jruby-19mode

data/README.md

@@ -286,6 +286,29 @@ though it is shorter, more declarative, gives you a clear message and handles ed
 `attr_id_query :foo?, :bar?` defines query methods like `foo?`, which is true if (and only if) `foo_id` is truthy. Goes well with Active Record.
 
 
+## Explicit mode
+
+By default, attr\_extras will add methods to every class and module.
+
+This is not ideal if you're using attr\_extras in a library: those who depend on your library will get those methods as well.
+
+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:
+
+```
+require "attr_extras/explicit"
+
+class MyLib
+  extend AttrExtras.mixin
+
+  pattr_initialize :now_this_class_can_use_attr_extras
+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.
+
+
 ## Philosophy
 
 Findability is a core value.
@@ -333,6 +356,8 @@ Or to see warnings (try not to have any):
 
 `RUBYOPT=-w rake`
 
+The tests are intentionally split into two test suites for reasons described in `Rakefile`.
+
 
 ## Contributors
 

data/Rakefile

@@ -2,8 +2,22 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.pattern = "spec/*_spec.rb"
+# "Explicit mode" cannot be truly tested if that process has already `require`d attr_extras.
+# Thus, we need separate test suites.
+
+explicit_tests = [ "spec/attr_extras/explicit_spec.rb" ]
+
+Rake::TestTask.new(:test_implicit) do |t|
+  implicit_tests = FileList["spec/**/*_spec.rb"] - explicit_tests
+
+  t.libs << "spec"
+  t.test_files = implicit_tests
+end
+
+Rake::TestTask.new(:test_explicit) do |t|
+  t.libs << "spec"
+  t.test_files = explicit_tests
 end
 
+task :test => [ :test_implicit, :test_explicit ]
 task :default => :test

data/lib/attr_extras.rb

@@ -1,97 +1,5 @@
-require "attr_extras/version"
-require "attr_extras/attr_initialize"
-require "attr_extras/attr_value"
-require "attr_extras/attr_query"
-require "attr_extras/utils"
-
-module AttrExtras
-  # To avoid masking coding errors, we don't inherit from StandardError (which would be implicitly rescued). Forgetting to define a requisite method isn't just some runtime error.
-  class MethodNotImplementedError < Exception; end
-
-  module ModuleMethods
-    def attr_initialize(*names, &block)
-      AttrInitialize.new(self, names, block).apply
-    end
-
-    def attr_private(*names)
-      # Need this to avoid "private attribute?" warnings when running
-      # the full test suite; not sure why exactly.
-      public
-
-      attr_reader(*names)
-      private(*names)
-    end
-
-    def attr_value(*names)
-      AttrValue.new(self, *names).apply
-    end
-
-    def pattr_initialize(*names, &block)
-      attr_initialize(*names, &block)
-      attr_private(*Utils.flat_names(names))
-    end
-
-    alias_method :attr_private_initialize, :pattr_initialize
-
-    def vattr_initialize(*names, &block)
-      attr_initialize(*names, &block)
-      attr_value(*Utils.flat_names(names))
-    end
-
-    alias_method :attr_value_initialize, :vattr_initialize
-
-    def rattr_initialize(*names, &block)
-      attr_initialize(*names, &block)
-      attr_reader(*Utils.flat_names(names))
-    end
-
-    alias_method :attr_reader_initialize, :rattr_initialize
-
-    def static_facade(method_name, *names)
-      define_singleton_method(method_name) do |*values|
-        new(*values).public_send(method_name)
-      end
-
-      pattr_initialize(*names)
-    end
-
-    def method_object(*names)
-      static_facade :call, *names
-    end
-
-    def attr_query(*names)
-      AttrQuery.define_with_suffix(self, "", *names)
-    end
-
-    def attr_id_query(*names)
-      AttrQuery.define_with_suffix(self, "_id", *names)
-    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
-    end
-  end
-end
+require "attr_extras/explicit"
 
 class Module
-  include AttrExtras::ModuleMethods
+  include AttrExtras.mixin
 end

data/lib/attr_extras/explicit.rb

@@ -0,0 +1,99 @@
+require "attr_extras/version"
+require "attr_extras/attr_initialize"
+require "attr_extras/attr_value"
+require "attr_extras/attr_query"
+require "attr_extras/utils"
+
+module AttrExtras
+  # To avoid masking coding errors, we don't inherit from StandardError (which would be implicitly rescued). Forgetting to define a requisite method isn't just some runtime error.
+  class MethodNotImplementedError < Exception; end
+
+  def self.mixin
+    self::ModuleMethods
+  end
+
+  # Separate module for `include`ing so that mixing in the methods doesn't also mix in constants:
+  # http://thepugautomatic.com/2014/02/private-api/
+  module ModuleMethods
+    def attr_initialize(*names, &block)
+      AttrInitialize.new(self, names, block).apply
+    end
+
+    def attr_private(*names)
+      # Need this to avoid "private attribute?" warnings when running
+      # the full test suite; not sure why exactly.
+      public
+
+      attr_reader(*names)
+      private(*names)
+    end
+
+    def attr_value(*names)
+      AttrValue.new(self, *names).apply
+    end
+
+    def pattr_initialize(*names, &block)
+      attr_initialize(*names, &block)
+      attr_private(*Utils.flat_names(names))
+    end
+
+    alias_method :attr_private_initialize, :pattr_initialize
+
+    def vattr_initialize(*names, &block)
+      attr_initialize(*names, &block)
+      attr_value(*Utils.flat_names(names))
+    end
+
+    alias_method :attr_value_initialize, :vattr_initialize
+
+    def rattr_initialize(*names, &block)
+      attr_initialize(*names, &block)
+      attr_reader(*Utils.flat_names(names))
+    end
+
+    alias_method :attr_reader_initialize, :rattr_initialize
+
+    def static_facade(method_name, *names)
+      define_singleton_method(method_name) do |*values|
+        new(*values).public_send(method_name)
+      end
+
+      pattr_initialize(*names)
+    end
+
+    def method_object(*names)
+      static_facade :call, *names
+    end
+
+    def attr_query(*names)
+      AttrQuery.define_with_suffix(self, "", *names)
+    end
+
+    def attr_id_query(*names)
+      AttrQuery.define_with_suffix(self, "_id", *names)
+    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
+    end
+  end
+end

data/lib/attr_extras/version.rb

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

data/spec/{attr_id_query_spec.rb → attr_extras/attr_id_query_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".attr_id_query" do
   it "creates id query methods" do

data/spec/{attr_implement_spec.rb → attr_extras/attr_implement_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".attr_implement" do
   it "creates 0-argument methods that raise" do

data/spec/{attr_initialize_spec.rb → attr_extras/attr_initialize_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".attr_initialize" do
   let(:klass) do

data/spec/{attr_private_spec.rb → attr_extras/attr_private_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".attr_private" do
   let(:klass) do

data/spec/{attr_query_spec.rb → attr_extras/attr_query_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".attr_query" do
   it "creates attribute query methods" do

data/spec/{attr_value_spec.rb → attr_extras/attr_value_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 require "set"
 
 describe Object, ".attr_value" do

data/spec/attr_extras/explicit_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper_without_loading_attr_extras"
+require "attr_extras/explicit"
+
+# Sanity check.
+if String.respond_to?(:pattr_initialize)
+  raise "Expected this test suite not to have AttrExtras mixed in!"
+end
+
+describe AttrExtras, "explicit mode" do
+  it "must have methods mixed in explicitly" do
+    has_methods_before_mixin = nil
+    has_methods_after_mixin = nil
+
+    Class.new do
+      has_methods_before_mixin = respond_to?(:pattr_initialize)
+      extend AttrExtras.mixin
+      has_methods_after_mixin = respond_to?(:pattr_initialize)
+    end
+
+    refute has_methods_before_mixin
+    assert has_methods_after_mixin
+  end
+end

data/spec/{method_object_spec.rb → attr_extras/method_object_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".method_object" do
   it "creates a .call class method that instantiates and runs the #call instance method" do

data/spec/{pattr_initialize_spec.rb → attr_extras/pattr_initialize_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".pattr_initialize" do
   it "creates both initializer and private readers" do

data/spec/{rattr_initialize_spec.rb → attr_extras/rattr_initialize_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".rattr_initialize" do
   it "creates both initializer and public readers" do

data/spec/{static_facade_spec.rb → attr_extras/static_facade_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".static_facade" do
   it "creates a class method that instantiates and runs that instance method" do

data/spec/{vattr_initialize_spec.rb → attr_extras/vattr_initialize_spec.rb}

@@ -1,4 +1,4 @@
-require_relative "spec_helper"
+require "spec_helper"
 
 describe Object, ".vattr_initialize" do
   it "creates initializer, value readers and value object identity" do

data/spec/attr_extras_spec.rb

@@ -1,7 +1,7 @@
-require_relative "spec_helper"
+require "spec_helper"
 
-describe AttrExtras, "in modules" do
-  it "is supported" do
+describe AttrExtras do
+  it "mixes helpers into all Modules (and thus all Classes)" do
     mod = Module.new do
       pattr_initialize :name
     end

data/spec/spec_helper.rb

@@ -1,5 +1,2 @@
-require "minitest/autorun"
-require "minitest/pride"
-
-$: << File.dirname(__FILE__) + "/../lib"
+require "spec_helper_without_loading_attr_extras"
 require "attr_extras"

data/spec/spec_helper_without_loading_attr_extras.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/pride"
+
+$: << File.dirname(__FILE__) + "/../lib"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_extras
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -48,7 +48,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rvmrc"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -59,22 +58,25 @@ files:
 - lib/attr_extras/attr_initialize.rb
 - lib/attr_extras/attr_query.rb
 - lib/attr_extras/attr_value.rb
+- lib/attr_extras/explicit.rb
 - lib/attr_extras/utils.rb
 - lib/attr_extras/version.rb
 - script/test
+- spec/attr_extras/attr_id_query_spec.rb
+- spec/attr_extras/attr_implement_spec.rb
+- spec/attr_extras/attr_initialize_spec.rb
+- spec/attr_extras/attr_private_spec.rb
+- spec/attr_extras/attr_query_spec.rb
+- spec/attr_extras/attr_value_spec.rb
+- spec/attr_extras/explicit_spec.rb
+- spec/attr_extras/method_object_spec.rb
+- spec/attr_extras/pattr_initialize_spec.rb
+- spec/attr_extras/rattr_initialize_spec.rb
+- spec/attr_extras/static_facade_spec.rb
+- spec/attr_extras/vattr_initialize_spec.rb
 - spec/attr_extras_spec.rb
-- spec/attr_id_query_spec.rb
-- spec/attr_implement_spec.rb
-- spec/attr_initialize_spec.rb
-- spec/attr_private_spec.rb
-- spec/attr_query_spec.rb
-- spec/attr_value_spec.rb
-- spec/method_object_spec.rb
-- spec/pattr_initialize_spec.rb
-- spec/rattr_initialize_spec.rb
 - spec/spec_helper.rb
-- spec/static_facade_spec.rb
-- spec/vattr_initialize_spec.rb
+- spec/spec_helper_without_loading_attr_extras.rb
 homepage: https://github.com/barsoom/attr_extras
 licenses:
 - MIT
@@ -95,21 +97,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Takes some boilerplate out of Ruby with methods like attr_initialize.
 test_files:
+- spec/attr_extras/attr_id_query_spec.rb
+- spec/attr_extras/attr_implement_spec.rb
+- spec/attr_extras/attr_initialize_spec.rb
+- spec/attr_extras/attr_private_spec.rb
+- spec/attr_extras/attr_query_spec.rb
+- spec/attr_extras/attr_value_spec.rb
+- spec/attr_extras/explicit_spec.rb
+- spec/attr_extras/method_object_spec.rb
+- spec/attr_extras/pattr_initialize_spec.rb
+- spec/attr_extras/rattr_initialize_spec.rb
+- spec/attr_extras/static_facade_spec.rb
+- spec/attr_extras/vattr_initialize_spec.rb
 - spec/attr_extras_spec.rb
-- spec/attr_id_query_spec.rb
-- spec/attr_implement_spec.rb
-- spec/attr_initialize_spec.rb
-- spec/attr_private_spec.rb
-- spec/attr_query_spec.rb
-- spec/attr_value_spec.rb
-- spec/method_object_spec.rb
-- spec/pattr_initialize_spec.rb
-- spec/rattr_initialize_spec.rb
 - spec/spec_helper.rb
-- spec/static_facade_spec.rb
-- spec/vattr_initialize_spec.rb
+- spec/spec_helper_without_loading_attr_extras.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm ruby-1.9.3-p0-patched@attr_extras --create