Skip to content

Commit

Permalink
Always support tenancy
Browse files Browse the repository at this point in the history
Simplifies code and testing
  • Loading branch information
ramontayag committed Nov 16, 2020
1 parent 9e82180 commit 9606fbf
Show file tree
Hide file tree
Showing 9 changed files with 72 additions and 70 deletions.
19 changes: 12 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Not Released
## Fixed
- Fix loading of jquery-ui files (Fixes https://github.com/mbulat/plutus/issues/58)

## Added
- Add `Account#amounts` and `Account#entries` to get all amounts and entries, respectively
# Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Changed
## [Unreleased]
### Changed
- Tenancy is enabled from the get go. Assigning a tenant is optional. See "Previous Versions" in the README on upgrading.
- Required jquery-ui version
- How migrations are done, which may be a breaking change from older versions of Plutus

### Fixed
- Fix loading of jquery-ui files (Fixes https://github.com/mbulat/plutus/issues/58)

### Added
- Add `Account#amounts` and `Account#entries` to get all amounts and entries, respectively
41 changes: 8 additions & 33 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -267,41 +267,11 @@ entry = Plutus::Entry.build(
Multitenancy Support
=====================

Plutus supports multitenant applications. Multitenancy is acheived by associating all Accounts under `Plutus::Account` with a "Tenant" object (typically some model in your Rails application). To add multi-tenancy support to Plutus, you must do the following:
Each account may belong to a polymorphic `tenant`. In previous versions plutus, the tenant code and tenant column had to be explicitly included by the developer. This complicated future changes (migrations, code testing) though and has since changed.

- Generate the migration which will add `tenant_id` to the plutus accounts table
In current versions of plutus, the accounts table have `tenant_id` and `tenant_type`. If you do not need accounts to belong to tenants, then you need not set these. The data storage overhead for empty columns with relational databases is negligible.

```sh
bundle exec rails g plutus:tenancy
```

- Run the migration

```sh
rake db:migrate
```

- Add an initializer to your Rails application, i.e. `config/initializers/plutus.rb`

```ruby
Plutus.config do |config|
config.enable_tenancy = true
config.tenant_class = 'Tenant'
end
```
*NOTE: When building entries, be sure to specify the account directly, rather than use the `account_name` feature. Otherwise you'll probably end up with the wrong account.*

```ruby
debit_account = Plutus::Account.where(:name => "Cash", :tenant => my_tenant).last
credit_account = Plutus::Account.where(:name => "Unearned Revenue", :tenant => my_tenant).last
entry = Plutus::Entry.new(
:description => "Order placed for widgets",
:date => Date.yesterday,
:debits => [
{:account => debit_account, :amount => 100.00}],
:credits => [
{:account => credit_account, :amount => 100.00}])
```
See "Previous Versions" on how to upgrade.

Reporting Views
===============
Expand All @@ -324,6 +294,11 @@ mount Plutus::Engine => "/plutus", :as => "plutus"
Previous Versions
=================

If you're upgrading from older versions prior to the tenancy changes, you need to:

1. `rake plutus:install:migrations`
2. `rake db:migrate`

For the rails 3 version, you can go here:

[https://github.com/mbulat/plutus/tree/rails3](https://github.com/mbulat/plutus/tree/rails3)
Expand Down
7 changes: 2 additions & 5 deletions app/models/plutus/account.rb
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,8 @@ class Account < ActiveRecord::Base

validates_presence_of :type

if Plutus.enable_tenancy
include Plutus::Tenancy
else
include Plutus::NoTenancy
end
validates :name, presence: true, uniqueness: { scope: [:tenant_id, :tenant_type] }
belongs_to :tenant, polymorphic: true

# The balance of the account. This instance method is intended for use only
# on instances of account subclasses.
Expand Down
9 changes: 0 additions & 9 deletions app/models/plutus/no_tenancy.rb

This file was deleted.

15 changes: 0 additions & 15 deletions app/models/plutus/tenancy.rb

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
class AddTenantIdAndTenantTypeToAccounts < ActiveRecord::Migration
def up
unless Plutus.enable_tenancy
add_column :plutus_accounts, :tenant_id, :integer
end

add_column :plutus_accounts, :tenant_type, :string

Plutus::Account.reset_column_information
Plutus::Account.update_all(tenant_type: Plutus.tenant_class)

add_index :plutus_accounts, [:tenant_id, :tenant_type]
end

def down
unless Plutus.enable_tenancy
remove_column :plutus_accounts, :tenant_id, :integer
end
remove_column :plutus_accounts, :tenant_type, :string
end
end
4 changes: 4 additions & 0 deletions fixture_rails_root/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,8 @@ DEPENDENCIES
web-console (>= 3.3.0)

BUNDLED WITH
<<<<<<< HEAD
1.15.1
=======
1.11.2
>>>>>>> 14e61c8... Always support tenancy
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# This migration comes from plutus (originally 20160422034059)
class AddTenantIdAndTenantTypeToAccounts < ActiveRecord::Migration
def up
unless Plutus.enable_tenancy
add_column :plutus_accounts, :tenant_id, :integer
end

add_column :plutus_accounts, :tenant_type, :string

Plutus::Account.reset_column_information
Plutus::Account.update_all(tenant_type: Plutus.tenant_class)

add_index :plutus_accounts, [:tenant_id, :tenant_type]
end

def down
unless Plutus.enable_tenancy
remove_column :plutus_accounts, :tenant_id, :integer
end
remove_column :plutus_accounts, :tenant_type, :string
end
end
4 changes: 3 additions & 1 deletion fixture_rails_root/db/schema.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@
t.boolean "contra"
t.datetime "created_at"
t.datetime "updated_at"
t.integer "tenant_id"
t.integer "tenant_id"
t.string "tenant_type"
t.index ["name", "type"], name: "index_plutus_accounts_on_name_and_type"
t.index ["tenant_id", "tenant_type"], name: "index_plutus_accounts_on_tenant_name_and_tenant_type"
end

create_table "plutus_amounts", force: :cascade do |t|
Expand Down

0 comments on commit 9606fbf

Please sign in to comment.