feat: Added base generator for ActiveRecord (devise-security#447)

* feat: Added base generator for ActiveRecord

* test: Update simplecov filters

Author: itsmechlark

.gitignore

@@ -1,5 +1,5 @@
-test/rails_app/log/*
-test/rails_app/tmp/*
+test/dummy/log/*
+test/dummy/tmp/*
 *~
 coverage/*
 *.sqlite3

lib/generators/active_record/devise_security_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../devise_security/migration_generator'
+
+# nodoc
+module ActiveRecord
+  # nodoc
+  module Generators
+    # Generator migration for DeviseSecurity
+    # Usage:
+    #  rails generate active_record:devise_security
+    class DeviseSecurityGenerator < ::DeviseSecurity::MigrationGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migration_file
+        # TODO: Add some migration here
+        # add_devise_security_migration 'some_migration_template'
+      end
+    end
+  end
+end

lib/generators/active_record/templates/.keep

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+# nodoc
+module DeviseSecurity
+  # Basic structure to support a generator that builds a migration
+  class MigrationGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    # Implement the required interface for Rails::Generators::Migration.
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    # Creates a devise security migration template.
+    #
+    # @param template [String] The name of the migration template
+    # @param extra_options [Hash] The options Additional options for the migration template (default: {})
+    # @return [void]
+    def add_devise_security_migration(template, extra_options = {})
+      migration_dir = File.expand_path('db/migrate')
+      return if self.class.migration_exists?(migration_dir, template)
+
+      migration_template(
+        "#{template}.rb.erb",
+        "db/migrate/#{template}.rb",
+        { migration_version: migration_version }.merge(extra_options)
+      )
+    end
+
+    # Checks if the Rails version is 6.1 or higher
+    #
+    # @return [Boolean] true if the Rails version is 6.1 or higher, false otherwise.
+    def rails61_and_up?
+      Rails.gem_version >= Gem::Version.new('6.1.0')
+    end
+
+    # Retrieves the ActiveRecord configuration
+    def ar_config
+      # Rails 6.0+ uses ActiveRecord::Base.configurations.configs_for
+      # Read more: https://github.com/rails/rails/pull/38256
+      if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+        if rails61_and_up?
+          # Rails 6.1+ uses ActiveRecord::Base.configurations.configs_for(env_name:, name:)
+          # Read more: https://github.com/rails/rails/pull/38536
+          ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: 'primary').configuration_hash
+        else
+          ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, spec_name: 'primary').config
+        end
+      else
+        ActiveRecord::Base.configurations[Rails.env]
+      end
+    end
+
+    # Retrieves the migration version
+    def migration_version
+      format(
+        '[%<major>s.%<minor>s]',
+        major: ActiveRecord::VERSION::MAJOR,
+        minor: ActiveRecord::VERSION::MINOR
+      )
+    end
+  end
+end

lib/generators/devise_security/migration_generator.rb

@@ -0,0 +1,13 @@
+class CreateSomeTable < ActiveRecord::Migration<%= migration_version %>
+  def up
+    create_table :some_table do |t|
+      t.string :adapter_name, default: '<%= ar_config['adapter'] %>'
+      t.string :rails61_and_up, default: <%= rails61_and_up? %>
+      t.timestamps null: false
+    end
+  end
+
+  def down
+    drop_table :some_table
+  end
+end

test/generators/templates/create_some_table.rb.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+if DEVISE_ORM == :active_record
+  require 'generators/active_record/devise_security_generator'
+
+  class TestActiveRecordGenerator < Rails::Generators::TestCase
+    tests ActiveRecord::Generators::DeviseSecurityGenerator
+    destination File.expand_path('../dummy/tmp', __dir__)
+    setup :prepare_destination
+
+    test 'all files are properly created with migration syntax' do
+      assert_nothing_raised { run_generator }
+    end
+  end
+end

test/generators/test_active_record_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+if DEVISE_ORM == :active_record
+  require 'generators/devise_security/migration_generator'
+
+  class TestMigrationGenerator < Rails::Generators::TestCase
+    class Migration < ::DeviseSecurity::MigrationGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migration_file
+        add_devise_security_migration 'create_some_table'
+      end
+    end
+
+    tests Migration
+    destination File.expand_path('../dummy/tmp', __dir__)
+    setup :prepare_destination
+
+    test 'all files are properly created with migration syntax' do
+      assert_nothing_raised { run_generator }
+      assert_migration 'db/migrate/create_some_table.rb', /create_table :some_table do |t|/
+    end
+  end
+end

test/generators/test_migration_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 ENV['RAILS_ENV'] ||= 'test'
+ENV['DEVISE_ORM'] ||= 'active_record'
 
 require 'simplecov'
 
@@ -11,8 +12,15 @@
 end
 
 SimpleCov.start do
-  add_filter 'gemfiles'
-  add_filter 'test/dummy/db'
+  add_filter %r{^/gemfiles/}
+  add_filter %r{^/test/dummy/}
+  if ENV['DEVISE_ORM'] == 'active_record'
+    add_filter %r{/mongoid/}
+  else
+    add_filter %r{^/lib/generators/(active_record|migration_generator)}
+    add_filter %r{^/test/generators}
+    add_filter %r{/active_record/}
+  end
   add_group 'ActiveRecord', 'active_record'
   add_group 'Expirable', /(?<!password_)expirable/
   add_group 'Mongoid', 'mongoid'