sidekiq-dry 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 282e093e2f1d0697be874b0f58809fb355c1fa4f9fd4cac8ba582e1bf16c9b08
+  data.tar.gz: 2109bf98148d6a90a7f6f8779759244f5da82353b1f45bcb7ef36227167f0f1b
+SHA512:
+  metadata.gz: 8c24e8f6d88e3f2b9e1a48aac40ffa8832080d99f7d61b3054a0a75f442d854b21f2e5c1debdd2488dd958faf374d0c47474fe70b8355530df797e73b7d66486
+  data.tar.gz: 722d24fa5c38df321abc9467d15910dc19aed1b935a75e15ad4f255253e48b9b5720be95c01900a82660e867e8dfd0c39c0db58351d109287ed6da8bf8adefd1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dimitrisplusplus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-dry (1.0.0)
+      activesupport
+      dry-struct (~> 1.0)
+      sidekiq (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.1.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.3.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-types (~> 1.3)
+      ice_nine (~> 0.11)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rake (12.3.3)
+    redis (4.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    sidekiq (6.1.2)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sidekiq-dry!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dimitris Zorbas
+
+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,143 @@
+# Sidekiq::Dry
+
+[![Gem version](https://badge.fury.io/rb/sidekiq-dry.png)](http://badge.fury.io/rb/sidekiq-dry)
+[![Build Status](https://travis-ci.org/zorbash/sidekiq-dry.svg?branch=master)](https://travis-ci.org/zorbash/sidekiq-dry)
+
+Gem to provide serialization and deserialization of [Dry::Struct][dry-struct]
+arguments for [Sidekiq][sidekiq] jobs.
+
+## Rationale
+
+**Argument Validation**
+
+By using `Dry::Struct` arguments you can choose to validate some attributes and mark
+any of them as optional. An attempt to enqueue a job with invalid arguments will raise,
+minimizing resource waste from jobs which would otherwise be retried multiple times without any chance of completing successfully.
+
+Example:
+
+```ruby
+class Coupons::ApplyCouponJob::Params < Dry::Struct
+  attribute :user_id,     Types::Strict::Integer
+  attribute :coupon_code, Types::Strict::String
+end
+
+job_params = Coupons::ApplyCouponJob::Params.new(user_id: user.id, coupon_code: coupon.code)
+
+Users::SendConfirmationEmailJob.perform_async(job_params)
+```
+
+**Documentation**
+
+Instead of documenting the types of each job argument, which can easily become outdated, you can refer to the types of the attributes of the struct.
+
+**Positional Arguments are Error Prone**
+
+You won't ever have to remember the order of arguments of a job.
+
+**Versioning**
+
+Adding this gem does not break any existing jobs in your app.
+It only works on jobs enqueued with `Dry::Struct` objects.
+
+Adding a new attribute to a parameter struct won't break already enqueued jobs.
+
+It's trivial to version your structs using either a `version` attribute:
+
+```ruby
+class Coupons::ApplyCouponJob::Params < Dry::Struct
+  attribute :user_id,     Types::Strict::Integer
+  attribute :coupon_code, Types::Strict::String
+  attribute :version,     Types::Strict::String.default('1')
+end
+```
+
+or versioned classes:
+
+```ruby
+class Coupons::ApplyCouponJob::Params::V1 < Dry::Struct
+  attribute :user_id,     Types::Strict::Integer
+  attribute :coupon_code, Types::Strict::String
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-dry'
+```
+
+And then execute:
+
+    $ bundle install
+
+Configure Sidekiq to use the middlewares provided by this gem:
+
+```ruby
+# File: config/initializers/sidekiq.rb
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Dry::Client::SerializationMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Dry::Server::DeserializationMiddleware
+  end
+end
+```
+
+See [Middleware usage](sidekiq-middlewares) on the Sidekiq wiki for more info.
+
+## Usage
+
+**Enqueuing Jobs**
+
+```ruby
+class Users::SendConfirmationEmailJob::Params < Dry::Struct
+  attribute :email, Types::Strict::String
+end
+
+job_params = Users::SendConfirmationEmailJob::Params.new(email: user.email)
+
+Users::SendConfirmationEmailJob.perform_async(job_params)
+```
+
+**Authoring Jobs**
+
+```ruby
+class Users::SendConfirmationEmailJob
+  include Sidekiq::Worker
+
+  def perform(params)
+    # params is an instance of Users::SendConfirmationEmailJob::Params
+    mail(to: params.email, subject: 'Welcome!')
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/sidekiq-dry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sidekiq-dry/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Dry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zorbash/sidekiq-dry/blob/master/CODE_OF_CONDUCT.md).
+
+[dry-struct]: https://dry-rb.org/gems/dry-struct/1.0/
+[sidekiq]: https://sidekiq.org/
+[sidekiq-middlewares]: https://github.com/mperham/sidekiq/wiki/Middleware

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/dry"
+
+# 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(__FILE__)

data/bin/setup

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

data/bin/sidekiq

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'sidekiq' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sidekiq", "sidekiq")

data/lib/sidekiq/dry.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'sidekiq'
+require 'dry/struct'
+require 'active_support/all'
+
+require_relative 'dry/client/serialization_middleware'
+require_relative 'dry/server/deserialization_middleware'
+
+module Sidekiq
+  module Dry
+  end
+end

data/lib/sidekiq/dry/client/serialization_middleware.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Dry
+    module Client
+      # Middleware which converts `Dry::Struct` job arguments to hashes with a
+      # `_type` key to help deserializing back to the initial struct
+      class SerializationMiddleware
+        def call(_worker_class, job, _queue, _redis_pool)
+          job['args'].map! do |arg|
+            # Don't mutate non-struct arguments
+            next arg unless arg.is_a? ::Dry::Struct
+
+            # Set a `_type` argument to be able to instantiate
+            # the struct when the job is performed
+            arg.to_h.merge(_type: arg.class)
+          end
+
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/dry/server/deserialization_middleware.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Dry
+    module Server
+      # Middleware which instantiates `Dry::Struct` hash arguments
+      class DeserializationMiddleware
+        def call(_worker, job, _queue)
+          job['args'].map! do |arg|
+            # Only mutate Dry::Struct hashes
+            next arg unless struct?(arg)
+
+            to_struct(arg)
+          end
+
+          yield
+        end
+
+        private
+
+        def struct?(arg)
+          arg.is_a?(Hash) && arg.key?('_type')
+        end
+
+        def to_struct(arg)
+          arg['_type'].constantize.new(arg.except('_type').symbolize_keys)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/dry/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Dry
+    VERSION = "1.0.0"
+  end
+end

data/sidekiq-dry.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/sidekiq/dry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-dry"
+  spec.version       = Sidekiq::Dry::VERSION
+  spec.authors       = ["Dimitris Zorbas"]
+  spec.email         = ["dimitrisplusplus@gmail.com"]
+
+  spec.summary       = %q{Dry::Struct arguments for Sidekiq jobs}
+  spec.description   = %q{Gem to provide serialization and deserialization of Dry::Struct arguments for Sidekiq jobs}
+  spec.homepage      = 'https://github.com/zorbash/sidekiq-dry'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/zorbash/sidekiq-dry'
+  spec.metadata["changelog_uri"] = 'https://github.com/zorbash/sidekiq-dry/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sidekiq', '~> 6.0'
+  spec.add_dependency 'dry-struct', '~> 1.0'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-dry
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimitris Zorbas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Gem to provide serialization and deserialization of Dry::Struct arguments
+  for Sidekiq jobs
+email:
+- dimitrisplusplus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/sidekiq
+- lib/sidekiq/dry.rb
+- lib/sidekiq/dry/client/serialization_middleware.rb
+- lib/sidekiq/dry/server/deserialization_middleware.rb
+- lib/sidekiq/dry/version.rb
+- sidekiq-dry.gemspec
+homepage: https://github.com/zorbash/sidekiq-dry
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zorbash/sidekiq-dry
+  source_code_uri: https://github.com/zorbash/sidekiq-dry
+  changelog_uri: https://github.com/zorbash/sidekiq-dry/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Dry::Struct arguments for Sidekiq jobs
+test_files: []