queue_classic_matchers 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8cfabef2f107163c77342e176369028419df0b9e
-  data.tar.gz: 7c3e40864f608225424faa87aa95c55d5dc0df50
+SHA256:
+  metadata.gz: 4c9c20b4638520c3bb0c5b8e9dbc64202d9fb9d59f0e29dc194a28d5d3b7020a
+  data.tar.gz: 82a3d2dc873586ee2d857a70494fd7055ff49bf771f9ab7608608fb6e760c32f
 SHA512:
-  metadata.gz: 68fcb9b92713b041b25859fc6ed13024023e5a55b9a0504d2098359faa0e66af21147c28e29aa005018dc8cbdc3951ce2dca4a01fc3068669e5f5e6ba7574173
-  data.tar.gz: 7d3997f9b70c53a8d1c98ed5a1624b41960d1701ac74972e91d802a84b083ad4209ddfefee0757d636943601cc0ab7aa936e3358f62fdd7e1643075cc16f5408
+  metadata.gz: 416468f930e73965959db66ddf2cdbe06f66cca892efa20da415025650006d1d18f61082a2a5c08bea3efb0731c005cfb72b96dafa0dfa86f4e17143b30efe33
+  data.tar.gz: 5e935730577ce891f07b48ee5d90b605824a95d412bc1d0a3ce0f118e3b6549daace6cf51ad08dc9975df4baa6bafc8200b86049c93a5e474fee9157c480cf17

data/.circleci/config.yml

@@ -0,0 +1,48 @@
+version: 2
+
+jobs:
+  test:
+    docker:
+      - image: circleci/ruby:2.5.3-node
+      - image: circleci/postgres:9.6.6-alpine
+    steps:
+      - checkout
+      - run:
+          name: run tests
+          command: |
+            bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+            bundle exec rspec
+
+  push_to_rubygems:
+    docker:
+      - image: circleci/ruby:2.5.3
+    steps:
+      - checkout
+      - run:
+          name: Create .gem/credentials file
+          command: |
+            mkdir ~/.gem
+            echo "---
+              :rubygems_api_key: $RUBYGEMS_API_KEY
+            " > ~/.gem/credentials
+            chmod 600 ~/.gem/credentials
+      - run:
+          name: Release to rubygems
+          command: |
+            gem build queue_classic_matchers
+            gem push queue_classic_matchers-*.gem
+
+workflows:
+  version: 2
+  gem_release:
+    jobs:
+      - test
+
+      - push_to_rubygems:
+          filters:
+            branches:
+              ignore:
+                - /.*/
+            tags:
+              only:
+                - /^v.*/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in queue_classic_matchers.gemspec
 gemspec
+
+gem 'rspec'
+# TODO: release qc plus
+gem 'queue_classic_plus', github: 'rainforestapp/queue_classic_plus', tag: 'v4.0.0-alpha2'

data/README.md

@@ -2,6 +2,10 @@
 
 Test helpers and RSpec matchers to [QueueClassicPlus](https://github.com/rainforestapp/queue_classic_plus).
 
+## Compatibility
+
+This version of the matchers are compatible with queue_classic 3.1+ which includes built-in scheduling. See other branches for other compatible versions.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,6 +30,8 @@ TODO: Write usage instructions here
 expect(MyQueueClassicPlusJob).to have_queued(*my_args)
 ```
 
+Other matchers are `have_queue_size_of`, `change_queue_size_of` and `have_scheduled`.
+
 
 ### Test Helper
 
@@ -43,3 +49,9 @@ run_queue q_name, [MyQueueClassicPlusJob]
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Releasing
+
+1. Open a PR and get it merged to master, making sure you've updated VERSION in `lib/queue_classic_matchers/version.rb`
+2. `git checkout master; git pull`
+3. `rake release:source_control_push`

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 

data/lib/queue_classic_matchers.rb

@@ -1,21 +1,48 @@
 require 'rspec/matchers'
-require "queue_classic_matchers/version"
-require "queue_classic_matchers/test_worker"
-require "queue_classic_matchers/test_helper"
+require 'rspec/core'
+require 'queue_classic_matchers/version'
+require 'queue_classic_matchers/test_worker'
+require 'queue_classic_matchers/test_helper'
 
 module QueueClassicMatchers
   # Your code goes here...
   module QueueClassicMatchers::QueueClassicRspec
-    def self.find_by_args(queue_name, method, args, table = "queue_classic_jobs")
-      q = "SELECT * FROM #{table} WHERE q_name = $1 AND method = $2 AND args::text = $3"
+    def self.find_by_args(queue_name, method, args)
+      q = 'SELECT * FROM queue_classic_jobs WHERE q_name = $1 AND method = $2 AND args::text = $3'
       result = QC.default_conn_adapter.execute q, queue_name, method, JSON.dump(args)
       result = [result] unless Array === result
       result.compact
     end
 
     def self.reset!
-      QC.default_conn_adapter.execute "DELETE FROM queue_classic_jobs"
-      QC.default_conn_adapter.execute "DELETE FROM queue_classic_later_jobs"
+      QC.default_conn_adapter.execute 'DELETE FROM queue_classic_jobs'
+    end
+  end
+
+  if defined?(QueueClassicPlus)
+    module QueueClassicPlus
+      module Job
+        def self.included(receiver)
+          receiver.class_eval do
+            shared_examples_for 'a queueable class' do
+              subject { described_class }
+              its(:queue) { should be_a(::QC::Queue) }
+              it { should respond_to(:do) }
+              it { should respond_to(:perform) }
+
+              it 'should be a valid queue name' do
+                expect(subject.queue.name).to be_present
+              end
+            end
+          end
+        end
+      end
+    end
+
+    if RSpec.respond_to?(:configure)
+      RSpec.configure do |c|
+        c.include QueueClassicMatchers::QueueClassicPlus::Job, type: :job
+      end
     end
   end
 end
@@ -37,7 +64,7 @@ RSpec::Matchers.define :have_queued do |*expected|
   end
 
   description do
-    "should enqueue in queue classic"
+    'should enqueue in queue classic'
   end
 end
 
@@ -87,14 +114,13 @@ RSpec::Matchers.define :change_queue_size_of do |expected|
   end
 
   description do
-    "should change the queue size"
+    'should change the queue size'
   end
 end
 
 
 RSpec::Matchers.define :have_scheduled do |*expected_args|
   chain :at do |timestamp|
-    @interval = nil
     @time = timestamp
     @time_info = "at #{@time}"
   end
@@ -102,13 +128,13 @@ RSpec::Matchers.define :have_scheduled do |*expected_args|
   match do |actual|
     method = "#{actual.to_s}._perform"
     queue_name = actual.queue.name
-    results = QueueClassicMatchers::QueueClassicRspec.find_by_args(queue_name,
-                                             method,
-                                             expected_args,
-                                             "queue_classic_later_jobs")
+    results = QueueClassicMatchers::QueueClassicRspec.find_by_args(queue_name, method, expected_args)
+
     results.any? do |entry|
-      time_matches = if @time
-        Time.parse(entry['not_before']).to_i == @time.to_i
+      if @time
+        scheduled_at = entry['scheduled_at']
+        scheduled_at = Time.parse(scheduled_at) unless scheduled_at.is_a?(Time) # ActiveRecord < 6
+        (scheduled_at.to_i - @time.to_i).abs <= 2
       else
         true
       end
@@ -124,6 +150,6 @@ RSpec::Matchers.define :have_scheduled do |*expected_args|
   end
 
   description do
-    "have scheduled arguments"
+    'have scheduled arguments'
   end
 end

data/lib/queue_classic_matchers/version.rb

@@ -1,3 +1,3 @@
 module QueueClassicMatchers
-  VERSION = "0.0.1"
+  VERSION = '1.1.0'
 end

data/queue_classic_matchers.gemspec

@@ -4,20 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'queue_classic_matchers/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "queue_classic_matchers"
+  spec.name          = 'queue_classic_matchers'
   spec.version       = QueueClassicMatchers::VERSION
-  spec.authors       = ["Simon Mathieu"]
-  spec.email         = ["simon.math@gmail.com"]
+  spec.authors       = ['Simon Mathieu', 'Jean-Philippe Boily', 'Emanuel Evans', 'Jonathan Barber']
   spec.summary       = %q{RSpec Matchers and helpers for QueueClassicPlus}
-  spec.description   = %q{RSpec Matchers and helpers for QueueClassicPlus}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/rainforestapp/queue_classic_matchers'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'queue_classic', '>= 3.1.0'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'timecop'
 end

data/spec/queue_classic_matchers_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe QueueClassicMatchers do
+  class TestJob < QueueClassicPlus::Base
+    @queue = :low
+    def self.perform
+    end
+  end
+
+  describe 'have_queued' do
+    it 'works with no arguments' do
+      expect(TestJob).to_not have_queued
+      TestJob.do
+      expect(TestJob).to have_queued
+    end
+
+    it 'works wiht argument' do
+      expect(TestJob).to_not have_queued(1)
+      TestJob.do 1
+      expect(TestJob).to have_queued(1)
+      expect(TestJob).to_not have_queued(2)
+    end
+  end
+
+  describe 'have_queue_size_of' do
+    it 'works' do
+      expect(TestJob).to have_queue_size_of(0)
+      expect(TestJob).to_not have_queue_size_of(1)
+
+      TestJob.do
+
+      expect(TestJob).to have_queue_size_of(1)
+      expect(TestJob).to_not have_queue_size_of(0)
+    end
+  end
+
+  describe 'have_scheduled' do
+    it 'works' do
+      Timecop.freeze do
+        t0 = Time.now
+        TestJob.enqueue_perform_in 60 * 60, 1
+
+        expect(TestJob).to have_scheduled(1).at(t0 + 60 * 60)
+        expect(TestJob).not_to have_scheduled(1).at(t0 + 60 * 60 - 3)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,123 @@
+require 'queue_classic_plus'
+require 'queue_classic_matchers'
+require 'timecop'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # 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
+
+  # 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!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # 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
+
+  # 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
+
+  # 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
+=end
+
+  config.before(:suite) do
+    require 'active_record'
+    require 'pg'
+
+    db_url = ENV.fetch('DATABASE_URL', 'postgres://postgres:@localhost')
+
+    ActiveRecord::Base.establish_connection(db_url)
+    begin
+      ActiveRecord::Base.connection.create_database('queue_classic_matcher_test')
+    rescue ActiveRecord::StatementInvalid => e
+      raise unless e.cause.class == PG::DuplicateDatabase
+    end
+
+    ActiveRecord::Base.connection.execute 'drop schema public cascade; create schema public;'
+
+    QC.default_conn_adapter = QC::ConnAdapter.new(connection: ActiveRecord::Base.connection.raw_connection)
+    QC::Setup.create
+
+    QueueClassicPlus.migrate
+  end
+
+  config.before(:each) do
+    tables = ActiveRecord::Base.connection.tables.select do |table|
+      table != 'schema_migrations'
+    end
+    ActiveRecord::Base.connection.execute("TRUNCATE #{tables.join(', ')} CASCADE") unless tables.empty?
+
+  end
+end

metadata

@@ -1,29 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: queue_classic_matchers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Simon Mathieu
+- Jean-Philippe Boily
+- Emanuel Evans
+- Jonathan Barber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: queue_classic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,15 +83,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RSpec Matchers and helpers for QueueClassicPlus
-email:
-- simon.math@gmail.com
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".rvmrc"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,7 +115,9 @@ files:
 - lib/queue_classic_matchers/test_worker.rb
 - lib/queue_classic_matchers/version.rb
 - queue_classic_matchers.gemspec
-homepage: ''
+- spec/queue_classic_matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rainforestapp/queue_classic_matchers
 licenses:
 - MIT
 metadata: {}
@@ -75,9 +136,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: RSpec Matchers and helpers for QueueClassicPlus
-test_files: []
+test_files:
+- spec/queue_classic_matchers_spec.rb
+- spec/spec_helper.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 2.1.2@queue_classic_matchers --create