activerecord-dbsnapshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54a0b9a73c7af8b2c2f02e7b6a15b476ce11544309d3e293f4078fdbf468bdc6
+  data.tar.gz: 4854a6d9eff890a5f9bd01f0d67422eba4620fc027bb8bd9bb9a0373dddc9115
+SHA512:
+  metadata.gz: 74857122ff508b761901ea8020826c1bd5831f8e4247a61d4d4bdc091d52ab45838116dc6b4666043a0869f3c0a7fca027f0823943d802b6542c6a1749719a90
+  data.tar.gz: 79d48c80d7880338520575b9dda121b9a21c1a6974c689fb3c9f73cacfcb739d43e20711533897582e39f4e7463713351cac3bef982c362256e1f284ac7919a5

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/activerecord-dbsnapshot.iml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.26, RVM: ruby-3.1.4 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-3.1.4 [global]) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-3.1.4 [global]" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/activerecord-dbsnapshot.iml" filepath="$PROJECT_DIR$/.idea/activerecord-dbsnapshot.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Activerecord::Dbsnapshot
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activerecord/dbsnapshot`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-dbsnapshot.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/activerecord-dbsnapshot.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/activerecord/dbsnapshot/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "activerecord-dbsnapshot"
+  spec.version = Activerecord::Dbsnapshot::VERSION
+  spec.authors = ["Ryan Mammina"]
+  spec.email = ["ryan@avamia.com"]
+
+  spec.summary = "Dump and Restore database snapshots."
+  spec.homepage = "https://github.com/avamia/activerecord-dbsnapshot"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/avamia/activerecord-dbsnapshot"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

data/lib/activerecord/dbsnapshot/railtie.rb

@@ -0,0 +1,17 @@
+require 'activerecord/dbsnapshot'
+require 'rails'
+
+module ActiveRecord
+  class DbSnapshot
+    class Railtie < Rails::Railtie
+      # Auto-load the generator when Rails starts
+      generators do
+        require 'generators/snapshot/snapshot_generator'
+      end
+
+      rake_tasks do
+        load 'tasks/snapshot_tasks.rake'
+      end
+    end
+  end
+end

data/lib/activerecord/dbsnapshot/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Dbsnapshot
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/dbsnapshot.rb

@@ -0,0 +1,77 @@
+require_relative "dbsnapshot/version"
+
+module ActiveRecord
+  class DbSnapshot
+    class << self
+      attr_accessor :snapshot_name, :excluded_tables
+
+      def name(value)
+        formatted_name = value.to_s.gsub('-', '_').underscore.to_sym
+        @snapshot_name = formatted_name
+      end
+
+      # Stores an array of tables to be excluded from the snapshot.
+      def exclude(tables)
+        @excluded_tables = tables.map(&:to_s)
+      end
+
+      # Finds the latest snapshot configuration
+      def latest_configuration
+        config_files = Dir.glob(Rails.root.join('db', 'snapshots', "*.rb"))
+        return nil if config_files.empty?
+
+        latest_config_file = config_files.max_by { |file| extract_timestamp(file) }
+        return nil unless latest_config_file
+
+        require latest_config_file
+
+        klass_name = File.basename(latest_config_file, '.rb').gsub(/^[^_]+_/, '').camelize
+        klass = klass_name.constantize
+
+        puts klass.snapshot_name, klass.excluded_tables.inspect
+        klass
+      end
+
+      # Finds snapshot configuration by name
+      def find_configuration(name)
+        config_file = Dir.glob(Rails.root.join('db', 'snapshots', "*_#{name}.rb")).first
+        unless config_file
+          puts "Snapshot configuration not found: #{name}"
+          return nil
+        end
+
+        load config_file
+        ActiveRecord::DbSnapshot.new
+      end
+
+      # Builds the dump command based on configuration
+      def build_dump_command(config, db_config, output_file)
+        pg_dump_cmd = "pg_dump"
+        pg_dump_cmd << " -U #{db_config[:username]}"
+        pg_dump_cmd << " -h #{db_config[:host]}"
+        pg_dump_cmd << " #{db_config[:database]}"
+
+        excluded_tables = config.excluded_tables.map(&:to_s).join(" ")
+        if excluded_tables.empty?
+          return "#{pg_dump_cmd} > #{output_file}"
+        else
+          excluded_tables_option = "--exclude-table=" + excluded_tables
+          return "#{pg_dump_cmd} #{excluded_tables_option} > #{output_file}"
+        end
+      end
+
+      # Executes the dump command
+      def execute_dump_command(dump_command)
+        system(dump_command)
+      end
+
+      private
+      def extract_timestamp(file)
+        timestamp = File.basename(file, ".rb").split('_').first.to_i
+        Time.at(timestamp)
+      end
+    end
+  end
+end
+
+require 'activerecord/dbsnapshot/railtie' if defined?(Rails)

data/lib/generators/snapshot/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Generates a configuration class for database snapshots.
+
+Example:
+    rails generate snapshot NAME [options]
+
+    This will create:
+        - A new snapshot configuration file at db/snapshots/YYYYMMDDHHMMSS_NAME.rb
+
+Options:
+    --exclude_tables=one two three
+        This option allows you to specify tables that should be excluded from the snapshot.
+        You can list multiple tables by separating them with a space.
+
+        Example:
+            rails generate snapshot MySnapshot --exclude_tables=users sessions logs
+
+        This will generate a configuration file that excludes the 'users', 'sessions', and 'logs' tables.
+
+More Information:
+    The generated configuration file is a Ruby class that extends ActiveRecord::DbSnapshot.
+    You can edit this class to further customize the behavior of your database snapshot.

data/lib/generators/snapshot/snapshot_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+class SnapshotGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  class_option :exclude_tables, type: :array, default: [], desc: "List of tables to exclude from the snapshot"
+
+  def create_snapshot_config
+    @exclude_tables = options[:exclude_tables] || []
+
+    @class_name = file_name.gsub('-', '_').camelize
+    @symbol_name = file_name.gsub('-', '_').underscore
+
+    timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+    filename_with_timestamp = "#{timestamp}_#{@symbol_name}"
+    template "snapshot_config.rb.erb", File.join("db/snapshots", "#{filename_with_timestamp}.rb")
+  end
+end

data/lib/generators/snapshot/templates/snapshot_config.rb.erb

@@ -0,0 +1,4 @@
+class <%= @class_name %> < ActiveRecord::DbSnapshot
+  name :<%= @symbol_name %>
+  exclude <%= @exclude_tables.inspect %>
+end

data/lib/tasks/snapshot_tasks.rake

@@ -0,0 +1,67 @@
+# lib/tasks/snapshot_tasks.rake
+
+namespace :db do
+  namespace :snapshot do
+    desc "Dump database based on snapshot configuration"
+    task :dump, [:name] => :environment do |t, args|
+      unless `which pg_dump`.present?
+        puts "Error: pg_dump not found. Ensure PostgreSQL client tools are installed."
+        next
+      end
+
+      unless Rails.env.development?
+        puts "You are about to dump the database. This action is not recommended in non-development environments."
+        puts "Proceed? (yes/no)"
+        response = STDIN.gets.chomp.downcase
+        unless response == 'yes'
+          puts "Dump canceled."
+          next
+        end
+      end
+
+      config = args[:name] ? ActiveRecord::DbSnapshot.find_configuration(args[:name]) : ActiveRecord::DbSnapshot.latest_configuration
+      unless config
+        puts "No snapshot configuration found."
+        next
+      end
+
+      db_config = ActiveRecord::Base.connection_config
+      output_file = Rails.root.join('db', 'snapshots', "#{config.snapshot_name}.sql")
+
+      puts output_file
+
+
+      dump_command = ActiveRecord::DbSnapshot.build_dump_command(config, db_config, output_file)
+      ActiveRecord::DbSnapshot.execute_dump_command(dump_command)
+
+      puts "Database dump completed: #{output_file}"
+    end
+
+    desc "Restore a snapshot SQL file into the database"
+    task :restore, [:name] => :environment do |_, args|
+      name = args[:name]
+      filename = "db/snapshots/#{name}.sql"
+
+      unless File.exist?(filename)
+        puts "Snapshot file not found: #{filename}"
+        next
+      end
+
+      unless Rails.env.development?
+        puts "You are about to restore a database snapshot. This action is not recommended in non-development environments."
+        puts "Proceed? (yes/no)"
+        response = STDIN.gets.chomp.downcase
+        unless response == 'yes'
+          puts "Snapshot restoration canceled."
+          next
+        end
+      end
+
+      # Restore the SQL file into the database
+      sql = File.read(filename)
+      ActiveRecord::Base.connection.execute(sql)
+
+      puts "Snapshot '#{name}' restored successfully."
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-dbsnapshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Mammina
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ryan@avamia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/activerecord-dbsnapshot.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-dbsnapshot.gemspec
+- lib/activerecord/dbsnapshot.rb
+- lib/activerecord/dbsnapshot/railtie.rb
+- lib/activerecord/dbsnapshot/version.rb
+- lib/generators/snapshot/USAGE
+- lib/generators/snapshot/snapshot_generator.rb
+- lib/generators/snapshot/templates/snapshot_config.rb.erb
+- lib/tasks/snapshot_tasks.rake
+homepage: https://github.com/avamia/activerecord-dbsnapshot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/avamia/activerecord-dbsnapshot
+  source_code_uri: https://github.com/avamia/activerecord-dbsnapshot
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Dump and Restore database snapshots.
+test_files: []