migratiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fea372348191f76c19066d1cb8237c6a21e0e30
+  data.tar.gz: d9ed7d3ef0689ded84ce0d1a8089db25b183e2be
+SHA512:
+  metadata.gz: 478f7c9582fa3fcd1cb42c8fbb3d5fab64546144cbf877af0d2f84e8ac7ac1452134488e7e6fda5fbd0ef1ab9c3006dd127990b08cfda1e918d272749fc6c4a1
+  data.tar.gz: fae1fc4d8287a5ba3dd196e861da69e15e39088546f03f64987dd1b9ab6750525237a0527bbdf3efdf290fe7b355e45db75473a21a91d4f57e8bbfe1e8f52446

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.rdb

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in migratiq.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brody Berson
+
+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,122 @@
+# Migratiq
+
+Migrate your scheduled sidekiq jobs when their arguements change. :tada:
+
+After a deploy, if the number of arguements on a worker has changed
+those workers tend to fail unless you delete them manually
+now you can either specify a migration plan for a particular number of arguments
+i.e.
+
+```Ruby
+class HardWorker
+  include Migratiq
+
+  def perform(a, b)
+    # Do work here...
+  end
+
+  migrate_by(arity: 5) do |a, b, c, d, e|
+    [b, a]
+  end
+end
+
+pry> HardWorker.migrate!
+```
+
+or remove all jobs that don't match the current interface
+
+```Ruby
+class HardWorker
+  include Migratiq
+
+  def perform(a, b)
+    # Do work here...
+  end
+end
+
+pry> HardWorker.migrate!(delete: true)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'migratiq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install migratiq
+
+## Usage
+
+Say your current worker looks something like,
+
+```Ruby
+class HardWorker
+  def perform(a, b, c, d)
+    # Do work here...
+  end
+end
+```
+
+and you find that you no longer need to take arguments `c` and `d`. So now your worker looks like,
+
+```Ruby
+class HardWorker
+  def perform(a, b)
+    # Do work here...
+  end
+end
+```
+
+Now if you deploy this change and `HardWorker` has work that is already scheduled, **all those jobs will fail**.
+
+if you aren't concerned about loosing that work, all you need to do is add migratiq and you can remove them all and clean up your logs
+
+```Ruby
+class HardWorker
+  include 'migratiq'
+  def perform(a, b)
+    # Do work here...
+  end
+end
+
+pry>HardWorker.migrate!(delete: true)
+```
+
+It will remove all the jobs that do not match the current arity of the perform function.
+However, if you don't want to loose your work, you can tell Migratiq how to migrate the worker params
+
+```Ruby
+class HardWorker
+  include Migratiq
+
+  def perform(a, b)
+
+  end
+
+  migrate_by(arity: 4) do |a, b, c, d|
+    [b, a]
+  end
+end
+
+pry> HardWorker.migrate!
+```
+
+This work will be rescheduled with the new arguements. if you also want to delete the old jobs you can add the `delete: true` flag on migrate.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HParker/migratiq.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+
+task :spec do
+  begin
+    require 'rspec/core/rake_task'
+    RSpec::Core::RakeTask.new(:spec)
+  rescue LoadError
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "migratiq"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/arity_checker.rb

@@ -0,0 +1,36 @@
+module Migratiq
+  class ArityChecker
+    def initialize(method_definition)
+      @method_definition = method_definition
+    end
+
+    def accepts?(arg_count)
+      allowed_range.include?(arg_count)
+    end
+
+    private
+
+    attr_reader :method_definition
+
+    def parameters
+      method_definition.parameters
+    end
+
+    def required
+      parameters.select { |param|
+        param[0] == :req
+      }.size
+    end
+
+    def optional
+      parameters.select { |param|
+        param[0] == :opt
+      }.size
+    end
+
+    def allowed_range
+      (required..required+optional)
+    end
+
+  end
+end

data/lib/migratiq.rb

@@ -0,0 +1,59 @@
+require "migratiq/version"
+require "arity_checker"
+require 'sidekiq/api'
+
+module Migratiq
+  def self.included(base)
+    @classes ||= []
+    @classes << base
+    base.extend(ClassMethods)
+  end
+
+  def self.migrate_all!
+    @classes.each do |klass|
+      klass.migrate!
+    end
+  end
+
+  module ClassMethods
+    def migrate!(delete: false)
+      method = self.new.method(:perform)
+      checker = ArityChecker.new(method)
+      outdated_jobs = check_arity(checker, Sidekiq::ScheduledSet.new)
+      migrate_outdated(outdated_jobs, delete)
+    end
+
+    def migrate_by(arity:, &block)
+      migraiton_plans[self.name][arity] = block
+    end
+
+    private
+
+    def check_arity(checker, set)
+      set.select { |job|
+        !checker.accepts?(job['args'].size)
+      }
+      end
+
+    def migrate_outdated(outdated, delete)
+      outdated.each do |job|
+        next if Sidekiq::ScheduledSet.new.find_job(job['jid']).nil?
+        Sidekiq::ScheduledSet.new.find_job(job['jid']).delete if delete || plan_for(job['args'].size)
+        if plan_for(job['args'].size)
+          new_args = plan_for(job['args'].size).call(job['args'])
+          self.perform_in(5, *new_args)
+        end
+      end
+    end
+
+    def migraiton_plans
+      @migration_plans ||= Hash.new({})
+    end
+
+    def plan_for(arity)
+      if migraiton_plans[self.name] && migraiton_plans[self.name][arity]
+        migraiton_plans[self.name][arity]
+      end
+    end
+  end
+end

data/lib/migratiq/version.rb

@@ -0,0 +1,3 @@
+module Migratiq
+  VERSION = "0.1.0"
+end

data/migratiq.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'migratiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "migratiq"
+  spec.version       = Migratiq::VERSION
+  spec.authors       = ["Adam Hess"]
+  spec.email         = ["adamhess1991@gmail.com"]
+
+  spec.summary       = %q{migrate sidekiq jobs when changing arguments that a worker accepts.}
+#  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/HParker/migratiq"
+
+  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.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: migratiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hess
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: sidekiq
+  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: 
+email:
+- adamhess1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/arity_checker.rb
+- lib/migratiq.rb
+- lib/migratiq/version.rb
+- migratiq.gemspec
+homepage: https://github.com/HParker/migratiq
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: migrate sidekiq jobs when changing arguments that a worker accepts.
+test_files: []