Change cache_key generation for TenantCommon (#188)

* change cache_key generation for TenantCommon

* refactor: simplify cache_key method in TenantCommon

* Tweak the CHANGELOG entry.

---------

Co-authored-by: Mike Dalessio <mike@37signals.com>

Author: miguelmarcondesf

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## next / unreleased
 
+### Changed
+
+- The return value from an Active Record model `#cache_key` has changed from `users/1?tenant=foo` to `foo/users/1`. For existing applications, this will invalidate any relevant cache entries. #187 @miguelmarcondesf
+
+
 ### Improved
 
 - For tenanted model instances, `#inspect` now outputs the tenant attribute first, before the column attributes. #191 @lairtonmendes

lib/active_record/tenanted/tenant.rb

@@ -13,7 +13,7 @@ module TenantCommon # :nodoc:
       end
 
       def cache_key
-        tenant ? "#{super}?tenant=#{tenant}" : super
+        tenant ? "#{tenant}/#{super}" : super
       end
 
       def inspect

test/unit/tenant_test.rb

@@ -1166,10 +1166,17 @@
             User.create!(email: "user1@example.org")
           end
 
-          assert_equal("users/1?tenant=foo", user.cache_key)
+          assert_equal("foo/users/1", user.cache_key)
 
           TenantedApplicationRecord.with_tenant("foo") do
-            assert_equal("users/1?tenant=foo", User.find(user.id).cache_key)
+            assert_equal("foo/users/1", User.find(user.id).cache_key)
+          end
+        end
+
+        test "handles special characters in tenant names" do
+          TenantedApplicationRecord.create_tenant("foo-bar_123") do
+            user = User.create!(email: "user1@example.org")
+            assert_equal("foo-bar_123/users/1", user.cache_key)
           end
         end
       end