acts_as_tenant 0.4.0 → 0.5.0

data/spec/controllers/filter_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+class ApplicationController2 < ActionController::Base
+  include Rails.application.routes.url_helpers
+  set_current_tenant_through_filter
+  before_action :your_method_that_finds_the_current_tenant
+
+  def your_method_that_finds_the_current_tenant
+    current_account = Account.new(name: "account1")
+    set_current_tenant(current_account)
+  end
+end
+
+# Start testing
+describe ApplicationController2, type: :controller do
+  controller do
+    def index
+      # Exercise current_tenant helper method
+      render plain: current_tenant.name
+    end
+  end
+
+  it "Finds the correct tenant using the filter command" do
+    get :index
+    expect(ActsAsTenant.current_tenant.name).to eq "account1"
+    expect(response.body).to eq "account1"
+  end
+end

data/spec/controllers/subdomain_or_domain_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+class DomainController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  set_current_tenant_by_subdomain_or_domain
+end
+
+describe DomainController, type: :controller do
+  let(:account) { accounts(:with_domain) }
+
+  controller do
+    def index
+      # Exercise current_tenant helper method
+      render plain: current_tenant.name
+    end
+  end
+
+  it "finds the correct tenant with a example1.com" do
+    @request.host = account.domain
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+    expect(response.body).to eq account.name
+  end
+
+  it "finds the correct tenant with a subdomain.example.com" do
+    @request.host = "#{account.subdomain}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+    expect(response.body).to eq account.name
+  end
+
+  it "finds the correct tenant with a www.subdomain.example.com" do
+    @request.host = "www.#{account.subdomain}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+  end
+
+  it "ignores case when finding tenant by subdomain" do
+    @request.host = "#{account.subdomain.upcase}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+  end
+
+  context "overriding subdomain lookup" do
+    after { controller.subdomain_lookup = :last }
+
+    it "allows overriding the subdomain lookup" do
+      controller.subdomain_lookup = :first
+      @request.host = "#{account.subdomain}.another.example.com"
+      get :index
+      expect(ActsAsTenant.current_tenant).to eq account
+      expect(response.body).to eq(account.subdomain)
+    end
+  end
+end

data/spec/controllers/subdomain_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+class SubdomainController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  set_current_tenant_by_subdomain
+end
+
+describe SubdomainController, type: :controller do
+  let(:account) { accounts(:with_domain) }
+
+  controller(SubdomainController) do
+    def index
+      # Exercise current_tenant helper method
+      render plain: current_tenant.name
+    end
+  end
+
+  it "finds the correct tenant with a subdomain.example.com" do
+    @request.host = "#{account.subdomain}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+    expect(response.body).to eq(account.subdomain)
+  end
+
+  it "finds the correct tenant with a www.subdomain.example.com" do
+    @request.host = "www.#{account.subdomain}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+    expect(response.body).to eq(account.subdomain)
+  end
+
+  it "ignores case when finding tenant by subdomain" do
+    @request.host = "#{account.subdomain.upcase}.example.com"
+    get :index
+    expect(ActsAsTenant.current_tenant).to eq account
+  end
+
+  context "overriding subdomain lookup" do
+    after { controller.subdomain_lookup = :last }
+
+    it "allows overriding the subdomain lookup" do
+      controller.subdomain_lookup = :first
+      @request.host = "#{account.subdomain}.another.example.com"
+      get :index
+      expect(ActsAsTenant.current_tenant).to eq account
+      expect(response.body).to eq(account.subdomain)
+    end
+  end
+end

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.1

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com", to: "to@example.com"
+  layout "mailer"
+end

data/spec/dummy/app/mailers/user_mailer.rb

@@ -0,0 +1,5 @@
+class UserMailer < ApplicationMailer
+  def comment_notification
+    mail(body: "")
+  end
+end

data/spec/dummy/app/models/account.rb

@@ -0,0 +1,4 @@
+class Account < ActiveRecord::Base
+  has_many :projects
+  has_many :global_projects
+end

data/spec/dummy/app/models/aliased_task.rb

@@ -0,0 +1,4 @@
+class AliasedTask < ActiveRecord::Base
+  acts_as_tenant(:account)
+  belongs_to :project_alias, class_name: "Project"
+end

data/spec/dummy/app/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  has_many :polymorphic_tenant_comments, as: :polymorphic_tenant_commentable
+end

data/spec/dummy/app/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  belongs_to :commentable, polymorphic: true
+  belongs_to :task, -> { where(comments: {commentable_type: "Task"}) }, foreign_key: "commentable_id"
+  acts_as_tenant :account
+end

data/spec/dummy/app/models/custom_counter_cache_task.rb

@@ -0,0 +1,4 @@
+class CustomCounterCacheTask < ActiveRecord::Base
+  self.table_name = "projects"
+  acts_as_tenant(:account, counter_cache: "projects_count")
+end

data/spec/dummy/app/models/custom_foreign_key_task.rb

@@ -0,0 +1,4 @@
+class CustomForeignKeyTask < ActiveRecord::Base
+  acts_as_tenant(:account, foreign_key: "accountID")
+  validates_uniqueness_to_tenant :name
+end

data/spec/dummy/app/models/custom_primary_key_task.rb

@@ -0,0 +1,4 @@
+class CustomPrimaryKeyTask < ActiveRecord::Base
+  acts_as_tenant(:account, foreign_key: "name", primary_key: "name")
+  validates_presence_of :name
+end

data/spec/dummy/app/models/global_project.rb

@@ -0,0 +1,6 @@
+class GlobalProject < ActiveRecord::Base
+  self.table_name = "projects"
+
+  acts_as_tenant :account, has_global_records: true
+  validates_uniqueness_to_tenant :name
+end

data/spec/dummy/app/models/manager.rb

@@ -0,0 +1,4 @@
+class Manager < ActiveRecord::Base
+  belongs_to :project
+  acts_as_tenant :account
+end

data/spec/dummy/app/models/polymorphic_tenant_comment.rb

@@ -0,0 +1,5 @@
+class PolymorphicTenantComment < ActiveRecord::Base
+  belongs_to :polymorphic_tenant_commentable, polymorphic: true
+  belongs_to :account
+  acts_as_tenant :polymorphic_tenant_commentable, polymorphic: true
+end

data/spec/dummy/app/models/project.rb

@@ -0,0 +1,8 @@
+class Project < ActiveRecord::Base
+  has_one :manager
+  has_many :tasks
+  has_many :polymorphic_tenant_comments, as: :polymorphic_tenant_commentable
+  acts_as_tenant :account
+
+  validates_uniqueness_to_tenant :name
+end

data/spec/dummy/app/models/task.rb

@@ -0,0 +1,7 @@
+class Task < ActiveRecord::Base
+  belongs_to :project
+  default_scope -> { where(completed: nil).order("name") }
+
+  acts_as_tenant :account
+  validates_uniqueness_of :name
+end

data/spec/dummy/app/models/unique_task.rb

@@ -0,0 +1,5 @@
+class UniqueTask < ActiveRecord::Base
+  acts_as_tenant(:account)
+  belongs_to :project
+  validates_uniqueness_to_tenant :name, scope: :user_defined_scope
+end

data/spec/dummy/app/models/unscoped_model.rb

@@ -0,0 +1,3 @@
+class UnscopedModel < ActiveRecord::Base
+  validates_uniqueness_of :name
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,19 @@
+require_relative "boot"
+
+require "rails/all"
+
+Bundler.require(*Rails.groups)
+require "acts_as_tenant"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+
+    if Rails.gem_version < Gem::Version.new("6.0") && config.active_record.sqlite3
+      config.active_record.sqlite3.represent_boolean_as_integer = true
+    end
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../../Gemfile", __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path("../../../lib", __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production