dumpcar 0.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f1dd091285da9e5736495a0ffc53e2b73176cc327a6d138f2ea8663e0b4d6a
-  data.tar.gz: 38d4fe0b357fc007491a154b6203a31514d22f17a21f38c40cfb0fe64eb7d8c9
+  metadata.gz: f4098f5a361deb33a01b2bf1551a41c532de946f1bae2f418ebcf5d4739bf68e
+  data.tar.gz: d82319e62b40f0cd3b619da6e07e083faff7ecf1c0cf03105b9ea8463f1932c5
 SHA512:
-  metadata.gz: 0bbe63e7e62033e29df0e1ae907adfbe03edede801be02af50dd551bdc7d98bf41874ff2c46ca790813f18ec34068846f0905fbec696cd78fb61df31978675ec
-  data.tar.gz: a9f5a753441535c546e4c2b20af60f8b8b9ea3c4cb42ef9db7aa74bc68780ab84ede78d24d8fd8eea2f11d39a97341a1231d660e164eca8660fa1c07151c6fab
+  metadata.gz: 80e2878b12006e0950a199cca67593ebec456f416b8f0529fda1a9753ca530303632ff8169a46f042f82d780a88afb264f100823bb7ffc76f95390601735829b
+  data.tar.gz: 505156796ac225a538c8da5e5233515ef3580fefaf0b688f257da4840022ec8a536e7b140105fc0485bae82b759dda245cef8d3c5219f51084bd4f4f38c320a5

data/.devcontainer/Dockerfile

@@ -1,7 +1,5 @@
 FROM mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye
 
-# Install Rails
-RUN su vscode -c "gem install rails webdrivers"
 RUN su vscode -c "/usr/local/rvm/bin/rvm fix-permissions"
 
 # Default value to allow debug server to serve content over GitHub Codespace's port forwarding service

data/.devcontainer/devcontainer.json

@@ -18,10 +18,19 @@
   // "forwardPorts": [3000, 5432],
 
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "bin/setup"
-
+  "postCreateCommand": "bundle config set path vendor/bundle && bin/setup",
   // Configure tool-specific properties.
-  // "customizations": {},
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "rubyLsp.addonSettings": {
+          "Ruby LSP RSpec": {
+            "rspecCommand": "rspec -f d"
+          }
+        }
+      }
+    }
+  }
 
   // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
   // "remoteUser": "root"

data/README.md

@@ -1,15 +1,15 @@
 # Dumpcar
 
-[![Ruby Gem version](https://badge.fury.io/rb/dumpcar.svg)](https://rubygems.org/gems/dumpcar)
+[![Ruby Gem version](https://badge.fury.io/rb/dumpcar.svg)](https://rubygems.org/gems/dumpcar) [![Ruby build](https://github.com/wwahammy/dumpcar/actions/workflows/main.yml/badge.svg)](https://github.com/wwahammy/dumpcar/actions/workflows/main.yml)
 
-Rake tasks for dumping and restoring the contents of the PostgreSQL database for your Rails application.
+Rails commands for dumping and restoring the contents of the PostgreSQL database for your Rails application.
 
 - Dump (`rails dumpcar:dump`) and restore your last dump (`rails dumpcar:restore`) with a single command
-- Uses your Rails database credentials for your environment
+- Uses your Rails database credentials for your environment OR any Rails supported Postgres connection string (via `DATABASE_URL`)
 
 ## Installation
 
-Install the gem executing:
+Install the gem by executing:
 
 ```bash
 bundle add dumpcar
@@ -21,6 +21,9 @@ rails g dumpcar # creates db/dumps folder, adds it to .gitignore and commits
 ```bash
 rails dumpcar:dump # creates a postgresql dump based on current time like db/dumps/20250601022124.dump
 rails dumpcar:restore # restores the last dump made chronologically from the db/dumps directory
+
+# You can use any Postgres connection string that Rails supports
+DATABASE_URL=postgres://myuser:mypassword@domain.hosting.pg.db:5432/mydatabase rails dumpcar:dump # creates a postgresql dump of the database at DATABASE_URL
 ```
 
 ## Compatibility
@@ -29,7 +32,7 @@ Outside of the `rails dumpcar:dump` and `rails dumpcar:restore` commands, don't
 
 ## Longer term feature goals
 
-- Support other Rails database (MySQL and SQLite)
+- Support other Rails databases (MySQL and SQLite)
 - Support other Rails environments than the current one
 - Ability to clean your db/dumps directory of all dumps before a given time
 - Add support for naming a dump (you can manually do this now but not via the rake task)
@@ -41,6 +44,9 @@ Outside of the `rails dumpcar:dump` and `rails dumpcar:restore` commands, don't
 
 ## Development
 
+NOTE: Using the Devcontainer is one of the easiest ways to get setup. Unfortunately, it also requires a no-charge but proprietary
+extension to VSCode to use.
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You should run `bin/appraisal rspec` to run all of the tests on all of the supported Rails versions. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing

data/Rakefile

@@ -8,3 +8,15 @@ RSpec::Core::RakeTask.new(:spec)
 require "standard/rake"
 
 task default: %i[spec standard]
+
+namespace :clean do
+  desc "Clean your tmp directory of copies of files used in rspec runs"
+  task :tmp do
+    tmp_dir_path = Pathname.new(__dir__).join("spec/internal/tmp")
+    tmp_dir_path.children.select { |file| file.basename.to_s != ".keep" }.each(&:rmtree)
+  end
+end
+
+Rake::Task[:clean].enhance do
+  Rake::Task["clean:tmp"].invoke
+end

data/gemfiles/rails_6.0.gemfile

@@ -18,4 +18,8 @@ gem "debug"
 gem "rails", "~> 6.0.0"
 gem "concurrent-ruby", "1.3.4"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_6.1.gemfile

@@ -18,4 +18,8 @@ gem "debug"
 gem "rails", "~> 6.1.0"
 gem "concurrent-ruby", "1.3.4"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_7.0.gemfile

@@ -18,4 +18,8 @@ gem "debug"
 gem "rails", "~> 7.0.0"
 gem "concurrent-ruby", "1.3.4"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_7.1.gemfile

@@ -17,4 +17,8 @@ gem "appraisal", :git => "https://github.com/pboling/appraisal.git", :ref => "c3
 gem "debug"
 gem "rails", "~> 7.1.0"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_7.2.gemfile

@@ -17,4 +17,8 @@ gem "appraisal", :git => "https://github.com/pboling/appraisal.git", :ref => "c3
 gem "debug"
 gem "rails", "~> 7.2.0"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_8.0.gemfile

@@ -17,4 +17,8 @@ gem "appraisal", :git => "https://github.com/pboling/appraisal.git", :ref => "c3
 gem "debug"
 gem "rails", "~> 8.0.0"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_edge.gemfile

@@ -17,4 +17,8 @@ gem "appraisal", :git => "https://github.com/pboling/appraisal.git", :ref => "c3
 gem "debug"
 gem "rails", :github => "rails/rails", :branch => "main"
 
+group :development do
+  gem "ruby-lsp-rspec", :require => false
+end
+
 gemspec :path => "../"

data/lib/dumpcar/instance.rb

@@ -1,9 +1,14 @@
 module Dumpcar
   class Instance
-    attr_reader :location, :pg
-    def initialize(base: Rails.root.join("db/dumps"))
-      @location = Location.new(base)
-      @pg = Pg.new(Dumpcar::Util.get_connection_db_config)
+    require "active_model"
+    include ActiveModel::Model
+
+    attr_accessor :connection, :location, :pg, :base_dir
+    def initialize(attributes = {})
+      cleanup_arguments(attributes)
+      @connection = Dumpcar::Util.get_connection_db_config
+      @location = Location.new(base_dir)
+      @pg = Pg.new(connection)
     end
 
     def dump
@@ -13,5 +18,14 @@ module Dumpcar
     def restore
       @pg.restore(@location.last)
     end
+
+    def cleanup_arguments(arguments)
+      arguments = arguments.to_h.with_indifferent_access
+      unless arguments.has_key?("base_dir")
+        arguments["base_dir"] = Rails.root.join("db/dumps")
+      end
+
+      assign_attributes(arguments)
+    end
   end
 end

data/lib/dumpcar/location.rb

@@ -4,18 +4,18 @@ module Dumpcar
     TIMESTAMP_GLOB = 14.times.map { "[0-9]" }.join
     TIMESTAMP_FILE_GLOB = TIMESTAMP_GLOB + "*.dump"
 
-    attr_reader :base
-    def initialize(base)
-      @base = Pathname.new base
+    attr_reader :base_dir
+    def initialize(base_dir)
+      @base_dir = Pathname.new base_dir
     end
 
     def dumps
-      prepare_base!
-      base.glob(TIMESTAMP_FILE_GLOB)
+      prepare_base_dir!
+      base_dir.glob(TIMESTAMP_FILE_GLOB)
     end
 
     def first
-      prepare_base!
+      prepare_base_dir!
       dumps.first
     end
 
@@ -24,13 +24,13 @@ module Dumpcar
     end
 
     def last
-      prepare_base!
+      prepare_base_dir!
       dumps.last
     end
 
     def next
-      prepare_base!
-      base.join(from_time + ".dump").to_s
+      prepare_base_dir!
+      base_dir.join(from_time + ".dump").to_s
     end
 
     def from_time(time = Time.now.utc)
@@ -39,8 +39,8 @@ module Dumpcar
 
     private
 
-    def prepare_base!
-      FileUtils.mkdir_p base
+    def prepare_base_dir!
+      FileUtils.mkdir_p base_dir
     end
   end
 end

data/lib/dumpcar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dumpcar
-  VERSION = "0.2"
+  VERSION = "0.3.1"
 end

data/lib/rails/commands/dumpcar_command.rb

@@ -1,15 +1,19 @@
 class DumpcarCommand < Rails::Command::Base
-  class_option :base, type: :string, desc: "the location of your DB dumps, defaults to Rails.root.join('db/dumps')"
+  class_option :base_dir, type: :string, desc: "the location of your DB dumps, defaults to Rails.root.join('db/dumps')"
 
   desc "dump", "Dump postgres backup file"
   def dump
+    require "rails"
+    (Rails.version < "7.1") ? require_application_and_environment! : boot_application!
     require "dumpcar"
-    Dumpcar::Instance.new.dump
+    Dumpcar::Instance.new(options).dump
   end
 
   desc "restore", "Restore postgres backup file"
   def restore
+    require "rails"
+    (Rails.version < "7.1") ? require_application_and_environment! : boot_application!
     require "dumpcar"
-    Dumpcar::Instance.new.restore
+    Dumpcar::Instance.new(options).restore
   end
 end

data/package-lock.json

@@ -6,8 +6,8 @@
     "": {
       "devDependencies": {
         "husky": "^9.0",
-        "lint-staged": "^16.0",
-        "prettier": "^3.0"
+        "lint-staged": "^16.1",
+        "prettier": "^3.6"
       }
     },
     "node_modules/ansi-escapes": {
@@ -252,9 +252,9 @@
       }
     },
     "node_modules/lint-staged": {
-      "version": "16.1.0",
-      "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-16.1.0.tgz",
-      "integrity": "sha512-HkpQh69XHxgCjObjejBT3s2ILwNjFx8M3nw+tJ/ssBauDlIpkx2RpqWSi1fBgkXLSSXnbR3iEq1NkVtpvV+FLQ==",
+      "version": "16.1.2",
+      "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-16.1.2.tgz",
+      "integrity": "sha512-sQKw2Si2g9KUZNY3XNvRuDq4UJqpHwF0/FQzZR2M7I5MvtpWvibikCjUVJzZdGE0ByurEl3KQNvsGetd1ty1/Q==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
@@ -440,9 +440,9 @@
       }
     },
     "node_modules/prettier": {
-      "version": "3.5.3",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz",
-      "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==",
+      "version": "3.6.0",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.0.tgz",
+      "integrity": "sha512-ujSB9uXHJKzM/2GBuE0hBOUgC77CN3Bnpqa+g80bkv3T3A93wL/xlzDATHhnhkzifz/UE2SNOvmbTz5hSkDlHw==",
       "dev": true,
       "license": "MIT",
       "bin": {

data/package.json

@@ -1,8 +1,8 @@
 {
   "devDependencies": {
     "husky": "^9.0",
-    "lint-staged": "^16.0",
-    "prettier": "^3.0"
+    "lint-staged": "^16.1",
+    "prettier": "^3.6"
   },
   "scripts": {
     "prepare": "husky"
@@ -10,6 +10,6 @@
   "lint-staged": {
     "*.{js,css,md,yml}": "prettier --write",
     "*.{rb,rake,gemspec,ru}": "bin/standardrb --fix",
-    "Gemfile": "bin/standardrb --fix"
+    "{Gemfile,Rakefile}": "bin/standardrb --fix"
   }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dumpcar
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.1
 platform: ruby
 authors:
 - Eric Schultz