static_db 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd3f2f094d3c3ab0c462e0eba2798ec64c381df7383334adf8af3bdad6ba471c
-  data.tar.gz: 9adfc8dc949619e3cad19f68c8e566fc79ac31ee0cbbecdb0d1c95373d59e832
+  metadata.gz: 57ead27ee0cc81c76fcb1f83c2b279819f3680895a59ab3e4dfcb80e26dad472
+  data.tar.gz: ac0d29ebfcc4a433f47b3e7e636e239937e2b41ecd905aabc280d045dd173ab8
 SHA512:
-  metadata.gz: 53ebfcd55d3e094489d6e662aa38b2735c2832dda24dce4fb45e3ccc4e243193628a873647b93dce524a712a50819d7b358471f5aaca95bea4b61159941273cc
-  data.tar.gz: be1ebfc35a13130da12a498418667cf964d8bde2d6758ff476d10132867121aea0635c3ff191955ecdd334b447f0780425358178149baf840c0f7ac4d8eccb64
+  metadata.gz: b070a834bc54a708fa340a65645160d36612774eabbd712893e9875e2e45e7ade87e40632f51f5e9eb489dc6b4cf8230b85a1f43ad0b46f05693de596db69cd6
+  data.tar.gz: 9dbb730c2a93af6ac1d8f70e0ea277ddb7394e4ccbdefe6f6a2278d3bbf4c877c2798e53f5a04dccede9a2ea941e0e109f2ccb32fbcaa953bbf28b6a02f49434

data/README.md

@@ -4,36 +4,41 @@
 
 # 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
 
-- Ruby (MRI) >= 2.7.0
-- JRuby >= 9.3.0
+- Ruby (MRI) >= 3.2.0
 
 ## Usage
 
-TBD
+Only use on Rails projects with SQLite. Have a valid `db/schema.rb`. For additional dramatic effect, do a `rails db:drop`.
+
+Start your app with `bin/dev`. You will notice that a DB gets created for you. It will be empty.
+
+Create some records. Then, stop your server with Ctrl+C.
+
+The DB contents will have been dumped to `content/data`. Your SQLite DB will be gone.
+
+Restart your server with `bin/dev`. Your SQLite DB will be back and populated with all previously stored data, recreated from `content/data`.
 
 ## Contributing
 

data/lib/static_db/dump.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module StaticDb
+  class Dump
+
+    attr_reader :fixture_path, :models_to_be_saved
+
+    def initialize(fixture_path:)
+      @fixture_path = Pathname.new(fixture_path)
+      @models_to_be_saved = models
+    end
+
+    def perform
+      exit 1 if $skip_active_fixtures_dump
+
+      reenable_rake_tasks!
+      validate_records!
+
+      puts green("Dumping fixtures ...")
+
+      dump_fixtures!
+      Rake::Task["db:drop"].invoke
+
+      puts green("Done!")
+    end
+
+    private
+
+    def reenable_rake_tasks!
+      ["db:drop"].each do |task_name|
+        Rake::Task[task_name].reenable
+      end
+    end
+
+    def validate_records!
+      puts green("Validating records ...")
+
+      errors = []
+
+      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 }
+          end
+        end
+      end
+
+      if errors.any?
+        puts red("Found #{errors.length} invalid records!")
+        errors.each do |error|
+          puts "- #{error[:model]} #{error[:slug]}: #{error[:errors].join(", ")}"
+        end
+        if ARGV.first == "build"
+          puts red("Build failed!")
+          exit 1
+        else
+          puts red("Please fix the invalid records before creating a PR!")
+        end
+      else
+        puts green("Done!")
+      end
+    end
+
+    def dump_fixtures!
+      reset_data_directory!
+      models_to_be_saved.each { |model| format_and_write_yaml_file!(model) }
+    end
+
+    def reset_data_directory!
+      FileUtils.rm_rf(fixture_path)
+      FileUtils.mkdir_p(fixture_path)
+    end
+
+    def format_and_write_yaml_file!(model)
+      instances = fetch_model_instances(model)
+      output = format_instances(model: model, instances: instances)
+      write_yaml_file!(model: model, data: output)
+    end
+
+    def fetch_model_instances(model)
+      model.unscoped.all.order('id ASC')
+    end
+
+    # TODO: check against old implementation!
+    def format_instances(model:, instances:)
+      output = {}
+
+      instances.each.with_index(1) do |instance, index|
+        attrs = {}
+
+        model.columns.each do |column|
+          value = instance.read_attribute_before_type_cast(column.name)
+          attrs[column.name] = value unless value.nil?
+        end
+
+        output["#{model}_#{index}"] = attrs
+      end
+
+      output
+    end
+
+    def write_yaml_file!(model:, data:)
+      File.open(yaml_file_path(model), 'w') { |file| file << data.to_yaml }
+    end
+
+    def models
+      Rails.application.eager_load!
+      models = ActiveRecord::Base.descendants
+      models.select! { |model| model.table_exists? && model.any? }
+      models.delete(ActiveRecord::SchemaMigration)
+      models
+    end
+
+    def yaml_file_path(model)
+      File.join(fixture_path, generate_file_name(model) + '.yml')
+    end
+
+    def generate_file_name(model)
+      model.table_name
+    end
+
+    def green(text)
+      "\e[32m#{text}\e[0m"
+    end
+
+    def red(text)
+      "\e[31m#{text}\e[0m"
+    end
+
+  end
+end

data/lib/static_db/engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "static_db/initializer"
+
+module StaticDb # :nodoc:
+  class Engine < ::Rails::Engine # :nodoc:
+    isolate_namespace StaticDb
+
+    rake_tasks do
+      load File.expand_path("./tasks/static.rake", __dir__)
+    end
+
+    initializer "static_db.configure" do |app|
+      if defined?(Rails::Server) || defined?(Rails::Console) || ARGV.first == "build"
+        Rails.application.config.after_initialize do
+          unless Object.const_defined?("Rake::Task") && Rake::Task.task_defined?("static:load")
+            Rails.application.load_tasks
+          end
+
+          Rake::Task["static:load"].invoke
+        end
+
+        at_exit do
+          unless Object.const_defined?("Rake::Task") && Rake::Task.task_defined?("static:dump")
+            Rails.application.load_tasks
+          end
+
+          Rake::Task["static:dump"].invoke
+        end
+      end
+    end
+
+  end
+end

data/lib/static_db/initializer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module StaticDb
+  # Configuration and setup utility.  The engine automatically requires this
+  # file during Rails initialization, so applications can simply call
+  # `StaticDb.configure` from **any** initializer (or even the engine's own
+  # initializer).  It behaves exactly like an initializer placed in
+  # `config/initializers` of a Rails project.
+  #
+  # Example usage from a host application:
+  #
+  #   # config/initializers/static_db.rb
+  #   StaticDb.configure do |config|
+  #     config.dump_path = Rails.root.join("content", "data")
+  #     #
+  #     # The rake tasks also accept an explicit path argument which is passed to
+  #     # the `StaticDb::Dump`/`Load` constructors; the configuration value is
+  #     # used when the argument is omitted.
+  #   end
+  #
+  # The configuration object is a plain OpenStruct and may be extended by
+  # the application or other libraries.
+  def self.configure
+    @config ||= OpenStruct.new
+    yield @config if block_given?
+    @config.fixture_path ||= Rails.root.join("content", "data")
+    @config
+  end
+
+  def self.config
+    @config || configure
+  end
+end

data/lib/static_db/load.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module StaticDb
+  class Load
+
+    attr_reader :fixture_path
+
+    def initialize(fixture_path:)
+      @fixture_path = Pathname.new(fixture_path)
+    end
+
+    def perform
+      puts green("Loading fixtures ...")
+
+      reenable_rake_tasks!
+      Rake::Task["db:create"].invoke
+      Rake::Task["db:schema:load"].invoke
+      load_fixtures!
+
+      puts green("Done!")
+    rescue => e
+      puts red("Failed to load fixtures: #{e.message}")
+      puts red("Exiting and skipping active_fixtures:dump!")
+      $skip_active_fixtures_dump = true
+      exit 1
+    end
+
+    private
+
+    def reenable_rake_tasks!
+      ["db:create", "db:schema:load"].each do |task_name|
+        Rake::Task[task_name].reenable
+      end
+    end
+
+    def load_fixtures!
+      base_names = Dir.glob(File.join(fixture_path, "*.yml")).map do |file|
+        File.basename(file, ".*")
+      end
+
+      ActiveRecord::FixtureSet.create_fixtures(fixture_path, base_names)
+    end
+
+    def green(text)
+      "\e[32m#{text}\e[0m"
+    end
+
+    def red(text)
+      "\e[31m#{text}\e[0m"
+    end
+
+  end
+end

data/lib/static_db/tasks/static.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+namespace :static do
+  desc "Create fixtures from database; accepts optional path argument"
+  task :dump, [:path] => :environment do |t, args|
+    path = if args[:path].blank?
+      StaticDb.config.fixture_path
+    else
+      Rails.root.join(args[:path])
+    end
+
+    StaticDb::Dump.new(fixture_path: path).perform
+  end
+
+  desc "Create database from fixtures; accepts optional path argument"
+  task :load, [:path] => :environment do |t, args|
+    path = if args[:path].blank?
+      StaticDb.config.fixture_path
+    else
+      Rails.root.join(args[:path])
+    end
+
+    StaticDb::Load.new(fixture_path: path).perform
+  end
+end

data/lib/static_db/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StaticDb # :nodoc:
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/static_db.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 require "static_db/version"
-require "static_db/railtie" if defined?(Rails::Railtie)
+require "static_db/dump"
+require "static_db/load"
+require "static_db/engine" if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static_db
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Klaus Weidinger
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +90,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/static_db.rb
-- lib/static_db/railtie.rb
+- lib/static_db/dump.rb
+- lib/static_db/engine.rb
+- lib/static_db/initializer.rb
+- lib/static_db/load.rb
+- lib/static_db/tasks/static.rake
 - lib/static_db/version.rb
 homepage: https://github.com/dunkelziffer/static_db
 licenses:
@@ -95,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Example description
 test_files: []

data/lib/static_db/railtie.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module StaticDb # :nodoc:
-  class Railtie < ::Rails::Railtie # :nodoc:
-  end
-end