deploy_pin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4914431f26a50b1860ca43f67f44cacce2f60657e0b15a509a4d374395f42631
+  data.tar.gz: 638c64f5c4e57a422c287b5aef988cc9bc962213a38a1a7efc58c238cf395dac
+SHA512:
+  metadata.gz: a8e26e27ed3f6cd8303637e595bec231b03a834c889253817aa6eb8fdc811a73f0360388bbd5567df912b8772a09a41bcf1814943f7afde179aa5aa1d971bb5a
+  data.tar.gz: '00168ce157b6cb8c3d8bc67edbefa37fa251cd152953425407fbeb544ee3946834c2f1c368c6fe524a81c5ef56f645e9749ca8705494b5bce9eaf7ded8d3586d'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 rafael
+
+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,86 @@
+[![Build Status](https://travis-ci.org/skcc321/deploy_pin.svg?branch=master)](https://travis-ci.org/skcc321/deploy_pin)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c0a9ca97c1f9c0478ffc/maintainability)](https://codeclimate.com/github/skcc321/deploy_pin/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c0a9ca97c1f9c0478ffc/test_coverage)](https://codeclimate.com/github/skcc321/deploy_pin/test_coverage)
+
+# DeployPin
+
+![DeployPin](http://hereisfree.com/content1//pic/zip/2009109935062477801.jpg)
+
+Sometimes we need to execute set of commands (tasks) after/before deployment.
+Most likely you use migrations for such things, but that is not what is related to migration at all.
+Also sometimes you need to execute some code before migration or later, after migration without blocking of main thread.
+
+deploy_pins is exactly what you need.
+
+## Usage
+
+To generate new task template file
+```bash
+rails g deploy_pin:task
+# or
+rails g deploy_pin:task --parallel
+```
+
+To list all pending tasks
+```bash
+rake deploy_pin:list
+```
+
+To run all pending tasks
+```bash
+rake deploy_pin:run
+```
+
+### Groupped tasks
+~~~ please define allowed groups in config/initializers/deploy_pin.rb ~~~
+
+if you want to group tasks around "allowed_group"
+
+```bash
+rails g deploy_pin:task allowed_group
+# or
+rails g deploy_pin:task allowed_group --parallel
+```
+
+To list all pending tasks
+```bash
+rake deploy_pin:list[allowed_group]
+```
+
+To run all pending tasks
+```bash
+rake deploy_pin:run[allowed_group]
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deploy_pin'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install deploy_pin
+```
+
+### then generate configuration file
+```bash
+rails g deploy_pin:install
+```
+
+and run migration
+```bash
+rake db:migrate
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeployPin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/deploy_pin/application_record.rb

@@ -0,0 +1,3 @@
+class DeployPin::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/deploy_pin/record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class DeployPin::Record < DeployPin::ApplicationRecord
+  self.table_name = 'deploy_pins'
+end
+

data/lib/deploy_pin.rb

@@ -0,0 +1,27 @@
+require "deploy_pin/runner"
+require "deploy_pin/task"
+require "deploy_pin/engine"
+require "parallel"
+require "ruby-progressbar"
+
+module DeployPin
+  OPTIONS = %i(
+    tasks_path
+    fallback_group
+    groups
+  )
+
+  OPTIONS.each do |option|
+    instance_eval %{
+      def #{option}(val = nil)
+        return @@#{option} unless val.present?
+
+        @@#{option} = val
+      end
+    }
+  end
+
+  def self.setup(&block)
+    instance_eval(&block)
+  end
+end

data/lib/deploy_pin/engine.rb

@@ -0,0 +1,3 @@
+class DeployPin::Engine < ::Rails::Engine
+  isolate_namespace DeployPin
+end

data/lib/deploy_pin/runner.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# executes tasks
+module DeployPin::Runner
+  def self.run(group:)
+    tasks = pending(group: group)
+    tasks.each_with_index do |task, index|
+      puts "[#{index + 1}/#{tasks.count}] Task UUID #{task.uuid}"
+      task.run
+      puts ""
+    end
+  end
+
+  def self.list(group:)
+    pending(group: group).each_with_index do |task, index|
+      puts "======= Task ##{index} ========"
+      puts task.script
+      puts ""
+    end
+
+    puts "======= summary ========"
+    puts "tasks number: #{pending(group: group).count}"
+  end
+
+  def self.pending(group:)
+    files = Dir["#{DeployPin.tasks_path}/*.rb"]
+
+    records = DeployPin::Record.pluck(:uuid)
+
+    files.map do |file|
+      task = DeployPin::Task.new(file)
+      task.parse_file
+      task unless records.include?(task.uuid) || task.group != group
+    end.compact
+  end
+end

data/lib/deploy_pin/task.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Task wrapper
+class DeployPin::Task
+  attr_reader :file,
+    :group,
+    :uuid,
+    :script
+
+  def initialize(file)
+    @file = file
+    @uuid = nil
+    @group = nil
+    @script = ""
+  end
+
+  def run
+    eval(@script)
+  end
+
+  def parse_file
+    @script = File.read(file)
+    @script.lines[0] =~ /\A# (\d+):(\w+)/
+    @uuid = $1
+    @group = $2
+  end
+
+  def details
+    puts @uuid, @group, @script
+  end
+end

data/lib/deploy_pin/version.rb

@@ -0,0 +1,3 @@
+module DeployPin
+  VERSION = '0.1.0'
+end

data/lib/generators/deploy_pin/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates base migration to store tasks state in the DB
+
+Example:
+    rails generate deploy_pin:install
+
+    This will create:
+        db/migrate/create_deploy_pins.rb

data/lib/generators/deploy_pin/install/install_generator.rb

@@ -0,0 +1,19 @@
+class DeployPin::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('templates', __dir__)
+  desc "Add the migration & initializer for DeployPin"
+
+  def self.next_migration_number(path)
+    next_migration_number = current_migration_number(path) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  def copy_migrations
+    migration_template "create_deploy_pins.rb", "db/migrate/create_deploy_pins.rb"
+  end
+
+  def copy_initializer
+    template "deploy_pin.rb", "config/initializers/deploy_pin.rb"
+  end
+end

data/lib/generators/deploy_pin/install/templates/create_deploy_pins.rb

@@ -0,0 +1,8 @@
+class CreateDeployPins < ActiveRecord::Migration[5.2]
+  def change
+    create_table :deploy_pins do |t|
+      t.string :uuid
+      t.timestamps
+    end
+  end
+end

data/lib/generators/deploy_pin/install/templates/deploy_pin.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+DeployPin.setup do
+  tasks_path "lib/deploy_pin"
+  groups ["post_script"]
+  fallback_group "post_script"
+end

data/lib/generators/deploy_pin/task/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates tasks for execution on deployment
+
+Example:
+    rails generate deploy_pin:task
+
+    This will create:
+        lib/deploy_pin/task.rb

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class DeployPin::TaskGenerator < Rails::Generators::Base
+  class_option :parallel, type: :boolean
+  argument :group, default: "post_script"
+
+  source_root File.expand_path('templates', __dir__)
+
+  desc 'This generator creates deploy_pin task at lib/deploy_pin/'
+  def create_task_file
+    raise "Not allowed 'group' argument! possible values are #{DeployPin.groups}" \
+      unless DeployPin.groups.include?(group)
+
+    template_file = if options[:parallel]
+                      'parallel_task.rb.erb'
+                    else
+                      'task.rb.erb'
+                    end
+
+    @uuid = Time.now.strftime('%Y%m%d%H%M%S')
+    template template_file, "#{DeployPin.tasks_path}/#{@uuid}_task.rb"
+  end
+end

data/lib/generators/deploy_pin/task/templates/parallel_task.rb.erb

@@ -0,0 +1,16 @@
+# <%= @uuid %>:<%= group %>
+
+# === parallel task code goes down here ===
+10.times { DeployPin::Record.create(uuid: "hello") }
+
+Parallel.each(DeployPin::Record.where(uuid: "hello"), progress: "Doing stuff") do |pin|
+  ActiveRecord::Base.connection_pool.with_connection do
+    pin.update_attribute(:uuid, "new uuid")
+  end
+  sleep(0.2)
+end
+
+
+
+# Create record in the DB to avoid multiple execution
+DeployPin::Record.create(uuid: "<%= @uuid %>")

data/lib/generators/deploy_pin/task/templates/task.rb.erb

@@ -0,0 +1,13 @@
+# <%= @uuid %>:<%= group %>
+
+# === task code goes down here ===
+progressbar = ProgressBar.create(title: "Doing stuff", total: 20, format: '%t |%E | %B | %a')
+
+20.times { progressbar.increment; sleep(0.2) }
+
+
+
+
+
+# Create record in the DB to avoid multiple execution
+DeployPin::Record.create(uuid: "<%= @uuid %>")

data/lib/tasks/deploy_pin_tasks.rake

@@ -0,0 +1,14 @@
+namespace :deploy_pin do
+  desc "run pending tasks"
+  task :run, [:group] => :environment do |t, args|
+    args.with_defaults(group: DeployPin.fallback_group)
+
+    DeployPin::Runner.run(args)
+  end
+
+  task :list, [:group] => :environment  do |t, args|
+    args.with_defaults(group: DeployPin.fallback_group)
+
+    DeployPin::Runner.list(args)
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: deploy_pin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rafael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-26 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.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+description: pin some task around deployment to execute them during deployment circle
+email:
+- skcc321@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/deploy_pin/application_record.rb
+- app/models/deploy_pin/record.rb
+- lib/deploy_pin.rb
+- lib/deploy_pin/engine.rb
+- lib/deploy_pin/runner.rb
+- lib/deploy_pin/task.rb
+- lib/deploy_pin/version.rb
+- lib/generators/deploy_pin/install/USAGE
+- lib/generators/deploy_pin/install/install_generator.rb
+- lib/generators/deploy_pin/install/templates/create_deploy_pins.rb
+- lib/generators/deploy_pin/install/templates/deploy_pin.rb
+- lib/generators/deploy_pin/task/USAGE
+- lib/generators/deploy_pin/task/task_generator.rb
+- lib/generators/deploy_pin/task/templates/parallel_task.rb.erb
+- lib/generators/deploy_pin/task/templates/task.rb.erb
+- lib/tasks/deploy_pin_tasks.rake
+homepage: https://github.com/skcc321/deploy_pin
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: pin some task around deployment
+test_files: []