migration_queries 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356aa56fbb9c867de2ff9a1ec41c1d4305031f65ba10e8ea50ea523b70896046
-  data.tar.gz: ec60f761a3f8a81aa4247ff3b4305843cde952951780e5a2c99cbc15b2b8c46a
+  metadata.gz: d841a636d5ad72e9991f1f87ed98bb4a0a1b51098a674db5dae93f5d2f94ccaa
+  data.tar.gz: aa79169e44d9ce5adbbf1142d738d49b3aee19048f86baa82be747695b653c8a
 SHA512:
-  metadata.gz: d2572cb64efab92fcda737c55dda35c7cc1ce8b0786f23435538335d45dc5631663a89f1fba5f2a49b6d20b647ecfff6190309d04750f775bbd6a0d4ec2adb05
-  data.tar.gz: da96b269d7049e01c2289a8cbaae3ca7789eb78961bbb0fd6d3d233577d038ebb862545c7cf6b7dfd9d8b58fa1a07e4c78bf2cc51ad2dca3676a28fe663297de
+  metadata.gz: 65e15bb1a441237afbc72d50a9206334dd7dafee4e0f4af3cbbbb949106e3e3e57088bada8464b781071177219ca366f1ffb1e34b3ef30675ce8117a09d59a27
+  data.tar.gz: b0cecb473508ad96399022335b6ff0e9decc6951f6f7f6b82f6bdd45a7acd70733a16358a8906f4279a93d8697ba8e9240bef4f0e77798a39d8845ac640ff29c

data/README.md

@@ -1,28 +1,40 @@
 # MigrationQueries
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/migration_queries`. To experiment with that code, run `bin/console` for an interactive prompt.
+The `migration_queries` gem improves tracking of migration queries in Ruby on Rails applications. It provides a simple way to log and analyze the SQL queries generated by ActiveRecord migrations, helping developers optimize their database interactions.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Add this gem to development dependencies in your `Gemfile`:
 
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+group :development do
+  gem 'migration_queries'
+end
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+Then, run `bundle install` to install the gem.
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem is going to automatically track migration queries executed by ActiveRecord. You can view the logged queries in your Rails console or in the log files.
+
+Example migration file after running migration and logging queries:
+
+```ruby
+class AddExampleTable < ActiveRecord::Migration[6.0]
+  def change
+    create_table :example do |t|
+      t.string :name
+      t.timestamps
+    end
+  end
+end
+=begin Migration Queries
+CREATE TABLE "example" ("id" bigserial primary key, "name" character varying, "created_at" timestamp(6) NOT NULL, "updated_at" timestamp(6) NOT NULL)
+
+# Migration Queries written on 2025-07-04 12:36:54 +0200
+=end
+```
 
 ## Development
 

data/Rakefile

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-load("lib/tasks/setup_migration_queries.rake")
-
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/lib/migration_queries/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MigrationQueries
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/migration_queries.rb

@@ -6,6 +6,9 @@ require_relative "migration_queries/executer"
 require_relative "migration_queries/migrater"
 require "active_record"
 
+ActiveRecord::ConnectionAdapters::AbstractAdapter.include(MigrationQueries::Executer)
+ActiveRecord::Migration::Current.include(MigrationQueries::Migrater)
+
 # MigrationQueries is a module that provides functionality to gather, execute, and migrate SQL queries
 # during ActiveRecord migrations. It includes the Gatherer, Executer, and Migrater modules to handle
 # different aspects of SQL query management.
@@ -15,9 +18,4 @@ module MigrationQueries
   def self.gatherer
     @gatherer ||= MigrationQueries::Gatherer.new
   end
-
-  def self.init!
-    ActiveRecord::ConnectionAdapters::AbstractAdapter.include(MigrationQueries::Executer)
-    ActiveRecord::Migration::Current.include(MigrationQueries::Migrater)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: migration_queries
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Szymon Lipka
@@ -46,7 +46,6 @@ files:
 - lib/migration_queries/gatherer.rb
 - lib/migration_queries/migrater.rb
 - lib/migration_queries/version.rb
-- lib/tasks/setup_migration_queries.rake
 - sig/migration_queries.rbs
 - sig/migration_queries/data.rbs
 - sig/migration_queries/executer.rbs

data/lib/tasks/setup_migration_queries.rake

@@ -1,24 +0,0 @@
-# lib/tasks/setup_migration_queries.rake
-
-namespace :migration_queries do
-  desc "Create migration_queries.rb initializer"
-  task :setup do
-    initializer_path = Rails.root.join("config", "initializers", "migration_queries.rb")
-    content = <<~RUBY
-      # frozen_string_literal: true
-
-      if Rails.env.development?
-        require 'migration_queries'
-
-        MigrationQueries.init!
-      end
-    RUBY
-
-    if File.exist?(initializer_path)
-      puts "Initializer file already exists at #{initializer_path}"
-    else
-      File.write(initializer_path, content)
-      puts "Created initializer file at #{initializer_path}"
-    end
-  end
-end