tasks-migration 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3819807335af95ccb427e285be7b1a1de33de62121de2e02dc84ef91b2beb7bd
+  data.tar.gz: b4fddc32fbbbed607aac80e1cde9f1b055fad5ac29585341e174797391647594
+SHA512:
+  metadata.gz: 26cc0a5b760811dc70cfbfd7399d8b2839188a52576de844da203194fe7a265f0e791c0898384f5e5fd4c018c201dc41647d9c34893822b2b14f5590265f1e98
+  data.tar.gz: f5f04b6dcac6ad14fecf802ea16368d3fda732abe502fca9bfb8123b8413ec4e8e3eaa781d686301a4ed0dd093a07664e2909557509f8f085e3229d9373d1f15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## `0.0.1`
+
+- Release gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 NamNV609
+
+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,79 @@
+# Tasks Migration
+
+## Getting started
+Tasks Migration works with Rails 4.1 onwards. Add the following line to your Gemfile
+
+```ruby
+gem "tasks-migration"
+```
+
+Then run
+
+```
+bundle install
+```
+
+Next, you need to run the generator:
+
+```
+rails generate tasks_migration:install
+```
+
+This command will create 2 files:
+
+* `db/migrate/<timestamp>_create_tasks_migration_schema.rb` (Create new table tasks_migration_schema in database)
+* `config/tasks_migration.yml` (Define Tasks will be runs )
+
+## Usage
+
+### Basic
+
+Create a new task by command:
+
+```
+rails generate tasks_migration:task <TaskName>
+```
+
+Business Logic will be handled in method `self.excute` on file  `app/migration_tasks/<task_name>.rb`. Example:
+
+```ruby
+# app/migration_tasks/hello_world_task.rb
+class HelloWorldTask
+  def self.execute
+      puts "Hello world :D"
+  end
+end
+```
+
+And add this task into `config/tasks_migration.yml`. Example:
+
+```yaml
+# config/tasks_migration.yml
+tasks:
+  - HelloWorldTask
+```
+
+The last, you run command:
+
+```
+bundle exec rake tasks_migration:migrate
+```
+
+### Capistrano
+
+
+Using Tasks Migration with Capistrano (after deploying completed `deploy:finished`) we just need to add following line into `Capfile`:
+
+```
+require "capistrano3/tasks-migration"
+```
+
+Another way, you also can do it manually through `Capistrano Task`:
+
+```
+bundle exec cap <stage> tasks_migration:migrate
+```
+
+# Credits
+
+Special thanks to [**ThanhTT**](https://github.com/thanhtt) for this file (**README.md**)

data/lib/capistrano3/tasks/tasks_migration.rake

@@ -0,0 +1,14 @@
+namespace :tasks_migration do
+  desc "Migrate the tasks"
+  task :migrate do
+    on roles(:db) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, "tasks_migration:migrate"
+        end
+      end
+    end
+  end
+end
+
+after "deploy:finished", "tasks_migration:migrate"

data/lib/capistrano3/tasks-migration.rb

@@ -0,0 +1 @@
+load File.expand_path "../tasks/tasks_migration.rake", __FILE__

data/lib/generators/tasks_migration/install_generator.rb

@@ -0,0 +1,38 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module TasksMigration
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Add setting files and create tasks folder"
+      def copy_config
+        copy_file "tasks_migration.yml", "config/tasks_migration.yml"
+      end
+
+      desc "Add migration for Tasks Migration"
+      def copy_migrations
+        migration_path = File.join "db", "migrate"
+        migration_template "migration.rb", "#{migration_path}/create_tasks_migration_schema.rb",
+          migration_version: migration_version
+      end
+
+      def self.next_migration_number path
+        next_migration_number = current_migration_number(path) + 1
+
+        ActiveRecord::Migration.next_migration_number next_migration_number
+      end
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5_and_up?
+      end
+    end
+  end
+end

data/lib/generators/tasks_migration/task_generator.rb

@@ -0,0 +1,14 @@
+require "rails/generators"
+
+module TasksMigration
+  module Generators
+    class TaskGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Add new migration task"
+      def add_task
+        template "task.rb", "app/migration_tasks/#{name.underscore}_task.rb", name: name
+      end
+    end
+  end
+end

data/lib/generators/tasks_migration/templates/migration.rb

@@ -0,0 +1,7 @@
+class CreateTasksMigrationSchema < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :tasks_migration_schema, id: false do |t|
+      t.string :version, primary_key: true
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+class <%= name %>Task
+  def self.execute
+    # Logic here
+  end
+end

data/lib/generators/tasks_migration/templates/tasks_migration.yml

@@ -0,0 +1,3 @@
+tasks:
+  # - SomeClass
+  # - SomeOtherClass

data/lib/models/tasks_migration_schema.rb

@@ -0,0 +1,3 @@
+class TasksMigrationSchema < ActiveRecord::Base
+  self.table_name = "tasks_migration_schema"
+end

data/lib/tasks-migration.rb

@@ -0,0 +1 @@
+require "tasks_migration/tasks_migration"

data/lib/tasks_migration/migrate.rb

@@ -0,0 +1,25 @@
+require "active_record"
+require "models/tasks_migration_schema"
+
+module TasksMigration
+  module Migrate
+    class << self
+      def start
+        all_tasks = get_all_tasks
+        executed_tasks = TasksMigrationSchema.pluck :version
+
+        (all_tasks - executed_tasks).each do |task|
+          puts "Running task #{task}..."
+          task.constantize.execute
+          TasksMigrationSchema.create version: task
+        end
+      end
+
+      private
+      def get_all_tasks
+        tasks_file_path = ::Rails.root.join "config", "tasks_migration.yml"
+        YAML.load_file(tasks_file_path)["tasks"] || []
+      end
+    end
+  end
+end

data/lib/tasks_migration/tasks/tasks_migration.rake

@@ -0,0 +1,8 @@
+require "rake"
+
+namespace :tasks_migration do
+  desc "Migrate the tasks"
+  task migrate: :environment do
+    TasksMigration::Migrate.start
+  end
+end

data/lib/tasks_migration/tasks_migration.rb

@@ -0,0 +1,3 @@
+require "tasks_migration/migrate"
+
+load File.expand_path "../tasks/tasks_migration.rake", __FILE__

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: tasks-migration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- NamNV609
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies: []
+description: Running tasks for Rails as migration
+email: namnv609@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/capistrano3/tasks-migration.rb
+- lib/capistrano3/tasks/tasks_migration.rake
+- lib/generators/tasks_migration/install_generator.rb
+- lib/generators/tasks_migration/task_generator.rb
+- lib/generators/tasks_migration/templates/migration.rb
+- lib/generators/tasks_migration/templates/task.rb
+- lib/generators/tasks_migration/templates/tasks_migration.yml
+- lib/models/tasks_migration_schema.rb
+- lib/tasks-migration.rb
+- lib/tasks_migration/migrate.rb
+- lib/tasks_migration/tasks/tasks_migration.rake
+- lib/tasks_migration/tasks_migration.rb
+homepage: https://github.com/namnv609/tasks-migration
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Allow run tasks as like as migration
+test_files: []