osmosis 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a003b88c32b0dcd67c6ef409c0ac5c560d923882faa7436123f21a642e6def5
-  data.tar.gz: f81d8284cda6f0cd05f64c25ca3eb5aef1bf700ffe2932aed84604017ceb9ef5
+  metadata.gz: 1c32c42fe854c9f29544cb890cc72db30bfb01d705fcd81bf0be4ce011b20881
+  data.tar.gz: 2f4a60dd5df8ebad2577f8a04f44532a6b9c67f80ba425915d0c9062b9ae0329
 SHA512:
-  metadata.gz: 74e79675ce1f5575c27a4972d9f48732e4d02d90710c71705b73ce0c50fe392da830d428a6889e0fc866a0b596b7fda5ec9faafe053bf27e9e74c07ee890de98
-  data.tar.gz: d53f62ee450a0746bd36f523df58eeafb4039f2247a627dff92ccc14c4f8d78171cfef3dde806147c0f179b4a8dcada243ebce3a16ebf3014cdad84d28849e2f
+  metadata.gz: 3a6e583c73707be4c9ce5f2524515fdf2bbc02173862a8f28c2ef538a5bdd7451ab6210907587f433f754948db3ff284183b17e55d2b6a3366d84f5d22e56085
+  data.tar.gz: 4f1e5458d0e5079ffa823f8b8bba4363033f788a646750245342561b157b294db412d9bf4a571b2721c29956ad29752ebf9666a1f4c3d92cad0ae25d311267d7

data/README.md

@@ -16,9 +16,21 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 Osmosis provides you with different rake tasks that simplify the management of your database.
 
-### Database restore
+### Database import
 
+The import command takes the `.dump` file provided and restores it to the PostgreSQL database. Any pre-existing data is dropped.
 
+```bash
+bundle exec rails db:import <filename>
+```
+
+### Database export
+
+The export command exports the PostgreSQL database into a `.dump` file. If the file already exists, it is overwritten.
+
+```bash
+bundle exec rails db:export <filename>
+```
 
 ## Development
 
@@ -28,7 +40,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/osmosis.
+Bug reports and pull requests are welcome on GitHub at https://github.com/code-fabrik/osmosis.
 
 ## License
 

data/lib/osmosis/command.rb

@@ -1,35 +1,51 @@
+require 'expect'
 require 'ostruct'
+require 'pty'
 
 module Osmosis
   class Command
-    def self.restore(argv)
-      files = Dir.glob("./*.dump")
-      case files.size
-      when 0
-        return [
-          OpenStruct.new(type: :print, command: "No backups found for *.dump")
-        ]
-      when 1
-        file = files.first
-        host = ActiveRecord::Base.connection_db_config.host
-        database = ActiveRecord::Base.connection_db_config.database
-        username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]
-        password = ActiveRecord::Base.connection_db_config.configuration_hash[:password]
-        cmd = "PGPASSWORD=#{password} pg_restore -U #{username} -h #{host} -d #{database} -cO --if-exists -w < #{file}"
-        Rake::Task["db:drop"].invoke
-        Rake::Task["db:create"].invoke
-        return [
-          OpenStruct.new(type: :rake, command: 'db:drop'),
-          OpenStruct.new(type: :rake, command: 'db:create'),
-          OpenStruct.new(type: :cmd, command: cmd),
-          OpenStruct.new(type: :print, command: "Restored database '#{database}'"),
-        ]
-      else
-        return [
-          OpenStruct.new(type: :print, command: "Too many backups found for *.dump:"),
-          OpenStruct.new(type: :print, command: ' ' + files.join("\n ")),
-        ]
+    def self.import(argv)
+      file = argv[0]
+      if file.nil?
+        return [OpenStruct.new(type: :print, command: "Please provide a filename parameter: rails db:import <filename>")]
       end
+      if !File.exist?(file)
+        return [OpenStruct.new(type: :print, command: "File #{file} does not exist")]
+      end
+      host = ActiveRecord::Base.connection_db_config.host
+      database = ActiveRecord::Base.connection_db_config.database
+      username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]
+      password = ActiveRecord::Base.connection_db_config.configuration_hash[:password]
+      cmd = "PGPASSWORD=#{password} pg_restore -U #{username} -h #{host} -d #{database} -cO --if-exists -w < #{file}"
+      return [
+        OpenStruct.new(type: :rake, command: 'db:drop'),
+        OpenStruct.new(type: :rake, command: 'db:create'),
+        OpenStruct.new(type: :cmd, command: cmd),
+        OpenStruct.new(type: :print, command: "Imported database '#{database}'"),
+      ]
+    end
+
+    def self.export(argv)
+      file = argv[0]
+      if file.nil?
+        return [OpenStruct.new(type: :print, command: "Please provide a filename parameter: rails db:export <filename>")]
+      end
+      host = ActiveRecord::Base.connection_db_config.host
+      database = ActiveRecord::Base.connection_db_config.database
+      username = ActiveRecord::Base.connection_db_config.configuration_hash[:username]
+      password = ActiveRecord::Base.connection_db_config.configuration_hash[:password]
+      cmd = "PGPASSWORD=#{password} pg_dump -Fc --no-acl --no-owner -h #{host} -U #{username} -w #{database} > #{file}"
+      return [
+        OpenStruct.new(type: :cmd, command: cmd),
+        OpenStruct.new(type: :print, command: "Exported database '#{database}'"),
+      ]
+    end
+
+    def self.connect(argv)
+      cmd = "PGPASSWORD=#{password} psql -U #{username} -h #{host} -d #{database}"
+      return [
+        OpenStruct.new(type: :pty, command: cmd)
+      ]
     end
 
     def self.run(commands)
@@ -40,6 +56,25 @@ module Osmosis
           system cmd.command
         elsif cmd.type == :print
           puts cmd.command
+        elsif cmd.type == :pty
+          PTY.spawn(cmd.command) do |stdout, stdin, pid|
+            trap("INT") { Process.kill("INT", pid) }
+
+            begin
+              loop do
+                # Read output from psql
+                stdout.each { |line| puts line}
+
+                # Check if there's any input from the user
+                if IO.select([STDIN], nil, nil, 0.1)
+                  user_input = STDIN.gets.chomp
+                  stdin.puts user_input
+                end
+              end
+            rescue Errno::EIO
+              puts "psql session ended"
+            end
+          end
         else
           raise StandardError, "Unknown command type #{cmd.type}"
         end

data/lib/osmosis/tasks/db/connect.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  desc "Connects to the application database"
+  task connect: :environment do
+    commands = Osmosis::Command.connect(ARGV)
+    ARGV.clear
+    Osmosis::Command.run(commands)
+  end
+end

data/lib/osmosis/tasks/db/export.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  desc "Exports a database to a backup"
+  task import: :environment do
+    commands = Osmosis::Command.export(ARGV)
+    ARGV.clear
+    Osmosis::Command.run(commands)
+  end
+end

data/lib/osmosis/tasks/db/import.rake

@@ -0,0 +1,8 @@
+namespace :db do
+  desc "Imports a database from a backup"
+  task import: :environment do
+    commands = Osmosis::Command.import(ARGV)
+    ARGV.clear
+    Osmosis::Command.run(commands)
+  end
+end

data/lib/osmosis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Osmosis
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osmosis
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Lukas_Skywalker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies: []
 description: This powerful database utility library simplifies and automates common
   database tasks, including exports, imports, and data migrations. With its intuitive
@@ -28,7 +28,9 @@ files:
 - lib/osmosis.rb
 - lib/osmosis/command.rb
 - lib/osmosis/railtie.rb
-- lib/osmosis/tasks/db/restore.rake
+- lib/osmosis/tasks/db/connect.rake
+- lib/osmosis/tasks/db/export.rake
+- lib/osmosis/tasks/db/import.rake
 - lib/osmosis/version.rb
 - sig/osmosis.rbs
 homepage: https://github.com/code-fabrik/osmosis

data/lib/osmosis/tasks/db/restore.rake

@@ -1,7 +0,0 @@
-namespace :db do
-  desc "Restores the database from a backup"
-  task restore: :environment do
-    commands = Osmosis::Command.restore(ARGV)
-    Osmosis::Command.run(commands)
-  end
-end