activejob-users 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c290e729335f4a6927c156aa0c12b47938096ca
+  data.tar.gz: b231fb49a34daa59e345c9924406e9772af0a659
+SHA512:
+  metadata.gz: 3b1e2b5f99b0e4a8c2189a48a1df7d741dd098f340cd1d113c930913e0bc853493ecab7deb3b0e73d578baf8bcc66f8fb62b1a64f773b33ce06bcbaf0c8750b3
+  data.tar.gz: f828f6551011564b38a901490a4e5ab64c77ecfc379b6defb349dc64bf9d33cc0fbe269e11564e6c0b0b7b28a7dee8c5d0838f9f20338cd8064f31403f5c1d8d

data/lib/active_job/users.rb

@@ -0,0 +1,19 @@
+module ActiveJob
+  module Users
+    def self.included(base)
+      base.send :attr_reader, :job_user
+
+      base.send :around_perform do |_job, block|
+        extract_job_user!
+
+        block.call
+      end
+
+      def extract_job_user!
+        options = arguments.extract_options!
+        @job_user = options.delete(:job_user)
+        arguments << options unless options.empty?
+      end
+    end
+  end
+end

data/lib/active_job/users/version.rb

@@ -0,0 +1,5 @@
+module ActiveJob
+  module Users
+    VERSION = '0.0.1'
+  end
+end

data/lib/activejob-users.rb

@@ -0,0 +1,2 @@
+require 'active_job/users'
+require 'active_job/users/version'

data/spec/active_job/users_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe ActiveJob::Users do
+  subject { TestJob.new }
+
+  context 'when a job_user argument is passed to the job' do
+    let(:user) { {email: 'mark@markrebec.com'} }
+
+    it 'extracts the job_user keyword argument' do
+      subject.arguments << {job_user: user}
+      subject.extract_job_user!
+
+      expect(subject.job_user).to eq(user)
+    end
+
+    it 'passes other keyword arguments through' do
+      subject.arguments << {job_user: user, foo: 'bar'}
+      subject.extract_job_user!
+
+      expect(subject.arguments.last).to eq({foo: 'bar'})
+    end
+  end
+
+  context 'when a job_user argument is not passed to the job' do
+    it 'sets the job_user to nil' do
+      subject.extract_job_user!
+
+      expect(subject.job_user).to eq(nil)
+    end
+
+    it 'passes all keyword arguments through' do
+      subject.arguments << {foo: 'bar'}
+      subject.extract_job_user!
+
+      expect(subject.arguments.last).to eq({foo: 'bar'})
+    end
+  end
+
+  describe 'around_perform' do
+    it 'calls extract_job_user!' do
+      expect_any_instance_of(TestJob).to receive(:extract_job_user!)
+      TestJob.perform_now
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+require 'coveralls'
+Coveralls.wear!
+require 'active_job'
+require 'activejob-users'
+require 'rspec'
+
+Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  #config.filter_run :focus
+  #config.run_all_when_everything_filtered = true
+end

data/spec/support/test_job.rb

@@ -0,0 +1,7 @@
+class TestJob < ActiveJob::Base
+  include ActiveJob::Users
+  queue_as :default
+
+  def perform
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: activejob-users
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Rebec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pass a user through to your active_jobs for context
+email:
+- mark@markrebec.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_job/users.rb
+- lib/active_job/users/version.rb
+- lib/activejob-users.rb
+- spec/active_job/users_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_job.rb
+homepage: http://github.com/markrebec/activejob-users
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Pass a user through to your active_jobs for context
+test_files:
+- spec/active_job/users_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_job.rb