taskgration 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db281d7628cf64179cd3c6f30db90c409b60e88864efdea8e0c6f1a8467583ab
+  data.tar.gz: f5290844bf6b6a4dd77b14b98ba6e70daed08b49766f9d37cd7bbbcda634049b
+SHA512:
+  metadata.gz: 53dce7ce73fb29d106989b2693fecb1ddbc0abffad968d5eef35a8ee991e3dc7f34174912b15243e338086491914d2c610b85328a3989a0c86085b8ee845df70
+  data.tar.gz: 712742982362b81a6fd8c4be291613e7a4f38728414d294048a965ab7b54164fdd8e9b5f53b99d9ae6678db565b4400a606557ed3e75560b245a0a3fde10e3e4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Fábio Araújo
+
+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,44 @@
+# Taskgration
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'taskgration'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ rake taskgration:install:migrations
+```
+
+## Usage
+
+### 1. Creating a task to migrate
+```bash
+$ rails generate taskgration:create YOUR_TASK_MIGRATION_NAME
+```
+
+### 2. Running the unapplied tasks migrations
+```bash
+$ rake taskgration:up
+```
+
+### 3. Rolling back applied tasks migrations
+```bash
+$ rake taskgration:down TASKGRATION_VERSION=YOUR_VERSION_NUMBER #=> Rollback 1 specific version
+$ rake taskgration:down TASKGRATION_STEPS=QUANTITY_OF_STEPS #=> Rollback the number of times passed
+$ rake taskgration:down #=> Rollback always the newest created migration
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "lib/tasks/up.rake"

data/app/assets/config/taskgration_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/taskgration .css

data/app/assets/stylesheets/taskgration/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/taskgration/application_controller.rb

@@ -0,0 +1,4 @@
+module Taskgration
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/taskgration/application_helper.rb

@@ -0,0 +1,4 @@
+module Taskgration
+  module ApplicationHelper
+  end
+end

data/app/jobs/taskgration/application_job.rb

@@ -0,0 +1,4 @@
+module Taskgration
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/taskgration/application_record.rb

@@ -0,0 +1,5 @@
+module Taskgration
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/taskgration/task_migration.rb

@@ -0,0 +1,16 @@
+module Taskgration
+  class TaskMigration < ApplicationRecord
+
+    ##
+    # Scopes
+    scope :newest, -> { order(version: :desc) }
+
+    ##
+    # Class Methods
+    class << self
+      def current_version
+        newest.first&.version
+      end
+    end
+  end
+end

data/app/views/layouts/taskgration/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Taskgration</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "taskgration/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Taskgration::Engine.routes.draw do
+end

data/db/migrate/20220514194721_create_taskgration_task_migrations.rb

@@ -0,0 +1,11 @@
+class CreateTaskgrationTaskMigrations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :taskgration_task_migrations do |t|
+      t.string :name
+      t.bigint :version
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/taskgration/create_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+module Taskgration
+  module Generators
+    class CreateGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :name
+
+      def set_version
+        @version = Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def set_file_name
+        @file_name = "#{@version}_#{name.underscore}"
+      end
+
+      def copy_file_to_main_app
+        template('create.rb.tt', "lib/tasks/migrations/#{@file_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/taskgration/templates/create.rb.tt

@@ -0,0 +1,9 @@
+class <%= name.camelcase %>
+  def up
+    # Write here everything you want to change
+  end
+
+  def down
+    # Write here the things to revert what you did
+  end
+end

data/lib/taskgration/engine.rb

@@ -0,0 +1,5 @@
+module Taskgration
+  class Engine < ::Rails::Engine
+    isolate_namespace Taskgration
+  end
+end

data/lib/taskgration/version.rb

@@ -0,0 +1,3 @@
+module Taskgration
+  VERSION = "0.1.5"
+end

data/lib/taskgration.rb

@@ -0,0 +1,11 @@
+require "taskgration/version"
+require "taskgration/engine"
+
+##
+# Generators
+require "generators/taskgration/install_generator"
+require "generators/taskgration/create_generator"
+
+module Taskgration
+  # Your code goes here...
+end

data/lib/tasks/down.rake

@@ -0,0 +1,41 @@
+require 'pathname'
+require 'fileutils'
+
+namespace :taskgration do
+  desc 'Run this task if you want to apply the latest tasks migrations'
+  task down: :environment do
+    started_at      = Time.now
+    root_path       = 'lib/tasks/migrations'
+    files_to_run    = []
+
+    if ENV['TASKGRATION_VERSION'].present?
+      target_version = ENV['TASKGRATION_VERSION'].to_i
+      taskgration    = Taskgration::TaskMigration.find_by_version!(target_version)
+      files_to_run << "#{target_version}_#{taskgration.name}"
+    elsif ENV['TASKGRATION_STEPS'].present?
+      quantity    = ENV['TASKGRATION_STEPS'].to_i
+      taskgration = Taskgration::TaskMigration.newest.limit(quantity)
+
+      taskgration.each { |t| files_to_run << "#{t.version}_#{t.name}" }
+    else
+      taskgration = Taskgration::TaskMigration.newest.first
+      files_to_run << "#{taskgration.version}_#{taskgration.name}"
+    end
+
+    files_to_run.each do |filename|
+      load "#{Dir.pwd}/#{root_path}/#{filename}.rb"
+
+      module_name = filename.split(/_/)[1..-1]
+      module_name = module_name.join('_').camelcase 
+
+      module_name.constantize.new.down
+    end
+
+    print "\n\nTasks migrated in #{Time.at(Time.now - started_at).utc.strftime('%H hours %M minutes and %S seconds')}.\n"
+
+    abort("NOTHING TO RUN...") if files_to_run.empty?
+
+    print "FILES MIGRATED:\n"
+    print files_to_run.map{ |name| "    #{name}" }.join("\n")
+  end
+end

data/lib/tasks/up.rake

@@ -0,0 +1,41 @@
+require 'pathname'
+require 'fileutils'
+
+namespace :taskgration do
+  desc 'Run this task if you want to apply the latest tasks migrations'
+  task up: :environment do
+    started_at      = Time.now
+    root_path       = 'lib/tasks/migrations'
+    executed_files  = []
+    all_versions    = Taskgration::TaskMigration.pluck(:version)
+
+    Dir.foreach(root_path).sort.each do |filename|
+      next if filename == '.' || filename == '..'
+
+      basename = File.basename(filename, '.rb')
+      version  = basename.split(/_/).first.to_i
+
+      if all_versions.exclude?(version)
+        load "#{Dir.pwd}/#{root_path}/#{filename}"
+
+        basename    = File.basename(filename, '.rb')
+        module_name = basename.split(/_/)[1..-1]
+        module_name = module_name.join('_').camelcase 
+
+        module_name.constantize.new.up
+
+        executed_files << filename
+
+        Taskgration::TaskMigration.create!(name: module_name.underscore, version: version)
+      end
+    end
+
+    print "\n\nTasks migrated in #{Time.at(Time.now - started_at).utc.strftime('%H hours %M minutes and %S seconds')}.\n"
+    print "Current version is: #{Taskgration::TaskMigration.current_version}\n\n"
+
+    abort("NOTHING NEW TO RUN...") if executed_files.empty?
+
+    print "FILES MIGRATED:\n"
+    print executed_files.map{ |name| "    #{name}" }.join("\n")
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: taskgration
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Fábio Araújo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Know what tasks ran and keep the track of it
+email:
+- fabioaraujo121@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/taskgration_manifest.js
+- app/assets/stylesheets/taskgration/application.css
+- app/controllers/taskgration/application_controller.rb
+- app/helpers/taskgration/application_helper.rb
+- app/jobs/taskgration/application_job.rb
+- app/models/taskgration/application_record.rb
+- app/models/taskgration/task_migration.rb
+- app/views/layouts/taskgration/application.html.erb
+- config/routes.rb
+- db/migrate/20220514194721_create_taskgration_task_migrations.rb
+- lib/generators/taskgration/create_generator.rb
+- lib/generators/taskgration/templates/create.rb.tt
+- lib/taskgration.rb
+- lib/taskgration/engine.rb
+- lib/taskgration/version.rb
+- lib/tasks/down.rake
+- lib/tasks/up.rake
+homepage: https://github.com/fabioaraujo121/taskgration
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fabioaraujo121/taskgration
+  source_code_uri: https://github.com/fabioaraujo121/taskgration
+  changelog_uri: https://github.com/fabioaraujo121/taskgration/CHANGELOG.md
+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.2.3
+signing_key:
+specification_version: 4
+summary: Track tasks like migrations
+test_files: []