multi_tenancy_database 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2813e27322bc7bca485ca23f1279798edbc98cab
+  data.tar.gz: 01d2f8c3d6ad76ce167642a10f83222fce071d15
+SHA512:
+  metadata.gz: 4bd26e6dc0f1d291e526e2444db19e3e9f0ed3c3e87e84cd3b2bffefa86448603ad02f5f7bff195c6e26b7b302e0623e10c4ea51401624ccfe2e6ec42f18e511
+  data.tar.gz: 6e82a972d72d3a16e57c2f7886fc28b5d49ccb6f7306eb2938bd45f95894316baa25a635590ff19ebefcff6bae81f97b08f468650bc38e3773492f645ed4d30d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# MultiTenancyDatabase
+
+Allowing multiple databases to connect to the same project and still use ActiveRecord to perform operations on the models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multi_tenancy_database'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_tenancy_database
+
+## Usage
+
+In this example, we’ll have a separate database for our e-commerce school that we’ll call school.
+
+### Add new database
+
+multi_tenancy_database -n school -a postgresql
+
+### Create Database
+
+rails school:db:create
+
+### Create new model
+
+rails g school_model user first_name:string last_name:string
+
+### Add more field to model user
+
+rails g school_migration AddPhoneFieldToUser phone:string
+
+### Migrate
+
+rails school:db:migrate

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multi_tenancy_database"
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/multi_tenancy_database

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require "multi_tenancy_database"
+
+MultiTenancyDatabase::Command.new(ARGV).run

data/lib/multi_tenancy_database/command.rb

@@ -0,0 +1,73 @@
+require 'optparse'
+require 'multi_tenancy_database'
+require 'multi_tenancy_database/version'
+
+module MultiTenancyDatabase
+  class Command
+    def initialize(args)
+      args << '-h' if args.empty?
+      @args    = args
+      @options = {}
+    end
+
+    def run
+      @opts = OptionParser.new(&method(:set_opts))
+      @opts.parse!(@args)
+      check_missing_requirement_options
+      process!
+      exit 0
+    rescue Exception => ex
+      raise ex if @options[:trace] || SystemExit === ex
+      $stderr.print "#{ex.class}: " if ex.class != RuntimeError
+      $stderr.puts ex.message
+      $stderr.puts '  Use --trace for backtrace.'
+      exit 1
+    end
+
+    protected
+    def check_missing_requirement_options
+      mandatory = [:name, :adapter]
+      missing = mandatory.select{ |param| @options[param].nil? } 
+      if !missing.empty?
+        puts "Missing options: #{missing.join(', ')}"
+        puts @opts.help
+        exit
+      end
+    end
+
+    def command_name
+      @command_name ||= 'multi_tenancy_database'
+    end
+
+    def set_opts(opts)
+      opts.banner = "Usage: #{command_name} [options]"
+
+      opts.on('--trace', :NONE, 'Show a full traceback on error') do
+        @options[:trace] = true
+      end
+
+      opts.on('-n', '--name=db_name', 'Database name') do |name|
+        @options[:name] = name.gsub(/^\=+/, '')
+      end
+
+      opts.on('-a', '--adapter=posttgresql|mysql', 'Adapter type') do |adapter|
+        @options[:adapter] = adapter.gsub(/^\=+/, '')
+      end
+
+      opts.on_tail('-v', '--version', 'Print version') do
+        puts "#{command_name} #{MultiTenancyDatabase::VERSION}"
+        exit
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end
+
+    def process!
+      args = @args.dup
+      MultiTenancyDatabase.generator!(@options)
+    end
+  end  
+end

data/lib/multi_tenancy_database/generator.rb

@@ -0,0 +1,297 @@
+require 'multi_tenancy_database'
+require 'fileutils'   
+
+module MultiTenancyDatabase
+  class Generator
+    def initialize(args)
+      @template_path = "#{__dir__}/templates"
+      @options = args
+      @current_dir = get_current_dir
+    end
+
+    def run
+      puts 'Starting generate database'
+      puts '1. Create config connect to new database'
+      copy_config
+      puts '2. Created migration'
+      copy_migrate
+      puts '3. Created generation command'
+      copy_libs_generators
+      puts '4. Created tasks'
+      copy_libs_tasks
+      puts '5. Created module model'
+      copy_model
+      puts 'Done generate database'
+      show_summary
+    end
+
+    private
+    def show_summary
+      puts %Q(Please fill user/password connect to database database_#{database_name}.
+To create new model for database #{database_name}:
+  rails g #{database_name}_model <model-name> field:type[, ....]
+  Ex: rails g #{database_name}_model user name:string address:string
+To create new migration for model #{database_name}:
+  rails g #{database_name}_migration <migration-name> field:type[, ....]
+  Ex: rails g #{database_name}_migration AddPhoneFieldToUser phone:string
+To run migration
+  rails g #{database_name}:db:migrate
+      )  
+    end
+
+    def copy_config
+      dir = "#{@current_dir}/config/"
+      FileUtils.mkdir_p("#{dir}databases")
+
+      puts "\t.Created database_#{database_name}.yml"
+      f = File.open("#{dir}databases/database_#{database_name}.yml", 'w')
+      f.puts database_config_template
+      f.close
+
+      f = File.open("#{dir}initializers/db_#{database_name}.rb", 'w')
+      f.puts constant_template
+      f.close
+    end
+
+    def constant_template
+      %Q(config=YAML::load(ERB.new(File.read(Rails.root.join('config','databases/database_#{database_name}.yml'))).result)
+#{database_name.upcase}_DB = config[Rails.env]        
+      )
+    end
+
+    def database_config_template
+      %Q(default: &default
+  adapter: #{adapter}
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  username: <%= ENV['DEV_DATABASE_#{database_name.upcase}_USERNAME'] %>
+  password: <%= ENV['DEV_DATABASE_#{database_name.upcase}_PASSWORD'] %>
+  database: #{database_name}_dev
+
+test:
+  <<: *default
+  username: <%= ENV['TEST_DATABASE_#{database_name.upcase}_USERNAME'] %>
+  password: <%= ENV['TEST_DATABASE_#{database_name.upcase}_PASSWORD'] %>
+  database: #{database_name}_test
+
+production:
+  <<: *default
+  username: <%= ENV['PROD_DATABASE_#{database_name.upcase}_USERNAME'] %>
+  password: <%= ENV['PROD_DATABASE_#{database_name.upcase}_PASSWORD'] %>
+  database: #{database_name}_prod
+      )      
+    end
+
+    def copy_model
+      dir = "#{@current_dir}/app/models/#{database_name}_db"
+      FileUtils.mkdir_p("#{dir}")
+      f = File.open("#{dir}/base.rb", 'w')
+      f.puts base_template_content
+      f.close  
+    end
+
+    def base_template_content
+      %Q(module #{camelize}Db
+  class Base < ActiveRecord::Base
+    self.abstract_class = true
+    establish_connection #{database_name.upcase}_DB
+  end
+end
+      )      
+    end
+
+    def copy_libs_tasks
+      dir = "#{@current_dir}/lib/"
+      FileUtils.mkdir_p("#{dir}/tasks")
+
+      f = File.open("#{dir}/tasks/db_#{database_name}.rake", 'w')
+      f.puts rake_template_content
+      f.close      
+    end
+
+    def copy_libs_generators
+      dir = "#{@current_dir}/lib/"
+      FileUtils.mkdir_p("#{dir}/generators/templates")
+      
+      puts "\t.Created template #{database_name}_db_model.rb"
+      f = File.open("#{dir}/generators/templates/#{database_name}_db_model.rb.tt", 'w')
+      f.puts model_template_content
+      f.close
+      
+      puts "\t.Created template #{database_name}_migration_generator.rb"
+      f = File.open("#{dir}/generators/#{database_name}_migration_generator.rb", 'w')
+      f.puts migration_generation
+      f.close
+      
+      puts "\t.Created template #{database_name}_model_generator.rb"
+      f = File.open("#{dir}/generators/#{database_name}_model_generator.rb", 'w')
+      f.puts model_generation
+      f.close
+
+    end
+
+    def rake_template_content
+      %Q(task spec: ['#{database_name}:db:test:prepare']
+
+namespace :#{database_name} do
+  namespace :db do |ns|
+    %i(drop create setup migrate rollback seed version).each do |task_name|
+      task task_name do
+        Rake::Task["db:\#{task_name}"].invoke
+      end
+    end
+
+    namespace :schema do
+      %i(load dump).each do |task_name|
+        task task_name do
+          Rake::Task["db:schema:\#{task_name}"].invoke
+        end
+      end
+    end
+
+    namespace :test do
+      task :prepare do
+        Rake::Task['db:test:prepare'].invoke
+      end
+    end
+
+    # append and prepend proper tasks to all the tasks defined here above
+    ns.tasks.each do |task|
+      task.enhance ['#{database_name}:set_custom_config'] do
+        Rake::Task['#{database_name}:revert_to_original_config'].invoke
+      end
+    end
+  end
+
+  task :set_custom_config do
+    # save current vars
+    @original_config = {
+      env_schema: ENV['SCHEMA'],
+      config: Rails.application.config.dup
+    }
+
+    # set config variables for custom database
+    ENV['SCHEMA'] = 'db/#{database_name}s/schema.rb'
+    Rails.application.config.paths['db'] = ['db/#{database_name}s']
+    Rails.application.config.paths['db/migrate'] = ['db/#{database_name}s/migrate']
+    # If you are using Rails 5 or higher change `paths['db/seeds']` to `paths['db/seeds.rb']`
+    Rails.application.config.paths['db/seeds'] = ['db/#{database_name}s/seeds.rb']
+    Rails.application.config.paths['config/database'] = ['config/databases/database_#{database_name}.yml']
+  end
+
+  task :revert_to_original_config do
+    # reset config variables to original values
+    ENV['SCHEMA'] = @original_config[:env_schema]
+    Rails.application.config = @original_config[:config]
+  end
+end
+      )      
+    end
+
+    def model_generation
+      %Q(require 'rails/generators/active_record/model/model_generator'
+
+class #{camelize}ModelGenerator < ActiveRecord::Generators::ModelGenerator
+  ActiveRecord::Generators::ModelGenerator
+    .instance_method(:create_model_file)
+
+  migration_file = File.dirname(
+    ActiveRecord::Generators::ModelGenerator
+      .instance_method(:create_migration_file)
+      .source_location.first
+  )
+
+  source_root File.join(migration_file, "templates")
+
+  def create_migration_file
+    return unless options[:migration] && options[:parent].nil?
+    attributes.each { |a| a.attr_options.delete(:index) if a.reference? && !a.has_index? } if options[:indexes] == false
+    migration_template "../../migration/templates/create_table_migration.rb", File.join('db/#{database_name}s/migrate', "create_\#{table_name}.rb")
+  end
+
+  def create_model_file
+    template Rails.root.join('lib', 'generators', "templates", "#{database_name}_db_model.rb"), File.join("app/models", class_path, "\#{file_name}.rb")
+  end
+end
+      )
+    end
+
+    def migration_generation
+      %Q(require 'rails/generators/active_record/migration/migration_generator'
+
+class #{camelize}MigrationGenerator < ActiveRecord::Generators::MigrationGenerator
+  migration_file = File.dirname(
+    ActiveRecord::Generators::MigrationGenerator
+      .instance_method(:create_migration_file)
+      .source_location.first
+  )
+
+  source_root File.join(migration_file, "templates")
+
+  def create_migration_file
+    set_local_assigns!
+    validate_file_name!
+    migration_template @migration_template, "db/#{database_name}s/migrate/\#{file_name}.rb"
+  end
+end
+      )
+    end
+
+    def model_template_content
+      %Q(<% module_namespacing do -%>
+class <%= class_name %> < #{camelize}Db::Base
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %><%= ', required: true' if attribute.required? %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+end
+<% end -%>          
+      )
+    end
+
+    def copy_migrate
+      dir = "#{@current_dir}/db/#{database_name}s"
+      FileUtils.mkdir_p("#{dir}/migrate")
+
+      f = File.open("#{dir}/schema.rb", 'w')
+      f.close
+
+      f = File.open("#{dir}/seed.rb", 'w')
+      f.close
+    end
+
+    def camelize
+      database_name.split('_').map {|w| w.capitalize}.join
+    end
+
+    def database_name
+      @options[:name].downcase
+    end
+
+    def adapter
+      @options[:adapter].downcase
+    end
+
+    def get_current_dir
+      if defined?(Rails)
+        return Rails.root
+      end
+
+      if defined?(Bundler)
+        return Bundler.root
+      end
+      
+      Dir.pwd
+    end
+  end
+end

data/lib/multi_tenancy_database/version.rb

@@ -0,0 +1,3 @@
+module MultiTenancyDatabase
+  VERSION = "0.1.1"
+end

data/lib/multi_tenancy_database.rb

@@ -0,0 +1,13 @@
+require "multi_tenancy_database/version"
+require 'thor'
+
+require_relative 'multi_tenancy_database/version'
+require_relative 'multi_tenancy_database/command'
+require_relative 'multi_tenancy_database/generator'
+
+module MultiTenancyDatabase
+  class Error < StandardError; end
+  def self.generator!(options)
+    MultiTenancyDatabase::Generator.new(options).run
+  end
+end

data/multi_tenancy_database.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "multi_tenancy_database/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_tenancy_database"
+  spec.version       = MultiTenancyDatabase::VERSION
+  spec.authors       = ["thuocsi.vn"]
+  spec.email         = ["phuong@thuocsi.vn"]
+
+  spec.summary       = %q{Generate and connect database}
+  spec.description   = %q{Generate new config datanbase and add this conneect to currentt project}
+  spec.homepage      = "https://github.com/thuocsi/multi_tenancy_database"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/thuocsi/multi_tenancy_database"
+    spec.metadata["changelog_uri"] = "https://github.com/thuocsi/multi_tenancy_database"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ['multi_tenancy_database']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: multi_tenancy_database
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- thuocsi.vn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Generate new config datanbase and add this conneect to currentt project
+email:
+- phuong@thuocsi.vn
+executables:
+- multi_tenancy_database
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/multi_tenancy_database
+- lib/multi_tenancy_database.rb
+- lib/multi_tenancy_database/command.rb
+- lib/multi_tenancy_database/generator.rb
+- lib/multi_tenancy_database/version.rb
+- multi_tenancy_database.gemspec
+homepage: https://github.com/thuocsi/multi_tenancy_database
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/thuocsi/multi_tenancy_database
+  source_code_uri: https://github.com/thuocsi/multi_tenancy_database
+  changelog_uri: https://github.com/thuocsi/multi_tenancy_database
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Generate and connect database
+test_files: []