db_vcs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad87a4ce6a39d924dfd4b7df99393d0379511b6034f38ef10be59e091b0bf847
-  data.tar.gz: 01d1173505e38a6abc7e9cceef3541fc13e338e4f90c0020e9b5f3ce35d452ea
+  metadata.gz: f22df6cac64b23c5396db8e1ba55b640b7a4fd5ffc2a55d8f05a7185985ba067
+  data.tar.gz: 0610b51b4a5ca2025eb8f76b1df56ed12ad4c802be3cbd99a9b00167a6456108
 SHA512:
-  metadata.gz: 6a90671b45f5d4c0069c01a37722f2224a0e655b3c3907a90cc255e2114f087e23d3c53a135b21fe6821ae188240f8f4cf9c52deb1416fb73c81dde74037ed39
-  data.tar.gz: 1952c97adeeb2134ed06b4ecde8036a3ed6adedee0634bf281e1e28a6fda120aa416e1707a3ddd8cd75a7d43fd4929e93290d8a19e6fdc267f9866209dd83c01
+  metadata.gz: fb51601226cb01d431ec76cfb76d527f5bd4e28134c8c3a075d588ecd1643b81cbdb5adacf4a50af2deded09abb43fe27c2e7e28aa571446091c53dc3f59649f
+  data.tar.gz: fec6984d43ddbbdafb389153b69d8f2a14139382bcba0debc3ad52e18e6520fd0410ca5743b6f286de1eb52c56d676565269da38b961f0e099d0d3bc0cf34948

data/.db_vcs.yml.sample

@@ -3,6 +3,9 @@ pg_config:
   port: 5532
 mongo_config:
   mongo_uri: "mongodb://localhost:28017"
+mysql_config:
+  username: root
+  port: 3406
 dbs_in_use:
   <% DbVcs::Manager::ADAPTERS.keys.each do |adapter_name| %>
   - <%= adapter_name %>

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
   Nothing new yet
 
+## [1.1.0] - 2022-01-27
+
+- Add support of MySQL
+
 ## [1.0.0] - 2022-01-04
 
 - Initial release

data/README.md

@@ -50,13 +50,22 @@ 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
+mysql_config: # Configuration of MySQL
+  host: 127.0.0.1
+  port: '3306'
+  username: root
+  password: root
+  mysqldump_path: "/path/to/mysqldump" # resolved automatically using which util. Override it otherwise
+  mysql_path: "/path/to/mysql" # resolved automatically using which util. Override it otherwise
 ```
 
 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 MongoDB - you need to have [MongoDB Database Tools](https://docs.mongodb.com/database-tools/) installed. You can have it as docker container - just make sure to adjust "mongodump_path" and "mongorestore_path" options in configuration file
 - to be able to use PostgreSQL - you need to have "pg" gem installed 
+- to be able to use MySQL - you need to have "mysql2" gem installed 
+- to be able to use MySQL - you need to have `mysql` and `mysqldump` utils installed. You can have it as docker container - just make sure to adjust "mysqldump_path" and "mysql_path" options in configuration file
 
 ## Usage
 
@@ -137,7 +146,7 @@ Example of file's content:
 # 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 db-vcs check # or "bundle exec db-vcs create" if you want to create databases automatically on checkout
     bundle exec pumactl -C config/puma.rb restart
 fi
 ```

data/bin/start-docker

@@ -7,9 +7,16 @@ 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
+mysql_port = DbVcs.config.mysql_config.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",
+  {
+    "PGUSER" => pg_user.to_s,
+    "PG_PORT" => pg_port.to_s,
+    "MONGO_PORT" => mongo_port.to_s,
+    "MYSQL_PORT" => mysql_port.to_s
+  },
+  "docker-compose up 1>&2",
   close_others: true
 )
 Process.waitpid(pid)

data/db_vcs.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "pg", "~> 1.2"
   spec.add_development_dependency "mongo", "~> 2.17"
+  spec.add_development_dependency "mysql2", "~> 0.5.3"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-its", "~> 1.3"
   spec.add_development_dependency "fivemat", "~> 1.3"

data/docker-compose.yml

@@ -18,6 +18,15 @@ services:
     ports:
       - ${MONGO_PORT}:27017
 
+  mysql:
+    image: mysql:latest
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=true
+    volumes:
+      - mysql_db:/var/lib/mysql
+    ports:
+      - ${MYSQL_PORT}:3306
 volumes:
   mongo_db:
   pg_db:
+  mysql_db:

data/lib/db_vcs/adapters/mysql.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module DbVcs
+  module Adapters
+    class Mysql
+      class Config
+        include DbVcs::ConfigAttributes
+
+        attr_accessor :host, :port, :username, :password
+        # Path to mysqldump util. It is resolved automatically.
+        attr_accessor :mysqldump_path
+        # Path to mysql util. It is resolved automatically.
+        attr_accessor :mysql_path
+
+        def initialize
+          @host = "127.0.0.1"
+          @port = "3306"
+          @username = "root"
+          @password = nil
+          @mysqldump_path = DbVcs::Utils.resolve_exec_path("mysqldump")
+          @mysql_path = DbVcs::Utils.resolve_exec_path("mysql")
+        end
+      end
+
+      class << self
+        include DbVcs::AdapterInterface
+
+        # @return [DbVcs::Adapters::Mysql::Config]
+        def config
+          DbVcs.config.mysql_config
+        end
+
+        # @return [Mysql2::Client]
+        def connection
+          @connection ||=
+            begin
+              require "mysql2"
+              Mysql2::Client.new(
+                host: config.host,
+                username: config.username,
+                port: config.port,
+                password: config.password
+              )
+            end
+        end
+
+        # @param db_name [String]
+        # @return [Boolean]
+        def db_exists?(db_name)
+          !connection
+             .query("SELECT 1 as one FROM `INFORMATION_SCHEMA`.`SCHEMATA` WHERE `SCHEMA_NAME` = '#{db_name}' LIMIT 1")
+             .first.nil?
+        end
+
+        # @param to_db [String]
+        # @param from_db [String]
+        # @return void
+        def copy_database(to_db, from_db)
+          create_opts =
+            connection.query(<<~SQL).first
+              SELECT `DEFAULT_CHARACTER_SET_NAME` as charset, `DEFAULT_COLLATION_NAME` as collation
+              FROM `INFORMATION_SCHEMA`.`SCHEMATA` WHERE `SCHEMA_NAME` = '#{from_db}' LIMIT 1
+            SQL
+          connection.query(<<~SQL)
+            CREATE DATABASE #{to_db} CHARACTER SET #{create_opts["charset"]} COLLATE #{create_opts["collation"]}
+          SQL
+          password_opt = config.password.to_s.strip.empty? ? "" : "-p #{config.password}"
+          command =
+            <<~SH
+            #{config.mysqldump_path} -u #{config.username} #{password_opt} -h #{config.host} -P #{config.port} #{from_db} \
+            | #{config.mysql_path} -u #{config.username} #{password_opt} -h #{config.host} -P #{config.port} #{to_db}
+          SH
+          `#{command}`
+        end
+
+        # @param db_name [String]
+        # @return void
+        def create_database(db_name)
+          connection.query("CREATE DATABASE #{db_name}")
+        end
+
+        # @return [Array<String>]
+        def list_databases
+          connection.query("SELECT `SCHEMA_NAME` FROM `INFORMATION_SCHEMA`.`SCHEMATA`").to_a.flat_map(&:values)
+        end
+
+        # @param db_name [String]
+        # @return [void]
+        def drop_by_dbname(db_name)
+          connection.query("DROP DATABASE #{db_name}")
+        end
+      end
+    end
+  end
+end

data/lib/db_vcs/config.rb

@@ -12,7 +12,7 @@ module DbVcs
     # available values. Defaults to empty array.
     attr_accessor :dbs_in_use
     # Configuration of dbs clients.
-    attr_reader :pg_config, :mongo_config
+    attr_reader :pg_config, :mongo_config, :mysql_config
     # A name of branch to be used as a default branch to copy databases from.
     attr_accessor :main_branch
 
@@ -23,6 +23,7 @@ module DbVcs
       @main_branch = "main"
       @pg_config = DbVcs::Adapters::Postgres::Config.new
       @mongo_config = DbVcs::Adapters::Mongo::Config.new
+      @mysql_config = DbVcs::Adapters::Mysql::Config.new
     end
 
     # @param hash [Hash]
@@ -36,5 +37,11 @@ module DbVcs
     def mongo_config=(hash)
       mongo_config.assign_attributes(hash)
     end
+
+    # @param hash [Hash]
+    # @return [void]
+    def mysql_config=(hash)
+      mysql_config.assign_attributes(hash)
+    end
   end
 end

data/lib/db_vcs/manager.rb

@@ -2,7 +2,11 @@
 
 module DbVcs
   class Manager
-    ADAPTERS = { "postgres" => DbVcs::Adapters::Postgres, "mongo" => DbVcs::Adapters::Mongo }.freeze
+    ADAPTERS = {
+      "postgres" => DbVcs::Adapters::Postgres,
+      "mongo" => DbVcs::Adapters::Mongo,
+      "mysql" => DbVcs::Adapters::Mysql
+    }.freeze
 
     class << self
       # @param adapter_name [String]

data/lib/db_vcs/version.rb

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

data/lib/db_vcs.rb

@@ -8,6 +8,7 @@ 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/adapters/mysql"
 require_relative "db_vcs/utils"
 require_relative "db_vcs/manager"
 require_relative "db_vcs/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_vcs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +149,7 @@ files:
 - lib/db_vcs.rb
 - lib/db_vcs/adapter_interface.rb
 - lib/db_vcs/adapters/mongo.rb
+- lib/db_vcs/adapters/mysql.rb
 - lib/db_vcs/adapters/postgres.rb
 - lib/db_vcs/autoconfigure.rb
 - lib/db_vcs/config.rb
@@ -148,8 +163,8 @@ licenses:
 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
+  source_code_uri: https://github.com/intale/vcs_db/tree/v1.1.0
+  changelog_uri: https://github.com/intale/vcs_db/blob/v1.1.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: