ardb 0.28.0 → 0.29.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 33194d527399daa093277e134bbcda8dee5c6069
-  metadata.gz: 7718eb32a25016d2d620a820b5a2b04244445b6a
-SHA512: 
-  data.tar.gz: 1597717aba91e83109628879b8ab51c52a81fe47c9f8182bf8bff32e91b7fe30f72a0543d97e1200b77926824b1d669790144fc3bf39bb9e9a30a95110192a69
-  metadata.gz: 02366a02d6aff1a513ea34969017cc07b56be184e906a7cb34b446811c6d4ebaa6fb97f6eddd04344b3f4d2dbca51624c4c57316f996e1b6b98809826e5d03f4
+---
+SHA256:
+  metadata.gz: 50d874e2df679ac2dff5d8617591ec70eb92cdf236324c6b9ba58e815c3a0f97
+  data.tar.gz: 28023038c65d75d082cd49545934657e3e11efb9be64cf7055335d09a68707ef
+SHA512:
+  metadata.gz: b7a3cfcb5f7bc262540e68ff4b0d259b8d9d95d5b109e521506229b4276bad96d3123c8cce6e7b0bf4f36777041fdbe2c714a17ca1f39e29846ba5d11b81b80b
+  data.tar.gz: 8cb2f15786e1a57c35ce32a39522aab648aa361ef29f4e0e6e8b63f70a3d5de3f41bfad99477751195a9d1ae68adf8363980211b1bd841841a508d57425246b0

data/Gemfile

@@ -1,13 +1,24 @@
 source "https://rubygems.org"
 
-gemspec
+ruby "~> 2.5"
 
-gem 'pg',  "~> 0.17.1"
-gem 'pry', "~> 0.9.0"
+gemspec
 
-# Lock down gem versions because they require a newer version of ruby
-gem 'i18n', "< 0.7"
+# Uncomment one of these and run:
+#
+#     bundle update activerecord activesupport
+#
+# to test a specific version.
+#
+# Rails 6.1
+gem "activerecord",  "~> 6.1"
+gem "activesupport", "~> 6.1"
+# Rails 6.0
+# gem "activerecord",  "~> 6.0.3"
+# gem "activesupport", "~> 6.0.3"
+# Rails 5.2
+# gem "activerecord",  "~> 5.2.4"
+# gem "activesupport", "~> 5.2.4"
 
-platform :ruby_18 do
-  gem 'json', '~> 1.8'
-end
+gem "pg",  "~> 1.1.4"
+gem "pry", "~> 0.12.2"

data/README.md

@@ -1,16 +1,265 @@
 # Ardb
 
-Activerecord database tools.
+Tools for using ActiveRecord with or without Rails.
 
 ## Usage
 
-TODO: Write code samples and usage instructions here
+Given configured database connection parameters, Ardb provides a CLI and assorted tools for working with an ActiveRecord database. Ardb is designed to be used with or without Rails.
+
+### Configuration
+
+By default, Ardb looks for database configuration in the `config/db.rb` file. You can override this using the `ENV["ARDB_DB_FILE"]` env var.
+
+The configuration includes typical database configuration parameters:
+
+```ruby
+# in config/db.rb
+require "ardb"
+
+Ardb.configure do |c|
+  c.logger Logger.new($stdout)
+  c.root_path File.expand_path("../..", __FILE__)
+
+  c.db.adapter      "postgresql"
+  c.db.encoding     "unicode"
+  c.db.min_messages "WARNING"
+  c.db.url          "localhost:5432"
+  c.db.username     "testuser"
+  c.db.password     "secret"
+  c.db.database     "testdb"
+end
+```
+
+#### Rails configuration
+
+If using Ardb with Rails, add a `config/db.rb` file to have Ardb use Rails's configuration settings:
+
+```ruby
+# in config/db.rb
+require_relative "./environment"
+require "ardb"
+
+# This Ardb configuration matches Rails's settings.
+Ardb.configure do |c|
+  rails_db_config    = Rails.application.config_for("database")
+  c.root_path        = Rails.root
+  c.logger           = Rails.logger
+  c.schema_format    = Rails.application.config.active_record.schema_format || :ruby
+  c.default_timezone = :utc
+  c.adapter          = rails_db_config["adapter"]
+  c.host             = rails_db_config["host"]
+  c.port             = rails_db_config["port"]
+  c.username         = rails_db_config["username"]
+  c.password         = rails_db_config["password"]
+  c.database         = rails_db_config["database"]
+  c.encoding         = rails_db_config["encoding"]
+  c.min_messages     = rails_db_config["min_messages"]
+
+  c.migrations_path = "db/migrate"
+  c.schema_path = "db/schema"
+end
+```
+
+### CLI
+
+```
+$ ardb --help
+Usage: ardb [COMMAND] [options]
+
+Options:
+        --version
+        --help
+
+Commands:
+  connect            Connect to the configured DB
+  create             Create the configured DB
+  drop               Drop the configured DB
+  generate-migration Generate a MIGRATION-NAME migration file
+  migrate            Migrate the configured DB
+  migrate-up         Migrate the configured DB up
+  migrate-down       Migrate the configured DB down
+  migrate-forward    Migrate the configured DB forward
+  migrate-backward   Migrate the configured DB backward
+```
+
+#### `connect` command
+
+```
+$ ardb connect --help
+Usage: ardb connect [options]
+
+Options:
+        --version
+        --help
+
+Description:
+  Connect to the configured DB
+$ ardb connect
+error: database "some_database" does not exist
+$ ardb create
+created postgresql db "some_database"
+$ ardb connect
+connected to postgresql db "some_database"
+```
+
+Use this command to verify the connection parameter configuration is correct.
+
+#### `create` command
+
+```
+$ ardb create --help
+Usage: ardb create [options]
+
+Options:
+        --version
+        --help
+
+Description:
+  Create the configured DB
+$ ardb create
+created postgresql db "some_database"
+$ ardb create
+error: database "some_database" already exists
+```
+
+#### `drop` command
+
+```
+$ ardb drop --help
+Usage: ardb drop [options]
+
+Options:
+        --version
+        --help
+
+Description:
+  Drop the configured DB
+$ ardb drop
+dropped postgresql db "some_database"
+$ ardb drop
+error: database "some_database" does not exist
+```
+
+#### `generate-migration` command
+
+```
+$ ardb generate-migration add_projects --help
+Usage: ardb generate-migration MIGRATION-NAME [options]
+
+Options:
+        --version
+        --help
+
+Description:
+  Generate a MIGRATION-NAME migration file
+$ ardb generate-migration add_projects
+generated /path/to/app/db/migrate/20191222074043_add_projects.rb
+```
+
+#### `migrate` command
+
+```
+$ ardb migrate --help
+Usage: ardb migrate [options]
+
+Options:
+        --version
+        --help
+
+Description:
+  Migrate the configured DB
+$ ardb migrate
+== 20191222074043 AddProjects: migrating ======================================
+-- create_table(:projects)
+   -> 0.0276s
+== 20191222074043 AddProjects: migrated (0.0277s) =============================
+```
+
+#### `migrate-up` command
+
+```
+$ ardb migrate-up --help
+Usage: ardb migrate-up [options]
+
+Options:
+    -t, --target-version VALUE       version to migrate to
+        --version
+        --help
+
+Description:
+  Migrate the configured DB up
+$ ardb migrate-up
+== 20191222074043 AddProjects: migrating ======================================
+-- create_table(:projects)
+   -> 0.0510s
+== 20191222074043 AddProjects: migrated (0.0511s) =============================
+```
+
+#### `migrate-down` command
+
+```
+$ ardb migrate-down --help
+Usage: ardb migrate-down [options]
+
+Options:
+    -t, --target-version VALUE       version to migrate to
+        --version
+        --help
+
+Description:
+  Migrate the configured DB down
+$ ardb migrate-down
+== 20191222074043 AddProjects: reverting ======================================
+-- drop_table(:projects)
+   -> 0.0092s
+== 20191222074043 AddProjects: reverted (0.0132s) =============================
+```
+
+#### `migrate-forward` command
+
+```
+$ ardb migrate-forward --help
+Usage: ardb migrate-forward [options]
+
+Options:
+    -s, --steps VALUE                number of migrations to migrate
+        --version
+        --help
+
+Description:
+  Migrate the configured DB forward
+$ ardb migrate-forward
+== 20191222074043 AddProjects: migrating ======================================
+-- create_table(:projects)
+   -> 0.0510s
+== 20191222074043 AddProjects: migrated (0.0511s) =============================
+```
+
+#### `migrate-backward` command
+
+```
+$ ardb migrate-backward --help
+Usage: ardb migrate-backward [options]
+
+Options:
+    -s, --steps VALUE                number of migrations to migrate
+        --version
+        --help
+
+Description:
+  Migrate the configured DB backward
+$ ardb migrate-backward
+== 20191222074043 AddProjects: reverting ======================================
+-- drop_table(:projects)
+   -> 0.0092s
+== 20191222074043 AddProjects: reverted (0.0132s) =============================
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'ardb'
+    gem "ardb"
 
 And then execute:
 

data/ardb.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ardb/version"
 
@@ -11,18 +11,19 @@ Gem::Specification.new do |gem|
   gem.summary     = %q{Activerecord database tools.}
   gem.description = %q{Activerecord database tools.}
   gem.homepage    = "http://github.com/redding/ardb"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.16.1"])
+  gem.required_ruby_version = "~> 2.5"
 
-  gem.add_dependency('activerecord',  ["~> 3.2"])
-  gem.add_dependency('activesupport', ["~> 3.2"])
-  gem.add_dependency('much-plugin',   ["~> 0.1.1"])
-  gem.add_dependency('scmd',          ["~> 3.0.2"])
+  gem.add_development_dependency("assert", ["~> 2.19.0"])
 
+  gem.add_dependency("activerecord",  ["> 5.0", "< 7.0"])
+  gem.add_dependency("activesupport", ["> 5.0", "< 7.0"])
+  gem.add_dependency("much-plugin",   ["~> 0.2.1"])
+  gem.add_dependency("scmd",          ["~> 3.0.3"])
 end

data/bin/ardb

@@ -3,5 +3,5 @@
 # Copyright (c) 2013-Present Kelly Redding and Collin Redding
 #
 
-require 'ardb/cli'
+require "ardb/cli"
 Ardb::CLI.run ARGV

data/lib/ardb.rb

@@ -1,12 +1,11 @@
-require 'active_record'
-require 'logger'
+require "active_record"
+require "logger"
 
-require 'ardb/version'
+require "ardb/version"
 
-ENV['ARDB_DB_FILE'] ||= 'config/db'
+ENV["ARDB_DB_FILE"] ||= "config/db"
 
 module Ardb
-
   def self.config
     @config ||= Config.new
   end
@@ -15,26 +14,35 @@ module Ardb
     self.config.tap(&block)
   end
 
-  def self.adapter; @adapter; end
+  def self.adapter
+    @adapter || raise(NotInitializedError.new(caller))
+  end
+
+  def self.reset_adapter; @adapter = nil; end
 
   def self.init(establish_connection = true)
-    require 'ardb/require_autoloaded_active_record_files'
+    require "ardb/require_autoloaded_active_record_files"
     begin
       require_db_file
     rescue InvalidDBFileError => exception
-      raise exception.tap{ |e| e.set_backtrace(caller) }
+      exception.set_backtrace(caller)
+      raise exception
     end
 
     self.config.validate!
     @adapter = Adapter.new(self.config)
 
     # setup AR
+    ActiveRecord::Base.default_timezone = self.config.default_timezone
     ActiveRecord::Base.logger = self.config.logger
     self.adapter.connect_db if establish_connection
   end
 
   def self.escape_like_pattern(pattern, escape_char = nil)
     self.adapter.escape_like_pattern(pattern, escape_char)
+  rescue NotInitializedError => exception
+    exception.set_backtrace(caller)
+    raise exception
   end
 
   private
@@ -43,18 +51,17 @@ module Ardb
   # that fails it tries requiring relative to the current working directory
   def self.require_db_file
     begin
-      require ENV['ARDB_DB_FILE']
+      require ENV["ARDB_DB_FILE"]
     rescue LoadError
-      require File.expand_path(ENV['ARDB_DB_FILE'], ENV['PWD'])
+      require File.expand_path(ENV["ARDB_DB_FILE"], ENV["PWD"])
     end
   rescue LoadError
-    raise InvalidDBFileError, "can't require `#{ENV['ARDB_DB_FILE']}`, " \
+    raise InvalidDBFileError, "can't require `#{ENV["ARDB_DB_FILE"]}`, " \
                               "check that the ARDB_DB_FILE env var is set to " \
                               "the file path of your db file"
   end
 
   class Config
-
     ACTIVERECORD_ATTRS = [
       :adapter,
       :database,
@@ -67,23 +74,25 @@ module Ardb
       :checkout_timeout,
       :min_messages
     ].freeze
-    DEFAULT_MIGRATIONS_PATH = 'db/migrations'.freeze
-    DEFAULT_SCHEMA_PATH     = 'db/schema'.freeze
+
+    DEFAULT_MIGRATIONS_PATH = "db/migrations".freeze
+    DEFAULT_SCHEMA_PATH     = "db/schema".freeze
     RUBY_SCHEMA_FORMAT      = :ruby.freeze
     SQL_SCHEMA_FORMAT       = :sql.freeze
     VALID_SCHEMA_FORMATS    = [RUBY_SCHEMA_FORMAT, SQL_SCHEMA_FORMAT].freeze
 
-    attr_accessor *ACTIVERECORD_ATTRS
-    attr_accessor :logger, :root_path
+    attr_accessor(*ACTIVERECORD_ATTRS)
+    attr_accessor :default_timezone, :logger, :root_path
     attr_reader :schema_format
     attr_writer :migrations_path, :schema_path
 
     def initialize
-      @logger          = Logger.new(STDOUT)
-      @root_path       = ENV['PWD']
-      @migrations_path = DEFAULT_MIGRATIONS_PATH
-      @schema_path     = DEFAULT_SCHEMA_PATH
-      @schema_format   = RUBY_SCHEMA_FORMAT
+      @default_timezone = :utc
+      @logger           = Logger.new(STDOUT)
+      @root_path        = ENV["PWD"]
+      @migrations_path  = DEFAULT_MIGRATIONS_PATH
+      @schema_path      = DEFAULT_SCHEMA_PATH
+      @schema_format    = RUBY_SCHEMA_FORMAT
     end
 
     def migrations_path
@@ -112,37 +121,39 @@ module Ardb
     def validate!
       if self.adapter.to_s.empty? || self.database.to_s.empty?
         raise ConfigurationError, "an adapter and database must be provided"
-      elsif !VALID_SCHEMA_FORMATS.include?(self.schema_format)
+      end
+
+      if !VALID_SCHEMA_FORMATS.include?(self.schema_format)
         raise ConfigurationError, "schema format must be one of: " \
-                                  "#{VALID_SCHEMA_FORMATS.join(', ')}"
+                                  "#{VALID_SCHEMA_FORMATS.join(", ")}"
       end
+
       true
     end
 
     def ==(other)
       if other.kind_of?(self.class)
         self.activerecord_connect_hash == other.activerecord_connect_hash &&
-        self.logger                    == other.logger           &&
-        self.root_path                 == other.root_path        &&
-        self.schema_format             == other.schema_format    &&
-        self.migrations_path           == other.migrations_path  &&
+        self.default_timezone          == other.default_timezone          &&
+        self.logger                    == other.logger                    &&
+        self.root_path                 == other.root_path                 &&
+        self.schema_format             == other.schema_format             &&
+        self.migrations_path           == other.migrations_path           &&
         self.schema_path               == other.schema_path
       else
         super
       end
     end
-
   end
 
   module Adapter
-
     VALID_ADAPTERS = [
-      'sqlite',
-      'sqlite3',
-      'postgresql',
-      'postgres',
-      'mysql',
-      'mysql2'
+      "sqlite",
+      "sqlite3",
+      "postgresql",
+      "postgres",
+      "mysql",
+      "mysql2"
     ].freeze
 
     def self.new(config)
@@ -153,30 +164,35 @@ module Ardb
     end
 
     def self.sqlite(config)
-      require 'ardb/adapter/sqlite'
+      require "ardb/adapter/sqlite"
       Adapter::Sqlite.new(config)
     end
 
     def self.sqlite3(config); self.sqlite(config); end
 
     def self.postgresql(config)
-      require 'ardb/adapter/postgresql'
+      require "ardb/adapter/postgresql"
       Adapter::Postgresql.new(config)
     end
 
     def self.postgres(config); self.postgresql(config); end
 
     def self.mysql(config)
-      require 'ardb/adapter/mysql'
+      require "ardb/adapter/mysql"
       Adapter::Mysql.new(config)
     end
 
     def self.mysql2(config); self.mysql(config); end
-
   end
 
   InvalidDBFileError  = Class.new(ArgumentError)
   ConfigurationError  = Class.new(ArgumentError)
   InvalidAdapterError = Class.new(RuntimeError)
 
+  class NotInitializedError < RuntimeError
+    def initialize(backtrace)
+      super("ardb hasn't been initialized yet, run `Ardb.init`")
+      set_backtrace(backtrace)
+    end
+  end
 end