fake-multitenancy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad491e2b416140b470ffc0fc91d6e22c1563f437
+  data.tar.gz: a1bfd12142c1c8a459db2c37f2b28561c96e17dd
+SHA512:
+  metadata.gz: c861a127aac42c62600a9596838c529158f6267c20ae9d000d69094dc0d9381c17cb380fc8bbd461ca8d58581d7977269a713c7890706e910ad74847221bb233
+  data.tar.gz: 96e869fcc2420c98e0c3e3b7ddb771e2a79700aaa04fa4cfaa4da1c6879e74e5c7c782fad12482380d7c946e16feea09b0b63a59a47aa667a7f336db6845eb01

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p643

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fake-multitenancy.gemspec
+gemspec

data/README.md

@@ -0,0 +1,71 @@
+# Fake-Multitenancy
+
+With fake-multitenancy, you can serve several clients with one single database. Each client (tenant) will have it's own incremented ids. Data is transparently isolated between tenants.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fake-multitenancy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake-multitenancy
+
+## Usage
+
+There's no much to do. Just install the gem and multitenancy will work out of the box. You next tables created with migrations will be multitenant ready.
+
+You just need to have a model named Tenant. This class should respond to an instance method called `name` returning a String. Tenant should have a class method named "current" that returns an instance of Tenant.
+
+While you should consider a database powered solution, here is the simplest implementation to test this gem :
+
+```ruby
+class Tenant
+  def switch
+    @@current = self
+  end
+
+  attr_accessor :name
+
+
+  def self.find(name)
+    new.tap{ |t| t.name = name }
+  end
+
+  def self.current
+    @@current
+  end
+end
+```
+
+## Internals
+
+
+This gem does the followings :
+- Adds columns `multitenant_id` and `tenant` to all your tables (via migrations) ;
+- It turns the `id` column to an indexed integer, unique, not primary key, that is assigned in a callback
+- Exclude tables from multitenancy when the parameter `multitenant: false` is set on create_table calls ;
+- Add a default_scope to all you models inheriting from ActiveRecord::Base ;
+- Modify schema.rb generation internals by excluding the multitenancy.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fake-multitenancy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fake/multitenancy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fake-multitenancy.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake/multitenancy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake-multitenancy"
+  spec.version       = Fake::Multitenancy::VERSION
+  spec.authors       = ["Ihcène Medjber"]
+  spec.email         = ["ihcene@aritylabs.com"]
+
+  spec.summary       = %q{Serve several clients with one single database.}
+  spec.description   = %q{Serve several clients with one single database with incremental and secure ids by tenant.}
+  spec.homepage      = "http://github.com/ihcene/fake-multitenancy"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/lib/fake/multitenancy.rb

@@ -0,0 +1,14 @@
+require "fake/multitenancy/version"
+require "active_record"
+require "active_support"
+require "active_support/core_ext"
+
+module Fake
+  module Multitenancy
+  end
+end
+
+require 'fake/multitenancy/abstract_adapter'
+require 'fake/multitenancy/active_record/base/multitenancy'
+require 'fake/multitenancy/active_record/schema_dumper'
+require 'fake/multitenancy/active_record/base'

data/lib/fake/multitenancy/abstract_adapter.rb

@@ -0,0 +1,22 @@
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  concerning :MultitenantSchemaStatements do
+    def create_table(table_name, options = {}, &block)
+      multitenant = options.fetch(:multitenant, true) && table_name != "schema_migrations"
+
+      if multitenant
+        super table_name, options.merge(primary_key: :multitenant_id) do |t|
+          t.integer     :id, null: false, unique: true
+          t.string      :tenant, null: false
+
+          block.call(t) if block_given?
+        end
+
+        add_index(table_name, [:id, :tenant], unique: true)
+        add_index(table_name, :id)
+        add_index(table_name, :tenant)
+      else
+        super(table_name, options, &block)
+      end
+    end
+  end
+end

data/lib/fake/multitenancy/active_record/base.rb

@@ -0,0 +1,17 @@
+class ActiveRecord::Base
+  def self.inherited(klass)
+    super
+
+    return if klass.name.eql?('SchemaMigration')
+
+    klass.class_eval do
+      default_scope do
+        if multitenant?
+          where(tenant: Tenant.current.name)
+        else
+          scoped
+        end
+      end
+    end
+  end
+end

data/lib/fake/multitenancy/active_record/base/multitenancy.rb

@@ -0,0 +1,47 @@
+ActiveRecord::Base.instance_eval do
+  concerning :Multitenacy do
+    included do
+      before_create do
+        if self.class.multitenant?
+          self.tenant = Tenant.current.name
+          self.id     = (self.class.where(tenant: tenant).maximum(:id) || 0) + 1
+        end
+      end
+    end
+
+    def save
+      if self.class.multitenant? && !persisted?
+        3.times do
+          begin
+            super
+            break
+
+          rescue ActiveRecord::RecordNotUnique
+          end
+        end
+
+      else
+        super
+
+      end
+    end
+
+    module ClassMethods
+      def primary_key
+        multitenant? ? "id" : super
+      end
+
+      def multitenant?
+        columns.map(&:name).include?("tenant")
+      end
+
+      def find_by_sql(*)
+        if multitenant? && !Rails.env.production?
+          Rails.logger.warn "WARNING : You are using find_by_sql. Make sure you include a multitenacy limitation clause: \"where `tenant` = :tenant, tenant: Tenant.current.name\""
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/fake/multitenancy/active_record/schema_dumper.rb

@@ -0,0 +1,118 @@
+class ActiveRecord::SchemaDumper
+  def table(table, stream)
+    columns = @connection.columns(table)
+    begin
+      tbl = StringIO.new
+
+      # first dump primary key column
+      if @connection.respond_to?(:pk_and_sequence_for)
+        pk, _ = @connection.pk_and_sequence_for(table)
+      elsif @connection.respond_to?(:primary_key)
+        pk = @connection.primary_key(table)
+      end
+
+      multitenant = (pk == 'multitenant_id')
+
+      tbl.print "  create_table #{remove_prefix_and_suffix(table).inspect}"
+      pkcol = columns.detect { |c| c.name == pk }
+      if pkcol
+        unless multitenant
+          tbl.print %Q(, multitenant: false)
+        end
+
+        if pk != 'id' && pk != 'multitenant_id'
+          tbl.print %Q(, primary_key: "#{pk}")
+        elsif pkcol.sql_type == 'uuid'
+          tbl.print ", id: :uuid"
+          tbl.print %Q(, default: "#{pkcol.default_function}") if pkcol.default_function
+        else
+        end
+      else
+        tbl.print ", id: false"
+      end
+      tbl.print ", force: true"
+      tbl.puts " do |t|"
+
+      # then dump all non-primary key columns
+      column_specs = columns.map do |column|
+        raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" unless @connection.valid_type?(column.type)
+        next if column.name == pk
+        @connection.column_spec(column, @types)
+      end.compact
+
+      # find all migration keys used in this table
+      keys = @connection.migration_keys
+
+      # figure out the lengths for each column based on above keys
+      lengths = keys.map { |key|
+        column_specs.map { |spec|
+          spec[key] ? spec[key].length + 2 : 0
+        }.max
+      }
+
+      # the string we're going to sprintf our values against, with standardized column widths
+      format_string = lengths.map{ |len| "%-#{len}s" }
+
+      # find the max length for the 'type' column, which is special
+      type_length = column_specs.map{ |column| column[:type].length }.max
+
+      # add column type definition to our format string
+      format_string.unshift "    t.%-#{type_length}s "
+
+      format_string *= ''
+
+      column_specs.each do |colspec|
+        next if multitenant && colspec[:name].in?(['"id"', '"tenant"'])
+
+        values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
+        values.unshift colspec[:type]
+        tbl.print((format_string % values).gsub(/,\s*$/, ''))
+        tbl.puts
+      end
+
+      tbl.puts "  end"
+      tbl.puts
+
+      indexes(table, tbl)
+
+      tbl.rewind
+      stream.print tbl.read
+    rescue => e
+      stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
+      stream.puts "#   #{e.message}"
+      stream.puts
+    end
+
+    stream
+  end
+
+  def indexes(table, stream)
+    indexes = @connection.indexes(table)
+                         .reject{ |index| index.columns.in?([['id'], ['tenant'] ,['id', 'tenant']]) }
+
+    if indexes.any?
+      add_index_statements = indexes.map do |index|
+        statement_parts = [
+          "add_index #{remove_prefix_and_suffix(index.table).inspect}",
+          index.columns.inspect,
+          "name: #{index.name.inspect}",
+        ]
+        statement_parts << 'unique: true' if index.unique
+
+        index_lengths = (index.lengths || []).compact
+        statement_parts << "length: #{Hash[index.columns.zip(index.lengths)].inspect}" if index_lengths.any?
+
+        index_orders = index.orders || {}
+        statement_parts << "order: #{index.orders.inspect}" if index_orders.any?
+        statement_parts << "where: #{index.where.inspect}" if index.where
+        statement_parts << "using: #{index.using.inspect}" if index.using
+        statement_parts << "type: #{index.type.inspect}" if index.type
+
+        "  #{statement_parts.join(', ')}"
+      end
+
+      stream.puts add_index_statements.sort.join("\n")
+      stream.puts
+    end
+  end
+end

data/lib/fake/multitenancy/version.rb

@@ -0,0 +1,5 @@
+module Fake
+  module Multitenancy
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: fake-multitenancy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ihcène Medjber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Serve several clients with one single database with incremental and secure
+  ids by tenant.
+email:
+- ihcene@aritylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fake-multitenancy.gemspec
+- lib/fake/multitenancy.rb
+- lib/fake/multitenancy/abstract_adapter.rb
+- lib/fake/multitenancy/active_record/base.rb
+- lib/fake/multitenancy/active_record/base/multitenancy.rb
+- lib/fake/multitenancy/active_record/schema_dumper.rb
+- lib/fake/multitenancy/version.rb
+homepage: http://github.com/ihcene/fake-multitenancy
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Serve several clients with one single database.
+test_files: []