rake_migrations_velocity 1.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaed9036fb33e17913e42665b7ccae84aaddfa24c46536cdc2bf18098c5ec9dd
+  data.tar.gz: 5d252854d591c8a315a567641e5daf8bb3ae213192cc013fdf730611473eb7e1
+SHA512:
+  metadata.gz: 54f63adc8d5d62dc0f67ac3f3494d7393668c6e81c268a4425d7f4d565e6149f728fe032c0c3fd9a8df8ea675f08d1b0e501c25a44d18bbecd5dab145483e089
+  data.tar.gz: d0f47ba6d55e0c74787f4746fae54577702491b6f9e8606dfeac0fed46e0f7ddd86cf03a4d390aae4f54be421304223ee65a9fc62affdb46b27db18456699ccb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,116 @@
+Rake Migrations
+===============
+
+This gem helps you and your team members keep track of which rake tasks are yet to be run on a particular system. The logic is similar to that of how `rake db:migrate` is used.
+
+For a more verbose explanation please refer to [this blog post](http://eyaleizenberg.blogspot.com/2014/08/how-to-keep-track-of-rails-rake-tasks.html).
+
+## Requirements
+At the moment I have only tested this on Rails 5.X.X, 6.X.x and 7.X.X  running postgresql on Mac OS X.
+If you can help by testing this on different versions, databases and platforms, let me know.
+
+## Installation
+First, add this this to your gemfile:
+```ruby
+gem 'rake_migrations', git: 'https://github.com/Velocity-Engineering/rake-migrations.git'
+```
+
+Then, run:
+```sh
+bundle install
+
+
+rails g rake_migrations:install
+
+# Don't forget to migrate
+rake db:migrate
+```
+
+This will copy a db schema migration (`rake_migrations`) file and a helper rake task (`devops_rake_utils.rake`) in your `lib/tasks/` directory
+
+Finally, add the following file in your `config/initializers` folder to provide the gem with database credentials via the `database.yml` file
+```ruby
+# rake_migrations.rb
+RakeMigrations.configure do |config|
+  config.database_name = 'neobank'
+  config.hostname = ENV['DATABASE_HOST']
+  config.username = ENV['DATABASE_USERNAME']
+  config.password = ENV['DATABASE_PASSWORD']
+end
+```
+
+## Usage
+Whenever somebody from your team wants to create a new run once task, simply generate it by running:
+
+```sh
+rails g task <namespace> <task>
+```
+
+For example:
+
+```sh
+rails g task migrations_test testing_the_gem
+```
+
+This will generate a file under `lib/tasks/rake_migrations` with a timestamp and six random character prefixed filename and the following content:
+
+```ruby
+# 
+  
+# Checklist:
+# 1. Re-runnable on production?
+# 2. Is there a chance emails will be sent?
+# 3. puts ids & logs (progress log)
+# 4. Should this be inside a Active Record Transaction block?
+# 5. Are there any callbacks?
+# 6. Performance issues?
+
+namespace :migrations_test do
+  desc "TODO"
+  task testing_the_gem: [:environment] do
+
+    # DO NOT REMOVE THIS PART. MARKS THE RAKE AS COMPLETE IN THE DATABASE
+    RakeMigration.mark_complete(__FILE__)
+  end
+end
+
+```
+
+Simply insert your code above the "DO NOT REMOVE THIS PART" line. The checklist is there to help you and the person who is code-reviewing your code to think of problems that might occur from your rake task.
+
+Afterwards, whenever we need to check whether pending rake tasks, we run the following helper rake task...
+
+```sh
+rake devops_rake_utils:list_pending_rake_tasks
+```
+
+... which will give the following output in case some tasks aren't mapped to the `rake_migrations` database table
+
+```sh
+You need to run the following rakes:
+------------------------------------
+rake migrations_test:testing_the_gem
+```
+
+You can run the rake task normally:
+
+```sh
+rake migrations_test:testing_the_gem
+```
+
+In case all of the rake files have been mapped across the `rake_migrations` table, you will receive the following message
+
+```sh
+All rake files are mapped in the DB! No untracked rake tasks are present!
+```
+
+## Caveats
+- In order to make sure the gem is serving the intended purpose, please make sure every rake file has just one namespace and one task only
+- Adding support for multiple tasks beneath a single name space in a single rake file might a feature request we may consider in the future
+
+## Issues, suggestions and forks.
+Feel free to open issues, send suggestions and fork this repository.
+
+This gem was developed by [Eyal Eizenberg](http://eyaleizenberg.blogspot.com/2014/08/how-to-keep-track-of-rails-rake-tasks.html) and enhanced by [Mani Bhushan](https://github.com/manibhushan05/).
+
+Thanks and Enjoy! :)

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RakeMigrations'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rails/generators/rake_migrations/install_generator.rb

@@ -0,0 +1,56 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module RakeMigrations
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      copy_migration_template_based_on_rails_version
+
+      # copying the Devops task template
+      template("devops_rake_utils.rake", "lib/tasks/devops_rake_utils.rake")
+
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number dirname
+    end
+
+    def write_to_post_merge_hook
+      post_merge_file = ".git/hooks/post-merge"
+      what_to_write = <<-TEXT
+#{!File.exists?(post_merge_file) ? '#!/bin/sh' : ''}
+ruby ./config/rake_migrations_check.rb
+TEXT
+
+      File.open(post_merge_file, 'a+') do |file|
+        file.write(what_to_write) unless file.read.match(/rake_migrations_check/)
+      end
+      `chmod 777 #{post_merge_file}`
+    end
+
+    private
+    def copy_migration_template_based_on_rails_version
+
+      host_rails_version = Rails.version
+      version_info = host_rails_version.split('.')
+
+      major_version = version_info.first
+      minor_version = version_info.second
+
+      if major_version.to_i <= 4
+        migration_template "migration_rails_on_and_before_v4.rb", "db/migrate/create_rake_migrations_table.rb"
+      else
+        @rails_major_minor_version = "[#{major_version}.#{minor_version}]"
+        migration_template "migration_rails_after_v4.rb", "db/migrate/create_rake_migrations_table.rb",
+                           rails_major_minor_version: @rails_major_minor_version
+
+      end
+    end
+
+  end
+end

data/lib/rails/generators/rake_migrations/templates/devops_rake_utils.rake

@@ -0,0 +1,6 @@
+namespace :devops_rake_utils do
+  desc "Lists out all the non migrated rake tasks for an application"
+  task list_pending_rake_tasks: [:environment] do
+    RakeMigrations.check
+  end
+end

data/lib/rails/generators/rake_migrations/templates/migration_rails_after_v4.rb

@@ -0,0 +1,16 @@
+class CreateRakeMigrationsTable < ActiveRecord::Migration<%= @rails_major_minor_version %>
+  def self.up
+    create_table :rake_migrations do |t|
+      t.string :version
+      t.string :namespace
+      t.string :task_name
+      t.string :created_by
+      t.datetime :created_at
+      t.float :duration
+    end
+  end
+
+  def self.down
+    drop_table :rake_migrations
+  end
+end

data/lib/rails/generators/rake_migrations/templates/migration_rails_on_and_before_v4.rb

@@ -0,0 +1,11 @@
+class CreateRakeMigrationsTable < ActiveRecord::Migration
+  def self.up
+    create_table :rake_migrations, id: false do |t|
+      t.string :version
+    end
+  end
+
+  def self.down
+    drop_table :rake_migrations
+  end
+end

data/lib/rails/generators/task/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create rake tasks with a time stamp and default messages.
+
+Example:
+    rails generate task incidents convert_x_to_y
+
+    This will create:
+        lib/tasks/rake_migrations/[time_stamp]incidents.rake

data/lib/rails/generators/task/task_generator.rb

@@ -0,0 +1,23 @@
+=begin
+  Creates a rake task file sourced from the template and stores it in the following directory
+
+  `/lib/tasks/<namespace>`
+
+  under the file name YYYYMMDDHHMMSS_<random-six-char-str>_task_name.rake
+
+  eg.
+
+  lib/tasks/rake_migrations/migration_test/20190403165149_8e374a_first_test.rake
+
+=end
+class TaskGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :actions, type: :array, default: [], banner: "action action"
+
+  def create_task_files
+    time_stamp = Time.now.strftime("%Y%m%d%H%M%S")
+    random_char_str = SecureRandom.hex(3)
+    task_name = actions.first.present? ? actions.first : file_name
+    template 'task.rb', File.join("lib/tasks/rake_migrations/#{file_name}", "#{time_stamp}_#{random_char_str}_#{task_name}.rake")
+  end
+end

data/lib/rails/generators/task/templates/task.rb

@@ -0,0 +1,23 @@
+# Checklist:
+# - Should this be inside a Active Record Transaction block?
+# - Do we need to notify specific stakeholders about the database changes?
+# - Any callbacks, emails or notifications triggered?
+# - Appropriate prints and progress logs?
+# - Performance issues and manual garbage collection required?
+
+namespace :<%= file_name %> do
+<% actions.each do |action| -%>
+  desc "TODO"
+  task <%= action %>: [:environment] do
+    time = Benchmark.ms {
+      ActiveRecord::Base.transaction do
+        # ADD YOUR CODE HERE
+
+      end
+    }
+    # DO NOT REMOVE THIS PART. MARKS THE RAKE AS COMPLETE IN THE DATABASE
+    top_level_task = Rake.application.top_level_tasks[0]
+    RakeMigration.mark_complete(__FILE__, top_level_task.split(':')[0], top_level_task.split(':')[1], 'System', time)
+  end
+<% end -%>
+end

data/lib/rake_migration.rb

@@ -0,0 +1,25 @@
+class RakeMigration < ::ActiveRecord::Base
+  def self.version_from_path(path)
+    path.split('/').last.split('_').first(2).join('_')
+  end
+
+  def self.findcreate_by_version(rake_id, namespace, task_name, created_by, duration)
+    find_or_create_by(
+      version: rake_id, namespace: namespace, task_name: task_name, created_by: created_by, duration: duration, created_at: Time.now.utc.in_time_zone('Asia/Kolkata'))
+  end
+
+  def self.mark_complete(file, namespace, task_name, created_by, duration)
+    rake_id = version_from_path(file)
+    if methods.include?(:find_or_create_by)
+      find_or_create_by(
+        version: rake_id, namespace: namespace, task_name: task_name, created_by: created_by, duration: duration, created_at: Time.now.utc.in_time_zone('Asia/Kolkata'))
+    else
+      findcreate_by_version(rake_id, namespace, task_name, created_by, duration)
+    end
+  end
+
+  def self.check_for_pending_tasks
+    RakeMigrations.check
+  end
+
+end

data/lib/rake_migrations/config.rb

@@ -0,0 +1,45 @@
+module RakeMigrations
+  class Config
+    attr_accessor :database_name, :hostname, :username, :password
+
+    def initialize
+      @database_name = nil
+      @hostname = nil
+      @username = nil
+      @password = nil
+    end
+
+    def generate_database_client
+      validate_presence_of_required_connection_attributes
+      log_presence_of_optional_connection_attributes
+      connection_object_based_on_attributes
+    end
+
+    private
+
+    def validate_presence_of_required_connection_attributes
+      fail 'Database name should be provided!' unless @database_name
+      fail 'Host Name should be provided' unless @hostname
+      true
+    end
+
+    def log_presence_of_optional_connection_attributes
+      p 'Connecting to the database without username' unless @username
+      p 'Connecting to the database without password' unless @password
+    end
+
+    def connection_object_based_on_attributes
+      if @password.present? && @username.present?
+        client = Mysql2::Client.new(host: @hostname,
+                            dbname: @database_name,
+                            user: @username,
+                            password: @password)
+      else
+        client = Mysql2::Client.new(host: @hostname,
+                            dbname: @database_name)
+      end
+      client
+    end
+
+  end
+end

data/lib/rake_migrations/version.rb

@@ -0,0 +1,3 @@
+module RakeMigrations
+  VERSION = "1.0.11"
+end

data/lib/rake_migrations.rb

@@ -0,0 +1,47 @@
+require 'active_record'
+require 'rake_migration'
+require 'rake_migrations/config'
+
+module RakeMigrations
+
+  def self.configure
+    yield @config = RakeMigrations::Config.new
+  end
+
+  def self.check
+=begin
+- list out all the filename present in /lib/tasks/rake_migrations/
+- compares the uuid (ts + 6 char) with that present database attached to the application
+- if the file prefix is not present in the `rake_migrations` table, prints out on the console
+  that the rake task is pending
+=end
+    client = @config.generate_database_client
+
+    results = client.exec("select * from rake_migrations").map {|res| res["version"] }
+    rake_migrations_lib = "#{`pwd`.strip}/lib/tasks/rake_migrations"
+    list_of_files = Dir[ File.join(rake_migrations_lib, '**', '*') ].reject { |p| File.directory? p }
+
+    rake_files = list_of_files.sort.map do |file|
+      rake_id = RakeMigration.version_from_path(file)
+
+      if !results.include?(rake_id)
+        file = File.read(file)
+        namespace = file[/namespace :?([^: ,]*)/m, 1].strip
+        task = file[/task :?([^ :,]*)/m, 1]
+        "rake #{namespace}:#{task} # #{rake_id}"
+      end
+    end.compact
+
+    if !rake_files.empty?
+      puts "\n"
+      puts "You need to run the following rakes:"
+      puts "------------------------------------"
+      rake_files.each { |file| puts "\e[31m#{file}\e[0m" }
+      puts "\n"
+    else
+      puts "\e[32mAll rake files are mapped in the DB! No untracked rake tasks are present!\e[0m"
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rake_migrations_velocity
+version: !ruby/object:Gem::Version
+  version: 1.0.11
+platform: ruby
+authors:
+- Mani Bhushan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This gem creates a rake_migrations table and keeps track of rake tasks
+  similar to migrations.
+email:
+- manilnct@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails/generators/rake_migrations/install_generator.rb
+- lib/rails/generators/rake_migrations/templates/devops_rake_utils.rake
+- lib/rails/generators/rake_migrations/templates/migration_rails_after_v4.rb
+- lib/rails/generators/rake_migrations/templates/migration_rails_on_and_before_v4.rb
+- lib/rails/generators/task/USAGE
+- lib/rails/generators/task/task_generator.rb
+- lib/rails/generators/task/templates/task.rb
+- lib/rake_migration.rb
+- lib/rake_migrations.rb
+- lib/rake_migrations/config.rb
+- lib/rake_migrations/version.rb
+homepage: http://eyaleizenberg.blogspot.com/
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: A gem to easily keep track of rake tasks
+test_files: []