dynamic-active-model-rails 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8515d28d9394768614fb8cd2f4cf49173ab1d5f97c905debbf3f9dc85d21f21
-  data.tar.gz: 33388b8956cc6106da4d6d94d0255a15b66d6156be30a49cfa9c941f31f3ed4e
+  metadata.gz: e99654c467d82a550320a4952955c2ac035a218940ba178f4aab57ea6036c438
+  data.tar.gz: fc7f43e364ced45bd2d52e0ea918ae4498ea690d3414a1c830c20f03495dc836
 SHA512:
-  metadata.gz: ed7b1653b8ea5643e50b797a0cad76714958d204052ee97ba44cd10eed2e3f2103e20bcad4c16ee7277a12886ef85cceb6421a8ca41c485dec72dbac67b89fc4
-  data.tar.gz: 42a9e8a11125f32d8e9ea403662e232d602595c776c7829a05f7759fd14f4c9fa88822100fd92dd52c2e2188fb39c1d95082eb62c0bef16f6f5c2c17ba13beed
+  metadata.gz: edd5f4bacf38a6a2e3fa610da7f6fe4aa01e781d7675feeb39164e97085842fbdaeb85d6ba8bc027b09672a58adaec9f875db1cdf352868a5c91b38ecece64cb
+  data.tar.gz: 6e5616c8bb2b5ca5c3fc7868f51d6b22b9c40ec0bfb6fd3d8c9942e57fc321eb7c445b1a09628416c71aee958b0c926c2cf7ca2239cce482fa9f5de48b5fcbbf

data/README.md

@@ -13,6 +13,21 @@ gem 'dynamic-active-model-rails'
 
 `dynamic-active-model-rails` is released in lockstep with `dynamic-active-model` and pins the same version.
 
+## Generators
+
+```bash
+bin/rails generate dynamic_active_model:install                        # DB, app/models/db/
+bin/rails generate dynamic_active_model:install grant_db               # GrantDB, app/models/grant_db/
+bin/rails generate dynamic_active_model:database cars --connection cars
+bin/rails generate dynamic_active_model:extension grant_db users       # app/models/grant_db/users.ext.rb
+```
+
+- **`install [NAME]`** creates `config/initializers/dynamic_active_model.rb`, declaring the first database (default `db`), and its models folder.
+- **`database NAME`** adds another `add_database` line to the initializer and creates the folder. It refuses a namespace the app already declares.
+- **`extension DATABASE TABLE`** creates an extension file. `DATABASE` can be a name (`grant_db`) or a namespace (`GrantDB`). The generator uses the app's configuration, so a custom `extensions_path:` or `extensions_suffix:` is respected.
+
+`--connection NAME` points the database at a `database.yml` entry. The generators warn if the current environment has no such entry. Without `--connection`, the database shares `ApplicationRecord`'s connection.
+
 ## Configuration
 
 ```ruby

data/lib/generators/dynamic_active_model/database/database_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative '../database_arguments'
+
+module DynamicActiveModel
+  module Generators
+    # rails g dynamic_active_model:database NAME [--connection=NAME]
+    class DatabaseGenerator < ::Rails::Generators::Base
+      include DatabaseArguments
+
+      desc 'Declares another database in config/initializers/dynamic_active_model.rb ' \
+           '(e.g. cars => CarsDB in app/models/cars_db/).'
+
+      argument :name, type: :string, banner: 'NAME'
+
+      def check_initializer
+        return if File.exist?(File.join(destination_root, INITIALIZER))
+
+        raise Thor::Error, "#{INITIALIZER} not found; run rails g dynamic_active_model:install first"
+      end
+
+      def check_not_declared
+        raise Thor::Error, "#{definition.module_name} is already declared" if declared?
+      end
+
+      def add_database
+        inject_into_file INITIALIZER, "  #{add_database_line}\n", before: /^end\b/
+      end
+
+      def create_models_folder
+        create_extensions_folder
+      end
+
+      def check_connection
+        warn_about_missing_connection
+      end
+
+      private
+
+      # @return [Boolean] Whether the app already declares this namespace
+      def declared?
+        DynamicActiveModel::Rails.configuration.definitions.any? { |db| db.module_name == definition.module_name }
+      end
+    end
+  end
+end

data/lib/generators/dynamic_active_model/database_arguments.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DynamicActiveModel
+  module Generators
+    # Shared --connection option and helpers for generators that declare a database
+    module DatabaseArguments
+      INITIALIZER = 'config/initializers/dynamic_active_model.rb'
+
+      def self.included(base)
+        base.class_option :connection,
+                          type: :string,
+                          desc: "database.yml entry to connect to (default: share ApplicationRecord's connection)"
+      end
+
+      private
+
+      # @return [DynamicActiveModel::Rails::DatabaseDefinition] Naming for the NAME argument
+      def definition
+        @definition ||= DynamicActiveModel::Rails::DatabaseDefinition.new(name)
+      end
+
+      # @return [String] e.g. "config.add_database :cars, :cars"
+      def add_database_line
+        args = [name.underscore.to_sym.inspect]
+        args << options[:connection].to_sym.inspect if options[:connection]
+        "config.add_database #{args.join(', ')}"
+      end
+
+      # Creates the database's models folder for its extension files
+      # @return [void]
+      def create_extensions_folder
+        create_file File.join(definition.extensions_path(destination_root), '.keep')
+      end
+
+      # Warns when --connection names a database.yml entry the current environment lacks
+      # @return [void]
+      def warn_about_missing_connection
+        return unless options[:connection]
+        return if ActiveRecord::Base.configurations.configs_for(env_name: ::Rails.env, name: options[:connection])
+
+        say_status :warning, "config/database.yml has no #{options[:connection]} entry for #{::Rails.env}", :yellow
+      end
+    end
+  end
+end

data/lib/generators/dynamic_active_model/extension/extension_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module DynamicActiveModel
+  module Generators
+    # rails g dynamic_active_model:extension DATABASE TABLE
+    class ExtensionGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc 'Creates an extension file for a table of a declared database ' \
+           '(e.g. grant_db users => app/models/grant_db/users.ext.rb).'
+
+      argument :database, type: :string, banner: 'DATABASE'
+      argument :table, type: :string, banner: 'TABLE'
+
+      def create_extension
+        template 'extension.rb.tt', File.join(definition.extensions_path(destination_root), file_name)
+      end
+
+      private
+
+      # The declared database named by DATABASE, as a name (grant_db) or namespace (GrantDB)
+      # @return [DynamicActiveModel::Rails::DatabaseDefinition]
+      # @raise [Thor::Error] If no such database is declared
+      def definition
+        @definition ||= declared.find { |db| [database, default_module_name].include?(db.module_name) } ||
+                        raise(Thor::Error, "no database #{database} is declared " \
+                                           "(declared: #{declared.map(&:module_name).join(', ')})")
+      end
+
+      # @return [Array<DynamicActiveModel::Rails::DatabaseDefinition>]
+      def declared
+        DynamicActiveModel::Rails.configuration.definitions
+      end
+
+      # @return [String] Namespace DATABASE maps to by default, e.g. "GrantDB"
+      def default_module_name
+        DynamicActiveModel::Rails::DatabaseDefinition.new(database).module_name
+      end
+
+      # @return [String] e.g. "users.ext.rb"
+      def file_name
+        "#{table}#{definition.extensions_suffix}"
+      end
+
+      # @return [String] e.g. "GrantDB::User"
+      def model_name
+        "#{definition.module_name}::#{definition.table_class_names[table] || table.classify}"
+      end
+    end
+  end
+end

data/lib/generators/dynamic_active_model/extension/templates/extension.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Extends <%= model_name %> (table <%= table %>). Columns and associations that
+# follow foreign key conventions are detected from the schema; add the rest here:
+# through/polymorphic associations, validations, scopes and methods.
+update_model do
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative '../database_arguments'
+
+module DynamicActiveModel
+  module Generators
+    # rails g dynamic_active_model:install [NAME] [--connection=NAME]
+    class InstallGenerator < ::Rails::Generators::Base
+      include DatabaseArguments
+
+      source_root File.expand_path('templates', __dir__)
+      desc 'Creates config/initializers/dynamic_active_model.rb declaring a first database ' \
+           '(default: db, i.e. DB in app/models/db/).'
+
+      argument :name, type: :string, default: 'db', banner: 'NAME'
+
+      def create_initializer
+        template 'dynamic_active_model.rb.tt', INITIALIZER
+      end
+
+      def create_models_folder
+        create_extensions_folder
+      end
+
+      def check_connection
+        warn_about_missing_connection
+      end
+    end
+  end
+end

data/lib/generators/dynamic_active_model/install/templates/dynamic_active_model.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Each database's tables become ActiveRecord models in a <Name>DB namespace. Models
+# are built on first use and rebuilt after code reloads and migrations. Per-table
+# extensions go in app/models/<name>_db/<table_name>.ext.rb.
+# https://github.com/dougyouch/dynamic-active-model/tree/master/dynamic-active-model-rails
+#
+# Add databases with bin/rails g dynamic_active_model:database NAME, or by hand:
+#   config.add_database :cars, :cars do |db|  # CarsDB, "cars" entry in database.yml
+#     db.skip_tables 'legacy_*'
+#   end
+DynamicActiveModel::Rails.configure do |config|
+  <%= add_database_line %>
+end
+
+# Setup that touches the models (e.g. has_paper_trail) belongs in a load hook,
+# which runs after every build of <%= definition.module_name %>'s models:
+# ActiveSupport.on_load(<%= definition.load_hook.inspect %>) do
+#   get_model!(:users).has_paper_trail
+# end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic-active-model-rails
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Doug Youch
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,12 @@ files:
 - lib/dynamic-active-model/rails/lazy_namespace.rb
 - lib/dynamic-active-model/rails/railtie.rb
 - lib/dynamic-active-model/rails/schema_change_hook.rb
+- lib/generators/dynamic_active_model/database/database_generator.rb
+- lib/generators/dynamic_active_model/database_arguments.rb
+- lib/generators/dynamic_active_model/extension/extension_generator.rb
+- lib/generators/dynamic_active_model/extension/templates/extension.rb.tt
+- lib/generators/dynamic_active_model/install/install_generator.rb
+- lib/generators/dynamic_active_model/install/templates/dynamic_active_model.rb.tt
 homepage: https://github.com/dougyouch/dynamic-active-model/tree/master/dynamic-active-model-rails
 licenses:
 - MIT