sequel_tools 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd0f583b78b874b3cfc1701a277ef182b184c66f
-  data.tar.gz: 980bc39cff7f7af9fcad83b4cd655d59aca0b3c3
+SHA256:
+  metadata.gz: 63dc5d382e886ba9dab8842c1541baf6b152b44ca2f9c063197ea8203246e9b7
+  data.tar.gz: 4c26c7e3e0959e32a806fa24839f7bcea96e2aafabe75e4b99d986537a290ec2
 SHA512:
-  metadata.gz: 912e0711195c5f895b40807d6013e899d6767f878438e2b4b173f910304e69928bf64da3c5c10db3d3ed12a9c768eb362fee42dc1b8726090278553fb86c4534
-  data.tar.gz: 55bfdf355d5f590e1d6ee16bd2096dce9c686ecbff614335928c96e08bb5477d1539542a1e0860919fc79ba59008c88b5d620f02522ed0d6b3aa1b9f2d1609c2
+  metadata.gz: 65a1d13e7afa10701999bb0952f0a47c71c541ca488e086ac3de1a0b53b2eb5483e5cb8275e4320f2bdc57e9980316bfd076dab3880e7cf719227f48df42b3bf
+  data.tar.gz: 5cac6fb94dd0146acf742765bb0a4bf57421e221a2a54cbf1f150af1938a0278249a6ff981af962a7a0b4b9be4d8e301e685d88becea245913bbc16e9e201428

data/.gitignore

@@ -10,6 +10,7 @@
 /spec/sample_project/db/seeds.rb
 /spec/sample_project/bin/bundle
 /spec/sample_project/bin/sequel
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.rvmrc

@@ -0,0 +1,2 @@
+# fix warnings in Travis CI build caused by RVM using the -client option in JRUBY_OPTS
+unset JRUBY_OPTS

data/.travis.yml

@@ -1,6 +1,7 @@
 sudo: true
 language: ruby
 rvm:
-  - 2.4.1
+  - 3.0.1
+  #- jruby-9.2.17.0
 before_install: scripts/ci/travis-build.sh
 #before_install: gem install bundler -v 1.16.0

data/README.md

@@ -21,6 +21,11 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'sequel_tools'
+gem 'rake'
+
+# For PostgreSQL:
+gem 'pg', platform: :mri
+gem 'jdbc-postgres', platform: :jruby
 ```
 
 And then execute:
@@ -54,7 +59,10 @@ base_config = SequelTools.base_config(
   migrations_location: 'db/migrations',
   schema_location: 'db/migrations/schema.sql',
   seeds_location: 'db/seeds.rb',
-  maintenancedb: 'postgres' # for tasks such as creating the database
+  # for tasks such as creating the database:
+  # when nil, defaults to the value of the :dbadapter config.
+  # This is the database we should connect to before executing "create database dbname"
+  maintenancedb: :default,
 )
 
 namespace 'db' do
@@ -71,8 +79,29 @@ Then you are able to run several tasks (`rake -T` will list all supported):
     rake db:create
     rake db:new_migration[migration_name]
     rake db:migrate
+    # setup creates the database, loads the latest schema
+    # and import seeds when available
     rake dbtest:setup
-    rake dbtest:shell
+    # reset drops (if existing) then recreate the database, run all migrations
+    # and import seeds when available
+    rake dbtest:reset
+    # shell opens a psql section to the database for the PostgreSQL adapter
+    rake db:shell
+    # irb runs "bundle exec sequel" pointing to the database and stores the connection in "DB"
+    rake db:irb
+    rake db:rollback
+    rake db:status
+    # version displays latest applied migration
+    rake db:version
+    rake db:seed
+    rake db:redo[migration_filename]
+    rake db:down[migration_filename]
+    rake db:up[migration_filename]
+    # schema_dump is called automatically after migrate/rollback/up/down/redo
+    # if passing { dump_schema_on_migrate: true } to the config
+    rake db:schema_dump
+    # database must be empty before calling db:schema_load
+    rake db:schema_load
 
 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

data/lib/sequel_tools.rb

@@ -7,7 +7,7 @@ module SequelTools
     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
+    maintenancedb: :default, # DB to connect to for creating/dropping databases
     migrations_location: 'db/migrations',
     schema_location: 'db/migrations/schema.sql',
     seeds_location: 'db/seeds.rb',
@@ -20,6 +20,7 @@ module SequelTools
     dump_schema_on_migrate: false,
     log_level: nil,
     sql_log_level: :debug,
+    migrations_table: nil,
   } # unfrozen on purpose so that one might want to update the defaults
 
   REQUIRED_KEYS = [ :project_root, :dbadapter, :dbname, :username ]
@@ -42,4 +43,15 @@ module SequelTools
     actions_manager.load_all
     actions_manager.export_as_rake_tasks rake_context
   end
+
+  def self.suppress_java_output
+    return yield unless RUBY_PLATFORM == 'java'
+    require 'java'
+    require 'stringio'
+    old_err = java.lang.System.err
+    java.lang.System.err = java.io.PrintStream.new(StringIO.new.to_outputstream)
+    yield
+  ensure
+    java.lang.System.err = old_err if RUBY_PLATFORM == 'java'
+  end
 end

data/lib/sequel_tools/actions/before_task.rb

@@ -0,0 +1,17 @@
+# frozen-string-literal: true
+
+require_relative '../actions_manager'
+
+SequelTools::ActionsManager::Action.register :before_task, nil do |args, context|
+  config = context[:config]
+  adapter = config[:dbadapter]
+  action = context[:current_action]
+  hooks = [:before_any, :"before_#{action.name}", :"before_any_#{adapter}",
+    :"before_#{action.name}_#{adapter}"]
+  hooks.each do |h|
+    next unless a = SequelTools::ActionsManager::Action[h]
+    a.run args, context
+    context[:"#{h}_processed"] = true
+  end
+  config[:maintenancedb] = adapter if context[:maintenancedb] == :default
+end

data/lib/sequel_tools/actions/connect_db.rb

@@ -7,7 +7,9 @@ require_relative '../sequel_tools_logger'
 SequelTools::ActionsManager::Action.register :connect_db, nil do |args, context|
   next if context[:db]
   config = context[:config]
-  context[:db] = db = Sequel.connect context[:uri_builder].call config
+  context[:db] = db = SequelTools.suppress_java_output do
+    Sequel.connect context[:uri_builder].call(config), test: true
+  end
   db.sql_log_level = config[:sql_log_level]
   db.log_connection_info = false
   next unless log_level = config[:log_level]

data/lib/sequel_tools/actions/irb.rb

@@ -3,12 +3,18 @@
 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
   description = "Opens an IRB session started as 'sequel uri_to_database' (DB is available to irb)"
   Action.register :irb, description do |args, context|
-    config = context[:config]
-    uri = context[:uri_builder][config]
-    exec "bundle exec sequel #{uri}"
+    # This code does the job, but for some reason the test will timeout under JRuby
+    #config = context[:config]
+    #uri = context[:uri_builder][config]
+    #exec "bundle exec sequel #{uri}"
+
+    Action[:connect_db].run({}, context)
+    require 'irb'
+    ::DB = context[:db]
+    ARGV.clear
+    puts 'Your database is stored in DB...'
+    IRB.start
   end
 end

data/lib/sequel_tools/actions/migrate.rb

@@ -12,6 +12,7 @@ class SequelTools::ActionsManager
     Sequel.extension :migration unless Sequel.respond_to? :migration
     options = {}
     options[:target] = args[:version].to_i if args[:version]
+    options[:table] = config[:migrations_table] if config[:migrations_table]
     Sequel::Migrator.run db, config[:migrations_location], options
     Action[:schema_dump].run({}, context) if config[:dump_schema_on_migrate]
   end

data/lib/sequel_tools/actions/postgresql_support.rb

@@ -0,0 +1,14 @@
+# frozen-string-literal: true
+
+require_relative '../actions_manager'
+require_relative 'schema_dump_postgres'
+require_relative 'shell_postgres'
+
+class SequelTools::ActionsManager
+  Action.register :before_any_postgres, nil do |args, context|
+    next if context[:before_any_postgres_processed]
+    config = context[:config]
+    config[:maintenancedb] = 'postgres' if config[:maintenancedb] == :default
+    config[:jdbc_adapter] = 'postgresql' if RUBY_PLATFORM == 'java'
+  end
+end

data/lib/sequel_tools/actions/schema_load.rb

@@ -16,7 +16,8 @@ class SequelTools::ActionsManager
         puts "Schema file '#{schema_location}' does not exist. Aborting."
         exit 1
       end
-      context[:db] << File.read(schema_location)
+      context[:db].run File.read(schema_location)
+      context[:db].disconnect # forces reconnection
     end
   end
 end

data/lib/sequel_tools/actions/shell.rb

@@ -3,8 +3,6 @@
 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)

data/lib/sequel_tools/actions/shell_postgres.rb

@@ -3,8 +3,6 @@
 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_postgres, nil do |args, context|
     c = context[:config]
     psql = c[:psql]

data/lib/sequel_tools/actions_manager.rb

@@ -6,15 +6,16 @@ module SequelTools
 
     URI_BUILDER = ->(config, dbname = config[:dbname]) do
       c = config
-      uri_parts = [ "#{c[:dbadapter]}://" ]
-      if user = c[:username]
-        uri_parts << user
-        uri_parts << ':' << c[:password] if c[:password]
-        uri_parts << '@'
-      end
+      uri_parts = []
+      uri_parts << 'jdbc:' if RUBY_PLATFORM == 'java'
+      uri_parts << "#{c[:jdbc_adapter] || c[:dbadapter]}://"
       uri_parts << c[:dbhost]
       uri_parts << ':' << c[:dbport] if c[:dbport]
       uri_parts << '/' << dbname
+      if user = c[:username]
+        uri_parts << '?user=' << user
+        uri_parts << '&password=' << c[:password] if c[:password]
+      end
       uri_parts.join('')
     end
 
@@ -33,6 +34,9 @@ module SequelTools
         rake_context.instance_eval do
           desc action.description unless action.description.nil?
           task action.name, action.arg_names do |t, args|
+            require_relative 'actions/before_task'
+            ctx[:current_action] = action
+            Action[:before_task].run args, ctx
             action.run args, ctx
           end
         end

data/lib/sequel_tools/all_actions.rb

@@ -3,7 +3,6 @@
 require_relative 'actions/connect_db'
 require_relative 'actions/create_db'
 require_relative 'actions/drop_db'
-require_relative 'actions/schema_dump_postgres'
 require_relative 'actions/schema_dump'
 require_relative 'actions/schema_load'
 require_relative 'actions/new_migration'
@@ -17,6 +16,6 @@ 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'
 require_relative 'actions/irb'
+require_relative 'actions/postgresql_support'

data/lib/sequel_tools/migration_utils.rb

@@ -22,6 +22,7 @@ class MigrationUtils
     options = { allow_missing_migration_files: true }
     options[:target] = 0 if direction == :down
     config = context[:config]
+    options[:table] = config[:migrations_table] if config[:migrations_table]
     Sequel::Migrator.migrator_class(config[:migrations_location]).
       new(context[:db], config[:migrations_location], options)
   end

data/lib/sequel_tools/version.rb

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

data/sequel_tools.gemspec

@@ -32,7 +32,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'sequel'
-  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'pg' unless RUBY_PLATFORM == 'java'
+  spec.add_development_dependency 'jdbc-postgres' if RUBY_PLATFORM == 'java'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -97,15 +97,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rvmrc"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/sequel_tools.rb
+- lib/sequel_tools/actions/before_task.rb
 - lib/sequel_tools/actions/connect_db.rb
 - lib/sequel_tools/actions/create_db.rb
 - lib/sequel_tools/actions/down.rb
@@ -113,6 +114,7 @@ files:
 - lib/sequel_tools/actions/irb.rb
 - lib/sequel_tools/actions/migrate.rb
 - lib/sequel_tools/actions/new_migration.rb
+- lib/sequel_tools/actions/postgresql_support.rb
 - lib/sequel_tools/actions/redo.rb
 - lib/sequel_tools/actions/reset.rb
 - lib/sequel_tools/actions/rollback.rb
@@ -153,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Add Rake tasks to manage Sequel migrations

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sequel_tools (0.1.4)
-      sequel
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    pg (0.21.0)
-    rake (12.3.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    sequel (5.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  pg
-  rake
-  rspec
-  sequel_tools!
-
-BUNDLED WITH
-   1.16.0