sublease 0.1.0

data/test/fixtures/lodgers.yml

@@ -0,0 +1,14 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+lodger_one:
+  tenant: site1
+lodger_two:
+  tenant: site2
+lodger_three:
+  tenant: site1
+lodger_four:
+  tenant: site1

data/test/fixtures/tenants.yml

@@ -0,0 +1,18 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+site1:
+  name: site1
+  subdomain: www
+  domain: example.com
+site2:
+  name: site2
+  subdomain: staging
+  domain: example.com
+site3:
+  name: site3
+  subdomain: junk
+  domain: yard.com

data/test/integration/navigation_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  setup do
+    Sublease.tenant_model = Tenant
+    host! 'staging.example.com'
+  end
+
+  context 'when switch_on_domain set' do
+    should 'change to the proper tenant' do
+      Sublease.switch_on_subdomain = false
+      Sublease.switch_on_subdomain_and_domain = false
+      Sublease.switch_on_domain = true
+      get '/'
+      assert_response :success
+      assert_select '#current_tenant_name','site1'
+    end
+  end
+
+  context 'when switch_on_subdomain set' do
+    should 'change to the proper tenant' do
+      Sublease.switch_on_domain = false
+      Sublease.switch_on_subdomain_and_domain = false
+      Sublease.switch_on_subdomain = true
+      get '/'
+      assert_response :success
+      assert_select '#current_tenant_name','site2'
+    end
+  end
+
+  context 'when switch_on_subdomain_and_domain set' do
+    should 'change to the proper tenant' do
+      Sublease.switch_on_domain = false
+      Sublease.switch_on_subdomain = false
+      Sublease.switch_on_subdomain_and_domain = true
+      get '/'
+      assert_response :success
+      assert_select '#current_tenant_name','site2'
+    end
+  end
+end

data/test/lib/generators/sublease/install_generator_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'generators/sublease/install/install_generator'
+
+module Sublease
+  class InstallGeneratorTest < Rails::Generators::TestCase
+    tests InstallGenerator
+    destination Rails.root.join('tmp/generators')
+    setup :prepare_destination
+
+    test 'install generator runs without errors' do
+      assert_nothing_raised do
+        run_generator ['sublease:install']
+      end
+    end
+
+    test 'initalizer copied to config/initializers/sublease.rb' do
+      path = Rails.root + 'config/initializers/sublease.rb'
+      assert_file path do
+        run_generator ['sublease:install']
+      end
+    end
+  end
+end

data/test/models/sublease/lodger_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+module Sublease
+  class LodgerTest < ActiveSupport::TestCase
+    setup do
+      @lodger = ::Lodger.first
+    end
+
+    context 'allow_sublease_change' do
+      should 'return false when not set' do
+        assert_equal false, @lodger.allow_sublease_change
+      end
+
+      should 'return false when set to anything not a true or false' do
+        @lodger.allow_sublease_change = 1
+        assert_equal false, @lodger.allow_sublease_change
+
+        @lodger.allow_sublease_change = 'true'
+        assert_equal false, @lodger.allow_sublease_change
+      end
+
+      should 'return true when set to true' do
+        @lodger.allow_sublease_change = true
+        assert_equal true, @lodger.allow_sublease_change
+      end
+    end
+
+
+    context 'changing the tenant' do
+      should 'fail without allow_sublease_change being set to true' do
+        @lodger.tenant_id = 2
+        assert_equal false, @lodger.valid?
+        assert_equal true, @lodger.errors.messages.has_key?(:tenant_id)
+      end
+
+      should 'fail with allow_sublease_change being set to true but value is invalid' do
+        @lodger.tenant_id = 1234
+        @lodger.allow_sublease_change = true
+        assert_equal false, @lodger.valid?
+        assert_equal true, @lodger.errors.messages.has_key?(:tenant_id)
+      end
+
+      should 'succeed with allow_sublease_change being set to true' do
+        tenant_id = ::Tenant.where.not(id: @lodger.tenant_id).pluck(:id).first
+        @lodger.tenant_id = tenant_id
+        @lodger.allow_sublease_change = true
+        assert_equal true, @lodger.valid?
+      end
+    end
+
+    context 'overridden Class method delete' do
+      should 'call destroy' do
+        Lodger.stub :destroy, true do
+          assert(Lodger.delete(1))
+        end
+      end
+    end
+
+    context 'overridden Instance method delete' do
+      should 'call destroy' do
+        @lodger.stub :destroy, true do
+          assert(@lodger.delete)
+        end
+      end
+    end
+  end
+end

data/test/models/sublease/tenant_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+module Sublease
+  class TenantTest < ActiveSupport::TestCase
+    setup do
+      @tenant = ::Tenant.first
+    end
+
+    context 'overridden Class method delete' do
+      should 'call destroy' do
+        Tenant.stub :destroy, true do
+          assert(Tenant.delete(1))
+        end
+      end
+    end
+
+    context 'overridden Instance method delete' do
+      should 'call destroy' do
+        @tenant.stub :destroy, true do
+          assert(@tenant.delete)
+        end
+      end
+    end
+  end
+end

data/test/sublease_test.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class Sublease::Test < ActiveSupport::TestCase
+  setup do
+    Sublease.tenant_model = Tenant
+  end
+
+  context 'configure block' do
+    should 'yield self' do
+      Sublease.configure do |config|
+        assert_equal Sublease, config
+      end
+    end
+  end
+
+  context 'tenant_model?' do
+    should 'raise Sublease::TenantModelNotSet when tenant_model is not set' do
+      Sublease.tenant_model = nil
+      assert_raises Sublease::TenantModelNotSet do
+        Sublease.send(:tenant_model?)
+      end
+    end
+  end
+
+  context 'default_tenant_domain=' do
+    should 'raise Sublease::TenantNotFound when tenant is not found' do
+      assert_raises Sublease::TenantNotFound do
+        Sublease.default_tenant_domain = 'test'
+      end
+    end
+
+    should 'set default_tenant if found' do
+      Sublease.default_tenant_subdomain = nil
+      Sublease.default_tenant_domain = 'example.com'
+      assert_equal Tenant, Sublease.default_tenant.class
+      assert_equal 'example.com', Sublease.default_tenant.domain
+    end
+  end
+
+  context 'default_tenant_subdomain=' do
+    should 'raise Sublease::TenantNotFound when tenant is not found' do
+      assert_raises Sublease::TenantNotFound do
+        Sublease.default_tenant_subdomain = 'test'
+      end
+    end
+
+    should 'set default_tenant if found' do
+      Sublease.default_tenant_domain = nil
+      Sublease.default_tenant_subdomain = 'www'
+      assert_equal Tenant, Sublease.default_tenant.class
+      assert_equal 'www', Sublease.default_tenant.subdomain
+    end
+  end
+
+  context 'default_tenant=' do
+    should 'raise Sublease::TenantNotFound when tenant is nil' do
+      assert_raises Sublease::TenantNotFound do
+        Sublease.default_tenant = nil
+      end
+    end
+  end
+
+  context 'switch_on_domain=' do
+    should 'return false if passed in value is not TrueClass' do
+      Sublease.switch_on_domain = 1234
+      assert_equal false, Sublease.switch_on_domain
+      Sublease.switch_on_domain = 'true'
+      assert_equal false, Sublease.switch_on_domain
+    end
+
+    should 'raise Sublease::ConfigError if switch_on_subdomain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_subdomain = true
+        Sublease.switch_on_domain = true
+      end
+    end
+
+    should 'raise Sublease::ConfigError if switch_on_subdomain_and_domain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_subdomain_and_domain = true
+        Sublease.switch_on_domain = true
+      end
+    end
+  end
+
+  context 'switch_on_subdomain=' do
+    should 'return false if passed in value is not TrueClass' do
+      Sublease.switch_on_subdomain = 1234
+      assert_equal false, Sublease.switch_on_subdomain
+      Sublease.switch_on_subdomain = 'true'
+      assert_equal false, Sublease.switch_on_subdomain
+    end
+
+    should 'raise Sublease::ConfigError if switch_on_domain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_domain = true
+        Sublease.switch_on_subdomain = true
+      end
+    end
+
+    should 'raise Sublease::ConfigError if switch_on_subdomain_and_domain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_subdomain_and_domain = true
+        Sublease.switch_on_subdomain = true
+      end
+    end
+  end
+
+  context 'switch_on_subdomain_and_domain=' do
+    should 'return false if passed in value is not TrueClass' do
+      Sublease.switch_on_subdomain_and_domain = 1234
+      assert_equal false, Sublease.switch_on_subdomain_and_domain
+      Sublease.switch_on_subdomain_and_domain = 'true'
+      assert_equal false, Sublease.switch_on_subdomain_and_domain
+    end
+
+    should 'raise Sublease::ConfigError if if switch_on_domain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_domain = true
+        Sublease.switch_on_subdomain_and_domain = true
+      end
+    end
+
+    should 'raise Sublease::ConfigError if if switch_on_subdomain is set' do
+      assert_raises Sublease::ConfigError do
+        Sublease.switch_on_subdomain = true
+        Sublease.switch_on_subdomain_and_domain = true
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../../test/dummy/db/migrate', __FILE__)]
+ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
+require 'rails/test_help'
+require 'minitest/autorun'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
+ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+ActiveSupport::TestCase.fixtures :all
+

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: sublease
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bacrossland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: shoulda
+  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'
+description: Sublease is a tenanting engine for Rails 4.2 and greater applications
+  using a shared database or schema.
+email:
+- bacrossland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- app/models/sublease/lodger.rb
+- app/models/sublease/tenant.rb
+- bin/rails
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/po.yml
+- gemfiles/Gemfile.jruby.rails-4.1-stable
+- gemfiles/Gemfile.jruby.rails-4.1-stable.lock
+- gemfiles/Gemfile.jruby.rails-4.2-stable
+- gemfiles/Gemfile.jruby.rails-4.2-stable.lock
+- gemfiles/Gemfile.jruby.rails-5.0-stable
+- gemfiles/Gemfile.jruby.rails-5.0-stable.lock
+- gemfiles/Gemfile.rails-4.1-stable
+- gemfiles/Gemfile.rails-4.1-stable.lock
+- gemfiles/Gemfile.rails-4.2-stable
+- gemfiles/Gemfile.rails-4.2-stable.lock
+- gemfiles/Gemfile.rails-5.0-stable
+- gemfiles/Gemfile.rails-5.0-stable.lock
+- lib/generators/sublease/install/USAGE
+- lib/generators/sublease/install/install_generator.rb
+- lib/generators/sublease/install/templates/sublease.rb
+- lib/sublease.rb
+- lib/sublease/engine.rb
+- lib/sublease/errors.rb
+- lib/sublease/tenant_switcher.rb
+- lib/sublease/version.rb
+- sublease.gemspec
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/lodgers.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/lodgers.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/lodgers_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/lodgers_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/models/lodger.rb
+- test/dummy/app/models/tenant.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/lodgers/index.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/sublease.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/db/migrate/20180114164205_create_tenants.rb
+- test/dummy/db/migrate/20180115012642_create_lodgers.rb
+- test/dummy/db/schema.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/fixtures/lodgers.yml
+- test/fixtures/tenants.yml
+- test/integration/navigation_test.rb
+- test/lib/generators/sublease/install_generator_test.rb
+- test/models/sublease/lodger_test.rb
+- test/models/sublease/tenant_test.rb
+- test/sublease_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bacrossland/sublease
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Sublease is a tenanting engine for Rails apps using a shared database or
+  schema.
+test_files:
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/lodgers.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/lodgers.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/lodgers_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/helpers/lodgers_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/models/lodger.rb
+- test/dummy/app/models/tenant.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/lodgers/index.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/sublease.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config/secrets.yml
+- test/dummy/db/migrate/20180114164205_create_tenants.rb
+- test/dummy/db/migrate/20180115012642_create_lodgers.rb
+- test/dummy/db/schema.rb
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/fixtures/lodgers.yml
+- test/fixtures/tenants.yml
+- test/integration/navigation_test.rb
+- test/lib/generators/sublease/install_generator_test.rb
+- test/models/sublease/lodger_test.rb
+- test/models/sublease/tenant_test.rb
+- test/sublease_test.rb
+- test/test_helper.rb