static_db 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479d7410cc5f976ed22e42d910e249055c741df4e4c6cdf8267b01bea16f8217
-  data.tar.gz: 7b9e03429fa960d457e60a49055eacdabdd55d987e73243a8beb56d72f7437de
+  metadata.gz: 02b96ad6eca0c26259e1e12e6ff9b83e770d37d2070487c011f6f2f1472c3a75
+  data.tar.gz: b1be8d64e52becc77b4163e3d3d521a42c046a799d73035624015074bf9d077e
 SHA512:
-  metadata.gz: 0e6ef11395d226a4c53bd953ca08c103509dae4c85330c797b7620b28360366815e32942a2284430be8437220f6433766a0ed0206582b56d823e80779cc00bde
-  data.tar.gz: d7bef38d14c21fcbbbf321756ec4d9319b90ef7d45ccd408de7bc80c596eb4c88f0a83b98b0f4b92e9fa0875973d45086b57745ea2a2782196001e3300f12a1e
+  metadata.gz: 29df6c00287bb63cab1b235b610d375521b689d1b4b1cc5823f53b8a395030437e3d119315ae68b7682c2a5266cd80a3c3658346d77a8304547d8e1a3bfe2889
+  data.tar.gz: 3d0631350c93afb497bef3b8205135a7ca6207927f67dc6426e8a13dc5fe4dbe3fc941512968097cdb8b305ee6838a7c71da9db8fbc5973f4e43a14d9441e806

data/CHANGELOG.md

@@ -1,3 +1,13 @@
-# Change log
+# Changelog
 
-## master
+> :warning: This project is not inteded for public usage yet.
+
+I will start keeping a changelog as soon as that happens.
+
+This project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
+
+## [Unreleased]
+
+### Breaking
+
+### Non-breaking

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Klaus Weidinger
+Copyright (c) 2026 Klaus Weidinger
 
 MIT License
 

data/README.md

@@ -1,47 +1,43 @@
 [![Gem Version](https://badge.fury.io/rb/static_db.svg)](https://rubygems.org/gems/static_db)
 [![Build](https://github.com/dunkelziffer/static_db/workflows/Build/badge.svg)](https://github.com/dunkelziffer/static_db/actions)
-[![JRuby Build](https://github.com/dunkelziffer/static_db/workflows/JRuby%20Build/badge.svg)](https://github.com/dunkelziffer/static_db/actions)
 
 # static_db
 
-TBD
+Dump DB contents to YAML and load them back again. Aimed at SQLite. Committable to git.
 
 ## Installation
 
-Adding to a gem:
+WARNING: This gem modifies the Rails startup sequence. Don't use this gem unless you want to build a static site generator. This gem also creates and drops the DB for you.
 
-```ruby
-# my-cool-gem.gemspec
-Gem::Specification.new do |spec|
-  # ...
-  spec.add_dependency "static_db"
-  # ...
-end
-```
-
-Or adding to your project:
+Add it to your Rails project:
 
 ```ruby
 # Gemfile
 gem "static_db"
+
+# config/initializer/static_db.rb
+StaticDb.configure do |config|
+  # `content/data` is the default. You only need this initializer,
+  # if you want a custom path.
+  config.fixture_path = Rails.root.join("content", "data")
+end
 ```
 
-### Supported Ruby versions
+## Usage
 
-- Ruby (MRI) >= 2.7.0
-- JRuby >= 9.3.0
+Only use on Rails projects with SQLite. Have a valid `db/schema.rb`. For additional dramatic effect, do a `rails db:drop`.
 
-## Usage
+Start your app with `bin/dev`. You will notice that a DB gets created for you. It will be empty.
 
-TBD
+Create some records. Then, stop your server with Ctrl+C.
 
-## Contributing
+The DB contents will have been dumped to `content/data`. Your SQLite DB will be gone.
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/dunkelziffer/static_db](https://github.com/dunkelziffer/static_db).
+Restart your server with `bin/dev`. Your SQLite DB will be back and populated with all previously stored data, recreated from `content/data`.
 
-## Credits
+## Contributing
 
-This gem is generated via [`newgem` template](https://github.com/palkan/newgem) by [@palkan](https://github.com/palkan).
+Bug reports and pull requests are welcome on GitHub at [https://github.com/dunkelziffer/static_db](https://github.com/dunkelziffer/static_db).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError
+  task(:rubocop) {}
+end
+
+task default: %w[rubocop spec]

data/lib/static_db/dump.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
 module StaticDb
   class Dump
 
-    attr_reader :fixture_path
+    attr_reader :fixture_path, :models_to_be_saved
 
     def initialize(fixture_path:)
       @fixture_path = Pathname.new(fixture_path)
@@ -37,9 +35,7 @@ module StaticDb
 
       errors = []
 
-      ActiveRecord::Base.descendants.each do |model|
-        next if model.abstract_class?
-
+      models_to_be_saved.each do |model|
         model.find_each do |record|
           unless record.valid?
             errors << { model: model.name, slug: record.slug, errors: record.errors.full_messages }
@@ -65,7 +61,7 @@ module StaticDb
 
     def dump_fixtures!
       reset_data_directory!
-      @models_to_be_saved.each { |model| format_and_write_yaml_file!(model) }
+      models_to_be_saved.each { |model| format_and_write_yaml_file!(model) }
     end
 
     def reset_data_directory!

data/lib/static_db/engine.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "static_db/initializer"
 
 module StaticDb # :nodoc:

data/lib/static_db/initializer.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "ostruct"
 
 module StaticDb

data/lib/static_db/load.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module StaticDb
   class Load
 

data/lib/static_db/tasks/static.rake

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 namespace :static do
   desc "Create fixtures from database; accepts optional path argument"
   task :dump, [:path] => :environment do |t, args|

data/lib/static_db/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module StaticDb # :nodoc:
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/static_db.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "static_db/version"
 require "static_db/dump"
 require "static_db/load"

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: static_db
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Klaus Weidinger
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -15,73 +15,32 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
-description: Example description
+        version: '0.6'
+description: Dump DB contents to YAML and load them back again. Aimed at SQLite. Committable
+  to git.
 email:
-- Klaus Weidinger
+- weidkl@gmx.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -89,6 +48,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/static_db.rb
 - lib/static_db/dump.rb
 - lib/static_db/engine.rb
@@ -100,12 +60,12 @@ homepage: https://github.com/dunkelziffer/static_db
 licenses:
 - MIT
 metadata:
+  source_code_uri: https://github.com/dunkelziffer/static_db
   homepage_uri: https://github.com/dunkelziffer/static_db
   changelog_uri: https://github.com/dunkelziffer/static_db/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/dunkelziffer/static_db/issues
   documentation_uri: https://github.com/dunkelziffer/static_db/blob/main/README.md
-  source_code_uri: https://github.com/dunkelziffer/static_db
-  custom_attribute: a, b, c
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -120,7 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.8
 specification_version: 4
-summary: Example description
+summary: Dump DB contents to YAML and load them back again. Aimed at SQLite. Committable
+  to git.
 test_files: []