dbreap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f48e84aa481947c4420a1ccf50711da91291de547ae0b00307ec63411472b7a8
+  data.tar.gz: 4ec7e1a94682c8c7ff9a331eb74cbf8b6a460ebf765d34b3590b58b78075920b
+SHA512:
+  metadata.gz: dbf4fccb4cfc85c6463e266594ce4f4e764a2e8acee74eb768ce6bb53ae40a8e7a4777f94884c3c41b1dd4050623cbc005a484a36f2af6bac7738f8121d0b8b9
+  data.tar.gz: 01d19e7d1d411dd4d630583f4a91ada900a90c84fdf616b956f5d34dfb574e3a83a2305191d9e0e90efa392e0f42fde29aab7597e16f6a0d02f18e4f8c645b76

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      minor-and-patch-updates:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ["3.3", "3.4"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rspec
+
+  audit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      - run: gem install bundler-audit
+      - run: bundle-audit check --update
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+
+      - run: bundle exec rubocop

data/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,28 @@
+name: Dependabot Auto-Merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Auto-approve and enable auto-merge (patch and minor only)
+        if: |
+          steps.metadata.outputs.update-type == 'version-update:semver-patch' ||
+          steps.metadata.outputs.update-type == 'version-update:semver-minor'
+        run: |
+          gh pr review --approve "$PR_URL"
+          gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release
+
+on:
+  push:
+    tags: ['v*']
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - uses: rubygems/release-gem@v1

data/.gitignore

@@ -0,0 +1,14 @@
+Gemfile.lock
+tmp/
+spec/dummy/config/master.key
+spec/dummy/config/credentials.yml.enc
+spec/dummy/config/ci.rb
+spec/dummy/config/puma.rb
+spec/dummy/config/environments/development.rb
+spec/dummy/config/environments/production.rb
+spec/dummy/Rakefile
+spec/dummy/db/seeds.rb
+spec/dummy/log/
+spec/log/
+spec/dummy/tmp/
+spec/dummy/storage/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,36 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "spec/dummy/**/*"
+    - "bin/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - "spec/integration/**/*"
+    - "spec/unit/reap_table_spec.rb"
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+dbreap

data/.ruby-version

@@ -0,0 +1 @@
+3.4.8

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+# dbreap
+
+[![CI](https://github.com/brentgreeff/dbreap/actions/workflows/ci.yml/badge.svg)](https://github.com/brentgreeff/dbreap/actions/workflows/ci.yml)
+
+Namespaced seed data - saved in YML. Much easier to see what's going on with your seed data than a bunch of ruby code that no-one maintains.
+
+Share essential database records between developers, staging, and demo environments.
+
+## Installation
+
+```ruby
+# Gemfile
+gem "dbreap"
+```
+
+```bash
+bundle install
+rails generate dbreap:install
+```
+
+This creates `db/fixtures/` and installs the seed loader into `db/seeds.rb` (appends if the file already exists).
+
+## Workflow
+
+### 1. Create your data
+
+Working on a new feature - Does having some example data help other developers on dev work with and test your new code in the UI?
+
+Create your data in the UI or console - and commit the seed YML alongside the feature code.
+
+### 2. Reap to YAML
+
+```bash
+# Reap specific tables
+rake db:reap FIXTURES=products,categories
+
+# Reap everything
+rake db:reap FIXTURES=ALL
+```
+
+Fixtures are written to `db/fixtures/<env>/`. Commit these files.
+
+### 3. Seed on another machine
+
+```bash
+# Clear existing data, then seed from fixtures
+rake db:empty
+rake db:seed
+```
+
+`db:seed` uses Rails' standard `db/seeds.rb`, configured by the install generator.
+
+## Rake tasks
+
+| Task | Description |
+|------|-------------|
+| `rake db:reap FIXTURES=ALL` | Reap all tables to YAML |
+| `rake db:reap FIXTURES=t1,t2` | Reap specific tables |
+| `rake db:empty` | Delete all rows from all tables (preserves schema) |
+
+## Development
+
+```bash
+bundle install
+bundle exec lefthook install  # installs pre-commit hooks
+bundle exec rspec
+```
+
+## Notes
+
+- Fixture files are ordered by `id` — reap → seed → reap produces identical output
+- JSON columns are preserved as structured data
+- String columns containing numeric values (e.g. `"123"`) are not cast to integers
+- `schema_migrations` and `ar_internal_metadata` are always skipped
+- `db:empty` uses `DELETE` (not `TRUNCATE`) — schema and sequences are preserved, no DDL lock
+- Run `db:empty` before `db:seed` to avoid duplicate records on repeated seeds
+- Fixture files are namespaced by environment (`db/fixtures/<env>/`) — development, staging, and demo data can coexist

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/db/seeds.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_record/fixtures'
+FIXTURES_PATHS = ['db/fixtures', "db/fixtures/#{Rails.env}"].freeze
+
+FIXTURES_PATHS.each do |path|
+  Dir.glob("#{Rails.root}/#{path}/*.yml").each do |file|
+    puts File.basename(file, '.*')
+    ActiveRecord::FixtureSet.create_fixtures(path, File.basename(file, '.*'))
+  end
+end

data/dbreap.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dbreap/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'dbreap'
+  spec.version     = Dbreap::VERSION
+  spec.authors     = ['Brent Greeff']
+  spec.email       = ['brent@example.com']
+  spec.summary     = 'Reap database records to YAML fixtures and seed them back.'
+  spec.homepage    = 'https://github.com/brentgreeff/dbreap'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 3.3'
+
+  spec.metadata = {
+    'source_code_uri' => 'https://github.com/brentgreeff/dbreap',
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:spec|test)/}) }
+  end
+
+  spec.add_dependency 'activerecord', '>= 7.0'
+  spec.add_dependency 'railties',     '>= 7.0'
+
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'factory_bot_rails'
+  spec.add_development_dependency 'lefthook'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/lefthook.yml

@@ -0,0 +1,9 @@
+pre-commit:
+  commands:
+    rubocop:
+      tags: style
+      glob: "*.rb"
+      run: bundle exec rubocop --force-exclusion {staged_files}
+    audit:
+      tags: security
+      run: bundle exec bundler-audit check --update

data/lib/db/empty.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :db do
+  desc 'Deletes everything in the database.'
+  task empty: :environment do
+    Dbreap::Empty.call
+  end
+end

data/lib/db/reap.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :db do
+  desc 'Create YAML seed fixtures from data in an existing database. Set FIXTURES=ALL or FIXTURES=table1,table2.'
+  task reap: :environment do
+    if ENV['FIXTURES'].nil?
+      puts 'Please specify FIXTURES: ALL or a comma-separated list of table names'
+      exit
+    end
+
+    tables = ENV['FIXTURES'] == 'ALL' ? ActiveRecord::Base.connection.tables : ENV['FIXTURES'].split(',').map(&:strip)
+    tables -= Dbreap::SKIP_TABLES
+
+    FileUtils.mkdir_p("#{Rails.root}/db/fixtures/#{Rails.env}")
+
+    tables.each(&Dbreap::Reap.method(:write_fixture))
+  end
+end

data/lib/dbreap/empty.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Dbreap
+  module Empty
+    def self.call(connection = ActiveRecord::Base.connection)
+      tables = connection.tables - Dbreap::SKIP_TABLES
+      tables.each { |t| connection.delete("DELETE FROM #{connection.quote_table_name(t)}") }
+    end
+  end
+end

data/lib/dbreap/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Dbreap
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'db/reap.rake'
+      load 'db/empty.rake'
+    end
+  end
+end

data/lib/dbreap/reap.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dbreap
+  module Reap
+    def self.build_yml(table_name, connection: ActiveRecord::Base.connection)
+      raw = fetch_rows(table_name, connection:)
+
+      rows = raw.each_with_index.with_object({}) do |(row, i), accum|
+        key = "#{table_name}_#{format('%03d', i + 1)}"
+        accum[key] = row.transform_values { |v| cast_value(v) }
+      end
+      Psych.dump(rows, line_width: -1)
+    end
+
+    def self.fetch_rows(table_name, connection: ActiveRecord::Base.connection)
+      quoted = connection.quote_table_name(table_name)
+      connection.select_all("SELECT * FROM #{quoted} ORDER BY id")
+    rescue ActiveRecord::StatementInvalid
+      connection.select_all("SELECT * FROM #{quoted} ORDER BY 1")
+    end
+
+    def self.cast_value(value)
+      return value unless value.is_a?(String) && value.match?(/\A[\[{]/)
+
+      JSON.parse(value)
+    rescue JSON::ParserError
+      value
+    end
+
+    def self.write_fixture(table_name, root: Rails.root, env: Rails.env)
+      path = "#{root}/db/fixtures/#{env}/#{table_name}.yml"
+      yaml = build_yml(table_name)
+      File.write(path, yaml)
+      puts "Reaped #{table_name}"
+    end
+  end
+end

data/lib/dbreap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dbreap
+  VERSION = '0.1.0'
+end

data/lib/dbreap.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'dbreap/version'
+
+module Dbreap
+  SKIP_TABLES = %w[schema_migrations ar_internal_metadata].freeze
+end
+
+require_relative 'dbreap/empty'
+require_relative 'dbreap/reap'
+require_relative 'dbreap/railtie' if defined?(Rails::Railtie)

data/lib/generators/dbreap/install/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dbreap
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Sets up db/seeds.rb and db/fixtures/ for dbreap.'
+
+      def create_fixtures_directory
+        empty_directory 'db/fixtures'
+      end
+
+      def install_seeds
+        seeds_path = File.join(destination_root, 'db/seeds.rb')
+        if File.exist?(seeds_path) && !File.read(seeds_path).strip.empty?
+          append_to_file 'db/seeds.rb', "\n#{File.read(File.join(self.class.source_root, 'seeds.rb'))}"
+          say 'Appended dbreap seed loader to db/seeds.rb', :green
+        else
+          copy_file 'seeds.rb', 'db/seeds.rb'
+          say 'Created db/seeds.rb', :green
+        end
+      end
+    end
+  end
+end

data/lib/generators/dbreap/install/templates/seeds.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_record/fixtures'
+
+FIXTURES_PATHS = ['db/fixtures', "db/fixtures/#{Rails.env}"].freeze
+
+FIXTURES_PATHS.each do |path|
+  Dir.glob("#{Rails.root}/#{path}/*.yml").each do |file|
+    ActiveRecord::FixtureSet.create_fixtures(path, File.basename(file, '.*'))
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: dbreap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brent Greeff
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- brent@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/dependabot-auto-merge.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/rubocop
+- db/seeds.rb
+- dbreap.gemspec
+- lefthook.yml
+- lib/db/empty.rake
+- lib/db/reap.rake
+- lib/dbreap.rb
+- lib/dbreap/empty.rb
+- lib/dbreap/railtie.rb
+- lib/dbreap/reap.rb
+- lib/dbreap/version.rb
+- lib/generators/dbreap/install/install_generator.rb
+- lib/generators/dbreap/install/templates/seeds.rb
+homepage: https://github.com/brentgreeff/dbreap
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/brentgreeff/dbreap
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Reap database records to YAML fixtures and seed them back.
+test_files: []