koine-db_bkp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46f82e70cbe9936dd67098b62a2d60726b4a3de2
-  data.tar.gz: 417e3bf56163661f599e0080387698a649144c79
+  metadata.gz: 9b2e5356b280e6bfb128566c9e83c4eb7d0780fe
+  data.tar.gz: 3c8cbb6454be752f108acf108a55508a2ffa0ab5
 SHA512:
-  metadata.gz: ace6bcc0ef66c0c067ec18caf12cb66cf68d5c2a403bd7dc025d2fb9eb4ca94c0be08aed9115ca2775df60724ebf9a91349d68928c8b1cad304243fa01f6bd46
-  data.tar.gz: e3242f32eafbdb8e5278e6d5fcd2e9640b8dbe91036a021957c5e0c4107434f194e61e3252ba7b94cc7b5e0e2be9b2c887db991698d1ea1106aac633fe9355ff
+  metadata.gz: 742a358cbe09f1edc8913aa114195b1f619656804a6d8b3234ba2c00bf81165ef0121c66d014b57215d6695fd05c4f7d6b15e68926f17d8c3e91dd0808f48ac5
+  data.tar.gz: 3ffa6e5151ea5fde3ac40d6f34d34d43a6ffdbd46c4ded4d105f2fbdb556b5a4f48dadd3b437397f4dcd3793340d4a4fc05475ab618a250c9e5d6a9bdf7dc994

data/README.md

@@ -32,33 +32,45 @@ backup = Koine::DbBkp::Mysql::Dump.new(
 backup.to_sql_file('/bkp/file.sql')
 ```
 
-### MySql on Rails
+### Rake tasks
 
 ```ruby
-require 'koine/db_bkp/mysql/rails_dump'
+# Rakefile
 
-# credentials taken from current Rails.configuration.database_configuration[Rails.env]
-backup = Koine::DbBkp::Mysql::RailsDump.new
-backup.to_sql_file('/bkp/file.sql')
+require "koine/db_bkp"
+
+Koine::Tasks::MysqlDump.new do |t|
+  t.task_name    = 'some_task'     # defaults to 'mysql:dump'
+  t.output_file  = 'backup_{timestamp}.sql' # defaults to ENV['MYSQL_BACKUP_FILE']
+                                            # {timestamp} is a placeholder for the autogenerated timestamp
+
+  # database config
+  t.url          = 'mysql2://username:password@hostname/database_name' # defaults to ENV['DB_URL']
+
+  # or database config
+  t.hostname     = 'hostname'      # defaults to ENV['DB_HOST']
+  t.database     = 'database_name' # defaults to ENV['DB_NAME']
+  t.username     = 'username'      # defaults to ENV['DB_USER']
+  t.password     = 'password'      # defaults to ENV['DB_PASSWORD']
+
+  # rake task dependencies
+  t.dependencies = [:environment] # defaults to []
+end
 ```
 
-### Rake tasks
+#### Rails task
 
 ```ruby
+# Rakefile
+
 require "koine/db_bkp"
 
-import 'lib/koine/tasks/mysql_dump.rake'
-import 'lib/koine/tasks/mysql_rails_dump.rake'
+# same options of Koine::Tasks::RailsMysqlDump apply
+Koine::Tasks::RailsMysqlDump.new
 ```
 
 ```bash
-export DB_HOST=some_host
-export DB_NAME=some_name
-export DB_USER=some_user
-export DB_PASSWORD=some_password
-export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
-
-rake koine:mysql:dump
+rake rake mysql:dump
 ```
 
 ```bash
@@ -66,7 +78,7 @@ rake koine:mysql:dump
 
 export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
 
-rake koine:mysql:rails_dump
+rake mysql:rails_dump
 ```
 
 ## Development

data/Rakefile

@@ -3,8 +3,11 @@ require "rspec/core/rake_task"
 
 require "koine/db_bkp"
 
-import 'lib/koine/tasks/mysql_dump.rake'
-import 'lib/koine/tasks/mysql_rails_dump.rake'
+Koine::Tasks::MysqlDump.new
+
+Koine::Tasks::RailsMysqlDump.new do |t|
+  t.task_name = 'rails:mysql_dump'
+end
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/koine/db_bkp/mysql/dump.rb

@@ -1,12 +1,15 @@
+require 'addressable/uri'
+
 module Koine
   module DbBkp
     module Mysql
       class Dump
         def initialize(config = {})
-          config = config.reject { |_k, v| ['', nil].include?(v) }
+          config = normalize_config(config)
 
-          @hostname = config[:hostname]
+          @hostname = config.fetch(:hostname)
           @database = config.fetch(:database)
+          @username = config[:username]
           @password = config[:password]
           @cli = Cli.new
         end
@@ -15,13 +18,45 @@ module Koine
           parts = ['mysqldump']
 
           parts.push("-h #{@hostname}") if @hostname
+          parts.push("-u #{@username}") if @username
           parts.push("-p#{@password}") if @password
 
           parts.push(@database)
+
+          file = FileName.new(file)
           parts.push("> #{file}")
 
           @cli.execute(parts.join(' '))
         end
+
+        private
+
+        def normalize_config(config)
+          config = config.reject { |_k, v| ['', nil].include?(v) }
+          merge_url(symbolize_keys(config))
+        end
+
+        def merge_url(config)
+          url = config.delete(:url)
+
+          return config unless url
+
+          url = Addressable::URI.parse(url)
+
+          config.merge(
+            adapter: url.scheme,
+            hostname: url.host,
+            database: url.path.split('/').join(''),
+            username: url.user,
+            password: url.password
+          )
+        end
+
+        def symbolize_keys(hash)
+          {}.tap do |new_hash|
+            hash.each { |key, value| new_hash[key.to_sym] = value }
+          end
+        end
       end
     end
   end

data/lib/koine/db_bkp/version.rb

@@ -1,5 +1,5 @@
 module Koine
   module DbBkp
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/koine/db_bkp.rb

@@ -1,6 +1,11 @@
 require 'koine/db_bkp/version'
 
 module Koine
+  module Tasks
+    autoload :MysqlDump, 'koine/tasks/mysql_dump'
+    autoload :RailsMysqlDump, 'koine/tasks/rails_mysql_dump'
+  end
+
   module DbBkp
     autoload :Cli, 'koine/db_bkp/cli'
     autoload :FileName, 'koine/db_bkp/file_name'

data/lib/koine/tasks/mysql_dump.rb

@@ -0,0 +1,60 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Koine
+  module Tasks
+    class MysqlDump < Rake::TaskLib
+      OutputFileNotSetError = Class.new(StandardError)
+
+      attr_accessor :task_name
+      attr_accessor :dependencies
+      attr_accessor :hostname
+      attr_accessor :database
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :url
+      attr_writer :output_file
+
+      def initialize(env: ENV)
+        self.task_name    ||= 'mysql:dump'
+        self.dependencies ||= []
+        self.url          ||= env['DB_URL']
+        self.hostname     ||= env['DB_HOST']
+        self.database     ||= env['DB_NAME']
+        self.username     ||= env['DB_USER']
+        self.password     ||= env['DB_PASSWORD']
+        self.output_file = env['MYSQL_BACKUP_FILE']
+        yield(self) if block_given?
+        define_task
+      end
+
+      def output_file
+        @output_file || raise(OutputFileNotSetError)
+      end
+
+      private
+
+      def define_task
+        desc 'Mysqldump to backup file'
+        task task_name => dependencies do
+          execute_task
+        end
+      end
+
+      def execute_task
+        backup = Koine::DbBkp::Mysql::Dump.new(configuration)
+        backup.to_sql_file(output_file)
+      end
+
+      def configuration
+        {
+          url: url,
+          hostname: hostname,
+          database: database,
+          username: username,
+          password: password
+        }
+      end
+    end
+  end
+end

data/lib/koine/tasks/rails_mysql_dump.rb

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Koine
+  module Tasks
+    class RailsMysqlDump < MysqlDump
+      def initialize(*args)
+        self.dependencies ||= [:environment]
+        super(*args)
+      end
+
+      private
+
+      def configuration
+        config = super.reject { |k, v| v.nil? }
+        rails_config.merge(config)
+      end
+
+      def rails_config
+        env = Rails.env.to_s
+        Rails.configuration.database_configuration[env].symbolize_keys
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koine-db_bkp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marcelo Jacobus
@@ -88,10 +88,9 @@ files:
 - lib/koine/db_bkp/cli.rb
 - lib/koine/db_bkp/file_name.rb
 - lib/koine/db_bkp/mysql/dump.rb
-- lib/koine/db_bkp/mysql/rails_dump.rb
 - lib/koine/db_bkp/version.rb
-- lib/koine/tasks/mysql_dump.rake
-- lib/koine/tasks/mysql_rails_dump.rake
+- lib/koine/tasks/mysql_dump.rb
+- lib/koine/tasks/rails_mysql_dump.rb
 homepage: https://github.com/mjacobus/koine-db_bkp
 licenses:
 - MIT

data/lib/koine/db_bkp/mysql/rails_dump.rb

@@ -1,62 +0,0 @@
-require 'addressable/uri'
-
-module Koine
-  module DbBkp
-    module Mysql
-      class RailsDump
-        def initialize(config = DatabaseConfig.new.to_h)
-          @backup = Dump.new(config)
-        end
-
-        def to_sql_file(file)
-          @backup.to_sql_file(file)
-        end
-
-        class DatabaseConfig
-          InvalidAdapter = Class.new(StandardError)
-          def to_h
-            config = symbolize_keys(database_configuration[env].to_h)
-            config = merge_url(config) if config[:url]
-            assert_adapter(config[:adapter])
-            config
-          end
-
-          def env
-            Rails.env.to_s
-          end
-
-          def database_configuration
-            Rails.configuration.database_configuration
-          end
-
-          private
-
-          def symbolize_keys(hash)
-            {}.tap do |new_hash|
-              hash.each do |key, value|
-                new_hash[key.to_sym] = value
-              end
-            end
-          end
-
-          def merge_url(config)
-            url = config.delete(:url)
-            url = Addressable::URI.parse(url)
-
-            config.merge(
-              adapter: url.scheme,
-              hostname: url.host,
-              database: url.path.split('/').join(''),
-              username: url.user,
-              password: url.password
-            )
-          end
-
-          def assert_adapter(adapter)
-            raise InvalidAdapter unless adapter.to_s =~ /mysql/
-          end
-        end
-      end
-    end
-  end
-end

data/lib/koine/tasks/mysql_dump.rake

@@ -1,26 +0,0 @@
-require 'rake'
-
-namespace :koine do
-  namespace :mysql do
-    desc 'mysqldump to backup file'
-    task :dump do
-
-      hostname = ENV.fetch('DB_HOST')
-      database = ENV.fetch('DB_NAME')
-      username = ENV.fetch('DB_USER')
-      password = ENV.fetch('DB_PASSWORD') { nil }
-      file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
-
-      file_pattern = file
-
-      backup = Koine::DbBkp::Mysql::Dump.new(
-        hostname: hostname,
-        database: database,
-        username: username,
-        password: password,
-      )
-
-      backup.to_sql_file(file)
-    end
-  end
-end

data/lib/koine/tasks/mysql_rails_dump.rake

@@ -1,13 +0,0 @@
-require 'rake'
-
-namespace :koine do
-  namespace :mysql do
-    desc 'mysqldump to backup file from rails database'
-    task rails_dump: [:environment] do
-      file_pattern = ENV.fetch('MYSQL_BACKUP_FILE')
-      file_pattern = file
-
-      Koine::DbBkp::Mysql::RailsDump.new.to_sql_file(file)
-    end
-  end
-end