puzzle-apartment 2.12.0

data/lib/generators/apartment/install/templates/apartment.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+# You can have Apartment route to the appropriate Tenant by adding some Rack middleware.
+# Apartment can support many different "Elevators" that can take care of this routing to your data.
+# Require whichever Elevator you're using below or none if you have a custom one.
+#
+# require 'apartment/elevators/generic'
+# require 'apartment/elevators/domain'
+require 'apartment/elevators/subdomain'
+# require 'apartment/elevators/first_subdomain'
+# require 'apartment/elevators/host'
+
+#
+# Apartment Configuration
+#
+Apartment.configure do |config|
+  # Add any models that you do not want to be multi-tenanted, but remain in the global (public) namespace.
+  # A typical example would be a Customer or Tenant model that stores each Tenant's information.
+  #
+  # config.excluded_models = %w{ Tenant }
+
+  # In order to migrate all of your Tenants you need to provide a list of Tenant names to Apartment.
+  # You can make this dynamic by providing a Proc object to be called on migrations.
+  # This object should yield either:
+  # - an array of strings representing each Tenant name.
+  # - a hash which keys are tenant names, and values custom db config
+  # (must contain all key/values required in database.yml)
+  #
+  # config.tenant_names = lambda{ Customer.pluck(:tenant_name) }
+  # config.tenant_names = ['tenant1', 'tenant2']
+  # config.tenant_names = {
+  #   'tenant1' => {
+  #     adapter: 'postgresql',
+  #     host: 'some_server',
+  #     port: 5555,
+  #     database: 'postgres' # this is not the name of the tenant's db
+  #                          # but the name of the database to connect to before creating the tenant's db
+  #                          # mandatory in postgresql
+  #   },
+  #   'tenant2' => {
+  #     adapter:  'postgresql',
+  #     database: 'postgres' # this is not the name of the tenant's db
+  #                          # but the name of the database to connect to before creating the tenant's db
+  #                          # mandatory in postgresql
+  #   }
+  # }
+  # config.tenant_names = lambda do
+  #   Tenant.all.each_with_object({}) do |tenant, hash|
+  #     hash[tenant.name] = tenant.db_configuration
+  #   end
+  # end
+  #
+  config.tenant_names = -> { ToDo_Tenant_Or_User_Model.pluck :database }
+
+  # PostgreSQL:
+  #   Specifies whether to use PostgreSQL schemas or create a new database per Tenant.
+  #
+  # MySQL:
+  #   Specifies whether to switch databases by using `use` statement or re-establish connection.
+  #
+  # The default behaviour is true.
+  #
+  # config.use_schemas = true
+
+  #
+  # ==> PostgreSQL only options
+
+  # Apartment can be forced to use raw SQL dumps instead of schema.rb for creating new schemas.
+  # Use this when you are using some extra features in PostgreSQL that can't be represented in
+  # schema.rb, like materialized views etc. (only applies with use_schemas set to true).
+  # (Note: this option doesn't use db/structure.sql, it creates SQL dump by executing pg_dump)
+  #
+  # config.use_sql = false
+
+  # There are cases where you might want some schemas to always be in your search_path
+  # e.g when using a PostgreSQL extension like hstore.
+  # Any schemas added here will be available along with your selected Tenant.
+  #
+  # config.persistent_schemas = %w{ hstore }
+
+  # <== PostgreSQL only options
+  #
+
+  # By default, and only when not using PostgreSQL schemas, Apartment will prepend the environment
+  # to the tenant name to ensure there is no conflict between your environments.
+  # This is mainly for the benefit of your development and test environments.
+  # Uncomment the line below if you want to disable this behaviour in production.
+  #
+  # config.prepend_environment = !Rails.env.production?
+
+  # When using PostgreSQL schemas, the database dump will be namespaced, and
+  # apartment will substitute the default namespace (usually public) with the
+  # name of the new tenant when creating a new tenant. Some items must maintain
+  # a reference to the default namespace (ie public) - for instance, a default
+  # uuid generation. Uncomment the line below to create a list of namespaced
+  # items in the schema dump that should *not* have their namespace replaced by
+  # the new tenant
+  #
+  # config.pg_excluded_names = ["uuid_generate_v4"]
+
+  # Specifies whether the database and schema (when using PostgreSQL schemas) will prepend in ActiveRecord log.
+  # Uncomment the line below if you want to enable this behavior.
+  #
+  # config.active_record_log = true
+end
+
+# Setup a custom Tenant switching middleware. The Proc should return the name of the Tenant that
+# you want to switch to.
+# Rails.application.config.middleware.use Apartment::Elevators::Generic, lambda { |request|
+#   request.host.split('.').first
+# }
+
+# Rails.application.config.middleware.use Apartment::Elevators::Domain
+Rails.application.config.middleware.use Apartment::Elevators::Subdomain
+# Rails.application.config.middleware.use Apartment::Elevators::FirstSubdomain
+# Rails.application.config.middleware.use Apartment::Elevators::Host

data/lib/tasks/apartment.rake

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'apartment/migrator'
+require 'apartment/tasks/task_helper'
+require 'parallel'
+
+apartment_namespace = namespace :apartment do
+  desc 'Create all tenants'
+  task :create do
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    Apartment::TaskHelper.tenants.each do |tenant|
+      Apartment::TaskHelper.create_tenant(tenant)
+    end
+  end
+
+  desc 'Drop all tenants'
+  task :drop do
+    Apartment::TaskHelper.tenants.each do |tenant|
+      puts("Dropping #{tenant} tenant")
+      Apartment::Tenant.drop(tenant)
+    rescue Apartment::TenantNotFound, ActiveRecord::NoDatabaseError => e
+      puts e.message
+    end
+  end
+
+  desc 'Migrate all tenants'
+  task :migrate do
+    Apartment::TaskHelper.warn_if_tenants_empty
+    Apartment::TaskHelper.each_tenant do |tenant|
+      Apartment::TaskHelper.migrate_tenant(tenant)
+    end
+  end
+
+  desc 'Seed all tenants'
+  task :seed do
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    Apartment::TaskHelper.each_tenant do |tenant|
+      Apartment::TaskHelper.create_tenant(tenant)
+      puts("Seeding #{tenant} tenant")
+      Apartment::Tenant.switch(tenant) do
+        Apartment::Tenant.seed
+      end
+    rescue Apartment::TenantNotFound => e
+      puts e.message
+    end
+  end
+
+  desc 'Rolls the migration back to the previous version (specify steps w/ STEP=n) across all tenants.'
+  task :rollback do
+    Apartment::TaskHelper.warn_if_tenants_empty
+
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+    Apartment::TaskHelper.each_tenant do |tenant|
+      puts("Rolling back #{tenant} tenant")
+      Apartment::Migrator.rollback tenant, step
+    rescue Apartment::TenantNotFound => e
+      puts e.message
+    end
+  end
+
+  namespace :migrate do
+    desc 'Runs the "up" for a given migration VERSION across all tenants.'
+    task :up do
+      Apartment::TaskHelper.warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      Apartment::TaskHelper.each_tenant do |tenant|
+        puts("Migrating #{tenant} tenant up")
+        Apartment::Migrator.run :up, tenant, version
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+
+    desc 'Runs the "down" for a given migration VERSION across all tenants.'
+    task :down do
+      Apartment::TaskHelper.warn_if_tenants_empty
+
+      version = ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+      raise 'VERSION is required' unless version
+
+      Apartment::TaskHelper.each_tenant do |tenant|
+        puts("Migrating #{tenant} tenant down")
+        Apartment::Migrator.run :down, tenant, version
+      rescue Apartment::TenantNotFound => e
+        puts e.message
+      end
+    end
+
+    desc 'Rolls back the tenant one migration and re migrate up (options: STEP=x, VERSION=x).'
+    task :redo do
+      if ENV['VERSION']
+        apartment_namespace['migrate:down'].invoke
+        apartment_namespace['migrate:up'].invoke
+      else
+        apartment_namespace['rollback'].invoke
+        apartment_namespace['migrate'].invoke
+      end
+    end
+  end
+end

data/puzzle-apartment.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('lib', __dir__)
+require 'apartment/version'
+
+Gem::Specification.new do |s|
+  s.name = 'puzzle-apartment'
+  s.version = Apartment::VERSION
+
+  s.authors       = ['Ryan Brunner', 'Brad Robertson', 'Rui Baltazar']
+  s.summary       = 'A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement'
+  s.description   = 'Apartment allows Rack applications to deal with database multitenancy through ActiveRecord'
+  s.email         = ['ryan@influitive.com', 'brad@influitive.com', 'rui.p.baltazar@gmail.com']
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      # NOTE: ignore all test related
+      f.match(%r{^(test|spec|features|documentation)/})
+    end
+  end
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.homepage = 'https://github.com/puzzle/apartment'
+  s.licenses = ['MIT']
+
+  s.add_dependency 'activerecord', '>= 6.1.0', '< 7.2'
+  s.add_dependency 'parallel', '>= 1.10'
+  s.add_dependency 'public_suffix', '>= 2.0.5'
+  s.add_dependency 'rack', '>= 1.3.6'
+
+  s.add_development_dependency 'appraisal', '~> 2.2'
+  s.add_development_dependency 'bundler', '>= 1.3', '< 3.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.2'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rspec_junit_formatter'
+  s.add_development_dependency 'rspec-rails', '~> 6.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rails'
+  s.add_development_dependency 'rubocop-rspec'
+
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency 'activerecord-jdbc-adapter'
+    s.add_development_dependency 'activerecord-jdbcmysql-adapter'
+    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+    s.add_development_dependency 'jdbc-mysql'
+    s.add_development_dependency 'jdbc-postgres'
+  else
+    s.add_development_dependency 'mysql2',  '~> 0.5'
+    s.add_development_dependency 'pg',      '~> 1.2'
+    s.add_development_dependency 'sqlite3', '~> 1.3.6'
+  end
+end

metadata

@@ -0,0 +1,385 @@
+--- !ruby/object:Gem::Specification
+name: puzzle-apartment
+version: !ruby/object:Gem::Version
+  version: 2.12.0
+platform: ruby
+authors:
+- Ryan Brunner
+- Brad Robertson
+- Rui Baltazar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Apartment allows Rack applications to deal with database multitenancy
+  through ActiveRecord
+email:
+- ryan@influitive.com
+- brad@influitive.com
+- rui.p.baltazar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/workflows/changelog.yml"
+- ".github/workflows/reviewdog.yml"
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".story_branch.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- HISTORY.md
+- README.md
+- Rakefile
+- TODO.md
+- docker-compose.yml
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_master.gemfile
+- lib/apartment.rb
+- lib/apartment/active_record/connection_handling.rb
+- lib/apartment/active_record/internal_metadata.rb
+- lib/apartment/active_record/postgresql_adapter.rb
+- lib/apartment/active_record/schema_migration.rb
+- lib/apartment/adapters/abstract_adapter.rb
+- lib/apartment/adapters/abstract_jdbc_adapter.rb
+- lib/apartment/adapters/jdbc_mysql_adapter.rb
+- lib/apartment/adapters/jdbc_postgresql_adapter.rb
+- lib/apartment/adapters/mysql2_adapter.rb
+- lib/apartment/adapters/postgis_adapter.rb
+- lib/apartment/adapters/postgresql_adapter.rb
+- lib/apartment/adapters/sqlite3_adapter.rb
+- lib/apartment/console.rb
+- lib/apartment/custom_console.rb
+- lib/apartment/deprecation.rb
+- lib/apartment/elevators/domain.rb
+- lib/apartment/elevators/first_subdomain.rb
+- lib/apartment/elevators/generic.rb
+- lib/apartment/elevators/host.rb
+- lib/apartment/elevators/host_hash.rb
+- lib/apartment/elevators/subdomain.rb
+- lib/apartment/log_subscriber.rb
+- lib/apartment/migrator.rb
+- lib/apartment/model.rb
+- lib/apartment/railtie.rb
+- lib/apartment/tasks/enhancements.rb
+- lib/apartment/tasks/task_helper.rb
+- lib/apartment/tenant.rb
+- lib/apartment/version.rb
+- lib/generators/apartment/install/USAGE
+- lib/generators/apartment/install/install_generator.rb
+- lib/generators/apartment/install/templates/apartment.rb
+- lib/tasks/apartment.rake
+- puzzle-apartment.gemspec
+homepage: https://github.com/puzzle/apartment
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for managing database multitenancy. Apartment Gem drop in replacement
+test_files: []