sidekiq-symbols 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 895afbd3618b031afb0839dbc36c10b90a4eb03a
+  data.tar.gz: a7df359e07d804c62fc6c7313cb04550dd990bdf
+SHA512:
+  metadata.gz: adb7baeb660624f770caedc595e38bcca55a7ed1ffedb076ecf6ca1760d7860ba05a64d5de7eba1734e6239f3d8349f3a98c8af0f916566c76cf799f1b266ac3
+  data.tar.gz: b2a086137d07ce88edc86834e4843c6c685c6334b29a1193b841c4b1a90ec690d77e250e70a8e704914645127c7d41038239f999fce19adfab98605eec96489b

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+(MIT License)
+
+Copyright (c) 2014 Adam Prescott
+
+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,72 @@
+[![Build Status](https://travis-ci.org/aprescott/sidekiq-symbols.svg?branch=master)](https://travis-ci.org/aprescott/sidekiq-symbols)
+
+sidekiq-symbols gives you symbol keys for your `perform` method.
+
+### Caveats
+
+I have not tested this in a production environment! The 0.x version is there for a reason!
+
+### To use
+
+Add
+
+```ruby
+include Sidekiq::Symbols
+```
+
+to your Sidekiq job class.
+
+```ruby
+class SomeJob
+  include Sidekiq::Worker
+  include Sidekiq::Symbols
+
+  # ...
+end
+```
+
+### What it does
+
+Because Sidekiq round-trips job arguments through JSON serialization-deserialization, a hash argument passed to `perform_async` which uses symbols won't actually be `fetch`able with symbol keys, because
+
+```ruby
+perform_async(x: 1)
+```
+
+leads to when it gets pulled out of Redis.
+
+```ruby
+perform("x" => 1)
+```
+
+sidekiq-symbols forces `perform` to use symbols for all its keys, so that this works:
+
+```ruby
+class SomeJob
+  include Sidekiq::Worker
+  include Sidekiq::Symbols
+
+  def perform(arg, opts = {})
+    opts[:x] # this works
+  end
+end
+
+SomeJob.perform_async("foo", x: 1)
+```
+
+Note that `perform_async("foo", "x" => 1)` here would leave `opts["x"] == nil` since you _must_ use `opts[:x]`.
+
+### Keyword arguments
+
+Ruby's keyword arguments are essentially an extension of using a symbol-keyed hash argument, so sidekiq-symbols also enables keyword arguments:
+
+```ruby
+class SomeJob
+  include Sidekiq::Worker
+  include Sidekiq::Symbols
+
+  def perform(x: 1, y: 2)
+    # x and y are availalbe
+  end
+end
+```

data/lib/sidekiq-symbols.rb

@@ -0,0 +1 @@
+require "sidekiq/symbols"

data/lib/sidekiq/symbols.rb

@@ -0,0 +1,33 @@
+require "sidekiq"
+
+module Sidekiq
+module Symbols
+  def self.included(klass)
+    klass.class_eval { prepend(Symbolizer) }
+  end
+
+  module Symbolizer
+    def perform(*args)
+      symbolized_args = args.map do |arg|
+        if arg.is_a?(Hash)
+          __sidekiq_symbols_symbolize_keys(arg)
+        else
+          arg
+        end
+      end.to_a
+      super(*symbolized_args)
+    end
+
+    private
+
+    def __sidekiq_symbols_symbolize_keys(arg)
+      h = {}
+      arg.each do |k, v|
+        k = k.to_sym if k.respond_to?(:to_sym)
+        h[k] = v.is_a?(Hash) ? __sidekiq_symbols_symbolize_keys(v) : v
+      end
+      h
+    end
+  end
+end
+end

data/sidekiq-symbols.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name         = "sidekiq-symbols"
+  s.version      = "0.1.1"
+  s.authors      = ["Adam Prescott"]
+  s.email        = ["adam@aprescott.com"]
+  s.homepage     = "https://github.com/aprescott/sidekiq-symbols"
+  s.summary      = "Symbolize your Sidekiq jobs."
+  s.description  = "Symbolize your Sidekiq jobs."
+  s.files        = Dir["{lib/**/*,spec/**/*}"] + %w[sidekiq-symbols.gemspec LICENSE Gemfile README.md]
+  s.require_path = "lib"
+  s.test_files   = Dir["spec/*"]
+  s.required_ruby_version = ">= 2.0.0"
+  s.licenses = ["MIT"]
+
+  s.add_dependency("sidekiq")
+  s.add_development_dependency("rspec", ">= 3.0")
+  s.add_development_dependency("pry-byebug")
+end

data/spec/re_run_friendly_formatter.rb

@@ -0,0 +1,31 @@
+require "rspec/core/formatters/progress_formatter"
+ 
+class ReRunFriendlyFormatter < RSpec::Core::Formatters::ProgressFormatter
+  RSpec::Core::Formatters.register self, :dump_summary
+ 
+  def dump_summary(summary)
+    super
+ 
+    failed_files = summary.failed_examples.map { |e| RSpec::Core::Metadata::relative_path(e.file_path) }.uniq
+ 
+    return if summary.failed_examples.empty? || failed_files.length > 10
+ 
+    output.puts
+    output.puts "Rerun all failed examples:"
+    output.puts
+ 
+    output.puts failure_colored("rspec #{summary.failed_examples.map { |e| RSpec::Core::Metadata::relative_path(e.location) }.join(" ")}")
+ 
+    output.puts
+    output.puts "Rerun all files containing failures:"
+    output.puts
+ 
+    output.puts failure_colored("rspec #{failed_files.join(" ")}")
+  end
+ 
+  private
+ 
+  def failure_colored(str)
+    RSpec::Core::Formatters::ConsoleCodes.wrap(str, :failure)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require "sidekiq/symbols"
+require "sidekiq/testing"
+require "pry-byebug"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.full_backtrace = true
+  end
+
+  config.around(:each) do |example|
+    Sidekiq::Testing.inline!(&example)
+  end
+end

data/spec/symbols_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Sidekiq::Symbols do
+  class SampleJob
+    include Sidekiq::Worker
+    include Sidekiq::Symbols
+
+    def perform(*args, **kwargs)
+      $find_a_better_way_than_this = [args, kwargs]
+    end
+  end
+
+  class SampleHashArgJob
+    include Sidekiq::Worker
+    include Sidekiq::Symbols
+
+    def perform(x, opts = {})
+      $find_a_better_way_than_this = [x, opts]
+    end
+  end
+
+  def expect_transformation(klass, *input, arg_signature)
+    expect(klass.new.perform(*input)).to eq(arg_signature)
+    klass.perform_async(*input)
+    expect($find_a_better_way_than_this).to eq(arg_signature)
+  end
+
+  it "allows regular arguments" do
+    expect_transformation(SampleJob, 1, [[1], {}])
+  end
+
+  it "allows keyword args" do
+    expect_transformation(SampleJob, { x: 1 }, [[], x: 1])
+  end
+
+  it "symbolizes old-style hash args" do
+    expect_transformation(SampleHashArgJob, 1, { "x" => 1 }, [1, x: 1])
+  end
+
+  it "symbolizes all arguments to Sidekiq's perform" do
+    input = [1, "x" => { "y" => 2, z: { "foo bar" => 0 } }]
+    arg_signature = [[1], { x: { y: 2, z: { :"foo bar" => 0 } } }]
+
+    expect_transformation(SampleJob, *input, arg_signature)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-symbols
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adam Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: 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-byebug
+  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: Symbolize your Sidekiq jobs.
+email:
+- adam@aprescott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/sidekiq-symbols.rb
+- lib/sidekiq/symbols.rb
+- sidekiq-symbols.gemspec
+- spec/re_run_friendly_formatter.rb
+- spec/spec_helper.rb
+- spec/symbols_spec.rb
+homepage: https://github.com/aprescott/sidekiq-symbols
+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.0.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: Symbolize your Sidekiq jobs.
+test_files:
+- spec/re_run_friendly_formatter.rb
+- spec/spec_helper.rb
+- spec/symbols_spec.rb