static_db 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20d2161d54e8efc24b529deb87f934c9396a75f2943598a72ce3b9b6f71cd265
-  data.tar.gz: ca21c07aa5f2dfa151e683719c5de3f9aff57f8ef8bdd729618718b30d301623
+  metadata.gz: 21a5a8909bd4d182d4045ce780e15d9d33c2a2e226148e76928ef76391b6c465
+  data.tar.gz: 901c8f63945110038f237f562150106d167c2eb6033ec17cf82e60eda97df89a
 SHA512:
-  metadata.gz: 129469328ab921155e7ff25c5cdca998cb6587febdec05bbe36939473ef2431189e5d5ea46e188638335f8d909a6b7c7739ceb1ed32ea881faf65ce816a7370b
-  data.tar.gz: 4dec7f69183acab466df33e7ff24d686054472238f6294935afd780d32e6b103fd02d54f543ac9917604c0426775d3e519d81bdd09f57217f8f003a048d4f904
+  metadata.gz: 6ff8c6ac84a7a469918dfe1781b4aa94fee65fb81a7bda3f858f11e5be4b7681da9913d7e502bcf8f25270f1f7bf60fdda5a95a8b93a9d861a1eb17bd0dbf8c4
+  data.tar.gz: befb42dbc227cac64482b9dfcd966c0f0f53754ccb3d71eff0893791c2fe3889f544c674d45a4c97c563026196e6ff2c9da28f2ceb1611bc72fb9afca79362b0

data/CHANGELOG.md

@@ -1,13 +1,31 @@
 # Changelog
 
-> :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
+
+-
+
+## [0.1.0] - 2026-05-03
+
+### Breaking
+
+- Drop database at a different point in time now. It's possible, but unlikely that this breaks anything for you.
+  - Previously: `db:drop` happend after dumping out data on shutdown.
+    - If dumping data failed, your `.sqlite3` files would remain and the next boot would fail.
+    - If everything succeeded, it worked OK, but keeping the `.sqlite3` files around might still be beneficial.
+  - Now: `db:drop` happens before loading data on boot.
+    - After a failed shutdown (e.g. due to validation errors), you don't need to manually delete the files anymore.
+      Restarting your Rails servers discards all data changes.
+    - After an interrupted shutdown (e.g. `bin/dev` / `foreman` killing your Rails process too early) you can
+      now retry dumping data via `bin/rails static:dump`.
+
+### Non-breaking
+
+- Internal code cleanup

data/README.md

@@ -7,14 +7,16 @@ Dump DB contents to YAML and load them back again. Aimed at SQLite. Committable
 
 ## Installation
 
-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.
+> ⚠️ 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.
 
 Add it to your Rails project:
 
 ```ruby
 # Gemfile
 gem "static_db"
+```
 
+```ruby
 # config/initializer/static_db.rb
 StaticDb.configure do |config|
   # `content/data` is the default. You only need this initializer,
@@ -25,15 +27,15 @@ end
 
 ## Usage
 
-Only use on Rails projects with SQLite. Have a valid `db/schema.rb`. For additional dramatic effect, do a `rails db:drop`.
+> ⚠️ Only use on Rails projects with SQLite. Have a valid `db/schema.rb`.
 
 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.
+The DB contents will have been dumped to `content/data`.
 
-Restart your server with `bin/dev`. Your SQLite DB will be back and populated with all previously stored data, recreated from `content/data`.
+Restart your server with `bin/dev`. Your SQLite DB will be dropped and recreated with all previously stored data from `content/data`.
 
 ## Contributing
 

data/lib/static_db/configurable.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# Copied and inlined from Rails, as it was deprecated there.
+
+require "active_support/concern"
+require "active_support/ordered_options"
+
+module StaticDb
+  # = Active Support \Configurable
+  #
+  # Configurable provides a <tt>config</tt> method to store and retrieve
+  # configuration options as an OrderedOptions.
+  module Configurable
+    extend ActiveSupport::Concern
+
+    class Configuration < ActiveSupport::InheritableOptions
+      def compile_methods!
+        self.class.compile_methods!(keys)
+      end
+
+      # Compiles reader methods so we don't have to go through method_missing.
+      def self.compile_methods!(keys)
+        keys.reject { |m| method_defined?(m) }.each do |key|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{key}; _get(#{key.inspect}); end
+          RUBY
+        end
+      end
+    end
+
+    module ClassMethods
+      # Reads and writes attributes from a configuration OrderedOptions.
+      #
+      #   require "active_support/configurable"
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #   end
+      #
+      #   User.config.allowed_access = true
+      #   User.config.level = 1
+      #
+      #   User.config.allowed_access # => true
+      #   User.config.level          # => 1
+      def config
+        @_config ||= if respond_to?(:superclass) && superclass.respond_to?(:config)
+          superclass.config.inheritable_copy
+        else
+          # create a new "anonymous" class that will host the compiled reader methods
+          Class.new(Configuration).new
+        end
+      end
+
+      # Configure values from within the passed block.
+      #
+      #   require "active_support/configurable"
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #   end
+      #
+      #   User.allowed_access # => nil
+      #
+      #   User.configure do |config|
+      #     config.allowed_access = true
+      #   end
+      #
+      #   User.allowed_access # => true
+      def configure
+        yield config
+      end
+
+      # Allows you to add shortcut so that you don't have to refer to attribute
+      # through config. Also look at the example for config to contrast.
+      #
+      # Defines both class and instance config accessors.
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #     config_accessor :allowed_access
+      #   end
+      #
+      #   User.allowed_access # => nil
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   user = User.new
+      #   user.allowed_access # => false
+      #   user.allowed_access = true
+      #   user.allowed_access # => true
+      #
+      #   User.allowed_access # => false
+      #
+      # The attribute name must be a valid method name in Ruby.
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #     config_accessor :"1_Badname"
+      #   end
+      #   # => NameError: invalid config attribute name
+      #
+      # To omit the instance writer method, pass <tt>instance_writer: false</tt>.
+      # To omit the instance reader method, pass <tt>instance_reader: false</tt>.
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #     config_accessor :allowed_access, instance_reader: false, instance_writer: false
+      #   end
+      #
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   User.new.allowed_access = true # => NoMethodError
+      #   User.new.allowed_access        # => NoMethodError
+      #
+      # Or pass <tt>instance_accessor: false</tt>, to omit both instance methods.
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #     config_accessor :allowed_access, instance_accessor: false
+      #   end
+      #
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   User.new.allowed_access = true # => NoMethodError
+      #   User.new.allowed_access        # => NoMethodError
+      #
+      # Also you can pass <tt>default</tt> or a block to set up the attribute with a default value.
+      #
+      #   class User
+      #     include ActiveSupport::Configurable
+      #     config_accessor :allowed_access, default: false
+      #     config_accessor :hair_colors do
+      #       [:brown, :black, :blonde, :red]
+      #     end
+      #   end
+      #
+      #   User.allowed_access # => false
+      #   User.hair_colors # => [:brown, :black, :blonde, :red]
+      def config_accessor(*names, instance_reader: true, instance_writer: true, instance_accessor: true, default: nil) # :doc:
+        names.each do |name|
+          raise NameError.new("invalid config attribute name") unless /\A[_A-Za-z]\w*\z/.match?(name)
+
+          reader, reader_line = "def #{name}; config.#{name}; end", __LINE__
+          writer, writer_line = "def #{name}=(value); config.#{name} = value; end", __LINE__
+
+          singleton_class.class_eval reader, __FILE__, reader_line
+          singleton_class.class_eval writer, __FILE__, writer_line
+
+          if instance_accessor
+            class_eval reader, __FILE__, reader_line if instance_reader
+            class_eval writer, __FILE__, writer_line if instance_writer
+          end
+
+          send("#{name}=", block_given? ? yield : default)
+        end
+      end
+      private :config_accessor
+
+      private
+        def inherited(subclass)
+          super
+          subclass.class_eval do
+            @_config = nil
+          end
+        end
+    end
+
+    # Reads and writes attributes from a configuration OrderedOptions.
+    #
+    #   require "active_support/configurable"
+    #
+    #   class User
+    #     include ActiveSupport::Configurable
+    #   end
+    #
+    #   user = User.new
+    #
+    #   user.config.allowed_access = true
+    #   user.config.level = 1
+    #
+    #   user.config.allowed_access # => true
+    #   user.config.level          # => 1
+    def config
+      @_config ||= self.class.config.inheritable_copy
+    end
+  end
+end

data/lib/static_db/dump.rb

@@ -3,7 +3,7 @@ module StaticDb
 
     attr_reader :fixture_path, :models_to_be_saved
 
-    def initialize(fixture_path:)
+    def initialize(fixture_path: StaticDb.config.fixture_path)
       @fixture_path = Pathname.new(fixture_path)
       @models_to_be_saved = models
     end
@@ -11,25 +11,15 @@ module StaticDb
     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 ...")
 
@@ -91,7 +81,7 @@ module StaticDb
           attrs[column.name] = value unless value.nil?
         end
 
-        output["#{model}_#{model.id}"] = attrs
+        output["#{model}_#{instance.id}"] = attrs
       end
 
       output

data/lib/static_db/engine.rb

@@ -1,6 +1,18 @@
-require "static_db/initializer"
+require "static_db/configurable"
 
 module StaticDb # :nodoc:
+  # Engines are required very early in the Rails boot sequence via
+  # `Bundler.require(*Rails.groups)` in `application.rb`.
+
+  # Thus, the config is available before:
+  # - the rest of `application.rb`
+  # - `environment/*.rb`
+  # - the engines `initializer` block gets executed
+  # - regular initializers from `config/initializers/`
+  include StaticDb::Configurable
+
+  config_accessor :fixture_path, instance_accessor: false, default: -> { Rails.root.join("content", "data") }
+
   class Engine < ::Rails::Engine # :nodoc:
     isolate_namespace StaticDb
 
@@ -11,19 +23,11 @@ module StaticDb # :nodoc:
     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
+          StaticDb::Load.new.perform
         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
+          StaticDb::Dump.new.perform
         end
       end
     end

data/lib/static_db/load.rb

@@ -3,18 +3,14 @@ module StaticDb
 
     attr_reader :fixture_path
 
-    def initialize(fixture_path:)
+    def initialize(fixture_path: StaticDb.config.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
+      system("bin/rails", "db:drop", "db:create", "db:schema:load")
       load_fixtures!
-
       puts green("Done!")
     rescue => e
       puts red("Failed to load fixtures: #{e.message}")
@@ -25,12 +21,6 @@ module StaticDb
 
     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, ".*")

data/lib/static_db/tasks/static.rake

@@ -1,23 +1,19 @@
 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
+    if args[:path].blank?
+      StaticDb::Dump.new.perform
     else
-      Rails.root.join(args[:path])
+      StaticDb::Dump.new(fixture_path: Rails.root.join(args[:path])).perform
     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
+    if args[:path].blank?
+      StaticDb::Load.new.perform
     else
-      Rails.root.join(args[:path])
+      StaticDb::Load.new(fixture_path: Rails.root.join(args[:path])).perform
     end
-
-    StaticDb::Load.new(fixture_path: path).perform
   end
 end

data/lib/static_db/version.rb

@@ -1,3 +1,3 @@
 module StaticDb # :nodoc:
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static_db
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Klaus Weidinger
@@ -50,9 +50,9 @@ files:
 - README.md
 - Rakefile
 - lib/static_db.rb
+- lib/static_db/configurable.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
@@ -66,6 +66,9 @@ metadata:
   bug_tracker_uri: https://github.com/dunkelziffer/static_db/issues
   documentation_uri: https://github.com/dunkelziffer/static_db/blob/main/README.md
   rubygems_mfa_required: 'true'
+post_install_message: "⚠️ 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."
 rdoc_options: []
 require_paths:
 - lib

data/lib/static_db/initializer.rb

@@ -1,33 +0,0 @@
-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