Merge pull request #1264 from cerebris/default_exclude_links

Support global exclude links configuration

Author: lgebhardt

lib/jsonapi/basic_resource.rb

@@ -963,21 +963,25 @@ def mutable?
         !@immutable
       end
 
-      def exclude_links(exclude)
+      def parse_exclude_links(exclude)
         case exclude
           when :default, "default"
-            @_exclude_links = [:self]
+            [:self]
           when :none, "none"
-            @_exclude_links = []
+            []
           when Array
-            @_exclude_links = exclude.collect {|link| link.to_sym}
+            exclude.collect {|link| link.to_sym}
           else
             fail "Invalid exclude_links"
         end
       end
 
+      def exclude_links(exclude)
+        @_exclude_links = parse_exclude_links(exclude)
+      end
+
       def _exclude_links
-        @_exclude_links ||= []
+        @_exclude_links ||= parse_exclude_links(JSONAPI.configuration.default_exclude_links)
       end
 
       def exclude_link?(link)

lib/jsonapi/configuration.rb

@@ -37,7 +37,8 @@ class Configuration
                 :default_caching,
                 :default_resource_cache_field,
                 :resource_cache_digest_function,
-                :resource_cache_usage_report_function
+                :resource_cache_usage_report_function,
+                :default_exclude_links
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -149,6 +150,12 @@ def initialize
       # Optionally provide a callable which JSONAPI will call with information about cache
       # performance. Should accept three arguments: resource name, hits count, misses count.
       self.resource_cache_usage_report_function = nil
+
+      # Global configuration for links exclusion
+      # Controls whether to generate links like `self`, `related` with all the resources
+      # and relationships. Accepts either `:default`, `:none`, or array containing the
+      # specific default links to exclude, which may be `:self` and `:related`.
+      self.default_exclude_links = :none
     end
 
     def cache_formatters=(bool)
@@ -276,6 +283,8 @@ def allow_include=(allow_include)
     attr_writer :resource_cache_digest_function
 
     attr_writer :resource_cache_usage_report_function
+
+    attr_writer :default_exclude_links
   end
 
   class << self

lib/jsonapi/relationship.rb

@@ -32,7 +32,7 @@ def initialize(name, options = {})
       @_routed = false
       @_warned_missing_route = false
 
-      exclude_links(options.fetch(:exclude_links, :none))
+      exclude_links(options.fetch(:exclude_links, JSONAPI.configuration.default_exclude_links))
 
       # Custom methods are reserved for future use
       @custom_methods = options.fetch(:custom_methods, {})

test/unit/resource/relationship_test.rb

@@ -159,4 +159,88 @@ def test_exclude_links_on_relationship
       JSONAPI::Relationship::ToOne.new "foo", :self
     end
   end
+
+  def test_global_exclude_links_configuration_on_relationship
+    JSONAPI.configuration.default_exclude_links = :none
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = :default
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [:self, :related], relationship._exclude_links
+    assert relationship.exclude_link?(:self)
+    assert relationship.exclude_link?("self")
+    assert relationship.exclude_link?(:related)
+    assert relationship.exclude_link?("related")
+
+    JSONAPI.configuration.default_exclude_links = "none"
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = "default"
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [:self, :related], relationship._exclude_links
+    assert relationship.exclude_link?(:self)
+    assert relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = :none
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = [:self]
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [:self], relationship._exclude_links
+    assert relationship.exclude_link?(:self)
+    assert relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = :none
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = ["self", :related]
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [:self, :related], relationship._exclude_links
+    assert relationship.exclude_link?(:self)
+    assert relationship.exclude_link?("self")
+
+    JSONAPI.configuration.default_exclude_links = []
+    relationship = JSONAPI::Relationship::ToOne.new "foo"
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+
+    assert_raises do
+      JSONAPI.configuration.default_exclude_links = :self
+      JSONAPI::Relationship::ToOne.new "foo"
+    end
+
+    # Test if the relationships will override the the global configuration
+    JSONAPI.configuration.default_exclude_links = :default
+    relationship = JSONAPI::Relationship::ToOne.new "foo", exclude_links: :none
+    assert_equal [], relationship._exclude_links
+    refute relationship.exclude_link?(:self)
+    refute relationship.exclude_link?("self")
+    refute relationship.exclude_link?(:related)
+    refute relationship.exclude_link?("related")
+
+    JSONAPI.configuration.default_exclude_links = :default
+    relationship = JSONAPI::Relationship::ToOne.new "foo", exclude_links: [:self]
+    assert_equal [:self], relationship._exclude_links
+    refute relationship.exclude_link?(:related)
+    refute relationship.exclude_link?("related")
+    assert relationship.exclude_link?(:self)
+    assert relationship.exclude_link?("self")
+  ensure
+    JSONAPI.configuration.default_exclude_links = :none
+  end
+
+
 end