ardb 0.28.3 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 352c1dc50e3ac2567d5f74cc148ba572d4fa8f3d
-  metadata.gz: 0a5e57adec591aaa7273bade002b3f873caef819
-SHA512: 
-  data.tar.gz: c16e759ea474b84490ebb450825b44e11725960d847ff82cfec5e5840dd00b853a4278cc92f49989da04f6f04196b61aa428f4ba7f151f7562cd3d562ead9015
-  metadata.gz: f61b9a4df10d7d2b5b4520d8f601c1e3f9d3e1155a306d9b477cecf63d9021546bf9123adcdfddd9747f1348a905a388d564ef4babbde667c97fd732b355e213
+---
+SHA256:
+  metadata.gz: f61742815afbcc9e0a4e2a450864e15297d2dc3d6e4d1b61fcaf62d87551b048
+  data.tar.gz: 388acb5b938c3c51a8d6f9aa1c382fe2310d7ba919c4ef9c2d62bc50c4fffc87
+SHA512:
+  metadata.gz: c05d1cefea07609365899f0f08d067a39b326859d86e13c669163658a0f56c0b162fda248be764ecf2c0638108b302893cd58717162027ce474d5fd06cd1db5a
+  data.tar.gz: 5080cb134c4f67bc6a8a6280f70945c0909bcdc4975123069663f5f061c8f63054970b87898e4a9d6f77171bb9ebbc3a88f766b5607040da637713667b5e305c

data/.l.yml

@@ -0,0 +1,9 @@
+# https://github.com/redding/l.rb
+
+linters:
+  - name: "Rubocop"
+    cmd: "bundle exec rubocop"
+    autocorrect_cmd: "bundle exec rubocop -A"
+    extensions:
+      - ".rb"
+    cli_abbrev: "u"

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  much-style-guide:
+    - "lib/much-style-guide/rubocop.yml"

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/.t.yml

@@ -0,0 +1,6 @@
+# https://github.com/redding/t.rb
+
+default_cmd: bundle exec assert
+test_dir: test
+test_file_suffixes:
+  - "_tests.rb"

data/Gemfile

@@ -1,13 +1,29 @@
+# frozen_string_literal: true
+
 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 7.0
+gem "activerecord",  "~> 7.0.1"
+gem "activesupport", "~> 7.0.1"
+# 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.3"
+gem "pry"

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,7 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ardb/version"
 
@@ -8,21 +10,23 @@ Gem::Specification.new do |gem|
   gem.version     = Ardb::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.summary     = %q{Activerecord database tools.}
-  gem.description = %q{Activerecord database tools.}
+  gem.summary     = "Activerecord database tools."
+  gem.description = "Activerecord database tools."
   gem.homepage    = "http://github.com/redding/ardb"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.2.0"])
-  gem.add_dependency('scmd',          ["~> 3.0.2"])
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.7"])
+  gem.add_development_dependency("assert",           ["~> 2.19.8"])
 
+  gem.add_dependency("activerecord",  [">= 5.0"])
+  gem.add_dependency("activesupport", [">= 5.0"])
+  gem.add_dependency("much-mixin",    ["~> 0.2.5"])
+  gem.add_dependency("scmd",          ["~> 3.0.5"])
 end

data/bin/ardb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2013-Present Kelly Redding and Collin Redding
 #
 
-require 'ardb/cli'
+require "ardb/cli"
 Ardb::CLI.run ARGV

data/lib/ardb/adapter/base.rb

@@ -1,27 +1,40 @@
-require 'ardb'
+# frozen_string_literal: true
+
+require "ardb"
 
 module Ardb; end
-module Ardb::Adapter
 
+module Ardb::Adapter
   class Base
-
     attr_reader :config
 
     def initialize(config)
       @config = config
+      validate!
+    end
+
+    def connect_hash
+      config.activerecord_connect_hash
+    end
+
+    def database
+      config.database
     end
 
-    def connect_hash;    self.config.activerecord_connect_hash; end
-    def database;        self.config.database;                  end
-    def migrations_path; self.config.migrations_path;           end
-    def schema_format;   self.config.schema_format;             end
+    def migrations_path
+      config.migrations_path
+    end
+
+    def schema_format
+      config.schema_format
+    end
 
     def ruby_schema_path
-      @ruby_schema_path ||= "#{self.config.schema_path}.rb"
+      @ruby_schema_path ||= "#{config.schema_path}.rb"
     end
 
     def sql_schema_path
-      @sql_schema_path ||= "#{self.config.schema_path}.sql"
+      @sql_schema_path ||= "#{config.schema_path}.sql"
     end
 
     def escape_like_pattern(pattern, escape_char = nil)
@@ -33,50 +46,55 @@ module Ardb::Adapter
       pattern
     end
 
-    def foreign_key_add_sql(*args);  raise NotImplementedError; end
-    def foreign_key_drop_sql(*args); raise NotImplementedError; end
+    def create_db(*args)
+      raise NotImplementedError
+    end
 
-    def create_db(*args); raise NotImplementedError; end
-    def drop_db(*args);   raise NotImplementedError; end
+    def drop_db(*args)
+      raise NotImplementedError
+    end
 
-    def drop_tables(*args); raise NotImplementedError; end
+    def drop_tables(*args)
+      raise NotImplementedError
+    end
 
     def connect_db
-      ActiveRecord::Base.establish_connection(self.connect_hash)
-      # checkout a connection to ensure we can connect to the DB, we don't do
+      ActiveRecord::Base.establish_connection(connect_hash)
+      # checkout a connection to ensure we can connect to the DB, we don"t do
       # anything with the connection and immediately check it back in
-      ActiveRecord::Base.connection_pool.with_connection{ }
+      ActiveRecord::Base.connection_pool.with_connection{}
     end
 
     def migrate_db
-      verbose = ENV["MIGRATE_QUIET"].nil?
-      version = ENV["MIGRATE_VERSION"] ? ENV["MIGRATE_VERSION"].to_i : nil
-
-      if defined?(ActiveRecord::Migration::CommandRecorder)
-        require 'ardb/migration_helpers'
-        ActiveRecord::Migration::CommandRecorder.class_eval do
-          include Ardb::MigrationHelpers::RecorderMixin
-        end
-      end
+      migrate_db_up
+    end
 
-      ActiveRecord::Migrator.migrations_path = self.migrations_path
-      ActiveRecord::Migration.verbose = verbose
-      ActiveRecord::Migrator.migrate(self.migrations_path, version) do |migration|
-        ENV["MIGRATE_SCOPE"].blank? || (ENV["MIGRATE_SCOPE"] == migration.scope)
-      end
+    def migrate_db_up(target_version = nil)
+      migration_context.up(target_version)
+    end
+
+    def migrate_db_down(target_version = nil)
+      migration_context.down(target_version)
+    end
+
+    def migrate_db_forward(steps = 1)
+      migration_context.forward(steps)
+    end
+
+    def migrate_db_backward(steps = 1)
+      migration_context.rollback(steps)
     end
 
     def load_schema
-      # silence STDOUT
-      current_stdout = $stdout.dup
-      $stdout = File.new('/dev/null', 'w')
-      load_ruby_schema if self.schema_format == Ardb::Config::RUBY_SCHEMA_FORMAT
-      load_sql_schema  if self.schema_format == Ardb::Config::SQL_SCHEMA_FORMAT
+      current_stdout = $stdout.dup # silence STDOUT
+      $stdout = File.new("/dev/null", "w")
+      load_ruby_schema if schema_format == Ardb::Config::RUBY_SCHEMA_FORMAT
+      load_sql_schema  if schema_format == Ardb::Config::SQL_SCHEMA_FORMAT
       $stdout = current_stdout
     end
 
     def load_ruby_schema
-      load self.ruby_schema_path
+      load ruby_schema_path
     end
 
     def load_sql_schema
@@ -84,18 +102,17 @@ module Ardb::Adapter
     end
 
     def dump_schema
-      # silence STDOUT
-      current_stdout = $stdout.dup
-      $stdout = File.new('/dev/null', 'w')
+      current_stdout = $stdout.dup # silence STDOUT
+      $stdout = File.new("/dev/null", "w")
       dump_ruby_schema
-      dump_sql_schema if self.schema_format == Ardb::Config::SQL_SCHEMA_FORMAT
+      dump_sql_schema if schema_format == Ardb::Config::SQL_SCHEMA_FORMAT
       $stdout = current_stdout
     end
 
     def dump_ruby_schema
-      require 'active_record/schema_dumper'
-      FileUtils.mkdir_p File.dirname(self.ruby_schema_path)
-      File.open(self.ruby_schema_path, 'w:utf-8') do |file|
+      require "active_record/schema_dumper"
+      FileUtils.mkdir_p File.dirname(ruby_schema_path)
+      File.open(ruby_schema_path, "w:utf-8") do |file|
         ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
       end
     end
@@ -105,13 +122,21 @@ module Ardb::Adapter
     end
 
     def ==(other)
-      if other.kind_of?(self.class)
-        self.config == other.config
+      if other.is_a?(self.class)
+        config == other.config
       else
         super
       end
     end
 
-  end
+    private
 
+    def validate!
+      # override as needed
+    end
+
+    def migration_context
+      ActiveRecord::MigrationContext.new(migrations_path)
+    end
+  end
 end

data/lib/ardb/adapter/mysql.rb

@@ -1,21 +1,8 @@
-require 'ardb/adapter/base'
+# frozen_string_literal: true
 
-module Ardb::Adapter
-
-  class Mysql < Base
-
-    def foreign_key_add_sql
-      "ALTER TABLE :from_table"\
-      " ADD CONSTRAINT :name"\
-      " FOREIGN KEY (:from_column)"\
-      " REFERENCES :to_table (:to_column)"
-    end
-
-    def foreign_key_drop_sql
-      "ALTER TABLE :from_table"\
-      " DROP FOREIGN KEY :name"
-    end
+require "ardb/adapter/base"
 
+module Ardb::Adapter
+  class Mysql < Ardb::Adapter::Base
   end
-
 end