migrate_factory_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00c651b60e4e45116ef9e831d30ba52a9e972609ce347b0675dc63c97148135a
+  data.tar.gz: 4844f07501e4fc303686f888fc7a3859ded076024799c49eaa0745cbf641def1
+SHA512:
+  metadata.gz: f124a2f9a3dd54df5c161b5c214458d6e02a3aa50c9f01b516d89c25f3c6c60e8eddde09ef3e782d535403afb21165eb513904c72692ca45c66df04cd5d018b9
+  data.tar.gz: e655960d2a1e788a12d768dabc8ae3aa24acc040374782a87f2cf71a6f090a8095c0923a2299de7c1045f014b6ae534e28c539923e7dfcc281289962d3ae6d22

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-08
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Diogo Fernandes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Rails Migrate Factory
+Completely rebuild your migrations to agilize setup and simplify schema
+
+## Install
+
+`gem install migrate_factory_rails`
+
+or add to your `Gemfile`
+
+```ruby
+group :development do
+  gem 'migrate_factory_rails'
+end
+```
+
+## How use
+
+**Be careful, rebuild do not cover all situations yet then may miss some migration**
+You can use two commands currently:
+
+- `rake rebuild:migrations` -> Will rebuild all your migrations and save on `tmp/rebuild`, then you can validate if it worths without lose any data.
+- `rake rebuild:cleanup`    -> Will cleanup all data on `tmp/rebuild`.
+
+## Goals
+
+My goal here was the challenge to rebuild every migrations from Rails, matching as close as possible the final `schema.rb` meanwhile reducing strongly the amount of migrations. Specially on old projects, there will be a lot ot migrations, sometimes for a single column or index which extends the setup for a few seconds. If is worth or not to use, feel free to discuss.
+
+## Author
+
+* [Diogo](https://github.com/dfop02)

data/lib/migrate_factory_rails/Rakefile.rb

@@ -0,0 +1,4 @@
+require 'migrate_factory_rails'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/migrate_factory_rails/builder.rb

@@ -0,0 +1,133 @@
+class MigrateFactoryRails::Builder
+  DATABASE_TYPES = %w[
+    string text binary boolean date datetime time decimal timestamp
+    index float integer references has_attached_file attachment
+  ].freeze
+
+  def initialize(*table_name, **options)
+    build_database_type_methods
+    sanitized_table_name = sanitize_table_names(table_name)
+
+    @join_table = sanitized_table_name.length > 1
+    @table_name = @join_table ? sanitized_table_name.map(&:to_s).join('_') : sanitized_table_name.first.to_s
+    @table_opt  = options
+    @table      = { "#{@table_name}": {} }
+  end
+
+  attr_reader :table_name, :table
+
+  def print_columns(space: 6)
+    table_columns.map do |column_name, column_options|
+      type = column_options.delete(:type)
+      next if type == 'index' || type.nil?
+
+      options = column_options.map do |ck, cv|
+        next if ck == 'index'
+
+        if type == 'string' && cv == ''
+          "#{ck}: ''"
+        elsif type == 'string' && ck == :default
+          "#{ck}: '#{cv}'"
+        elsif cv.is_a?(Symbol)
+          "#{ck}: #{cv.inspect}"
+        else
+          "#{ck}: #{cv}"
+        end
+      end.compact.join(', ')
+
+      printed_column = "t.#{type}#{valid_column_name(column_name)}"
+      printed_column += ", #{options}" if options.present?
+      printed_column
+    end.compact.join("\n#{' ' * space}")
+  end
+
+  def print_indexes(space: 2)
+    indexed_columns = table_columns.select { |_, c_opt| c_opt[:type] == 'index' || c_opt[:index] }
+    return '' if indexed_columns.empty?
+
+    spaces = ' ' * space
+    indexed_columns.map do |column_name, _|
+      "add_index :#{table_name},#{valid_column_name(column_name)}"
+    end.join("\n#{spaces}").insert(0, "\n\n#{spaces}")
+  end
+
+  def print_table_name_and_options
+    return print_table_name if @table_opt.blank?
+
+    "#{print_table_name}, #{@table_opt.map { |key, value| print_options_key_value(key, value) }.join(', ') }"
+  end
+
+  def print_table_name
+    return ":#{table_name.join(', :')}" if @join_table
+
+    ":#{table_name}"
+  end
+
+  def print_options_key_value(key, value)
+    value = value.inspect if value.is_a?(Symbol)
+    "#{key}: #{value}"
+  end
+
+  def print_table_type
+    @join_table ? 'create_join_table' : 'create_table'
+  end
+
+  def build_database_type_methods
+    DATABASE_TYPES.each do |name|
+      define_singleton_method(name) do |*column_names, **column_options|
+        column_names.each do |col|
+          if __method__.to_s == 'references'
+            table_columns["#{col}_id".to_sym] = column_options.merge(type: :integer)
+            next
+          end
+
+          table_columns[col] = column_options.merge(type: __method__.to_s)
+        end
+      end
+    end
+  end
+
+  def change_column_default(table_name, column_name, default)
+    @table[table_name.to_sym][column_name.to_sym][:default] = default.is_a?(Hash) ? default[:to] : default
+  end
+
+  def change_column_null(table_name, column_name, null)
+    @table[table_name.to_sym][column_name.to_sym][:null] = null
+  end
+
+  def timestamps(**column_options)
+    table_columns[:timestamps] = column_options.merge(type: __method__.to_s)
+  end
+
+  def column(column_name, type, **column_options)
+    table_columns[column_name] = column_options.merge(type: type.to_s)
+  end
+
+  def remove_column(column_name)
+    table_columns.delete(column_name.to_sym)
+  end
+
+  def add_index(column_name, **column_options)
+    table_columns[column_name][:index] = column_options.present? ? column_options : true
+  end
+
+  def remove_index(column_name)
+    table_columns[column_name].delete(:index) if table_columns[column_name][:index].present?
+  end
+
+  private
+
+  def table_columns
+    @table[@table_name.to_sym]
+  end
+
+  def valid_column_name(column_name)
+    return '' if column_name.to_sym == :timestamps
+
+    " :#{column_name}"
+  end
+
+  def sanitize_table_names(table_names)
+    table_names.select { |tn| tn.is_a?(Symbol) }
+  end
+end

data/lib/migrate_factory_rails/exceptions.rb

@@ -0,0 +1,35 @@
+require 'migrate_factory_rails/ui'
+
+class MigrateFactoryException < StandardError
+  def initialize(table_name, process, backtrace)
+    super
+    @table_name = table_name
+    @process = process
+    @backtrace = backtrace
+    log_exception
+  end
+
+  def message
+    "\nOn table #{@table_name}, I do not know how deal with:\n#{@process}"
+  end
+
+  def print_msg(msg, color = nil)
+    MigrateFactoryRails::UI.print_message(msg, color)
+  end
+
+  def log_exception
+    print_separator
+
+    print_msg("🚨🚨🚨 #{self.class} 🚨🚨🚨", :red)
+    print_msg(message, :red)
+    print_msg("\nBacktrace:\n#{@backtrace}")
+
+    print_separator
+  end
+
+  def print_separator
+    puts "\n"
+    ENV['COLUMNS'].to_i.times { print '-' }
+    puts "\n"
+  end
+end

data/lib/migrate_factory_rails/factory.rb

@@ -0,0 +1,152 @@
+require 'migrate_factory_rails/builder'
+require 'migrate_factory_rails/exceptions'
+require 'migrate_factory_rails/ui'
+
+class MigrateFactoryRails::Factory
+  def initialize(migrate_content)
+    @migrate_content = migrate_content
+    @builder         = create_table_from_migrate_content
+    @table_name      = @builder&.table_name if @builder.present?
+    build_collection_methods
+  end
+
+  attr_reader :table_name
+
+  def create_table(table_name, **options)
+    @builder = MigrateFactoryRails::Builder.new(table_name, options)
+    yield @builder
+    @builder
+  end
+
+  def create_join_table(*table_name, **options)
+    @builder = MigrateFactoryRails::Builder.new(table_name, options)
+    yield @builder
+    @builder
+  end
+
+  def add_column(_table_name, column_name, type, **column_options)
+    @builder.send(type.to_s, *column_name, **column_options)
+  end
+
+  def remove_column(_table_name, column_name, _type = nil)
+    @builder.remove_column(column_name)
+  end
+
+  def change_column_default(table_name, column_name, default)
+    @builder.change_column_default(table_name, column_name, default)
+  end
+
+  def change_column_null(table_name, column_name, null)
+    @builder.change_column_null(table_name, column_name, null)
+  end
+
+  def add_attachment(table_name, *column_name, **column_options)
+    add_column(table_name, *column_name, :attachment, **column_options)
+  end
+
+  def remove_attachment(table_name, column_name, **_column_options)
+    remove_column(table_name, column_name, :attachment)
+  end
+
+  def add_index(_table_name, column_name, **column_options)
+    @builder.add_index(column_name, **column_options)
+  end
+
+  def remove_index(_table_name, column_name, **_column_options)
+    @builder.remove_index(column_name)
+  end
+
+  def collect_info_from_children_migrate_content(children_content)
+    collect_column(children_content)        if has_add_or_remove_column?(children_content)
+    collect_index(children_content)         if has_add_or_remove_index?(children_content)
+    collect_attachment(children_content)    if has_add_or_remove_attachment?(children_content)
+    collect_change_column(children_content) if has_change_column?(children_content)
+  end
+
+  def rebuild_file_migration(file)
+    file.write(generate_new_file)
+  end
+
+  private
+
+  def table_name_from_migrate_content
+    @migrate_content[/create_table[\s+|(]:(.*?)\)?\s+/, 1]
+  end
+
+  def create_table_from_migrate_content
+    return eval(@migrate_content[/create_table(.*?)\W+end\W?$/m])      if has_create_table?(@migrate_content)
+    return eval(@migrate_content[/create_join_table(.*?)\W+end\W?$/m]) if has_create_join_table?(@migrate_content)
+
+    ''
+  rescue StandardError => e
+    MigrateFactoryRails::UI.print_message("\nError while rebuilding this table:\n", :red)
+    puts @migrate_content[/create_table(.*?)\W+end\W?$/m].squeeze.gsub(/ end/, 'end')
+    raise e
+  end
+
+  def has_create_table?(content)
+    content[/create_table(.*?)\W+end\W?$/m].present?
+  end
+
+  def has_create_join_table?(content)
+    content[/create_join_table(.*?)\W+end\W?$/m].present?
+  end
+
+  def build_collection_methods
+    %w[column index attachment].each do |action|
+      define_singleton_method("has_add_or_remove_#{action}?") do |children_content|
+        children_content[/(add|remove)_#{action}\s+:#{@table_name}/].present?
+      end
+
+      define_singleton_method("collect_#{action}") do |children_content|
+        block_pattern = /def\s+(change|up|self\.up)(.*?)\s+end/xm
+        command_pattern = /(?:add|remove)_(?:#{action})\s+:#{@table_name}.*/
+
+        columns_to_process = children_content.scan(block_pattern).flat_map do |_, body|
+          # Clean block to collect actions:
+          # Remove comment lines
+          # Remove extra spaces
+          # Add newline before all actions
+          # Remove only the first newline
+          body = body.gsub(/#\s*.*/, '').gsub(/\s+/, ' ').gsub(/((?:add|remove)_(?:\w+))/, "\n\\1").sub(/\s+\n/, '')
+          body.scan(command_pattern).map do |command|
+            # Define the regex pattern to match everything up to the first occurrence of a class/module name followed by '::' or '.'
+            pattern = /.*?(?=[A-Z][a-zA-Z0-9_]*.?:?)/
+            command = command.match(pattern).to_s if command.match(pattern)
+            command.squish
+          end
+        end
+
+        begin
+          columns_to_process.each do |process|
+            eval(process)
+          end
+        rescue StandardError => e
+          raise MigrateFactoryException.new(@table_name, process, e.backtrace[0, 10].join("\n"))
+        end
+      end
+    end
+  end
+
+  def has_change_column?(children_content)
+    children_content[/change_column_(null|default).*/].present?
+  end
+
+  def collect_change_column(children_content)
+    columns_to_process = children_content.to_enum(:scan, /change_column_(null|default)\s+:#{@table_name}.*/).map { Regexp.last_match.to_s }
+    columns_to_process.each { |process| eval(process) }
+  end
+
+  def generate_new_file
+    rails_version = Rails.version[/\d\.\d/]
+    <<~END
+    class Create#{@table_name.classify.pluralize} < ActiveRecord::Migration[#{rails_version}]
+      def change
+        #{@builder.print_table_type}(#{@builder.print_table_name_and_options}) do |t|
+          #{@builder.print_columns}
+        end
+      end#{@builder.print_indexes}
+    end
+    END
+  end
+end

data/lib/migrate_factory_rails/railtie.rb

@@ -0,0 +1,13 @@
+require 'migrate_factory_rails'
+require 'rails'
+
+module MigrateFactoryRails
+  class Railtie < Rails::Railtie
+    railtie_name :migrate_factory
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/migrate_factory_rails/tasks/rebuild/migrations.rake

@@ -0,0 +1,58 @@
+require 'migrate_factory_rails/factory'
+
+namespace :rebuild do
+  desc 'Rebuild your migrations for agilize setup'
+  task :migrations, [:keep_last_n_migrations] => [:environment] do |_task, args|
+    include MigrateFactoryRails
+
+    args.with_defaults(keep_last_n_migrations: 5)
+
+    rebuild_path = Rails.root.join('tmp/rebuild/')
+    FileUtils.mkdir_p(rebuild_path)
+
+    begin
+      mgt_files = Dir.glob(Rails.root.join('db/migrate/*'))
+
+      if args.keep_last_n_migrations > mgt_files.length
+        invalid_text = "Invalid 'keep_last_n_migrations' options because your project has less than #{args.keep_last_n_migrations} migrations."
+        abort invalid_text
+      end
+
+      mgt_total_files = mgt_files[0..-args.keep_last_n_migrations].length
+      puts 'Starting rebuild migrations...'
+
+      mgt_files.each_with_index do |migrate_file, index|
+        factory_service = Factory.new(File.read(migrate_file))
+        next if factory_service.table_name.blank?
+
+        print "Working on #{factory_service.table_name} table..."
+        File.open(Rails.root.join("tmp/rebuild/#{factory_service.table_name}.rb"), 'a+') do |f|
+          mgt_files[index..-args.keep_last_n_migrations].each do |migrate_children|
+            factory_service.collect_info_from_children_migrate_content(File.read(migrate_children))
+          end
+
+          factory_service.rebuild_file_migration(f)
+        end
+
+        print "Done!\n"
+      end
+    rescue StandardError
+      @error = true
+    ensure
+      new_total_files = Dir.glob(Rails.root.join('tmp/rebuild/*')).length
+      abort 'Something goes wrong and the script abort' if new_total_files.zero? || @error
+
+      puts "\nStatistics:\n"
+      puts "Ignoring last #{args.keep_last_n_migrations} migrations, we had #{mgt_total_files} migrates reduced to #{new_total_files} migrates."
+      puts "Total #{((1-(new_total_files/mgt_total_files.to_f))*100).to_i}% reduction in migrations.."
+    end
+  end
+
+  desc 'Cleanup rebuild tasks folder'
+  task :cleanup do
+    rebuild_path = Rails.root.join('tmp/rebuild/')
+    print 'Cleaning...'
+    rebuild_path.children.each(&:unlink) if rebuild_path.exist?
+    print "Done!\n"
+  end
+end

data/lib/migrate_factory_rails/ui.rb

@@ -0,0 +1,37 @@
+class MigrateFactoryRails::UI
+  class << self
+    def print_message(message, color = nil)
+      if color.nil?
+        puts message
+        return
+      end
+
+      puts color_msg(color.to_sym, message)
+    end
+
+    private
+
+    def color_msg(color, msg)
+      case color
+      when :black
+        "\033[30m#{msg}\033[0m"
+      when :red
+        "\033[31m#{msg}\033[0m"
+      when :green
+        "\033[32m#{msg}\033[0m"
+      when :brown
+        "\033[33m#{msg}\033[0m"
+      when :blue
+        "\033[34m#{msg}\033[0m"
+      when :magenta
+        "\033[35m#{msg}\033[0m"
+      when :cyan
+        "\033[36m#{msg}\033[0m"
+      when :gray
+        "\033[37m#{msg}\033[0m"
+      else
+        msg
+      end
+    end
+  end
+end

data/lib/migrate_factory_rails/version.rb

@@ -0,0 +1,3 @@
+module MigrateFactoryRails
+  VERSION = '1.0.0'.freeze
+end

data/lib/migrate_factory_rails.rb

@@ -0,0 +1,7 @@
+require_relative 'migrate_factory_rails/version'
+require_relative 'migrate_factory_rails/factory'
+
+module MigrateFactoryRails
+  class Error < StandardError; end
+  require 'migrate_factory_rails/railtie' if defined?(Rails)
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: migrate_factory_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diogo Fernandes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Completely rebuild your migrations to agilize setup and simplify schema.
+email:
+- diogofernandesop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/migrate_factory_rails.rb
+- lib/migrate_factory_rails/Rakefile.rb
+- lib/migrate_factory_rails/builder.rb
+- lib/migrate_factory_rails/exceptions.rb
+- lib/migrate_factory_rails/factory.rb
+- lib/migrate_factory_rails/railtie.rb
+- lib/migrate_factory_rails/tasks/rebuild/migrations.rake
+- lib/migrate_factory_rails/ui.rb
+- lib/migrate_factory_rails/version.rb
+homepage: https://github.com/dfop02/migrate_factory_rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/dfop02/migrate_factory_rails/issues
+  wiki_uri: https://github.com/dfop02/migrate_factory_rails/wiki
+  changelog_uri: https://github.com/dfop02/migrate_factory_rails/blob/1.0.0/Changelog.md
+  homepage_uri: https://github.com/dfop02/migrate_factory_rails
+  documentation_uri: https://github.com/dfop02/migrate_factory_rails
+  source_code_uri: https://github.com/dfop02/migrate_factory_rails
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rebuild your Rails migrations
+test_files: []