sequel_tools 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 437ee89e0a2b2873e1651f948c8a89fc1a0aedf6
-  data.tar.gz: 4ba17eb0f479f61e39fb02be3caf45598a269115
+SHA256:
+  metadata.gz: 17bb9b0da66eb5b99c648c41d902e56e2cb93348d7a1b50d6ab447bfab0cabe8
+  data.tar.gz: 2c066a0179cd2a67127cca5812cc37abb40b02b63ceef28186376540ec2798fc
 SHA512:
-  metadata.gz: 3d59d32bc56d2d39f6bf378c7be5713b253162b7f48dbca61f922d23660a5137332a2070b2fec00dccebb6fd25a2a880e6fea8575c347f758f57ce3c99c5d6bd
-  data.tar.gz: 15cce1e67d59678423f000e8ab192e4205726eb2f9939623b8f68eccaf7c80235f19e964a0f367aabc95d4af71b1e0e9e118b6cecbbbcef3666839d57784413b
+  metadata.gz: b3f10ee727d2b6ae3b8a3b7c0ead5947817fa6f6b9238d3c7708553534936c303bd09665a45519ff4b6cf0041f64c348b5eb117267d22b24b814cb21c8f33057
+  data.tar.gz: 65493ac56d38975f0857a0db28007fd06036c668a035e7de6e1694902025ea2df77d4b6b3e0f82a18115cf77684cd6451035a3d7c71174296b98ef4987be928a

data/.gitignore

@@ -8,6 +8,9 @@
 /tmp/
 /spec/sample_project/db/migrations/
 /spec/sample_project/db/seeds.rb
+/spec/sample_project/bin/bundle
+/spec/sample_project/bin/sequel
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -2,5 +2,6 @@ sudo: true
 language: ruby
 rvm:
   - 2.4.1
+  - jruby-9.1.9.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:
@@ -51,10 +56,13 @@ base_config = SequelTools.base_config(
   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',
+  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,8 +7,8 @@ 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
-    db_migrations_location: 'db/migrations',
+    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',
     dbname: nil,
@@ -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 ]
@@ -29,7 +30,7 @@ module SequelTools
     REQUIRED_KEYS.each do |key|
       raise MissingConfigError, "Expected value for #{key} config is missing" if config[key].nil?
     end
-    [:db_migrations_location, :schema_location, :seeds_location].each do |k|
+    [:migrations_location, :schema_location, :seeds_location].each do |k|
       config[k] = File.expand_path config[k], config[:project_root]
     end
     config
@@ -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

@@ -0,0 +1,20 @@
+# frozen-string-literal: true
+
+require_relative '../actions_manager'
+
+class SequelTools::ActionsManager
+  description = "Opens an IRB session started as 'sequel uri_to_database' (DB is available to irb)"
+  Action.register :irb, description do |args, context|
+    # 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,7 +12,8 @@ class SequelTools::ActionsManager
     Sequel.extension :migration unless Sequel.respond_to? :migration
     options = {}
     options[:target] = args[:version].to_i if args[:version]
-    Sequel::Migrator.run db, config[:db_migrations_location], options
+    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
 end

data/lib/sequel_tools/actions/new_migration.rb

@@ -7,7 +7,7 @@ class SequelTools::ActionsManager
   Action.register :new_migration, desc, arg_names: [ :name ] do |args, context|
     (puts 'Migration name is missing - aborting'; exit 1) unless name = args[:name]
     require 'time'
-    migrations_path = context[:config][:db_migrations_location]
+    migrations_path = context[:config][:migrations_location]
     filename = "#{migrations_path}/#{Time.now.strftime '%Y%m%d%H%M%S'}_#{name}.rb"
     File.write filename, <<~MIGRATIONS_TEMPLATE_END
       # documentation available at http://sequel.jeremyevans.net/rdoc/files/doc/migration_rdoc.html

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

@@ -1,11 +1,8 @@
 # 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]

data/lib/sequel_tools/actions/status.rb

@@ -8,7 +8,7 @@ class SequelTools::ActionsManager
   description = 'Show migrations status (applied and missing in migrations path vs unapplied)'
   Action.register :status, description do |args, context|
     unapplied, files_missing = MigrationUtils.migrations_differences context
-    path = context[:config][:db_migrations_location]
+    path = context[:config][:migrations_location]
     unless files_missing.empty?
       puts "The following migrations were applied to the database but can't be found in #{path}:"
       puts files_missing.map{|fn| "  - #{fn}" }.join("\n")

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,5 +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,8 +22,9 @@ class MigrationUtils
     options = { allow_missing_migration_files: true }
     options[:target] = 0 if direction == :down
     config = context[:config]
-    Sequel::Migrator.migrator_class(config[:db_migrations_location]).
-      new(context[:db], config[:db_migrations_location], options)
+    options[:table] = config[:migrations_table] if config[:migrations_table]
+    Sequel::Migrator.migrator_class(config[:migrations_location]).
+      new(context[:db], config[:migrations_location], options)
   end
 
   def self.current_version(context)
@@ -32,7 +33,7 @@ class MigrationUtils
   end
 
   def self.last_found_migration(context)
-    migrations_path = context[:config][:db_migrations_location]
+    migrations_path = context[:config][:migrations_location]
     migrator = find_migrator(context)
     migrator.ds.order(Sequel.desc(migrator.column)).select_map(migrator.column).find do |fn|
       File.exist?("#{migrations_path}/#{fn}")
@@ -41,7 +42,7 @@ class MigrationUtils
 
   def self.migrations_differences(context)
     config = context[:config]
-    migrations_path = config[:db_migrations_location]
+    migrations_path = config[:migrations_location]
     existing = Dir["#{migrations_path}/*.rb"].map{|fn| File.basename fn }.sort
     migrator = find_migrator context
     migrated = migrator.ds.select_order_map(migrator.column)

data/lib/sequel_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module SequelTools
-  VERSION = '0.1.3'
+  VERSION = '0.1.8'
 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.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -99,19 +99,21 @@ files:
 - ".rspec"
 - ".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
 - lib/sequel_tools/actions/drop_db.rb
+- 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
@@ -152,8 +154,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.3
 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.3)
-      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