delayed_job_json 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5df5eb2a641bfd511bc8ff10c9103373588917f851376dfcb883db4adfeac66b
+  data.tar.gz: c89630ae7e529ee4447d207deeb24ef230b500d378f5eb55e869edae6aefb0c6
+SHA512:
+  metadata.gz: '038a824b83c46ca64bb9b892d19a64b686d7d3189de6552f7d4e8a79cc3d4126ad08947a1aabeaf2c1f5321ead205a242f6e34f35e657f6da1f408059846c21c'
+  data.tar.gz: 937d89f1592fd6a78ef43bb2a953f813e1951d5679b6084958be148733a0e78d279b01ced8bb76a316ae00c92c6daba780e20f311e9a1d661dd84f7f30912f51

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    services:
+      postgres:
+        image: postgres:9.5
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 3306:3306
+        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, '3.0', 3.1, 3.2]
+        gemfile: ['rails60', 'rails61', 'rails70']
+        database: ['postgresql', 'mysql', 'sqlite']
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, ${{ matrix.database }}
+
+    env:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      DATABASE: ${{ matrix.database }}
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Prepare test
+      run: |
+        cd spec/dummy
+        BUNDLE_GEMFILE=../../${{ env.BUNDLE_GEMFILE }} RAILS_ENV=test bundle exec rake db:create db:migrate
+        cd ../..
+    - name: Run test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/Gemfile.lock
+/gemfiles/*gemfile.lock
+/coverage/
+/pkg/
+/spec/reports/
+/spec/**/db/*.sqlite3
+/spec/**/log/*.log
+/spec/**/tmp/*
+/vendor/

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require rails_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0
+
+* First release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Yoshikazu Kaneta
+
+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,71 @@
+# DelayedJobJson
+
+Migrate handler of text column to json column for delayed_job.
+
+## Dependencies
+
+* ruby 2.7+
+* activerecord 6.0+
+* delayed_job 4.1
+* delayed_job_active_record 4.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_json'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Generate migration files:
+
+    $ rails generate delayed_job_json:migration
+
+Edit generated files and leave codes only for your database. An example of generated file is shown as follows:
+
+```ruby
+class AddPayloadToDelayedJobs < ActiveRecord::Migration[7.0]
+  def up
+    case ENV['DATABASE']
+    when 'postgresql'
+      add_column :delayed_jobs, :payload, :jsonb, null: false, default: {}
+      add_index :delayed_jobs, :payload, using: :gin
+    when 'mysql'
+      add_column :delayed_jobs, :payload, :json
+    else
+      add_column :delayed_jobs, :payload, :json, null: false, default: {}
+    end
+  end
+
+  def down
+    case ENV['DATABASE']
+    when 'postgresql'
+      remove_column :delayed_jobs, :payload, :jsonb, null: false, default: {}
+    when 'mysql'
+      remove_column :delayed_jobs, :payload, :json
+    else
+      remove_column :delayed_jobs, :payload, :json, null: false, default: {}
+    end
+  end
+end
+```
+
+Then run migration:
+
+    $ rake db:migrate
+
+This migration adds `payload` column to delayed_jobs table, and YAML data in `handler` column is migrated to `payload` as json data.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kanety/delayed_job_json.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/delayed_job_json.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delayed/backend/json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "delayed_job_json"
+  spec.version       = Delayed::Backend::Json::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Migrate handler of text column to json column for delayed_job}
+  spec.description   = %q{Migrate handler of text column to json column for delayed_job}
+  spec.homepage      = "https://github.com/kanety/delayed_job_json"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_dependency "delayed_job", ">= 4.1"
+  spec.add_dependency "delayed_job_active_record", ">= 4.1"
+  spec.add_dependency "activesupport", ">= 6.0"
+  spec.add_dependency "activerecord", ">= 6.0"
+
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "sqlite3"
+end

data/gemfiles/rails60.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.0.0"
+gem "psych", "~> 3.3.0"
+
+gemspec path: "../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.1"
+
+gemspec path: "../"

data/lib/delayed/backend/json/patch.rb

@@ -0,0 +1,23 @@
+module Delayed
+  module Backend
+    module Json
+      module Patch
+        def payload_object=(object)
+          @payload_object = object
+          self.handler = '{}'
+          self.payload = object.job_data
+        end
+
+        def payload_object
+          if payload.present?
+            @payload_object ||= ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(payload)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+Delayed::Job.prepend Delayed::Backend::Json::Patch

data/lib/delayed/backend/json/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Delayed
+  module Backend
+    module Json
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/delayed/backend/json.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'json/patch'

data/lib/delayed_job_json.rb

@@ -0,0 +1,4 @@
+require 'active_support'
+require 'delayed_job_active_record'
+
+require_relative 'delayed/backend/json'

data/lib/generators/delayed_job_json/migration_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module DelayedJobJson
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    def create_migration_file
+      migration_template "migration1.rb", "db/migrate/add_payload_to_delayed_jobs.rb", migration_version: migration_version
+      migration_template "migration2.rb", "db/migrate/migrate_handler_to_payload_on_delayed_jobs.rb", migration_version: migration_version
+    end
+
+    private
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+  end
+end

data/lib/generators/delayed_job_json/templates/migration1.rb

@@ -0,0 +1,24 @@
+class AddPayloadToDelayedJobs < ActiveRecord::Migration<%= migration_version %>
+  def up
+    case ENV['DATABASE']
+    when 'postgresql'
+      add_column :delayed_jobs, :payload, :jsonb, null: false, default: {}
+      add_index :delayed_jobs, :payload, using: :gin
+    when 'mysql'
+      add_column :delayed_jobs, :payload, :json
+    else
+      add_column :delayed_jobs, :payload, :json, null: false, default: {}
+    end
+  end
+
+  def down
+    case ENV['DATABASE']
+    when 'postgresql'
+      remove_column :delayed_jobs, :payload, :jsonb, null: false, default: {}
+    when 'mysql'
+      remove_column :delayed_jobs, :payload, :json
+    else
+      remove_column :delayed_jobs, :payload, :json, null: false, default: {}
+    end
+  end
+end

data/lib/generators/delayed_job_json/templates/migration2.rb

@@ -0,0 +1,18 @@
+class MigrateHandlerToPayloadOnDelayedJobs < ActiveRecord::Migration<%= migration_version %>
+  class DelayedJob < ActiveRecord::Base
+  end
+
+  def up
+    DelayedJob.find_each do |job|
+      loaded = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(job.handler) : YAML.load(job.handler)
+      job.update_columns(payload: loaded.job_data)
+    end
+  end
+
+  def down
+    DelayedJob.find_each do |job|
+      handler = ActiveJob::QueueAdapters::DelayedJobAdapter::JobWrapper.new(job.payload).to_yaml
+      job.update_columns(handler: handler)
+    end
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_json
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Migrate handler of text column to json column for delayed_job
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delayed_job_json.gemspec
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
+- lib/delayed/backend/json.rb
+- lib/delayed/backend/json/patch.rb
+- lib/delayed/backend/json/version.rb
+- lib/delayed_job_json.rb
+- lib/generators/delayed_job_json/migration_generator.rb
+- lib/generators/delayed_job_json/templates/migration1.rb
+- lib/generators/delayed_job_json/templates/migration2.rb
+homepage: https://github.com/kanety/delayed_job_json
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Migrate handler of text column to json column for delayed_job
+test_files: []