db_vcs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad87a4ce6a39d924dfd4b7df99393d0379511b6034f38ef10be59e091b0bf847
+  data.tar.gz: 01d1173505e38a6abc7e9cceef3541fc13e338e4f90c0020e9b5f3ce35d452ea
+SHA512:
+  metadata.gz: 6a90671b45f5d4c0069c01a37722f2224a0e655b3c3907a90cc255e2114f087e23d3c53a135b21fe6821ae188240f8f4cf9c52deb1416fb73c81dde74037ed39
+  data.tar.gz: 1952c97adeeb2134ed06b4ecde8036a3ed6adedee0634bf281e1e28a6fda120aa416e1707a3ddd8cd75a7d43fd4929e93290d8a19e6fdc267f9866209dd83c01

data/.db_vcs.yml.sample

@@ -0,0 +1,9 @@
+pg_config:
+  username: postgres
+  port: 5532
+mongo_config:
+  mongo_uri: "mongodb://localhost:28017"
+dbs_in_use:
+  <% DbVcs::Manager::ADAPTERS.keys.each do |adapter_name| %>
+  - <%= adapter_name %>
+  <% end %>

data/.rspec

@@ -0,0 +1,3 @@
+--format Fivemat
+--require spec_helper
+--require fivemat

data/.ruby-gemset

@@ -0,0 +1 @@
+db_vcs

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+  Nothing new yet
+
+## [1.0.0] - 2022-01-04
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at intale.a@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in db_vcs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ivan Dzyzenko
+
+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,161 @@
+# DbVcs
+
+Makes it possible to version your local databases during development.
+
+## What is it for?
+
+During the development, you need to handle several branches for several tickets at a time. This make the necessity to have correct database for each branch. For example, `branch1` add `table1.some_column` and `branch2` removes `table1.some_another_column`. When switching between `branch1` and `branch2` - you need to re-create databases, seed then, etc, to make your application work properly. This process may be annoying, especially for large projects with a ton of seeds.
+
+## How it works?
+
+Integrating `db_vcs` helps you to have separated databases for each branch. It provides a tool to create a database for new branch with single command, based on a database you already have in main branch. No need to create/migrate/seed new database when switching between branches.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "db_vcs", require: "db_vcs/autoconfigure"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install db_vcs
+
+`db_vcs` has its own command line tool - `db-vcs`. After installing a gem - you can run `db-vcs --help` in your terminal to see available options.
+
+## Configuration
+
+`db_vcs` autoloads configuration from `.db_vcs.yml` file, placed under your project's root folder. The configuration loader supports ERB templating as well. Example:
+
+```yaml
+environments: # The list of environments you want to use db_vcs gem for
+  - test
+  - development
+db_basename: your_project_name # This name will be used as a prefix of all databases names, related to your project
+dbs_in_use: # The list of databases you want to use db_vcs gem for
+  - mongo
+  - postgres
+main_branch: main # The name of your main branch. When creating new database for new branch, this branch's database will be used as a source database
+pg_config: # Configuration of PostgreSQL
+  host: localhost
+  port: '5432'
+  username: <%= ENV['PGUSER'] %>
+  password: postgres
+mongo_config: # Configuration of Mongodb
+  mongodump_path: "/path/to/mongodump" # resolved automatically using which util. Override it otherwise
+  mongorestore_path: "/path/to/mongorestore" # resolved automatically using which util. Override it otherwise
+  mongo_uri: mongodb://localhost:27017
+```
+
+Notices:
+
+- to be able to use MongoDB - you need to have "mongo" gem installed
+- to be able to use MongoDB - you need to have [MongoDB Database Tools](https://docs.mongodb.com/database-tools/) installed
+- to be able to use PostgreSQL - you need to have "pg" gem installed 
+
+## Usage
+
+**WARNING!** This gem should be used **only** locally - its architecture isn't supposed the usage of it in production environment. 
+
+- Create configuration file `.db_vcs.yml` in your project's root folder.
+- Edit your `database.yml`/`mongoid.yml`/any other config file and change database name to `DbVcs::Utils.db_name(env, DbVcs::Utils.current_branch)`. It will allow `db_vcs` gem correctly calculate database name for each branch/environment. 
+
+Example of `database.yml`:
+
+```yaml
+development:
+  adapter: postgresql
+  prepared_statements: false
+  encoding: utf8
+  username: postgres
+  port: 5432
+  database: <%= DbVcs::Utils.db_name("development", DbVcs::Utils.current_branch) %>
+test:
+  adapter: postgresql
+  prepared_statements: false
+  encoding: utf8
+  username: postgres
+  port: 5432
+  database: <%= DbVcs::Utils.db_name("test", DbVcs::Utils.current_branch) %>
+```
+
+Example of `mongoid.yml`:
+
+```yaml
+development:
+  clients:
+    default:
+      database: <%= DbVcs::Utils.db_name("development", DbVcs::Utils.current_branch) %>
+      hosts:
+        - localhost:27017      
+test:
+  clients:
+    default:
+      database: <%= DbVcs::Utils.db_name("test", DbVcs::Utils.current_branch) %>
+      hosts:
+      - localhost:27017      
+```
+
+- Create DbVcs-friendly databases. You can skip this step if you want to create databases in your own. Switch into you main branch, and run:
+
+```shell
+bundle exec db-vcs init
+```
+
+- Now, run commands to load your db structure and populate it with test data. In rails you would usually want to run `rails db:schema:load && rails db:seed`.
+
+Done! The databases for your main branch are setup. Now, when switching into new branch, you can create the database for it just with a single command:
+
+```
+bundle exec db-vcs create
+```
+
+## git-checkout integration
+
+You may want to add git hook that, when switching between branches: 
+
+- will inform you about databases existence
+- restart processes, such as puma server, to apply new database settings
+
+To do so, create `.git/hooks/post-checkout` file(if you don't have it yet) and make it executable:
+
+```shell
+touch .git/hooks/post-checkout
+chmod +x .git/hooks/post-checkout
+```
+
+Example of file's content:
+
+```shell
+#!/bin/bash
+
+# Comparison with third argument is needed to detect whether the checkout is related to the switching between branches. In this case third argument equals to 1.
+if [ $3 -eq 1 ]
+  then
+    bundle exec db-vcs check
+    bundle exec pumactl -C config/puma.rb restart
+fi
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Interactive console and tests require all, supported by DbVcs gem, databases to be installed and run. You can do it by running docker with `bin/start-docker` command.
+
+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`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/intale/db_vcs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/intale/db_vcs/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DbVcs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/intale/db_vcs/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "db_vcs/autoconfigure"
+require_relative "../spec/support/db_helper"
+
+DbHelper.pre_create_all("development", DbVcs::Utils.current_branch)
+
+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/bin/start-docker

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "db_vcs/autoconfigure"
+
+pg_user = DbVcs.config.pg_config.username
+pg_port = DbVcs.config.pg_config.port
+mongo_port = URI.parse(DbVcs.config.mongo_config.mongo_uri).port
+
+pid = Kernel.spawn(
+  { "PGUSER" => pg_user.to_s, "PG_PORT" => pg_port.to_s, "MONGO_PORT" => mongo_port.to_s }, "docker-compose up 1>&2",
+  close_others: true
+)
+Process.waitpid(pid)

data/db_vcs.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/db_vcs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_vcs"
+  spec.version       = DbVcs::VERSION
+  spec.authors       = ["Ivan Dzyzenko"]
+  spec.email         = ["ivan.dzyzenko@gmail.com"]
+
+  spec.summary       = "Database versions control."
+  spec.description   = "Have a separate database for each git branch!"
+  spec.homepage      = "https://github.com/intale/db_vcs"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/intale/vcs_db/tree/v#{spec.version}"
+  spec.metadata["changelog_uri"] = "https://github.com/intale/vcs_db/blob/v#{spec.version}/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pg", "~> 1.2"
+  spec.add_development_dependency "mongo", "~> 2.17"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec-its", "~> 1.3"
+  spec.add_development_dependency "fivemat", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "fakefs", "~> 1.4"
+end

data/docker-compose.yml

@@ -0,0 +1,23 @@
+version: "3.9"
+
+services:
+  db:
+    image: postgres:14
+    environment:
+      - PGUSER=${PGUSER}
+      - POSTGRES_HOST_AUTH_METHOD=trust
+    volumes:
+      - pg_db:/var/lib/postgresql/data
+    ports:
+      - ${PG_PORT}:5432
+
+  mongodb:
+    image: mongo:latest
+    volumes:
+      - mongo_db:/data/db
+    ports:
+      - ${MONGO_PORT}:27017
+
+volumes:
+  mongo_db:
+  pg_db:

data/exe/db-vcs

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "db_vcs/autoconfigure"
+require "optparse"
+
+source_branch = DbVcs.config.main_branch
+force = false
+
+opt_parser = OptionParser.new do |parser|
+  parser.banner = <<~TEXT
+    Usage: db-vcs [command] [options]
+
+      Pre-create databases, suitable for usage with db_vcs gem. This will create empty databases:
+        db-vcs init
+      Checks databases existence and warns you if they miss
+        db-vcs check
+      Create databases for current branch, based on main branch:
+        db-vcs create
+      Create databases for current branch, based on a branch, defined by --source-branch option:
+        db-vcs create --source-branch=some_branch
+      Drop databases of current branch. By default you can not drop the databases of main branch (defined by config.main_branch):
+        db-vcs drop
+      Force drop databases of current branch:
+        db-vcs drop --force
+      Drop databases that don't have related branches.
+        db-vcs cleanup
+
+  TEXT
+
+  parser.on(
+    "-bBRANCH_NAME",
+    "--source-branch=BRANCH_NAME",
+    "Set the branch name to create databases from. Default value is a value of config.main_branch config option."
+  ) do |branch_name|
+    source_branch = branch_name
+  end
+
+  parser.on("-f", "--force", "Force the action. The effect depends on a command being executed.") do
+    force = true
+  end
+
+  parser.on("-h", "--help", "Prints this help") do
+    puts parser
+    exit
+  end
+end
+
+args = ARGV.dup
+opt_parser.parse!(args)
+command = args[0]
+
+case command
+when "create"
+  DbVcs::Manager.copy_for_all_envs(target: DbVcs::Utils.current_branch, source: source_branch)
+when "drop"
+  if DbVcs::Utils.current_branch == DbVcs.config.main_branch && !force
+    puts "Databases of main branch(#{DbVcs.config.main_branch}) can't be dropped. Use --force option if you would like to do it."
+  else
+    DbVcs::Manager.drop_for_all_envs(DbVcs::Utils.current_branch)
+  end
+when "cleanup"
+  databases_to_keep = DbVcs::Utils.git_branches.flat_map do |br|
+    DbVcs.config.environments.map do |env|
+      DbVcs::Utils.db_name(env, br)
+    end
+  end
+  DbVcs.config.dbs_in_use.each do |adapter_name|
+    manager = DbVcs::Manager.new(adapter_name)
+    manager.adapter.list_databases.each do |db_name|
+      next if databases_to_keep.include?(db_name)
+      next unless db_name.start_with?(DbVcs::Utils.normalize_db_part(DbVcs.config.db_basename))
+
+      manager.drop(db_name)
+    end
+  end
+when "init"
+  DbVcs.config.dbs_in_use.each do |adapter_name|
+    inst = DbVcs::Manager.new(adapter_name)
+    DbVcs.config.environments.each do |env|
+      inst.create(DbVcs::Utils.db_name(env, DbVcs::Utils.current_branch))
+    end
+  end
+when "check"
+  DbVcs.config.dbs_in_use.each do |adapter_name|
+    inst = DbVcs::Manager.new(adapter_name)
+    DbVcs.config.environments.each do |env|
+      db_name = DbVcs::Utils.db_name(env, DbVcs::Utils.current_branch)
+      unless inst.adapter.db_exists?(db_name)
+        inst.failure("#{db_name} does not exist! Run 'bundle exec db-vcs create' to create it.")
+      end
+    end
+  end
+else
+  puts opt_parser.help
+end
+

data/lib/db_vcs/adapter_interface.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module AdapterInterface
+    def config
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def connection
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def db_exists?(db_name)
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def copy_database(to_db, from_db)
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def create_database(db_name)
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def list_databases
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+
+    def drop_by_dbname(db_name)
+      raise NotImplementedError, "You have to implement this method in adapter's class"
+    end
+  end
+end

data/lib/db_vcs/adapters/mongo.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module Adapters
+    class Mongo
+      class Config
+        include DbVcs::ConfigAttributes
+
+        # Path to mongodump util. It is resolved automatically.
+        attr_accessor :mongodump_path
+        # Path to mongorestore util. It is resolved automatically.
+        attr_accessor :mongorestore_path
+        # Mongodb connection uri. Defaults to "mongodb://localhost:27017".
+        # See https://docs.mongodb.com/manual/reference/connection-string/ for more info.
+        attr_accessor :mongo_uri
+
+        def initialize
+          @mongodump_path = Utils.resolve_exec_path("mongodump")
+          @mongorestore_path = Utils.resolve_exec_path("mongorestore")
+          @mongo_uri = "mongodb://localhost:27017"
+        end
+      end
+
+      class << self
+        include DbVcs::AdapterInterface
+
+        # @return [DbVcs::Adapters::Mongo::Config]
+        def config
+          DbVcs.config.mongo_config
+        end
+
+        # @return [Mongo::Client]
+        def connection
+          @connection ||=
+            begin
+              require "mongo"
+              ::Mongo::Client.new(config.mongo_uri)
+            end
+        end
+
+        # @param db_name [String]
+        # @return [Boolean]
+        def db_exists?(db_name)
+          list_databases.include?(db_name)
+        end
+
+        # @param to_db [String]
+        # @param from_db [String]
+        # @return void
+        def copy_database(to_db, from_db)
+          command =
+            <<~SH
+            #{config.mongodump_path} #{config.mongo_uri} --db="#{from_db}" --archive --quiet \
+            | #{config.mongorestore_path} #{config.mongo_uri} --archive --quiet --nsFrom='#{from_db}.*' --nsTo='#{to_db}.*'
+          SH
+          `#{command}`
+        end
+
+        # @param db_name [String]
+        # @return void
+        def create_database(db_name)
+          # Mongodb databases should contain at least one collection
+          connection.use(db_name).database.collection("_db_vcs").insert_one(_db_vcs: 1)
+        end
+
+        # @return [Array<String>]
+        def list_databases
+          connection.database_names
+        end
+
+        # @param db_name [String]
+        # @return [void]
+        def drop_by_dbname(db_name)
+          connection.use(db_name).database.drop
+        end
+      end
+    end
+  end
+end

data/lib/db_vcs/adapters/postgres.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module Adapters
+    class Postgres
+      class Config
+        include DbVcs::ConfigAttributes
+
+        attr_accessor :host, :port, :username, :password
+
+        def initialize
+          @host = "localhost"
+          @port = "5432"
+          @username = "postgres"
+          @password = nil
+        end
+      end
+
+      class << self
+        include DbVcs::AdapterInterface
+
+        # @return [DbVcs::Adapters::Postgres::Config]
+        def config
+          DbVcs.config.pg_config
+        end
+
+        # @return [PG::Connection]
+        def connection
+          @connection ||=
+            begin
+              require "pg"
+              PG.connect(user: config.username, host: config.host, port: config.port, password: config.password)
+            end
+        end
+
+        # @param db_name [String]
+        # @return [Boolean]
+        def db_exists?(db_name)
+          !connection.exec("SELECT 1 AS one FROM pg_database WHERE datname='#{db_name}' LIMIT 1").first.nil?
+        end
+
+        # @param to_db [String]
+        # @param from_db [String]
+        # @return void
+        def copy_database(to_db, from_db)
+          connection.exec("CREATE DATABASE #{to_db} TEMPLATE #{from_db} OWNER #{config.username}")
+        end
+
+        # @param db_name [String]
+        # @return void
+        def create_database(db_name)
+          connection.exec("CREATE DATABASE #{db_name} OWNER #{config.username}")
+        end
+
+        # @return [Array<String>]
+        def list_databases
+          connection.exec("SELECT datname FROM pg_database WHERE datistemplate = false").to_a.flat_map(&:values)
+        end
+
+        # @param db_name [String]
+        # @return [void]
+        def drop_by_dbname(db_name)
+          connection.exec("DROP DATABASE IF EXISTS #{db_name}")
+        end
+      end
+    end
+  end
+end

data/lib/db_vcs/autoconfigure.rb

@@ -0,0 +1,3 @@
+require "db_vcs"
+
+DbVcs.load_config

data/lib/db_vcs/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module DbVcs
+  class Config
+    include DbVcs::ConfigAttributes
+
+    # Environments you want to create database versions for. Default is ["development", "test"].
+    attr_accessor :environments
+    # This name will be used as a prefix to all your databases in a project.
+    attr_accessor :db_basename
+    # A list of databases you want to enable versioning for. See {DbVcs::Manager::ADAPTERS} keys for the list of
+    # available values. Defaults to empty array.
+    attr_accessor :dbs_in_use
+    # Configuration of dbs clients.
+    attr_reader :pg_config, :mongo_config
+    # A name of branch to be used as a default branch to copy databases from.
+    attr_accessor :main_branch
+
+    def initialize
+      @environments = %w(development test)
+      @dbs_in_use = []
+      @db_basename = Dir.pwd.split(File::SEPARATOR).last
+      @main_branch = "main"
+      @pg_config = DbVcs::Adapters::Postgres::Config.new
+      @mongo_config = DbVcs::Adapters::Mongo::Config.new
+    end
+
+    # @param hash [Hash]
+    # @return [void]
+    def pg_config=(hash)
+      pg_config.assign_attributes(hash)
+    end
+
+    # @param hash [Hash]
+    # @return [void]
+    def mongo_config=(hash)
+      mongo_config.assign_attributes(hash)
+    end
+  end
+end

data/lib/db_vcs/config_attributes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module ConfigAttributes
+    # Assigns config attributes from hash.
+    # @param hash [Hash]
+    #   Example:
+    #     {
+    #       environments: ["development"],
+    #       pg_config: {
+    #         port: 5433
+    #       }
+    #     }
+    # @return [void]
+    def assign_attributes(hash)
+      hash.each do |k, v|
+        if public_methods(false).include?(:"#{k}=")
+          public_send(:"#{k}=", v)
+        end
+      end
+    end
+  end
+end

data/lib/db_vcs/manager.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module DbVcs
+  class Manager
+    ADAPTERS = { "postgres" => DbVcs::Adapters::Postgres, "mongo" => DbVcs::Adapters::Mongo }.freeze
+
+    class << self
+      # @param adapter_name [String]
+      # @return [Class<DbVcs::Adapters::Postgres>, Class<DbVcs::Adapters::Mongo>]
+      # @raise [NotImplementedError] in case if no adapter is found
+      def get_adapter_by_name(adapter_name)
+        ADAPTERS[adapter_name] || raise(NotImplementedError, "No adapter for `#{adapter_name}' is implemented.")
+      end
+
+      # Creates databases for target branch from source branch for all setup environments for all setup databases
+      # @param :target [String] target branch name
+      # @param :source [String] a branch name to copy the db from
+      # @return [void]
+      def copy_for_all_envs(target:, source: DbVcs.config.main_branch)
+        DbVcs.config.dbs_in_use.each do |adapter_name|
+          inst = new(adapter_name)
+          DbVcs.config.environments.each do |env|
+            inst.copy(target: DbVcs::Utils.db_name(env, target), source: DbVcs::Utils.db_name(env, source))
+          end
+        end
+      end
+
+      # Drops databases of given branch name for all environments for all setup databases
+      # @param branch_name [String]
+      def drop_for_all_envs(branch_name)
+        DbVcs.config.dbs_in_use.each do |adapter_name|
+          inst = new(adapter_name)
+          DbVcs.config.environments.each do |env|
+            inst.drop(DbVcs::Utils.db_name(env, branch_name))
+          end
+        end
+      end
+    end
+
+    attr_reader :adapter, :adapter_name
+
+    # @param adapter_name [String]
+    def initialize(adapter_name)
+      @adapter_name = adapter_name
+      @adapter = self.class.get_adapter_by_name(adapter_name)
+    end
+
+    # @param :target [String] new database name
+    # @param :source [String] database name to create a new db from
+    # @return [void]
+    def copy(target:, source:)
+      unless adapter.db_exists?(source)
+        return failure "#{source}' doesn't exist"
+      end
+      if adapter.db_exists?(target)
+        return failure "#{target} already exists"
+      end
+      success "Copying #{source} -> #{target}"
+      adapter.copy_database(target, source)
+    end
+
+    # @param db_name [String]
+    # @return [void]
+    def drop(db_name)
+      unless adapter.db_exists?(db_name)
+        return failure "#{db_name}' doesn't exist"
+      end
+      adapter.drop_by_dbname(db_name)
+      success "Database #{db_name} was dropped successfully"
+    end
+
+    # @param db_name [String]
+    # @return [void]
+    def create(db_name)
+      if adapter.db_exists?(db_name)
+        return failure "#{db_name}' already exist"
+      end
+      adapter.create_database(db_name)
+      success "Database #{db_name} created successfully"
+    end
+
+    # @param text [String, nil]
+    # @return void
+    def message(text)
+      "#{adapter_name.capitalize} :: #{text}"
+    end
+
+    # @param text [String, nil]
+    # @return void
+    def success(text)
+      puts "\e[1m\e[32m#{message(text)}\e[0m\e[0m"
+    end
+
+    # @param text [String, nil]
+    # @return void
+    def failure(text)
+      puts "\e[1m\e[31m#{message(text)}\e[0m\e[0m"
+    end
+
+    # @param text [String, nil]
+    # @return void
+    def regular(text)
+      puts message(text)
+    end
+  end
+end

data/lib/db_vcs/utils.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module Utils
+    class << self
+      # @return [String] current branch name
+      def current_branch
+        `git rev-parse --abbrev-ref HEAD`.chomp
+      end
+
+      # @return [Array<String>] array of local branches names
+      def git_branches
+        `git for-each-ref refs/heads --format='%(refname:short)'`.scan(/[[:graph:]]+/)
+      end
+
+      # Generate db name, based on branch name and environment.
+      # @param environment [String] application's environment name. E.g. "development", "test"
+      # @param branch [String]
+      # @return [String]
+      def db_name(environment, branch)
+        [DbVcs.config.db_basename, environment, branch].map do |str|
+          normalize_db_part(str)
+        end.join("_")
+      end
+
+      # Removes special characters from string that is used as a part of database name
+      # @param str [String]
+      # @return [String]
+      def normalize_db_part(str)
+        str.gsub(/[\W]/, "_")
+      end
+
+      # @param exec [String] a name of executable
+      # @param fallback_exec [String] a name of executable to fallback to if exec was not resolved
+      # @return [String] path to executable
+      def resolve_exec_path(exec, fallback_exec: nil)
+        path = `which #{exec}`.chomp
+        return resolve_exec_path(fallback_exec) if fallback_exec && path.empty?
+
+        path.empty? ? exec : path
+      end
+    end
+  end
+end

data/lib/db_vcs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DbVcs
+  VERSION = "1.0.0"
+end

data/lib/db_vcs.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "json"
+require "yaml"
+require "erb"
+require_relative "db_vcs/config_attributes"
+require_relative "db_vcs/config"
+require_relative "db_vcs/adapter_interface"
+require_relative "db_vcs/adapters/mongo"
+require_relative "db_vcs/adapters/postgres"
+require_relative "db_vcs/utils"
+require_relative "db_vcs/manager"
+require_relative "db_vcs/version"
+
+module DbVcs
+  class Error < StandardError; end
+
+  class << self
+    # @return [DbVcs::Config]
+    def config
+      @config ||= DbVcs::Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def load_config
+      config_path = File.join(Dir.pwd, ".db_vcs.yml")
+      if File.exists?(config_path)
+        config.assign_attributes(YAML.load(ERB.new(File.read(config_path)).result))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: db_vcs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Dzyzenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-20 00:00:00.000000000 Z
+dependencies:
+- !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: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  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'
+- !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: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Have a separate database for each git branch!
+email:
+- ivan.dzyzenko@gmail.com
+executables:
+- db-vcs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".db_vcs.yml.sample"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/start-docker
+- db_vcs.gemspec
+- docker-compose.yml
+- exe/db-vcs
+- lib/db_vcs.rb
+- lib/db_vcs/adapter_interface.rb
+- lib/db_vcs/adapters/mongo.rb
+- lib/db_vcs/adapters/postgres.rb
+- lib/db_vcs/autoconfigure.rb
+- lib/db_vcs/config.rb
+- lib/db_vcs/config_attributes.rb
+- lib/db_vcs/manager.rb
+- lib/db_vcs/utils.rb
+- lib/db_vcs/version.rb
+homepage: https://github.com/intale/db_vcs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/intale/db_vcs
+  source_code_uri: https://github.com/intale/vcs_db/tree/v1.0.0
+  changelog_uri: https://github.com/intale/vcs_db/blob/v1.0.0/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Database versions control.
+test_files: []