sequel_tools 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cedf58b1f6a6ae3c117160b80d67dc480b7e632
-  data.tar.gz: 5475ddb9d818523ae54c1120a2a61e81dfbf778a
+  metadata.gz: 437ee89e0a2b2873e1651f948c8a89fc1a0aedf6
+  data.tar.gz: 4ba17eb0f479f61e39fb02be3caf45598a269115
 SHA512:
-  metadata.gz: 8ec010df4d9227e688cb0fa27ab02050862cefbf0331111a90237801108e0ce8ac53803bc36c65fe4c23384a5b1af7f216b80689841ca843661ac1b3e214fe58
-  data.tar.gz: 69685b37ca21f1c4fcc54273bb304348e125f773182d6a5eee264b1b7aa3260f54f3ce170ee644ffd770ac2c339ed9ea20ab0dd59e73e93cefb015ba46de108b
+  metadata.gz: 3d59d32bc56d2d39f6bf378c7be5713b253162b7f48dbca61f922d23660a5137332a2070b2fec00dccebb6fd25a2a880e6fea8575c347f758f57ce3c99c5d6bd
+  data.tar.gz: 15cce1e67d59678423f000e8ab192e4205726eb2f9939623b8f68eccaf7c80235f19e964a0f367aabc95d4af71b1e0e9e118b6cecbbbcef3666839d57784413b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sequel_tools (0.1.2)
+    sequel_tools (0.1.3)
       sequel
 
 GEM

data/README.md

@@ -50,6 +50,7 @@ base_config = SequelTools.base_config(
   sql_log_level: :debug,
   dump_schema_on_migrate: false, # it's a good idea to enable it for the reference environment
   pg_dump: 'pg_dump', # command used to run pg_dump
+  pg_dump: 'psql', # command used to run psql when calling rake db:shell if adapter is postgres
   db_migrations_location: 'db/migrations',
   schema_location: 'db/migrations/schema.sql',
   seeds_location: 'db/seeds.rb',
@@ -71,6 +72,32 @@ Then you are able to run several tasks (`rake -T` will list all supported):
     rake db:new_migration[migration_name]
     rake db:migrate
     rake dbtest:setup
+    rake dbtest:shell
+
+You may define your own command to open a shell to your database upon the 'db:shell' task.
+PostgreSQL is supported out-of-the-box, but if it wasn't, here's a sample script that would
+get the job done:
+
+```bash
+#!/bin/bash
+
+# name it like ~/bin/opensql for example and give it execution permission
+
+PGDATABASE=$DBNAME
+PGHOST=$DBHOST
+PGPORT=$DBPORT
+PGUSER=$DBUSERNAME
+PGPASSWORD=$DBPASSWORD
+psql
+```
+
+Then you may pass `shell_command: '~/bin/opensql'` to `SequelTools.base_config`.
+
+Alternatively you can define the `shell_#{dbadapter}` action if you prefer. Take a look at
+the implementation for `shell_postgres` to see how to do that. If you want to share that action
+with others you may either submit a pull request to this project or create a separate gem to
+add support for your database to `sequel_tools`, which wouldn't require waiting for me to
+approve your pull requests and you'd be able to maintain it independently.
 
 ## Development and running tests
 

data/lib/sequel_tools.rb

@@ -6,6 +6,7 @@ module SequelTools
   DEFAULT_CONFIG = {
     project_root: nil,
     pg_dump: 'pg_dump', # command used to run pg_dump
+    psql: 'psql', # command used to run psql
     maintenancedb: 'postgres', # DB to connect to for creating/dropping databases
     db_migrations_location: 'db/migrations',
     schema_location: 'db/migrations/schema.sql',

data/lib/sequel_tools/actions/shell.rb

@@ -0,0 +1,33 @@
+# frozen-string-literal: true
+
+require_relative '../actions_manager'
+
+class SequelTools::ActionsManager
+  # TODO: this action is not currently tested automatically as it's not critical and not
+  # trivial to write a test for
+  Action.register :shell, 'Open an interactive shell to the database' do |args, context|
+    begin
+      Action[:connect_db].run({}, context)
+    rescue
+      puts 'Database does not exist - aborting.'
+      exit 1
+    else
+      c = context[:config]
+      if shell_command = c[:shell_command]
+        env = {
+          'DBHOST' => c[:dbhost], 'DBPORT' => c[:dbport].to_s, 'DBUSERNAME' => c[:username],
+          'DBPASSWORD' => c[:password].to_s, 'DBNAME' => c[:dbname]
+        }
+        exec env, shell_command
+      else
+        unless action = Action[:"shell_#{c[:dbadapter]}"]
+          puts "Opening an interactive shell is not currently supported for #{c[:dbadapter]}." +
+               " Aborting"
+          exit 1
+        end
+        action.run({}, context)
+      end
+    end
+  end
+end
+

data/lib/sequel_tools/actions/shell_postgres.rb

@@ -0,0 +1,21 @@
+# frozen-string-literal: true
+
+require_relative '../actions_manager'
+require_relative '../pg_helper'
+
+class SequelTools::ActionsManager
+  # TODO: this action is not currently tested automatically as it's not critical and not
+  # trivial to write a test for
+  Action.register :shell_postgres, nil do |args, context|
+    c = context[:config]
+    psql = c[:psql]
+    env = {
+      'PGDATABASE' => c[:dbname],
+      'PGHOST' => c[:dbhost],
+      'PGPORT' => c[:dbport].to_s,
+      'PGUSER' => c[:username],
+      'PGPASSWORD' => c[:password].to_s,
+    }
+    exec env, psql
+  end
+end

data/lib/sequel_tools/all_actions.rb

@@ -17,3 +17,5 @@ require_relative 'actions/redo'
 require_relative 'actions/version'
 require_relative 'actions/rollback'
 require_relative 'actions/status'
+require_relative 'actions/shell_postgres'
+require_relative 'actions/shell'

data/lib/sequel_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module SequelTools
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
@@ -120,6 +120,8 @@ files:
 - lib/sequel_tools/actions/schema_load.rb
 - lib/sequel_tools/actions/seed.rb
 - lib/sequel_tools/actions/setup.rb
+- lib/sequel_tools/actions/shell.rb
+- lib/sequel_tools/actions/shell_postgres.rb
 - lib/sequel_tools/actions/status.rb
 - lib/sequel_tools/actions/up.rb
 - lib/sequel_tools/actions/version.rb